Ramp: Fetch a purchase order — response body — line items item
Fetch a purchase order: response body, field line_items / item. Complete fields and constraints for contract 2026-10-27.
API reference · Contract 2026-10-27
SDK schema: Fetch a purchase order — 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 purchase order 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. Read only: true |
custom_field_values | array | Required within parent | Custom field values associated with this purchase order line item. Read only: true |
custom_field_values[] | Model | Each item | Expand Fetch a purchase order — response body — line items item custom field values item |
description | JSON | Required within parent | |
description (anyOf 1) | string | Alternative | Description of the line item. |
description (anyOf 2) | null | Alternative | |
end_date | JSON | Required within parent | |
end_date (anyOf 1) | string | Alternative | The date when spending for this line item ends. Format: date |
end_date (anyOf 2) | null | Alternative | |
external_id | JSON | Required within parent | |
external_id (anyOf 1) | string | Alternative | Customer-provided external identifier of the line item. |
external_id (anyOf 2) | null | Alternative | |
id | string | Required within parent | Unique identifier for the line item. Format: uuid |
quantity | JSON | Required within parent | |
quantity (anyOf 1) | JSON | Alternative | |
quantity (anyOf 1) (anyOf 1) | number | Alternative | Quantity of the line item. |
quantity (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
quantity (anyOf 2) | null | Alternative | |
remote_id | JSON | Required within parent | |
remote_id (anyOf 1) | string | Alternative | The accounting remote identifier of the line item. Read only: true |
remote_id (anyOf 2) | null | Alternative | |
start_date | JSON | Required within parent | |
start_date (anyOf 1) | string | Alternative | The date when spending for this line item begins. Format: date |
start_date (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. Read only: true |
unit_price (anyOf 2) | null | Alternative | |
withholding_rate | JSON | Required within parent | |
withholding_rate (anyOf 1) | string | Alternative | Retainage withholding rate for the line item, expressed as a fractional decimal. If set, this line-level rate overrides the purchase order withholding_default_rate for this line item. For example, 0.10 means 10%. Format: decimal Maximum: 1 Minimum: 0 |
withholding_rate (anyOf 2) | null | Alternative |
Referenced models: Hold Bill — response body — accounting field selections item, Hold Bill — response body — amount, Fetch a purchase order — response body — line items item custom field values item