Ramp: Fetch a draft bill — response body
Fetch a draft bill: response body. Complete fields and constraints for contract 2026-10-27.
API reference · Contract 2026-10-27
SDK schema: 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