Skip to content

Ramp: Bill schemas

42 Ramp schemas with complete fields and constraints.

← Bill operations · All schemas

Associate Bills — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
bill_idstringRequired within parentUnique identifier of the bill to associate.
Format: uuid
labelstringRequired within parentLabel shown on this bill for the associated bill (e.g. 'Insurance bill').
Maximum length: 64
Minimum length: 1
reverse_labelstringRequired within parentLabel shown on the associated bill for this bill (e.g. 'Rental bill').
Maximum length: 64
Minimum length: 1

Create a bill — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
accounting_field_selectionsarrayOptionalList of accounting field options selected to code the bill.
accounting_field_selections[]ModelEach itemExpand Create a bill — request body — body accounting field selections item
attachment_idJSONOptional
attachment_id (anyOf 1)stringAlternativeUUID of a previously uploaded file to attach to this bill.
Default: null
Format: uuid
attachment_id (anyOf 2)nullAlternative
due_atstringRequired within parentDue date of the bill.
Format: date
enable_accounting_syncbooleanOptionalA flag you can set to False to prevent this bill from syncing to your ERP. Note: enable_accounting_sync must be True when remote_id is provided.
Default: true
entity_idstringRequired within parentAssociated business entity.
Format: uuid
inventory_line_itemsJSONOptional
inventory_line_items (anyOf 1)arrayAlternativeList of inventory line items related to the bill.
inventory_line_items (anyOf 1)[]ModelEach itemExpand Create a bill — request body — body inventory line items List of inventory line items related to the bill item
inventory_line_items (anyOf 2)nullAlternative
invoice_currencystringRequired within parentCurrency of the invoice.
One of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNH, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, EURC, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, OPEN_USD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USDB, USDC, USDG, USDT, USN, UYI, UYU, UYW, UZS, VED, VES, VND, VUV, WST, XAD, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XCG, XDR, XOF, XPD, XPF, XPT, XSU, XTS, XUA, XXX, YER, ZAR, ZMW, ZWG, ZWL
invoice_numberstringRequired within parentThe invoice number on the bill.
Maximum length: 84
issued_atstringRequired within parentIssued date of the bill.
Format: date
line_itemsJSONOptional
line_items (anyOf 1)arrayAlternativeList of line items related to the bill.
line_items (anyOf 1)[]ModelEach itemExpand Create a bill — request body — body line items List of line items related to the bill item
line_items (anyOf 2)nullAlternative
memoJSONOptional
memo (anyOf 1)stringAlternativeMemo of the bill.
Default: null
Maximum length: 1000
memo (anyOf 2)nullAlternative
payment_datestringOptionalFor a non-card bill, the date the payment is scheduled to be initiated. If the requested date is unavailable, such as a weekend, bank holiday, past date, or same-day cutoff miss, Ramp schedules the payment for the next available initiation date.
Format: date
payment_detailsJSONOptional
payment_details (anyOf 1)ModelAlternativeExpand Create a bill — request body — body payment details value
Payment details for the bill. Expected schema depends on payment_method.
Default: null
payment_details (anyOf 2)nullAlternative
payment_methodstringOptionalPayment method for the bill. Required unless use_default_payment_method is true.
Default: UNSPECIFIED
One of: ACH, CARD, CHECK, CRYPTO_WALLET_TRANSFER, DOMESTIC_WIRE, INTERNATIONAL, LOCAL_BANK_TRANSFER, ONE_TIME_CARD, ONE_TIME_CARD_DELIVERY, PAID_MANUALLY, SWIFT
posting_dateJSONOptional
posting_date (anyOf 1)stringAlternativeThe date the bill is posted to the accounting system.
Default: null
Format: date
posting_date (anyOf 2)nullAlternative
purchase_order_idsarrayOptionalUnique identifiers of the purchase orders to match this bill to.
purchase_order_ids[]stringEach itemFormat: uuid
remote_idJSONOptional
remote_id (anyOf 1)stringAlternativeAn ID that identifies the bill on the client's side. An accounting connection is required and enable_accounting_sync must be True when remote_id is provided. Omit remote_id for bills that will not be synced to an accounting provider.
Default: null
remote_id (anyOf 2)nullAlternative
target_payment_arrival_dateJSONOptional
target_payment_arrival_date (anyOf 1)stringAlternativeFor a bill created with use_default_payment_method=true, the target vendor arrival date. Ramp uses this date to compute the latest payment initiation date needed to target vendor arrival. If that initiation date is in the past or after today's cutoff, Ramp schedules the next valid initiation date.
Default: null
Format: date
target_payment_arrival_date (anyOf 2)nullAlternative
use_default_payment_methodbooleanOptionalWhen set to true, create the bill using the default payment method configured for the vendor. If set to true, payment_method and payment_details should not be provided.
Default: false
use_default_vendor_contactbooleanOptionalWhen set to true, create the bill using the default contact configured for the vendor. If set to true, vendor_contact_id should not be provided.
Default: false
vendor_contact_idJSONOptional
vendor_contact_id (anyOf 1)stringAlternativeUnique identifier of vendor contact, must be associated with passed vendor. Required unless use_default_vendor_contact is true.
Default: null
Format: uuid
vendor_contact_id (anyOf 2)nullAlternative
vendor_idstringRequired within parentUnique identifier of bill vendor.
Format: uuid
vendor_memoJSONOptional
vendor_memo (anyOf 1)stringAlternativeMemo to the vendor.
Default: null
Maximum length: 400
vendor_memo (anyOf 2)nullAlternative

Referenced models: Create a bill — request body — body accounting field selections item, Create a bill — request body — body inventory line items List of inventory line items related to the bill item, Create a bill — request body — body line items List of line items related to the bill item, Create a bill — request body — body payment details value

Create a bill — request body — body accounting field selections item

FieldTypePresenceDescription and constraints
$objectRoot
field_external_idstringRequired within parentRemote ID of accounting field. This is the external ID, likely from ERP system.
field_option_external_idJSONOptional
field_option_external_id (anyOf 1)stringAlternativeRemote ID of accounting field option. This is the external ID, likely from ERP system. Required if free_form_text is not provided.
Default: null
field_option_external_id (anyOf 2)nullAlternative
free_form_textJSONOptional
free_form_text (anyOf 1)stringAlternativeFree form text for the accounting field selection. For DATE-type fields, use ISO format (YYYY-MM-DD). Required if field_option_external_id is not provided.
Default: null
Minimum length: 1
free_form_text (anyOf 2)nullAlternative

Create a bill — request body — body inventory line items List of inventory line items related to the bill item

FieldTypePresenceDescription and constraints
$objectRoot
accounting_field_selectionsarrayOptional
accounting_field_selections[]ModelEach itemExpand Create a bill — request body — body accounting field selections item
memoJSONOptional
memo (anyOf 1)stringAlternativeDefault: null
memo (anyOf 2)nullAlternative
quantityJSONRequired within parentMinimum: 0
quantity (oneOf 1)stringAlternativeFormat: decimal
quantity (oneOf 2)numberAlternative
unit_priceJSONRequired within parent
unit_price (oneOf 1)stringAlternativeFormat: decimal
unit_price (oneOf 2)numberAlternative

Referenced models: Create a bill — request body — body accounting field selections item

