Ramp: Bill schemas
42 Ramp schemas with complete fields and constraints.
← Bill operations · All schemas
Associate Bills — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
bill_id | string | Required within parent | Unique identifier of the bill to associate. Format: uuid |
label | string | Required within parent | Label shown on this bill for the associated bill (e.g. 'Insurance bill'). Maximum length: 64 Minimum length: 1 |
reverse_label | string | Required within parent | Label shown on the associated bill for this bill (e.g. 'Rental bill'). Maximum length: 64 Minimum length: 1 |
Create a bill — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_field_selections | array | Optional | List of accounting field options selected to code the bill. |
accounting_field_selections[] | Model | Each item | Expand Create a bill — request body — body accounting field selections item |
attachment_id | JSON | Optional | |
attachment_id (anyOf 1) | string | Alternative | UUID of a previously uploaded file to attach to this bill. Default: null Format: uuid |
attachment_id (anyOf 2) | null | Alternative | |
due_at | string | Required within parent | Due date of the bill. Format: date |
enable_accounting_sync | boolean | Optional | A 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_id | string | Required within parent | Associated business entity. Format: uuid |
inventory_line_items | JSON | Optional | |
inventory_line_items (anyOf 1) | array | Alternative | List of inventory line items related to the bill. |
inventory_line_items (anyOf 1)[] | Model | Each item | Expand Create a bill — request body — body inventory line items List of inventory line items related to the bill item |
inventory_line_items (anyOf 2) | null | Alternative | |
invoice_currency | string | Required within parent | Currency 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_number | string | Required within parent | The invoice number on the bill. Maximum length: 84 |
issued_at | string | Required within parent | Issued date of the bill. Format: date |
line_items | JSON | Optional | |
line_items (anyOf 1) | array | Alternative | List of line items related to the bill. |
line_items (anyOf 1)[] | Model | Each item | Expand Create a bill — request body — body line items List of line items related to the bill item |
line_items (anyOf 2) | null | Alternative | |
memo | JSON | Optional | |
memo (anyOf 1) | string | Alternative | Memo of the bill. Default: null Maximum length: 1000 |
memo (anyOf 2) | null | Alternative | |
payment_date | string | Optional | For 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_details | JSON | Optional | |
payment_details (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
payment_method | string | Optional | Payment 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_date | JSON | Optional | |
posting_date (anyOf 1) | string | Alternative | The date the bill is posted to the accounting system. Default: null Format: date |
posting_date (anyOf 2) | null | Alternative | |
purchase_order_ids | array | Optional | Unique identifiers of the purchase orders to match this bill to. |
purchase_order_ids[] | string | Each item | Format: uuid |
remote_id | JSON | Optional | |
remote_id (anyOf 1) | string | Alternative | An 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) | null | Alternative | |
target_payment_arrival_date | JSON | Optional | |
target_payment_arrival_date (anyOf 1) | string | Alternative | For 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) | null | Alternative | |
use_default_payment_method | boolean | Optional | When 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_contact | boolean | Optional | When 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_id | JSON | Optional | |
vendor_contact_id (anyOf 1) | string | Alternative | Unique 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) | null | Alternative | |
vendor_id | string | Required within parent | Unique identifier of bill vendor. Format: uuid |
vendor_memo | JSON | Optional | |
vendor_memo (anyOf 1) | string | Alternative | Memo to the vendor. Default: null Maximum length: 400 |
vendor_memo (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
field_external_id | string | Required within parent | Remote ID of accounting field. This is the external ID, likely from ERP system. |
field_option_external_id | JSON | Optional | |
field_option_external_id (anyOf 1) | string | Alternative | Remote 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) | null | Alternative | |
free_form_text | JSON | Optional | |
free_form_text (anyOf 1) | string | Alternative | Free 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) | null | Alternative |
Create a bill — request body — body inventory line items List of inventory line items related to the bill item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_field_selections | array | Optional | |
accounting_field_selections[] | Model | Each item | Expand Create a bill — request body — body accounting field selections item |
memo | JSON | Optional | |
memo (anyOf 1) | string | Alternative | Default: null |
memo (anyOf 2) | null | Alternative | |
quantity | JSON | Required within parent | Minimum: 0 |
quantity (oneOf 1) | string | Alternative | Format: decimal |
quantity (oneOf 2) | number | Alternative | |
unit_price | JSON | Required within parent | |
unit_price (oneOf 1) | string | Alternative | Format: decimal |
unit_price (oneOf 2) | number | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_field_selections | array | Optional | |
accounting_field_selections[] | Model | Each item | Expand Create a bill — request body — body accounting field selections item |
amount | JSON | Required within parent | |
amount (oneOf 1) | string | Alternative | Format: decimal |
amount (oneOf 2) | number | Alternative | |
memo | JSON | Optional | |
memo (anyOf 1) | string | Alternative | Default: null |
memo (anyOf 2) | null | Alternative |
Referenced models: Create a bill — request body — body accounting field selections item
Create a bill — request body — body payment details value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | discriminator: {"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) | Model | Alternative | Expand Create a bill — request body — body payment details value is same day, payment arrival date, source bank account id, vendor account id |
$ (oneOf 2) | Model | Alternative | Expand Create a bill — request body — body payment details value is same day, payment arrival date, source bank account id |
$ (oneOf 3) | Model | Alternative | Expand Create a bill — request body — body payment details value spend limit id, transaction id |
$ (oneOf 4) | Model | Alternative | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
is_same_day | boolean | Optional | 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_date | string | Required 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_id | string | Required within parent | Unique 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
is_same_day | boolean | Optional | 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_date | string | Required 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_id | string | Required within parent | Unique 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_id | string | Required within parent | Unique 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
manual_payment_method | string | Required within parent | Manual 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_date | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
spend_limit_id | string | Required within parent | Unique identifier of the spend limit associated with the matched transaction. Format: uuid |
transaction_id | JSON | Optional | |
transaction_id (anyOf 1) | string | Alternative | If 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) | null | Alternative |
Create a draft bill — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_field_selections | array | Optional | List of accounting field options selected to code the bill. |
accounting_field_selections[] | Model | Each item | Expand Create a bill — request body — body accounting field selections item |
due_at | string | Optional | Due date of the bill. Format: date |
enable_accounting_sync | boolean | Optional | A flag you can set to False to prevent this bill from syncing to your ERP. |
entity_id | string | Optional | Associated business entity. Format: uuid |
inventory_line_items | JSON | Optional | |
inventory_line_items (anyOf 1) | array | Alternative | List of inventory line items associated with the bill. When provided, this will replace all existing inventory line items. |
inventory_line_items (anyOf 1)[] | Model | Each item | Expand Update a bill — request body — body inventory line items array item |
inventory_line_items (anyOf 2) | null | Alternative | |
invoice_currency | string | Optional | Currency 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_number | string | Optional | The invoice number on the bill. Maximum length: 84 |
issued_at | string | Optional | Issued date of the bill. Format: date |
line_items | JSON | Optional | |
line_items (anyOf 1) | array | Alternative | List of line items related to the bill. When provided, this will replace all existing line items. |
line_items (anyOf 1)[] | Model | Each item | Expand Update a bill — request body — body line items array item |
line_items (anyOf 2) | null | Alternative | |
memo | JSON | Optional | |
memo (anyOf 1) | string | Alternative | Memo of the bill. Maximum length: 1000 |
memo (anyOf 2) | null | Alternative | |
payment_method | string | Optional | Payment 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_date | JSON | Optional | |
posting_date (anyOf 1) | string | Alternative | The date the bill is posted to the accounting system. Format: date |
posting_date (anyOf 2) | null | Alternative | |
purchase_order_ids | array | Optional | Unique identifiers of the purchase orders to match this bill to. When provided, this will replace all existing linked purchase orders. |
purchase_order_ids[] | string | Each item | Format: uuid |
remote_id | JSON | Optional | |
remote_id (anyOf 1) | string | Alternative | An ID that identifies the bill on client's side. |
remote_id (anyOf 2) | null | Alternative | |
use_default_payment_method | boolean | Optional | When 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_id | string | Optional | Unique identifier of vendor contact, must be associated with passed vendor. Format: uuid |
vendor_id | string | Required within parent | Unique identifier of bill vendor. Format: uuid |
vendor_memo | JSON | Optional | |
vendor_memo (anyOf 1) | string | Alternative | Memo to the vendor. Maximum length: 400 |
vendor_memo (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_date | JSON | Required within parent | |
accounting_date (anyOf 1) | string | Alternative | The 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) | null | Alternative | |
accounting_field_selections | array | Required within parent | List of accounting field options selected to code the bill. |
accounting_field_selections[] | Model | Each item | Expand Hold Bill — response body — accounting field selections item |
amount | JSON | Required within parent | |
amount (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
bill_owner | JSON | Required within parent | |
bill_owner (anyOf 1) | Model | Alternative | Expand Hold Bill — response body — bill owner Information about the bill owner. |
bill_owner (anyOf 2) | null | Alternative | |
created_at | string | Required within parent | The date the bill was created. Format: date-time |
due_at | JSON | Required within parent | |
due_at (anyOf 1) | string | Alternative | The date the bill is due. Format: date-time |
due_at (anyOf 2) | null | Alternative | |
entity_id | JSON | Required within parent | |
entity_id (anyOf 1) | string | Alternative | Associated business entity. Format: uuid |
entity_id (anyOf 2) | null | Alternative | |
id | string | Required within parent | Format: uuid |
inventory_line_items | array | Required within parent | List of inventory line items related to the bill. |
inventory_line_items[] | Model | Each item | Expand Fetch a draft bill — response body — inventory line items item |
invoice_number | JSON | Required within parent | |
invoice_number (anyOf 1) | string | Alternative | The invoice number on the bill. |
invoice_number (anyOf 2) | null | Alternative | |
invoice_urls | array | Required within parent | Pre-signed urls to download invoice files. Read only: true |
invoice_urls[] | string | Each item | |
issued_at | JSON | Required within parent | |
issued_at (anyOf 1) | string | Alternative | The date the bill was issued on invoice. Format: date-time |
issued_at (anyOf 2) | null | Alternative | |
line_items | array | Required within parent | List of line items related to the bill. |
line_items[] | Model | Each item | Expand Fetch a draft bill — response body — line items item |
memo | JSON | Required within parent | |
memo (anyOf 1) | string | Alternative | Memo of the bill. |
memo (anyOf 2) | null | Alternative | |
posting_date | JSON | Required within parent | |
posting_date (anyOf 1) | string | Alternative | The date the bill was posted to the ERP. Alternatively known as accounting date, accounting sync date. Format: date-time |
posting_date (anyOf 2) | null | Alternative | |
remote_id | JSON | Required within parent | |
remote_id (anyOf 1) | string | Alternative | The external ID that identifies the bill on the client's side. |
remote_id (anyOf 2) | null | Alternative | |
status | JSON | Required within parent | Payment status of the bill. Always DRAFT for provisional bills. Default: DRAFT |
sync_status | JSON | Required within parent | Sync status of the bill. Always NOT_SYNCED for drafts. Default: NOT_SYNCED |
vendor | JSON | Required within parent | |
vendor (anyOf 1) | Model | Alternative | Expand Hold Bill — response body — vendor Vendor information of the bill. |
vendor (anyOf 2) | null | Alternative | |
vendor_memo | JSON | Required within parent | |
vendor_memo (anyOf 1) | string | Alternative | Memo to the vendor. |
vendor_memo (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_field_selections | array | Required within parent | List of accounting field options selected to code the inventory line item. |
accounting_field_selections[] | Model | Each item | Expand Hold Bill — response body — accounting field selections item |
amount | JSON | Required within parent | |
amount (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
id | string | Required within parent | Unique identifier of the inventory line item. Stable across draft updates and draft-to-bill conversion. Format: uuid |
memo | JSON | Required within parent | |
memo (anyOf 1) | string | Alternative | Memo of the inventory line item |
memo (anyOf 2) | null | Alternative | |
quantity | JSON | Required within parent | |
quantity (anyOf 1) | JSON | Alternative | |
quantity (anyOf 1) (anyOf 1) | number | Alternative | Quantity of the inventory line item Read only: true |
quantity (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
quantity (anyOf 2) | null | Alternative | |
unit_price | JSON | Required within parent | |
unit_price (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative |
Referenced models: Hold Bill — response body — accounting field selections item, Hold Bill — response body — amount
Fetch a draft bill — response body — line items item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_field_selections | array | Required within parent | List of accounting field options selected to code the line item. |
accounting_field_selections[] | Model | Each item | Expand Hold Bill — response body — accounting field selections item |
amount | JSON | Required within parent | |
amount (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
id | string | Required within parent | Unique identifier of the line item. Stable across draft updates and draft-to-bill conversion. Format: uuid |
memo | JSON | Required within parent | |
memo (anyOf 1) | string | Alternative | Memo of the line item |
memo (anyOf 2) | null | Alternative |
Referenced models: Hold Bill — response body — accounting field selections item, Hold Bill — response body — amount
Hold Bill — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
reason | JSON | Optional | |
reason (anyOf 1) | string | Alternative | Optional reason for placing the bill on hold. Default: null |
reason (anyOf 2) | null | Alternative |
Hold Bill — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_date | string | Required within parent | The 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_selections | array | Required within parent | List of accounting field options selected to code the bill. |
accounting_field_selections[] | Model | Each item | Expand Hold Bill — response body — accounting field selections item |
amount | Model | Required within parent | Expand 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_credits | array | Required within parent | Vendor Credits that have been applied to this Bill Read only: true |
applied_vendor_credits[] | Model | Each item | Expand Hold Bill — response body — applied vendor credits item |
approval_status | JSON | Required within parent | |
approval_status (anyOf 1) | string | Alternative | Approval 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) | null | Alternative | |
archived_at | JSON | Required within parent | |
archived_at (anyOf 1) | string | Alternative | The datetime the bill was archived. Format: date-time |
archived_at (anyOf 2) | null | Alternative | |
attachments | array | Required within parent | Business-visible bill attachments with their types and download URLs. Read only: true |
attachments[] | Model | Each item | Expand Hold Bill — response body — attachments item |
bill_owner | Model | Required within parent | Expand Hold Bill — response body — bill owner Information about the bill owner. |
created_at | string | Required within parent | Format: date-time |
deep_link_url | string | Optional | Link to bill in ERP, if exists. |
draft_bill_created_at | JSON | Required within parent | |
draft_bill_created_at (anyOf 1) | string | Alternative | The 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) | null | Alternative | |
draft_bill_id | JSON | Required within parent | |
draft_bill_id (anyOf 1) | string | Alternative | Unique identifier of the draft bill this bill was created from, if one exists. Format: uuid |
draft_bill_id (anyOf 2) | null | Alternative | |
due_at | string | Required within parent | Format: date-time |
enable_accounting_sync | boolean | Optional | Flag specifying whether the bill should sync to the ERP |
entity_id | string | Required within parent | Associated business entity. Format: uuid |
fx_conversion_rate | string | Required within parent | FX conversion rate from bill invoice currency to payer currency. Format: decimal Read only: true |
id | string | Required within parent | Format: uuid |
inventory_line_items | array | Required within parent | List of inventory line items related to the bill. |
inventory_line_items[] | Model | Each item | Expand Hold Bill — response body — inventory line items item |
invoice_number | string | Optional | The invoice number on the bill. |
invoice_urls | array | Required within parent | Pre-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[] | string | Each item | |
is_payment_sync_ready | boolean | Required within parent | Whether 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_release | JSON | Optional | |
is_withholding_release (anyOf 1) | boolean | Alternative | Whether this bill is a retainage withholding release bill, if applicable. Read only: true |
is_withholding_release (anyOf 2) | null | Alternative | |
issued_at | string | Required within parent | The date the bill was issued on invoice. Format: date-time |
item_receipt_ids | array | Required within parent | List of unique identifiers for item receipts associated with this bill through matched purchase orders. Read only: true |
item_receipt_ids[] | string | Each item | Format: uuid |
line_items | array | Required within parent | List of line items related to the bill. |
line_items[] | Model | Each item | Expand Hold Bill — response body — line items item |
memo | string | Optional | Memo of the bill. |
paid_at | string | Optional | The datetime the bill's payment status is set to PAID. None if the bill's payment status is OPEN Format: date-time |
payment | JSON | Required within parent | |
payment (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
posting_date | string | Optional | The date the bill was posted to the ERP. Alternatively known as accounting date, accounting sync date. Format: date-time |
purchase_order_id | string | Optional | Unique identifier of matched purchase order, if one exists. Format: uuid Read only: true |
related_bills | array | Optional | Bills 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[] | Model | Each item | Expand Hold Bill — response body — related bills item |
remote_id | string | Optional | The external ID that identifies the bill on the client's side. |
status | string | Required within parent | Known values: OPEN, PAID |
status_summary | string | Required within parent | Status 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_status | string | Required within parent | Sync status of the bill. Known values: BILL_AND_PAYMENT_SYNCED, BILL_SYNCED, NOT_SYNCED Read only: true |
vendor | Model | Required within parent | Expand Hold Bill — response body — vendor Vendor information of the bill. |
vendor_contact_id | JSON | Required within parent | |
vendor_contact_id (anyOf 1) | string | Alternative | Unique identifier of associated vendor contact. Format: uuid |
vendor_contact_id (anyOf 2) | null | Alternative | |
vendor_memo | string | Optional | Memo 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
category_info | Model | Required within parent | Expand Hold Bill — response body — accounting field selections item category info information about the accounting category (or accounting field). |
display_name | JSON | Required within parent | |
display_name (anyOf 1) | string | Alternative | Customer-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) | null | Alternative | |
external_code | JSON | Optional | |
external_code (anyOf 1) | string | Alternative | external code of accounting field option; Code field displayed on the ERP. |
external_code (anyOf 2) | null | Alternative | |
external_id | string | Required within parent | external id of accounting field option; It should uniquely identify an accounting field option on the client end. |
id | string | Required within parent | ID that uniquely identifies an accounting field option within Ramp |
name | string | Required within parent | name of accounting field option |
provider_name | JSON | Required within parent | |
provider_name (anyOf 1) | string | Alternative | Name of the accounting provider Read only: true |
provider_name (anyOf 2) | null | Alternative |
Referenced models: Hold Bill — response body — accounting field selections item category info
Hold Bill — response body — accounting field selections item category info
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
external_id | string | Required within parent | external id of accounting field; It should uniquely identify an accounting field on the client end. |
id | string | Required within parent | ID that uniquely identifies an accounting field within Ramp |
name | string | Required within parent | name of accounting field |
type | string | Required within parent | accounting 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | JSON | Required within parent | |
amount (anyOf 1) | integer | Alternative | the 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) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
currency_code | string | Required within parent | The type of currency, in ISO 4217 format. e.g. USD for US dollars Default: USD |
minor_unit_conversion_rate | JSON | Required within parent | |
minor_unit_conversion_rate (anyOf 1) | JSON | Alternative | |
minor_unit_conversion_rate (anyOf 1) (anyOf 1) | integer | Alternative | The 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) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
minor_unit_conversion_rate (anyOf 2) | null | Alternative |
Hold Bill — response body — applied vendor credits item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | Model | Required within parent | Expand 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 |
id | string | Required within parent | Unique identifier for the vendor credit |
Referenced models: Hold Bill — response body — amount
Hold Bill — response body — attachments item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
attachment_type | string | Required within parent | Type of attachment. Known values: EMAIL, FILE, INVOICE, VENDOR_CREDIT |
id | string | Required within parent | Unique identifier of the bill attachment. Format: uuid |
url | string | Required within parent | Pre-signed URL to download the attachment. Read only: true |
Hold Bill — response body — bill owner
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
first_name | string | Optional | Bill owner's first name. |
id | string | Required within parent | Bill owner's ID. Format: uuid |
last_name | string | Optional | Bill owner's last name. |
Hold Bill — response body — inventory line items item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_field_selections | array | Required within parent | List of accounting field options selected to code the line item. |
accounting_field_selections[] | Model | Each item | Expand Hold Bill — response body — accounting field selections item |
amount | Model | Required within parent | Expand 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 |
id | string | Required within parent | Unique identifier of the inventory line item. Stable across bill updates and draft-to-bill conversion. Format: uuid |
item_receipt_line_item_ids | array | Required within parent | List 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[] | string | Each item | Format: uuid |
memo | string | Optional | Memo of the line item |
purchase_order_line_item_id | JSON | Required within parent | |
purchase_order_line_item_id (anyOf 1) | string | Alternative | Unique identifier of the matched purchase order line item, if any Format: uuid |
purchase_order_line_item_id (anyOf 2) | null | Alternative | |
quantity | JSON | Required within parent | |
quantity (anyOf 1) | number | Alternative | Quantity of the line item |
quantity (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
unit_price | Model | Required within parent | Expand 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_item | JSON | Optional | |
withholding_line_item (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_field_selections | array | Required within parent | List of accounting field options selected to code the line item. Read only: true |
accounting_field_selections[] | Model | Each item | Expand Hold Bill — response body — accounting field selections item |
amount | Model | Required within parent | Expand 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 |
id | string | Required within parent | Unique identifier of the line item. Stable across bill updates and draft-to-bill conversion. Format: uuid |
item_receipt_line_item_ids | array | Required within parent | List 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[] | string | Each item | Format: uuid |
memo | string | Optional | Memo of the line item |
purchase_order_line_item_id | JSON | Required within parent | |
purchase_order_line_item_id (anyOf 1) | string | Alternative | Unique identifier of the matched purchase order line item, if any Format: uuid |
purchase_order_line_item_id (anyOf 2) | null | Alternative | |
withholding_line_item | JSON | Optional | |
withholding_line_item (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
gross_amount | Model | Required within parent | Expand Fetch a payment — response body — amount Gross amount of the line item before retainage withholding. |
withholding_amount | Model | Required within parent | Expand Fetch a payment — response body — amount Retainage withholding amount for the line item. |
withholding_percentage | JSON | Required within parent | |
withholding_percentage (anyOf 1) | string | Alternative | Retainage withholding percentage for the line item. Format: decimal |
withholding_percentage (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | Model | Required within parent | Expand Hold Bill — response body — amount Paid amount of the bill. |
bank_debit_trace_id | Model | Optional | Expand 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_id | JSON | Required within parent | |
customer_friendly_payment_id (anyOf 1) | string | Alternative | Customer-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) | null | Alternative | |
details | Model | Required within parent | Expand 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_date | JSON | Required within parent | |
effective_date (anyOf 1) | string | Alternative | For non-card payment methods only, the date the payment is actually initiated. Format: date-time |
effective_date (anyOf 2) | null | Alternative | |
id | JSON | Required within parent | |
id (anyOf 1) | string | Alternative | Unique identifier of the payment. Bills sharing the same payment ID belong to the same batch payment. Read only: true |
id (anyOf 2) | null | Alternative | |
payment_date | JSON | Required within parent | |
payment_date (anyOf 1) | string | Alternative | For 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) | null | Alternative | |
payment_method | JSON | Required within parent | |
payment_method (anyOf 1) | string | Alternative | Known 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) | null | Alternative | |
trace_id | JSON | Required within parent | |
trace_id (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
descriptor | string | Optional | Human-readable description of the trace ID. For example, 'Check Number' or 'ACH Trace ID'. |
trace_id | string | Optional | The 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
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
approval_status | JSON | Required within parent | |
approval_status (anyOf 1) | string | Alternative | Approval status of the payment, if payment-step approvals are used. Known values: APPROVED, INITIALIZED, PENDING, REJECTED, TERMINATED |
approval_status (anyOf 2) | null | Alternative | |
is_same_day | boolean | Required within parent | Specifies whether the payment is configured for same-day delivery. Read only: true |
source_bank_account_id | JSON | Required within parent | |
source_bank_account_id (anyOf 1) | string | Alternative | Unique identifier of the bank account associated with this bill payment, if it exists. Format: uuid |
source_bank_account_id (anyOf 2) | null | Alternative | |
vendor_account_id | JSON | Required within parent | |
vendor_account_id (anyOf 1) | string | Alternative | Unique identifier of the vendor account associated with this bill payment, if it exists. Format: uuid |
vendor_account_id (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
fund_id | string | Optional | Unique identifier of the fund associated with this bill payment. Format: uuid |
spend_limit_id | string | Optional | Alias of fund_id. The fund to which this bill payment is attributed, if it exists. Format: uuid |
transaction_ids | array | Optional | Transaction 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[] | string | Each item | Format: 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
manual_payment_method | JSON | Required within parent | |
manual_payment_method (anyOf 1) | string | Alternative | Manual 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) | null | Alternative |
Hold Bill — response body — related bills item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | JSON | Required within parent | |
amount (anyOf 1) | Model | Alternative | Expand Hold Bill — response body — amount Amount of the associated bill in the lowest denomination of its invoice currency. Read only: true |
amount (anyOf 2) | null | Alternative | |
bill_id | string | Required within parent | Unique identifier of the associated bill. Format: uuid |
invoice_number | JSON | Required within parent | |
invoice_number (anyOf 1) | string | Alternative | Invoice number of the associated bill. |
invoice_number (anyOf 2) | null | Alternative | |
label | string | Required within parent | Display label for the associated bill as seen from this bill (e.g. 'Insurance bill'). |
status | string | Required within parent | Payment status of the associated bill. Known values: OPEN, PAID |
vendor_name | JSON | Required within parent | |
vendor_name (anyOf 1) | string | Alternative | Vendor name of the associated bill. |
vendor_name (anyOf 2) | null | Alternative |
Referenced models: Hold Bill — response body — amount
Hold Bill — response body — vendor
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | Unique identifier of the vendor. Format: uuid |
name | string | Required within parent | Name of the vendor. |
remote_code | string | Optional | Code of the vendor; usually it is a unique identifier for the vendor in the remote ERP system. |
remote_id | string | Optional | External ID that uniquely identifies the vendor on the client's side. |
remote_name | string | Optional | Name of the vendor. |
type | string | Optional | Known values: BUSINESS, INDIVIDUAL |
List bills — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Resources returned in this page. |
data[] | Model | Each item | Expand Hold Bill — response body |
page | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Pagination details for a Developer API response. |
next | JSON | Required within parent | |
next (anyOf 1) | string | Alternative | the query to get to the next page; it is in the format of <BASE_URL>?<new_params> |
next (anyOf 2) | null | Alternative |
List draft bills — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Resources returned in this page. |
data[] | Model | Each item | Expand Fetch a draft bill — response body |
page | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_field_selections | array | Optional | List of accounting field options selected to code the bill. |
accounting_field_selections[] | Model | Each item | Expand Create a bill — request body — body accounting field selections item |
due_at | string | Optional | Due date of the bill. Format: date |
entity_id | string | Optional | Associated business entity. Format: uuid |
inventory_line_items | JSON | Optional | |
inventory_line_items (anyOf 1) | array | Alternative | List of inventory line items associated with the bill. When provided, this will replace all existing inventory line items. |
inventory_line_items (anyOf 1)[] | Model | Each item | Expand Update a bill — request body — body inventory line items array item |
inventory_line_items (anyOf 2) | null | Alternative | |
invoice_number | string | Optional | The invoice number on the bill. Maximum length: 84 |
issued_at | string | Optional | Issued date of the bill. Format: date |
line_items | JSON | Optional | |
line_items (anyOf 1) | array | Alternative | List of line items related to the bill. When provided, this will replace all existing line items. |
line_items (anyOf 1)[] | Model | Each item | Expand Update a bill — request body — body line items array item |
line_items (anyOf 2) | null | Alternative | |
memo | JSON | Optional | |
memo (anyOf 1) | string | Alternative | Memo of the bill. Maximum length: 1000 |
memo (anyOf 2) | null | Alternative | |
payment_date | JSON | Optional | |
payment_date (anyOf 1) | string | Alternative | For 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) | null | Alternative | |
payment_method | string | Optional | Payment 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_date | JSON | Optional | |
posting_date (anyOf 1) | string | Alternative | The date the bill is posted to the accounting system. Format: date |
posting_date (anyOf 2) | null | Alternative | |
purchase_order_ids | array | Optional | Unique identifiers of the purchase orders to match this bill to. When provided, this will replace all existing linked purchase orders. |
purchase_order_ids[] | string | Each item | Format: uuid |
remote_id | JSON | Optional | |
remote_id (anyOf 1) | string | Alternative | An ID that identifies the bill on client's side. |
remote_id (anyOf 2) | null | Alternative | |
vendor_contact_id | string | Optional | Unique identifier of vendor contact, must be associated with passed vendor. Format: uuid |
vendor_id | string | Optional | Unique identifier of bill vendor. Format: uuid |
vendor_memo | JSON | Optional | |
vendor_memo (anyOf 1) | string | Alternative | Memo to the vendor. Maximum length: 400 |
vendor_memo (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_field_selections | array | Optional | |
accounting_field_selections[] | Model | Each item | Expand Create a bill — request body — body accounting field selections item |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | Unique 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) | null | Alternative | |
memo | JSON | Optional | |
memo (anyOf 1) | string | Alternative | Default: null |
memo (anyOf 2) | null | Alternative | |
purchase_order_line_item_id | JSON | Optional | |
purchase_order_line_item_id (anyOf 1) | string | Alternative | Unique 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) | null | Alternative | |
quantity | JSON | Required within parent | Minimum: 0 |
quantity (oneOf 1) | string | Alternative | Format: decimal |
quantity (oneOf 2) | number | Alternative | |
unit_price | JSON | Required within parent | |
unit_price (oneOf 1) | string | Alternative | Format: decimal |
unit_price (oneOf 2) | number | Alternative |
Referenced models: Create a bill — request body — body accounting field selections item
Update a bill — request body — body line items array item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_field_selections | array | Optional | |
accounting_field_selections[] | Model | Each item | Expand Create a bill — request body — body accounting field selections item |
amount | JSON | Required within parent | |
amount (oneOf 1) | string | Alternative | Format: decimal |
amount (oneOf 2) | number | Alternative | |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | Unique 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) | null | Alternative | |
memo | JSON | Optional | |
memo (anyOf 1) | string | Alternative | Default: null |
memo (anyOf 2) | null | Alternative | |
purchase_order_line_item_id | JSON | Optional | |
purchase_order_line_item_id (anyOf 1) | string | Alternative | Unique 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) | null | Alternative |
Referenced models: Create a bill — request body — body accounting field selections item
Update a draft bill — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_field_selections | array | Optional | List of accounting field options selected to code the bill. |
accounting_field_selections[] | Model | Each item | Expand Create a bill — request body — body accounting field selections item |
due_at | string | Optional | Due date of the bill. Format: date |
enable_accounting_sync | boolean | Optional | A flag you can set to False to prevent this bill from syncing to your ERP. |
entity_id | string | Optional | Associated business entity. Format: uuid |
inventory_line_items | JSON | Optional | |
inventory_line_items (anyOf 1) | array | Alternative | List of inventory line items associated with the bill. When provided, this will replace all existing inventory line items. |
inventory_line_items (anyOf 1)[] | Model | Each item | Expand Update a bill — request body — body inventory line items array item |
inventory_line_items (anyOf 2) | null | Alternative | |
invoice_currency | string | Optional | Currency 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_number | string | Optional | The invoice number on the bill. Maximum length: 84 |
issued_at | string | Optional | Issued date of the bill. Format: date |
line_items | JSON | Optional | |
line_items (anyOf 1) | array | Alternative | List of line items related to the bill. When provided, this will replace all existing line items. |
line_items (anyOf 1)[] | Model | Each item | Expand Update a bill — request body — body line items array item |
line_items (anyOf 2) | null | Alternative | |
memo | JSON | Optional | |
memo (anyOf 1) | string | Alternative | Memo of the bill. Maximum length: 1000 |
memo (anyOf 2) | null | Alternative | |
payment_method | string | Optional | Payment 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_date | JSON | Optional | |
posting_date (anyOf 1) | string | Alternative | The date the bill is posted to the accounting system. Format: date |
posting_date (anyOf 2) | null | Alternative | |
purchase_order_ids | array | Optional | Unique identifiers of the purchase orders to match this bill to. When provided, this will replace all existing linked purchase orders. |
purchase_order_ids[] | string | Each item | Format: uuid |
remote_id | JSON | Optional | |
remote_id (anyOf 1) | string | Alternative | An ID that identifies the bill on client's side. |
remote_id (anyOf 2) | null | Alternative | |
use_default_payment_method | boolean | Optional | When 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_id | string | Optional | Unique identifier of vendor contact, must be associated with passed vendor. Format: uuid |
vendor_id | string | Optional | Unique identifier of bill vendor. Format: uuid |
vendor_memo | JSON | Optional | |
vendor_memo (anyOf 1) | string | Alternative | Memo to the vendor. Maximum length: 400 |
vendor_memo (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Pydantic input model for bill attachment upload |
attachment_type | string | Required within parent | Type of attachment. Supported values: INVOICE, FILE. Set to 'INVOICE' for the actual invoice on a bill. One of: EMAIL, FILE, INVOICE, VENDOR_CREDIT |
file | object | Required within parent | Additional keys: not allowed |
file.filename | string | Required within parent | Minimum length: 1 |
file.content_type | string | Required within parent | Minimum length: 1 |
file.content_base64 | string | Required within parent |
Upload a file attachment to an existing bill — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | Attachment UUID Format: uuid |