Create a bill — request body — body line items List of line items related to the bill item

FieldTypePresenceDescription and constraints
$objectRoot
accounting_field_selectionsarrayOptional
accounting_field_selections[]ModelEach itemExpand Create a bill — request body — body accounting field selections item
amountJSONRequired within parent
amount (oneOf 1)stringAlternativeFormat: decimal
amount (oneOf 2)numberAlternative
memoJSONOptional
memo (anyOf 1)stringAlternativeDefault: null
memo (anyOf 2)nullAlternative

Referenced models: Create a bill — request body — body accounting field selections item

Create a bill — request body — body payment details value

FieldTypePresenceDescription and constraints
$JSONRootdiscriminator: {"mapping": {"ACH": "#/components/schemas/ApiCreateBankAccountPaymentParamsRequestBody", "CARD": "#/components/schemas/ApiCreateCardBillPaymentParamsRequestBody", "CHECK": "#/components/schemas/ApiCreateBillVendorPaymentParamsRequestBody", "CRYPTO_WALLET_TRANSFER": "#/components/schemas/ApiCreateBankAccountPaymentParamsRequestBody", "DOMESTIC_WIRE": "#/components/schemas/ApiCreateBankAccountPaymentParamsRequestBody", "INTERNATIONAL": "#/components/schemas/ApiCreateBankAccountPaymentParamsRequestBody", "LOCAL_BANK_TRANSFER": "#/components/schemas/ApiCreateBankAccountPaymentParamsRequestBody", "PAID_MANUALLY": "#/components/schemas/ApiCreateManualBillPaymentParamsRequestBody", "SWIFT": "#/components/schemas/ApiCreateBankAccountPaymentParamsRequestBody"}, "propertyName": "payment_method"}
$ (oneOf 1)ModelAlternativeExpand Create a bill — request body — body payment details value is same day, payment arrival date, source bank account id, vendor account id
$ (oneOf 2)ModelAlternativeExpand Create a bill — request body — body payment details value is same day, payment arrival date, source bank account id
$ (oneOf 3)ModelAlternativeExpand Create a bill — request body — body payment details value spend limit id, transaction id
$ (oneOf 4)ModelAlternativeExpand Create a bill — request body — body payment details value manual payment method, payment date

Referenced models: Create a bill — request body — body payment details value is same day, payment arrival date, source bank account id, vendor account id, Create a bill — request body — body payment details value is same day, payment arrival date, source bank account id, Create a bill — request body — body payment details value spend limit id, transaction id, Create a bill — request body — body payment details value manual payment method, payment date

Create a bill — request body — body payment details value is same day, payment arrival date, source bank account id

FieldTypePresenceDescription and constraints
$objectRoot
is_same_daybooleanOptional
Enables same-day delivery for eligible payments. Currently, this functionality is available only for ACH payments.
Same-day delivery may incur an additional fee. For more details, see the [Ramp Help Center](https://support.ramp.com/hc/en-us/articles/4417836454419-Bill-payment-methods-and-timelines#same-day-delivery).
To use same-day delivery via the API, your account must first be enabled for this feature. Please visit https://app.ramp.com/chat?entryVariant=developerSupport to request access before implementing.

Default: false
payment_arrival_datestringRequired within parent
The expected date the payment will arrive in the vendor's bank account.

The required time and fee to process the payment depends on the payment method. See the [Ramp Help Center](https://support.ramp.com/hc/en-us/articles/4417836454419-Bill-payment-methods-and-timelines) for more information on payment speeds. An error will be thrown if selected date is invalid.

Format: date
source_bank_account_idstringRequired within parentUnique identifier of the bank account to pay the bill from. Must be associated with the passed business entity and have usage_type=BILL_PAY_BANK_ACCOUNT.
Format: uuid

Create a bill — request body — body payment details value is same day, payment arrival date, source bank account id, vendor account id

FieldTypePresenceDescription and constraints
$objectRoot
is_same_daybooleanOptional
Enables same-day delivery for eligible payments. Currently, this functionality is available only for ACH payments.
Same-day delivery may incur an additional fee. For more details, see the [Ramp Help Center](https://support.ramp.com/hc/en-us/articles/4417836454419-Bill-payment-methods-and-timelines#same-day-delivery).
To use same-day delivery via the API, your account must first be enabled for this feature. Please visit https://app.ramp.com/chat?entryVariant=developerSupport to request access before implementing.

Default: false
payment_arrival_datestringRequired within parent
The expected date the payment will arrive in the vendor's bank account.

The required time and fee to process the payment depends on the payment method. See the [Ramp Help Center](https://support.ramp.com/hc/en-us/articles/4417836454419-Bill-payment-methods-and-timelines) for more information on payment speeds. An error will be thrown if selected date is invalid.

Format: date
source_bank_account_idstringRequired within parentUnique identifier of the bank account to pay the bill from. Must be associated with the passed business entity and have usage_type=BILL_PAY_BANK_ACCOUNT.
Format: uuid
vendor_account_idstringRequired within parentUnique identifier of the vendor account to pay the bill to.
Format: uuid

Create a bill — request body — body payment details value manual payment method, payment date

FieldTypePresenceDescription and constraints
$objectRoot
manual_payment_methodstringRequired within parentManual payment method of the bill. If passed, payment_date must also be passed and the bill will be marked as paid.
One of: CASH, CHECK, CROSS_BORDER_PAYMENT, CRYPTO_WALLET_TRANSFER, DIRECT_DEBIT, DOMESTIC_WIRE_TRANSFER, NON_RAMP_CREDIT_CARD, OTHER, PAID_IN_ERP
payment_datestringRequired within parentThe date the bill is paid. This field is not relevant for one-time card delivery, as limits are created immediately and sent out to the vendor on the due date.
Format: date

Create a bill — request body — body payment details value spend limit id, transaction id

FieldTypePresenceDescription and constraints
$objectRoot
spend_limit_idstringRequired within parentUnique identifier of the spend limit associated with the matched transaction.
Format: uuid
transaction_idJSONOptional
transaction_id (anyOf 1)stringAlternativeIf already paid, the unique identifier of the bill payment transaction. The bill will be marked as paid with this transaction once approved.
Default: null
Format: uuid
transaction_id (anyOf 2)nullAlternative

Create a draft bill — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
accounting_field_selectionsarrayOptionalList of accounting field options selected to code the bill.
accounting_field_selections[]ModelEach itemExpand Create a bill — request body — body accounting field selections item
due_atstringOptionalDue date of the bill.
Format: date
enable_accounting_syncbooleanOptionalA flag you can set to False to prevent this bill from syncing to your ERP.
entity_idstringOptionalAssociated business entity.
Format: uuid
inventory_line_itemsJSONOptional
inventory_line_items (anyOf 1)arrayAlternativeList of inventory line items associated with the bill. When provided, this will replace all existing inventory line items.
inventory_line_items (anyOf 1)[]ModelEach itemExpand Update a bill — request body — body inventory line items array item
inventory_line_items (anyOf 2)nullAlternative
invoice_currencystringOptionalCurrency of the invoice.
One of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNH, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, EURC, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, OPEN_USD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USDB, USDC, USDG, USDT, USN, UYI, UYU, UYW, UZS, VED, VES, VND, VUV, WST, XAD, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XCG, XDR, XOF, XPD, XPF, XPT, XSU, XTS, XUA, XXX, YER, ZAR, ZMW, ZWG, ZWL
invoice_numberstringOptionalThe invoice number on the bill.
Maximum length: 84
issued_atstringOptionalIssued date of the bill.
Format: date
line_itemsJSONOptional
line_items (anyOf 1)arrayAlternativeList of line items related to the bill. When provided, this will replace all existing line items.
line_items (anyOf 1)[]ModelEach itemExpand Update a bill — request body — body line items array item
line_items (anyOf 2)nullAlternative
memoJSONOptional
memo (anyOf 1)stringAlternativeMemo of the bill.
Maximum length: 1000
memo (anyOf 2)nullAlternative
payment_methodstringOptionalPayment method of the bill.
One of: ACH, CARD, CHECK, CRYPTO_WALLET_TRANSFER, DOMESTIC_WIRE, INTERNATIONAL, LOCAL_BANK_TRANSFER, ONE_TIME_CARD, ONE_TIME_CARD_DELIVERY, PAID_MANUALLY, SWIFT
posting_dateJSONOptional
posting_date (anyOf 1)stringAlternativeThe date the bill is posted to the accounting system.
Format: date
posting_date (anyOf 2)nullAlternative
purchase_order_idsarrayOptionalUnique identifiers of the purchase orders to match this bill to. When provided, this will replace all existing linked purchase orders.
purchase_order_ids[]stringEach itemFormat: uuid
remote_idJSONOptional
remote_id (anyOf 1)stringAlternativeAn ID that identifies the bill on client's side.
remote_id (anyOf 2)nullAlternative
use_default_payment_methodbooleanOptionalWhen set to true, create the draft bill using the default payment method configured for the vendor. If set to true, payment_method and payment_details should not be provided.
Default: false
vendor_contact_idstringOptionalUnique identifier of vendor contact, must be associated with passed vendor.
Format: uuid
vendor_idstringRequired within parentUnique identifier of bill vendor.
Format: uuid
vendor_memoJSONOptional
vendor_memo (anyOf 1)stringAlternativeMemo to the vendor.
Maximum length: 400
vendor_memo (anyOf 2)nullAlternative

Referenced models: Create a bill — request body — body accounting field selections item, Update a bill — request body — body inventory line items array item, Update a bill — request body — body line items array item

Fetch a draft bill — response body

FieldTypePresenceDescription and constraints
$objectRoot
accounting_dateJSONRequired within parent
accounting_date (anyOf 1)stringAlternativeThe date for the bill for accounting purposes. If not specified, falls back to the bill issue date.
Format: date-time
Read only: true
accounting_date (anyOf 2)nullAlternative
accounting_field_selectionsarrayRequired within parentList of accounting field options selected to code the bill.
accounting_field_selections[]ModelEach itemExpand Hold Bill — response body — accounting field selections item
amountJSONRequired within parent
amount (anyOf 1)ModelAlternativeExpand Hold Bill — response body — amount
Amount of the bill, represented in the lowest denomination of the currency (e.g., cents for USD).
Read only: true
amount (anyOf 2)nullAlternative
bill_ownerJSONRequired within parent
bill_owner (anyOf 1)ModelAlternativeExpand Hold Bill — response body — bill owner
Information about the bill owner.
bill_owner (anyOf 2)nullAlternative
created_atstringRequired within parentThe date the bill was created.
Format: date-time
due_atJSONRequired within parent
due_at (anyOf 1)stringAlternativeThe date the bill is due.
Format: date-time
due_at (anyOf 2)nullAlternative
entity_idJSONRequired within parent
entity_id (anyOf 1)stringAlternativeAssociated business entity.
Format: uuid
entity_id (anyOf 2)nullAlternative
idstringRequired within parentFormat: uuid
inventory_line_itemsarrayRequired within parentList of inventory line items related to the bill.
inventory_line_items[]ModelEach itemExpand Fetch a draft bill — response body — inventory line items item
invoice_numberJSONRequired within parent
invoice_number (anyOf 1)stringAlternativeThe invoice number on the bill.
invoice_number (anyOf 2)nullAlternative
invoice_urlsarrayRequired within parentPre-signed urls to download invoice files.
Read only: true
invoice_urls[]stringEach item
issued_atJSONRequired within parent
issued_at (anyOf 1)stringAlternativeThe date the bill was issued on invoice.
Format: date-time
issued_at (anyOf 2)nullAlternative
line_itemsarrayRequired within parentList of line items related to the bill.
line_items[]ModelEach itemExpand Fetch a draft bill — response body — line items item
memoJSONRequired within parent
memo (anyOf 1)stringAlternativeMemo of the bill.
memo (anyOf 2)nullAlternative
posting_dateJSONRequired within parent
posting_date (anyOf 1)stringAlternativeThe date the bill was posted to the ERP. Alternatively known as accounting date, accounting sync date.
Format: date-time
posting_date (anyOf 2)nullAlternative
remote_idJSONRequired within parent
remote_id (anyOf 1)stringAlternativeThe external ID that identifies the bill on the client's side.
remote_id (anyOf 2)nullAlternative
statusJSONRequired within parentPayment status of the bill. Always DRAFT for provisional bills.
Default: DRAFT
sync_statusJSONRequired within parentSync status of the bill. Always NOT_SYNCED for drafts.
Default: NOT_SYNCED
vendorJSONRequired within parent
vendor (anyOf 1)ModelAlternativeExpand Hold Bill — response body — vendor
Vendor information of the bill.
vendor (anyOf 2)nullAlternative
vendor_memoJSONRequired within parent
vendor_memo (anyOf 1)stringAlternativeMemo to the vendor.
vendor_memo (anyOf 2)nullAlternative

Referenced models: Hold Bill — response body — bill owner, Hold Bill — response body — accounting field selections item, Hold Bill — response body — vendor, Fetch a draft bill — response body — inventory line items item, Fetch a draft bill — response body — line items item, Hold Bill — response body — amount

Fetch a draft bill — response body — inventory line items item

FieldTypePresenceDescription and constraints
$objectRoot
accounting_field_selectionsarrayRequired within parentList of accounting field options selected to code the inventory line item.
accounting_field_selections[]ModelEach itemExpand Hold Bill — response body — accounting field selections item
amountJSONRequired within parent
amount (anyOf 1)ModelAlternativeExpand Hold Bill — response body — amount
Amount of the line item, equal to the product of unit quantity and unit price, represented in the lowest denomination of the currency (e.g., cents for USD).
Read only: true
amount (anyOf 2)nullAlternative
idstringRequired within parentUnique identifier of the inventory line item. Stable across draft updates and draft-to-bill conversion.
Format: uuid
memoJSONRequired within parent
memo (anyOf 1)stringAlternativeMemo of the inventory line item
memo (anyOf 2)nullAlternative
quantityJSONRequired within parent
quantity (anyOf 1)JSONAlternative
quantity (anyOf 1) (anyOf 1)numberAlternativeQuantity of the inventory line item
Read only: true
quantity (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
quantity (anyOf 2)nullAlternative
unit_priceJSONRequired within parent
unit_price (anyOf 1)ModelAlternativeExpand Hold Bill — response body — amount
Unit price of the line item, represented in the lowest denomination of the currency (e.g., cents for USD).
Read only: true
unit_price (anyOf 2)nullAlternative

Referenced models: Hold Bill — response body — accounting field selections item, Hold Bill — response body — amount

Fetch a draft bill — response body — line items item

FieldTypePresenceDescription and constraints
$objectRoot
accounting_field_selectionsarrayRequired within parentList of accounting field options selected to code the line item.
accounting_field_selections[]ModelEach itemExpand Hold Bill — response body — accounting field selections item
amountJSONRequired within parent
amount (anyOf 1)ModelAlternativeExpand Hold Bill — response body — amount
Amount of the line item, represented in the lowest denomination of the currency (e.g., cents for USD).
Read only: true
amount (anyOf 2)nullAlternative
idstringRequired within parentUnique identifier of the line item. Stable across draft updates and draft-to-bill conversion.
Format: uuid
memoJSONRequired within parent
memo (anyOf 1)stringAlternativeMemo of the line item
memo (anyOf 2)nullAlternative

Referenced models: Hold Bill — response body — accounting field selections item, Hold Bill — response body — amount

Hold Bill — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
reasonJSONOptional
reason (anyOf 1)stringAlternativeOptional reason for placing the bill on hold.
Default: null
reason (anyOf 2)nullAlternative

Hold Bill — response body

FieldTypePresenceDescription and constraints
$objectRoot
accounting_datestringRequired within parentThe date for the bill for accounting purposes. If not specified, falls back to the bill issue date.
Format: date-time
Read only: true
accounting_field_selectionsarrayRequired within parentList of accounting field options selected to code the bill.
accounting_field_selections[]ModelEach itemExpand Hold Bill — response body — accounting field selections item
amountModelRequired within parentExpand Hold Bill — response body — amount
Amount of the bill, represented in the lowest denomination of the currency (e.g., cents for USD).
Read only: true
applied_vendor_creditsarrayRequired within parentVendor Credits that have been applied to this Bill
Read only: true
applied_vendor_credits[]ModelEach itemExpand Hold Bill — response body — applied vendor credits item
approval_statusJSONRequired within parent
approval_status (anyOf 1)stringAlternativeApproval status of the bill. Note that this is separate from the approval status for payment release.
Known values: APPROVED, INITIALIZED, PENDING, REJECTED, TERMINATED
approval_status (anyOf 2)nullAlternative
archived_atJSONRequired within parent
archived_at (anyOf 1)stringAlternativeThe datetime the bill was archived.
Format: date-time
archived_at (anyOf 2)nullAlternative
attachmentsarrayRequired within parentBusiness-visible bill attachments with their types and download URLs.
Read only: true
attachments[]ModelEach itemExpand Hold Bill — response body — attachments item
bill_ownerModelRequired within parentExpand Hold Bill — response body — bill owner
Information about the bill owner.
created_atstringRequired within parentFormat: date-time
deep_link_urlstringOptionalLink to bill in ERP, if exists.
draft_bill_created_atJSONRequired within parent
draft_bill_created_at (anyOf 1)stringAlternativeThe date the draft bill was created if this bill was created from a draft bill, otherwise None.
Format: date-time
draft_bill_created_at (anyOf 2)nullAlternative
draft_bill_idJSONRequired within parent
draft_bill_id (anyOf 1)stringAlternativeUnique identifier of the draft bill this bill was created from, if one exists.
Format: uuid
draft_bill_id (anyOf 2)nullAlternative
due_atstringRequired within parentFormat: date-time
enable_accounting_syncbooleanOptionalFlag specifying whether the bill should sync to the ERP
entity_idstringRequired within parentAssociated business entity.
Format: uuid
fx_conversion_ratestringRequired within parentFX conversion rate from bill invoice currency to payer currency.
Format: decimal
Read only: true
idstringRequired within parentFormat: uuid
inventory_line_itemsarrayRequired within parentList of inventory line items related to the bill.
inventory_line_items[]ModelEach itemExpand Hold Bill — response body — inventory line items item
invoice_numberstringOptionalThe invoice number on the bill.
invoice_urlsarrayRequired within parentPre-signed URLs for all business-visible bill attachments, including supporting files. Use attachments and filter by attachment_type INVOICE to identify the invoice document.
Read only: true
invoice_urls[]stringEach item
is_payment_sync_readybooleanRequired within parentWhether the bill is ready for payment accounting export. Can be true while status is OPEN. For bills with multiple payments, one eligible ready payment is sufficient; this field does not identify which payments are ready. Excludes manual payments, fully synced bills, and bills paid entirely with vendor credits.
Read only: true
is_withholding_releaseJSONOptional
is_withholding_release (anyOf 1)booleanAlternativeWhether this bill is a retainage withholding release bill, if applicable.
Read only: true
is_withholding_release (anyOf 2)nullAlternative
issued_atstringRequired within parentThe date the bill was issued on invoice.
Format: date-time
item_receipt_idsarrayRequired within parentList of unique identifiers for item receipts associated with this bill through matched purchase orders.
Read only: true
item_receipt_ids[]stringEach itemFormat: uuid
line_itemsarrayRequired within parentList of line items related to the bill.
line_items[]ModelEach itemExpand Hold Bill — response body — line items item
memostringOptionalMemo of the bill.
paid_atstringOptionalThe datetime the bill's payment status is set to PAID. None if the bill's payment status is OPEN
Format: date-time
paymentJSONRequired within parent
payment (anyOf 1)ModelAlternativeExpand Hold Bill — response body — payment amount, bank debit trace id, customer friendly payment id, details, effective date, id, payment date, payment method, trace id
Payment information for the bill. For bills with multiple payments, this is the first non-vendor-credit payment.
Read only: true
payment (anyOf 2)nullAlternative
posting_datestringOptionalThe date the bill was posted to the ERP. Alternatively known as accounting date, accounting sync date.
Format: date-time
purchase_order_idstringOptionalUnique identifier of matched purchase order, if one exists.
Format: uuid
Read only: true
related_billsarrayOptionalBills associated with this bill, labelled from this bill's side (e.g. the insurance bill for a rental). Only returned when bill associations are enabled for the business.
Read only: true
related_bills[]ModelEach itemExpand Hold Bill — response body — related bills item
remote_idstringOptionalThe external ID that identifies the bill on the client's side.
statusstringRequired within parentKnown values: OPEN, PAID
status_summarystringRequired within parentStatus summary of the bill.
Known values: APPROVAL_PENDING, APPROVAL_REJECTED, ARCHIVED, AWAITING_PAYMENT, AWAITING_RELEASE, BLOCKED, HELD_BY_PROVIDER, ON_HOLD, PAYMENT_COMPLETED, PAYMENT_DETAILS_MISSING, PAYMENT_ERROR, PAYMENT_NOT_INSTRUCTED, PAYMENT_PROCESSING, PAYMENT_READY, PAYMENT_SCHEDULED, PENDING_VENDOR_APPROVAL, WAITING_FOR_TRANSACTION_MATCH, WAITING_FOR_TRANSFER_MATCH, WAITING_FOR_VENDOR
Read only: true
sync_statusstringRequired within parentSync status of the bill.
Known values: BILL_AND_PAYMENT_SYNCED, BILL_SYNCED, NOT_SYNCED
Read only: true
vendorModelRequired within parentExpand Hold Bill — response body — vendor
Vendor information of the bill.
vendor_contact_idJSONRequired within parent
vendor_contact_id (anyOf 1)stringAlternativeUnique identifier of associated vendor contact.
Format: uuid
vendor_contact_id (anyOf 2)nullAlternative
vendor_memostringOptionalMemo to the vendor.

Referenced models: Hold Bill — response body — bill owner, Hold Bill — response body — accounting field selections item, Hold Bill — response body — attachments item, Hold Bill — response body — inventory line items item, Hold Bill — response body — line items item, Hold Bill — response body — payment amount, bank debit trace id, customer friendly payment id, details, effective date, id, payment date, payment method, trace id, Hold Bill — response body — vendor, Hold Bill — response body — related bills item, Hold Bill — response body — applied vendor credits item, Hold Bill — response body — amount

Hold Bill — response body — accounting field selections item

FieldTypePresenceDescription and constraints
$objectRoot
category_infoModelRequired within parentExpand Hold Bill — response body — accounting field selections item category info
information about the accounting category (or accounting field).
display_nameJSONRequired within parent
display_name (anyOf 1)stringAlternativeCustomer-set display name for the accounting field option in Ramp. When the customer renames an option inside Ramp, this returns the new label while `name` continues to return the ERP-source name. May be null if no Ramp-side override is set.
display_name (anyOf 2)nullAlternative
external_codeJSONOptional
external_code (anyOf 1)stringAlternativeexternal code of accounting field option; Code field displayed on the ERP.
external_code (anyOf 2)nullAlternative
external_idstringRequired within parentexternal id of accounting field option; It should uniquely identify an accounting field option on the client end.
idstringRequired within parentID that uniquely identifies an accounting field option within Ramp
namestringRequired within parentname of accounting field option
provider_nameJSONRequired within parent
provider_name (anyOf 1)stringAlternativeName of the accounting provider
Read only: true
provider_name (anyOf 2)nullAlternative

Referenced models: Hold Bill — response body — accounting field selections item category info

Hold Bill — response body — accounting field selections item category info

FieldTypePresenceDescription and constraints
$objectRoot
external_idstringRequired within parentexternal id of accounting field; It should uniquely identify an accounting field on the client end.
idstringRequired within parentID that uniquely identifies an accounting field within Ramp
namestringRequired within parentname of accounting field
typestringRequired within parentaccounting field type
Known values: AMORTIZATION_TEMPLATE, BILLABLE, COST_CENTER, CUSTOMERS_JOBS, DEFERRAL_CODE, EXPENSE_ENTITY, GL_ACCOUNT, INVENTORY_ITEM, JOURNAL, MERCHANT, NON_ERP, OTHER, PAYROLL_PROVIDER, PROJECT, REPORTING_TAG, SALES_TAX_CODE, SUBSIDIARY, TAX_CODE, UNIT_OF_MEASURE

Hold Bill — response body — amount

FieldTypePresenceDescription and constraints
$objectRoot
amountJSONRequired within parent
amount (anyOf 1)integerAlternativethe amount of money represented in the smallest denomination of the currency. For example, when the currency is USD, then the amount is expressed in cents.
amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
currency_codestringRequired within parentThe type of currency, in ISO 4217 format. e.g. USD for US dollars
Default: USD
minor_unit_conversion_rateJSONRequired within parent
minor_unit_conversion_rate (anyOf 1)JSONAlternative
minor_unit_conversion_rate (anyOf 1) (anyOf 1)integerAlternativeThe conversion factor to convert from the integer amount to the actual currency value. Divide amount by this value to get the real currency amount. For USD, this is 100 (e.g., 12034 / 100 = 120.34 USD). See https://docs.ramp.com/developer-api/v1/monetary-values for more information.
Read only: true
minor_unit_conversion_rate (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
minor_unit_conversion_rate (anyOf 2)nullAlternative

Hold Bill — response body — applied vendor credits item

FieldTypePresenceDescription and constraints
$objectRoot
amountModelRequired within parentExpand Hold Bill — response body — amount
Amount of the Vendor Credit applied to this specific bill. This is not necessarily the entire amount of the Vendor Credit itself. Denominated in the Vendor Credit's currency.
Read only: true
idstringRequired within parentUnique identifier for the vendor credit

Referenced models: Hold Bill — response body — amount

Hold Bill — response body — attachments item

FieldTypePresenceDescription and constraints
$objectRoot
attachment_typestringRequired within parentType of attachment.
Known values: EMAIL, FILE, INVOICE, VENDOR_CREDIT
idstringRequired within parentUnique identifier of the bill attachment.
Format: uuid
urlstringRequired within parentPre-signed URL to download the attachment.
Read only: true

Hold Bill — response body — bill owner

FieldTypePresenceDescription and constraints
$objectRoot
first_namestringOptionalBill owner's first name.
idstringRequired within parentBill owner's ID.
Format: uuid
last_namestringOptionalBill owner's last name.

Hold Bill — response body — inventory line items item

FieldTypePresenceDescription and constraints
$objectRoot
accounting_field_selectionsarrayRequired within parentList of accounting field options selected to code the line item.
accounting_field_selections[]ModelEach itemExpand Hold Bill — response body — accounting field selections item
amountModelRequired within parentExpand Hold Bill — response body — amount
Amount of the line item, equal to the product of unit quantity and unit price, represented in the lowest denomination of the currency (e.g., cents for USD).
Read only: true
idstringRequired within parentUnique identifier of the inventory line item. Stable across bill updates and draft-to-bill conversion.
Format: uuid
item_receipt_line_item_idsarrayRequired within parentList of unique identifiers for item receipt line items associated with this bill inventory line item through the purchase order line item
Read only: true
item_receipt_line_item_ids[]stringEach itemFormat: uuid
memostringOptionalMemo of the line item
purchase_order_line_item_idJSONRequired within parent
purchase_order_line_item_id (anyOf 1)stringAlternativeUnique identifier of the matched purchase order line item, if any
Format: uuid
purchase_order_line_item_id (anyOf 2)nullAlternative
quantityJSONRequired within parent
quantity (anyOf 1)numberAlternativeQuantity of the line item
quantity (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
unit_priceModelRequired within parentExpand Hold Bill — response body — amount
Unit price of the line item, represented in the lowest denomination of the currency (e.g., cents for USD).
Read only: true
withholding_line_itemJSONOptional
withholding_line_item (anyOf 1)ModelAlternativeExpand Hold Bill — response body — line items item withholding line item gross amount, withholding amount, withholding percentage
Retainage withholding details for the inventory line item, if applicable.
Read only: true
withholding_line_item (anyOf 2)nullAlternative

Referenced models: Hold Bill — response body — accounting field selections item, Hold Bill — response body — line items item withholding line item gross amount, withholding amount, withholding percentage, Hold Bill — response body — amount

Hold Bill — response body — line items item

FieldTypePresenceDescription and constraints
$objectRoot
accounting_field_selectionsarrayRequired within parentList of accounting field options selected to code the line item.
Read only: true
accounting_field_selections[]ModelEach itemExpand Hold Bill — response body — accounting field selections item
amountModelRequired within parentExpand Hold Bill — response body — amount
Amount of the line item, represented in the lowest denomination of the currency (e.g., cents for USD).
Read only: true
idstringRequired within parentUnique identifier of the line item. Stable across bill updates and draft-to-bill conversion.
Format: uuid
item_receipt_line_item_idsarrayRequired within parentList of unique identifiers for item receipt line items associated with this bill line item through the purchase order line item
Read only: true
item_receipt_line_item_ids[]stringEach itemFormat: uuid
memostringOptionalMemo of the line item
purchase_order_line_item_idJSONRequired within parent
purchase_order_line_item_id (anyOf 1)stringAlternativeUnique identifier of the matched purchase order line item, if any
Format: uuid
purchase_order_line_item_id (anyOf 2)nullAlternative
withholding_line_itemJSONOptional
withholding_line_item (anyOf 1)ModelAlternativeExpand Hold Bill — response body — line items item withholding line item gross amount, withholding amount, withholding percentage
Retainage withholding details for the line item, if applicable.
Read only: true
withholding_line_item (anyOf 2)nullAlternative

Referenced models: Hold Bill — response body — accounting field selections item, Hold Bill — response body — line items item withholding line item gross amount, withholding amount, withholding percentage, Hold Bill — response body — amount

Hold Bill — response body — line items item withholding line item gross amount, withholding amount, withholding percentage

FieldTypePresenceDescription and constraints
$objectRoot
gross_amountModelRequired within parentExpand Fetch a payment — response body — amount
Gross amount of the line item before retainage withholding.
withholding_amountModelRequired within parentExpand Fetch a payment — response body — amount
Retainage withholding amount for the line item.
withholding_percentageJSONRequired within parent
withholding_percentage (anyOf 1)stringAlternativeRetainage withholding percentage for the line item.
Format: decimal
withholding_percentage (anyOf 2)nullAlternative

Referenced models: Fetch a payment — response body — amount

Hold Bill — response body — payment amount, bank debit trace id, customer friendly payment id, details, effective date, id, payment date, payment method, trace id

FieldTypePresenceDescription and constraints
$objectRoot
amountModelRequired within parentExpand Hold Bill — response body — amount
Paid amount of the bill.
bank_debit_trace_idModelOptionalExpand Hold Bill — response body — payment amount, bank debit trace id, customer friendly payment id, details, effective date, id, payment date, payment method, trace id bank debit trace id
The bank-facing accountability reference for the business bank debit leg of this payment, when available.
Read only: true
customer_friendly_payment_idJSONRequired within parent
customer_friendly_payment_id (anyOf 1)stringAlternativeCustomer-friendly payment identifier for non-card payment methods, if available. Bills sharing the same value belong to the same payment or batch payment.
Read only: true
customer_friendly_payment_id (anyOf 2)nullAlternative
detailsModelRequired within parentExpand Hold Bill — response body — payment amount, bank debit trace id, customer friendly payment id, details, effective date, id, payment date, payment method, trace id details
Additional payment details specific to payment method.
effective_dateJSONRequired within parent
effective_date (anyOf 1)stringAlternativeFor non-card payment methods only, the date the payment is actually initiated.
Format: date-time
effective_date (anyOf 2)nullAlternative
idJSONRequired within parent
id (anyOf 1)stringAlternativeUnique identifier of the payment. Bills sharing the same payment ID belong to the same batch payment.
Read only: true
id (anyOf 2)nullAlternative
payment_dateJSONRequired within parent
payment_date (anyOf 1)stringAlternativeFor non-card payment methods, the scheduled initiation date. For card payment methods, the scheduled payment or card-delivery date until a transaction is associated, then the transaction date. This field does not indicate settlement; use details.transaction_ids and the Transactions API.
Format: date-time
payment_date (anyOf 2)nullAlternative
payment_methodJSONRequired within parent
payment_method (anyOf 1)stringAlternativeKnown values: ACH, AUTOMATIC_CARD_PAYMENT, CARD, CHECK, CRYPTO_WALLET_TRANSFER, DIRECT_DEBIT, DOMESTIC_WIRE, EARLY_PAYMENT_DISCOUNT, FED_NOW, INTERNATIONAL, LOCAL_BANK_TRANSFER, ONE_TIME_CARD, ONE_TIME_CARD_DELIVERY, PAID_MANUALLY, RTP, SWIFT, UNSPECIFIED, VENDOR_CREDIT
Read only: true
payment_method (anyOf 2)nullAlternative
trace_idJSONRequired within parent
trace_id (anyOf 1)ModelAlternativeExpand Hold Bill — response body — payment amount, bank debit trace id, customer friendly payment id, details, effective date, id, payment date, payment method, trace id bank debit trace id
For non-card payment methods only, the trace ID for this bill. This field is only returned in the GET /bills/{bill_id} response body (not in the GET /bills paginated query).
trace_id (anyOf 2)nullAlternative

Referenced models: Hold Bill — response body — payment amount, bank debit trace id, customer friendly payment id, details, effective date, id, payment date, payment method, trace id bank debit trace id, Hold Bill — response body — payment amount, bank debit trace id, customer friendly payment id, details, effective date, id, payment date, payment method, trace id details, Hold Bill — response body — amount

Hold Bill — response body — payment amount, bank debit trace id, customer friendly payment id, details, effective date, id, payment date, payment method, trace id bank debit trace id

FieldTypePresenceDescription and constraints
$objectRoot
descriptorstringOptionalHuman-readable description of the trace ID. For example, 'Check Number' or 'ACH Trace ID'.
trace_idstringOptionalThe unique reference ID to the payment for this bill.

Hold Bill — response body — payment amount, bank debit trace id, customer friendly payment id, details, effective date, id, payment date, payment method, trace id details

FieldTypePresenceDescription and constraints
$JSONRootdiscriminator: {"mapping": {"CardPaymentDetailsSchema": "#/components/schemas/ApiCardPaymentDetailsResource", "ManualPaymentDetailsSchema": "#/components/schemas/ApiManualPaymentDetailsResource", "VendorPaymentDetailsSchema": "#/components/schemas/ApiVendorPaymentDetailsResource"}, "propertyName": "schema_type"}
$ (anyOf 1)ModelAlternativeExpand Hold Bill — response body — payment amount, bank debit trace id, customer friendly payment id, details, effective date, id, payment date, payment method, trace id details fund id, spend limit id, transaction ids
$ (anyOf 2)ModelAlternativeExpand Hold Bill — response body — payment amount, bank debit trace id, customer friendly payment id, details, effective date, id, payment date, payment method, trace id details manual payment method
$ (anyOf 3)ModelAlternativeExpand Hold Bill — response body — payment amount, bank debit trace id, customer friendly payment id, details, effective date, id, payment date, payment method, trace id details approval status, is same day, source bank account id, vendor account id

Referenced models: Hold Bill — response body — payment amount, bank debit trace id, customer friendly payment id, details, effective date, id, payment date, payment method, trace id details fund id, spend limit id, transaction ids, Hold Bill — response body — payment amount, bank debit trace id, customer friendly payment id, details, effective date, id, payment date, payment method, trace id details manual payment method, Hold Bill — response body — payment amount, bank debit trace id, customer friendly payment id, details, effective date, id, payment date, payment method, trace id details approval status, is same day, source bank account id, vendor account id

Hold Bill — response body — payment amount, bank debit trace id, customer friendly payment id, details, effective date, id, payment date, payment method, trace id details approval status, is same day, source bank account id, vendor account id

FieldTypePresenceDescription and constraints
$objectRoot
approval_statusJSONRequired within parent
approval_status (anyOf 1)stringAlternativeApproval status of the payment, if payment-step approvals are used.
Known values: APPROVED, INITIALIZED, PENDING, REJECTED, TERMINATED
approval_status (anyOf 2)nullAlternative
is_same_daybooleanRequired within parentSpecifies whether the payment is configured for same-day delivery.
Read only: true
source_bank_account_idJSONRequired within parent
source_bank_account_id (anyOf 1)stringAlternativeUnique identifier of the bank account associated with this bill payment, if it exists.
Format: uuid
source_bank_account_id (anyOf 2)nullAlternative
vendor_account_idJSONRequired within parent
vendor_account_id (anyOf 1)stringAlternativeUnique identifier of the vendor account associated with this bill payment, if it exists.
Format: uuid
vendor_account_id (anyOf 2)nullAlternative

Hold Bill — response body — payment amount, bank debit trace id, customer friendly payment id, details, effective date, id, payment date, payment method, trace id details fund id, spend limit id, transaction ids

FieldTypePresenceDescription and constraints
$objectRoot
fund_idstringOptionalUnique identifier of the fund associated with this bill payment.
Format: uuid
spend_limit_idstringOptionalAlias of fund_id. The fund to which this bill payment is attributed, if it exists.
Format: uuid
transaction_idsarrayOptionalTransaction IDs associated with this card bill payment, including pre-matched and automatically matched transactions once cleared. Bill is marked paid once transaction matched and prerequisite bill and payment approvals are complete.
transaction_ids[]stringEach itemFormat: uuid

Hold Bill — response body — payment amount, bank debit trace id, customer friendly payment id, details, effective date, id, payment date, payment method, trace id details manual payment method

FieldTypePresenceDescription and constraints
$objectRoot
manual_payment_methodJSONRequired within parent
manual_payment_method (anyOf 1)stringAlternativeManual payment method used for this bill payment. Null if the bill has not yet been marked as paid.
Known values: CASH, CHECK, CROSS_BORDER_PAYMENT, CRYPTO_WALLET_TRANSFER, DIRECT_DEBIT, DOMESTIC_WIRE_TRANSFER, NON_RAMP_CREDIT_CARD, OTHER, PAID_IN_ERP
manual_payment_method (anyOf 2)nullAlternative

Hold Bill — response body — related bills item

FieldTypePresenceDescription and constraints
$objectRoot
amountJSONRequired within parent
amount (anyOf 1)ModelAlternativeExpand Hold Bill — response body — amount
Amount of the associated bill in the lowest denomination of its invoice currency.
Read only: true
amount (anyOf 2)nullAlternative
bill_idstringRequired within parentUnique identifier of the associated bill.
Format: uuid
invoice_numberJSONRequired within parent
invoice_number (anyOf 1)stringAlternativeInvoice number of the associated bill.
invoice_number (anyOf 2)nullAlternative
labelstringRequired within parentDisplay label for the associated bill as seen from this bill (e.g. 'Insurance bill').
statusstringRequired within parentPayment status of the associated bill.
Known values: OPEN, PAID
vendor_nameJSONRequired within parent
vendor_name (anyOf 1)stringAlternativeVendor name of the associated bill.
vendor_name (anyOf 2)nullAlternative

Referenced models: Hold Bill — response body — amount

Hold Bill — response body — vendor

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentUnique identifier of the vendor.
Format: uuid
namestringRequired within parentName of the vendor.
remote_codestringOptionalCode of the vendor; usually it is a unique identifier for the vendor in the remote ERP system.
remote_idstringOptionalExternal ID that uniquely identifies the vendor on the client's side.
remote_namestringOptionalName of the vendor.
typestringOptionalKnown values: BUSINESS, INDIVIDUAL

List bills — response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentResources returned in this page.
data[]ModelEach itemExpand Hold Bill — response body
pageModelRequired within parentExpand List bills — response body — page
Pagination details for this response.

Referenced models: List bills — response body — page, Hold Bill — response body

List bills — response body — page

FieldTypePresenceDescription and constraints
$objectRootPagination details for a Developer API response.
nextJSONRequired within parent
next (anyOf 1)stringAlternativethe query to get to the next page; it is in the format of <BASE_URL>?<new_params>
next (anyOf 2)nullAlternative

List draft bills — response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentResources returned in this page.
data[]ModelEach itemExpand Fetch a draft bill — response body
pageModelRequired within parentExpand List bills — response body — page
Pagination details for this response.

Referenced models: List bills — response body — page, Fetch a draft bill — response body

Update a bill — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
accounting_field_selectionsarrayOptionalList of accounting field options selected to code the bill.
accounting_field_selections[]ModelEach itemExpand Create a bill — request body — body accounting field selections item
due_atstringOptionalDue date of the bill.
Format: date
entity_idstringOptionalAssociated business entity.
Format: uuid
inventory_line_itemsJSONOptional
inventory_line_items (anyOf 1)arrayAlternativeList of inventory line items associated with the bill. When provided, this will replace all existing inventory line items.
inventory_line_items (anyOf 1)[]ModelEach itemExpand Update a bill — request body — body inventory line items array item
inventory_line_items (anyOf 2)nullAlternative
invoice_numberstringOptionalThe invoice number on the bill.
Maximum length: 84
issued_atstringOptionalIssued date of the bill.
Format: date
line_itemsJSONOptional
line_items (anyOf 1)arrayAlternativeList of line items related to the bill. When provided, this will replace all existing line items.
line_items (anyOf 1)[]ModelEach itemExpand Update a bill — request body — body line items array item
line_items (anyOf 2)nullAlternative
memoJSONOptional
memo (anyOf 1)stringAlternativeMemo of the bill.
Maximum length: 1000
memo (anyOf 2)nullAlternative
payment_dateJSONOptional
payment_date (anyOf 1)stringAlternativeFor non-card payment methods, the date the payment is scheduled to be initiated. If the requested date is unavailable, such as a weekend, bank holiday, past date, or same-day cutoff miss, Ramp schedules the payment for the next available initiation date. Set to null to unschedule the payment.
Format: date
payment_date (anyOf 2)nullAlternative
payment_methodstringOptionalPayment method of the bill.
One of: ACH, CARD, CHECK, CRYPTO_WALLET_TRANSFER, DOMESTIC_WIRE, INTERNATIONAL, LOCAL_BANK_TRANSFER, ONE_TIME_CARD, ONE_TIME_CARD_DELIVERY, PAID_MANUALLY, SWIFT
posting_dateJSONOptional
posting_date (anyOf 1)stringAlternativeThe date the bill is posted to the accounting system.
Format: date
posting_date (anyOf 2)nullAlternative
purchase_order_idsarrayOptionalUnique identifiers of the purchase orders to match this bill to. When provided, this will replace all existing linked purchase orders.
purchase_order_ids[]stringEach itemFormat: uuid
remote_idJSONOptional
remote_id (anyOf 1)stringAlternativeAn ID that identifies the bill on client's side.
remote_id (anyOf 2)nullAlternative
vendor_contact_idstringOptionalUnique identifier of vendor contact, must be associated with passed vendor.
Format: uuid
vendor_idstringOptionalUnique identifier of bill vendor.
Format: uuid
vendor_memoJSONOptional
vendor_memo (anyOf 1)stringAlternativeMemo to the vendor.
Maximum length: 400
vendor_memo (anyOf 2)nullAlternative

Referenced models: Create a bill — request body — body accounting field selections item, Update a bill — request body — body inventory line items array item, Update a bill — request body — body line items array item

Update a bill — request body — body inventory line items array item

FieldTypePresenceDescription and constraints
$objectRoot
accounting_field_selectionsarrayOptional
accounting_field_selections[]ModelEach itemExpand Create a bill — request body — body accounting field selections item
idJSONOptional
id (anyOf 1)stringAlternativeUnique identifier of an existing inventory line item on this bill. When provided, the updated line keeps this identifier; when omitted, a new identifier is assigned.
Default: null
Format: uuid
id (anyOf 2)nullAlternative
memoJSONOptional
memo (anyOf 1)stringAlternativeDefault: null
memo (anyOf 2)nullAlternative
purchase_order_line_item_idJSONOptional
purchase_order_line_item_id (anyOf 1)stringAlternativeUnique identifier of the purchase order line item to match this bill inventory line item to.
Default: null
Format: uuid
purchase_order_line_item_id (anyOf 2)nullAlternative
quantityJSONRequired within parentMinimum: 0
quantity (oneOf 1)stringAlternativeFormat: decimal
quantity (oneOf 2)numberAlternative
unit_priceJSONRequired within parent
unit_price (oneOf 1)stringAlternativeFormat: decimal
unit_price (oneOf 2)numberAlternative

Referenced models: Create a bill — request body — body accounting field selections item

Update a bill — request body — body line items array item

FieldTypePresenceDescription and constraints
$objectRoot
accounting_field_selectionsarrayOptional
accounting_field_selections[]ModelEach itemExpand Create a bill — request body — body accounting field selections item
amountJSONRequired within parent
amount (oneOf 1)stringAlternativeFormat: decimal
amount (oneOf 2)numberAlternative
idJSONOptional
id (anyOf 1)stringAlternativeUnique identifier of an existing line item on this bill. When provided, the updated line keeps this identifier; when omitted, a new identifier is assigned.
Default: null
Format: uuid
id (anyOf 2)nullAlternative
memoJSONOptional
memo (anyOf 1)stringAlternativeDefault: null
memo (anyOf 2)nullAlternative
purchase_order_line_item_idJSONOptional
purchase_order_line_item_id (anyOf 1)stringAlternativeUnique identifier of the purchase order line item to match this bill line item to.
Default: null
Format: uuid
purchase_order_line_item_id (anyOf 2)nullAlternative

Referenced models: Create a bill — request body — body accounting field selections item

Update a draft bill — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
accounting_field_selectionsarrayOptionalList of accounting field options selected to code the bill.
accounting_field_selections[]ModelEach itemExpand Create a bill — request body — body accounting field selections item
due_atstringOptionalDue date of the bill.
Format: date
enable_accounting_syncbooleanOptionalA flag you can set to False to prevent this bill from syncing to your ERP.
entity_idstringOptionalAssociated business entity.
Format: uuid
inventory_line_itemsJSONOptional
inventory_line_items (anyOf 1)arrayAlternativeList of inventory line items associated with the bill. When provided, this will replace all existing inventory line items.
inventory_line_items (anyOf 1)[]ModelEach itemExpand Update a bill — request body — body inventory line items array item
inventory_line_items (anyOf 2)nullAlternative
invoice_currencystringOptionalCurrency of the invoice.
One of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNH, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, EURC, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, OPEN_USD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USDB, USDC, USDG, USDT, USN, UYI, UYU, UYW, UZS, VED, VES, VND, VUV, WST, XAD, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XCG, XDR, XOF, XPD, XPF, XPT, XSU, XTS, XUA, XXX, YER, ZAR, ZMW, ZWG, ZWL
invoice_numberstringOptionalThe invoice number on the bill.
Maximum length: 84
issued_atstringOptionalIssued date of the bill.
Format: date
line_itemsJSONOptional
line_items (anyOf 1)arrayAlternativeList of line items related to the bill. When provided, this will replace all existing line items.
line_items (anyOf 1)[]ModelEach itemExpand Update a bill — request body — body line items array item
line_items (anyOf 2)nullAlternative
memoJSONOptional
memo (anyOf 1)stringAlternativeMemo of the bill.
Maximum length: 1000
memo (anyOf 2)nullAlternative
payment_methodstringOptionalPayment method of the bill.
One of: ACH, CARD, CHECK, CRYPTO_WALLET_TRANSFER, DOMESTIC_WIRE, INTERNATIONAL, LOCAL_BANK_TRANSFER, ONE_TIME_CARD, ONE_TIME_CARD_DELIVERY, PAID_MANUALLY, SWIFT
posting_dateJSONOptional
posting_date (anyOf 1)stringAlternativeThe date the bill is posted to the accounting system.
Format: date
posting_date (anyOf 2)nullAlternative
purchase_order_idsarrayOptionalUnique identifiers of the purchase orders to match this bill to. When provided, this will replace all existing linked purchase orders.
purchase_order_ids[]stringEach itemFormat: uuid
remote_idJSONOptional
remote_id (anyOf 1)stringAlternativeAn ID that identifies the bill on client's side.
remote_id (anyOf 2)nullAlternative
use_default_payment_methodbooleanOptionalWhen set to true, create the draft bill using the default payment method configured for the vendor. If set to true, payment_method and payment_details should not be provided.
Default: false
vendor_contact_idstringOptionalUnique identifier of vendor contact, must be associated with passed vendor.
Format: uuid
vendor_idstringOptionalUnique identifier of bill vendor.
Format: uuid
vendor_memoJSONOptional
vendor_memo (anyOf 1)stringAlternativeMemo to the vendor.
Maximum length: 400
vendor_memo (anyOf 2)nullAlternative

Referenced models: Create a bill — request body — body accounting field selections item, Update a bill — request body — body inventory line items array item, Update a bill — request body — body line items array item

Upload a file attachment to an existing bill — request body — body

FieldTypePresenceDescription and constraints
$objectRootPydantic input model for bill attachment upload
attachment_typestringRequired within parentType of attachment. Supported values: INVOICE, FILE. Set to 'INVOICE' for the actual invoice on a bill.
One of: EMAIL, FILE, INVOICE, VENDOR_CREDIT
fileobjectRequired within parentAdditional keys: not allowed
file.filenamestringRequired within parentMinimum length: 1
file.content_typestringRequired within parentMinimum length: 1
file.content_base64stringRequired within parent

Upload a file attachment to an existing bill — response body

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentAttachment UUID
Format: uuid

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.