Ramp: Purchase order schemas
13 Ramp schemas with complete fields and constraints.
← Purchase order operations · All schemas
Add line items to an existing purchase order — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
line_items | array | Required within parent | List of line items to add to the purchase order. Existing line items attached to the purchase order won't be modified |
line_items[] | Model | Each item | Expand Create a purchase order — request body — body line items item |
Referenced models: Create a purchase order — request body — body line items item
Archive a purchase order — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
archived_reason | JSON | Optional | |
archived_reason (anyOf 1) | string | Alternative | Reason for archiving the purchase order. |
archived_reason (anyOf 2) | null | Alternative |
Create a purchase order — 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 purchase order. Generally, only a single vendor accounting field is supported. |
accounting_field_selections[] | Model | Each item | Expand Create a bill — request body — body accounting field selections item |
currency | string | Required within parent | Currency of the purchase order. 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 |
entity_id | string | Required within parent | Unique identifier of associated business entity. Format: uuid |
external_id | JSON | Optional | |
external_id (anyOf 1) | string | Alternative | An ID that uniquely identifies the purchase order on the client's side. Must be unique per business and cannot be updated after creation. Default: null |
external_id (anyOf 2) | null | Alternative | |
line_items | array | Required within parent | List of purchase order line items. |
line_items[] | Model | Each item | Expand Create a purchase order — request body — body line items item |
memo | JSON | Optional | |
memo (anyOf 1) | string | Alternative | Memo for the purchase order. Default: null |
memo (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | Name of the purchase order. Must contain a non-whitespace character. Default: null Pattern: \s*\S |
name (anyOf 2) | null | Alternative | |
net_payment_terms | JSON | Optional | |
net_payment_terms (anyOf 1) | integer | Alternative | The required time an invoice needs to be paid after receipt in days. Default: null |
net_payment_terms (anyOf 2) | null | Alternative | |
owner_id | JSON | Optional | |
owner_id (anyOf 1) | string | Alternative | Unique identifier for the owner of the purchase order. Defaults to the API caller when not provided. Default: null Format: uuid |
owner_id (anyOf 2) | null | Alternative | |
promise_date | JSON | Optional | |
promise_date (anyOf 1) | string | Alternative | The date the vendor will deliver the goods or services. Default: null Format: date |
promise_date (anyOf 2) | null | Alternative | |
purchase_order_number | JSON | Optional | |
purchase_order_number (anyOf 1) | string | Alternative | Unique purchase order number with format <prefix>-<number>. Prefixes must only contain numbers, uppercase letters, and dashes. Invalid characters will be filtered out automatically. If not provided, one will be auto-generated using a prefix specified in procurement settings, if it exists. Default: null |
purchase_order_number (anyOf 2) | null | Alternative | |
spend_end_date | JSON | Optional | |
spend_end_date (anyOf 1) | string | Alternative | The date when spending for this purchase order ends. Default: null Format: date |
spend_end_date (anyOf 2) | null | Alternative | |
spend_start_date | JSON | Optional | |
spend_start_date (anyOf 1) | string | Alternative | The date when spending for this purchase order begins. Default: null Format: date |
spend_start_date (anyOf 2) | null | Alternative | |
three_way_match_enabled | boolean | Required within parent | Whether three-way match is enabled for the purchase order. I.e. whether an item receipt will be attached to indicate goods were received. |
vendor_id | JSON | Optional | |
vendor_id (anyOf 1) | string | Alternative | Unique identifier for the vendor. Default: null Format: uuid |
vendor_id (anyOf 2) | null | Alternative | |
withholding_default_rate | JSON | Optional | |
withholding_default_rate (anyOf 1) | JSON | Alternative | Default retainage withholding rate for the purchase order, expressed as a fractional decimal. For example, 0.10 means 10%. Default: null Minimum: 0 Less than: 1 |
withholding_default_rate (anyOf 1) (oneOf 1) | string | Alternative | Format: decimal |
withholding_default_rate (anyOf 1) (oneOf 2) | number | Alternative | |
withholding_default_rate (anyOf 2) | null | Alternative |
Referenced models: Create a bill — request body — body accounting field selections item, Create a purchase order — request body — body line items item
Create a purchase order — request body — body line items item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_field_selections | array | Optional | List of accounting field options selected to code the line item. |
accounting_field_selections[] | Model | Each item | Expand Create a bill — request body — body accounting field selections item |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Description of the line item. Default: null |
description (anyOf 2) | null | Alternative | |
end_date | JSON | Optional | |
end_date (anyOf 1) | string | Alternative | The date when spending for this line item ends. Default: null Format: date |
end_date (anyOf 2) | null | Alternative | |
external_id | JSON | Optional | |
external_id (anyOf 1) | string | Alternative | An ID that identifies the line item on the client's side. Must be unique within the purchase order and cannot be updated after creation. Default: null |
external_id (anyOf 2) | null | Alternative | |
start_date | JSON | Optional | |
start_date (anyOf 1) | string | Alternative | The date when spending for this line item begins. Default: null Format: date |
start_date (anyOf 2) | null | Alternative | |
unit_price | JSON | Required within parent | Unit price of the line item. |
unit_price (oneOf 1) | string | Alternative | Format: decimal |
unit_price (oneOf 2) | number | Alternative | |
unit_quantity | JSON | Required within parent | Quantity of the line item. Supports fractional values as a JSON number or decimal string. |
unit_quantity (oneOf 1) | string | Alternative | Format: decimal |
unit_quantity (oneOf 2) | number | Alternative | |
withholding_rate | JSON | Optional | |
withholding_rate (anyOf 1) | JSON | 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%. Default: null Minimum: 0 Less than: 1 |
withholding_rate (anyOf 1) (oneOf 1) | string | Alternative | Format: decimal |
withholding_rate (anyOf 1) (oneOf 2) | number | Alternative | |
withholding_rate (anyOf 2) | null | Alternative |
Referenced models: Create a bill — request body — body accounting field selections item
Create a purchase order — response body
| 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. 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 purchse order. Read only: true |
archived_at | JSON | Required within parent | |
archived_at (anyOf 1) | string | Alternative | Format: date-time |
archived_at (anyOf 2) | null | Alternative | |
bill_ids | array | Required within parent | List of unique identifiers for attached bills. Read only: true |
bill_ids[] | string | Each item | Format: uuid |
billing_status | JSON | Optional | |
billing_status (anyOf 1) | string | Alternative | Known values: CLOSED, DELETED, FULLY_BILLED, OPEN, PARTIALLY_BILLED Read only: true |
billing_status (anyOf 2) | null | Alternative | |
created_at | string | Required within parent | Format: date-time |
creation_source | string | Required within parent | Known values: ACCOUNTING_PROVIDER, DEVELOPER_API, EXTERNAL_IMPORT, RAMP |
entity_id | string | Required within parent | Associated business entity. Format: uuid |
external_id | JSON | Required within parent | |
external_id (anyOf 1) | string | Alternative | An ID that uniquely identifies the purchase order on the client's side. Must be unique per business and cannot be updated after creation. |
external_id (anyOf 2) | null | Alternative | |
id | string | Required within parent | Format: uuid |
item_receipt_ids | array | Required within parent | List of unique identifiers for item receipts matched to the purchase order. Read only: true |
item_receipt_ids[] | string | Each item | Format: uuid |
line_items | array | Required within parent | List of line items on the purchase order. |
line_items[] | Model | Each item | Expand Create a purchase order — response body — line items item |
memo | JSON | Required within parent | |
memo (anyOf 1) | string | Alternative | Memo of the purchase order. |
memo (anyOf 2) | null | Alternative | |
name | JSON | Required within parent | |
name (anyOf 1) | string | Alternative | The name of the spend request associated with the purchase order. |
name (anyOf 2) | null | Alternative | |
net_payment_terms | JSON | Required within parent | |
net_payment_terms (anyOf 1) | JSON | Alternative | |
net_payment_terms (anyOf 1) (anyOf 1) | integer | Alternative | The required time an invoice needs to be paid after receipt. |
net_payment_terms (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
net_payment_terms (anyOf 2) | null | Alternative | |
owner_id | JSON | Required within parent | |
owner_id (anyOf 1) | string | Alternative | Unique identifier for the owner of the spend request. This value will only be present for Ramp-created purchase orders. Format: uuid |
owner_id (anyOf 2) | null | Alternative | |
promise_date | JSON | Required within parent | |
promise_date (anyOf 1) | string | Alternative | The date the vendor will deliver the goods or services. Format: date-time |
promise_date (anyOf 2) | null | Alternative | |
purchase_order_number | JSON | Required within parent | |
purchase_order_number (anyOf 1) | string | Alternative | |
purchase_order_number (anyOf 2) | null | Alternative | |
ramp_url | string | Required within parent | A stable URL that links to the purchase order in the Ramp web application. Read only: true |
receipt_status | string | Required within parent | Known values: FULLY_RECEIVED, NOT_RECEIVED, OVER_RECEIVED, PARTIALLY_RECEIVED |
remote_id | JSON | Required within parent | |
remote_id (anyOf 1) | string | Alternative | The accounting remote identifier of the purchase order. Read only: true |
remote_id (anyOf 2) | null | Alternative | |
ship_to_address | JSON | Required within parent | |
ship_to_address (anyOf 1) | Model | Alternative | Expand Fetch a purchase order — response body — ship to address address1, address2, city, country, postal code, state Delivery address for the purchase order. |
ship_to_address (anyOf 2) | null | Alternative | |
ship_to_company_name | JSON | Required within parent | |
ship_to_company_name (anyOf 1) | string | Alternative | Company name associated with the delivery address. |
ship_to_company_name (anyOf 2) | null | Alternative | |
shipping_contact_email | JSON | Required within parent | |
shipping_contact_email (anyOf 1) | string | Alternative | Email address of the delivery contact. |
shipping_contact_email (anyOf 2) | null | Alternative | |
shipping_contact_first_name | JSON | Required within parent | |
shipping_contact_first_name (anyOf 1) | string | Alternative | First name of the delivery contact. |
shipping_contact_first_name (anyOf 2) | null | Alternative | |
shipping_contact_last_name | JSON | Required within parent | |
shipping_contact_last_name (anyOf 1) | string | Alternative | Last name of the delivery contact. |
shipping_contact_last_name (anyOf 2) | null | Alternative | |
shipping_contact_phone_number | JSON | Required within parent | |
shipping_contact_phone_number (anyOf 1) | string | Alternative | Phone number of the delivery contact. |
shipping_contact_phone_number (anyOf 2) | null | Alternative | |
spend_end_date | JSON | Required within parent | |
spend_end_date (anyOf 1) | string | Alternative | The date when spending for this purchase order ends. Format: date-time |
spend_end_date (anyOf 2) | null | Alternative | |
spend_program_id | JSON | Required within parent | |
spend_program_id (anyOf 1) | string | Alternative | Unique identifier for the spend program associated with the purchase order. This value will only be null for purchase orders imported from an accounting provider. Format: uuid Read only: true |
spend_program_id (anyOf 2) | null | Alternative | |
spend_request_id | JSON | Required within parent | |
spend_request_id (anyOf 1) | string | Alternative | Unique identifier for the spend request associated with the purchase order. This value will only be null for purchase orders imported from an accounting provider. Format: uuid |
spend_request_id (anyOf 2) | null | Alternative | |
spend_start_date | JSON | Required within parent | |
spend_start_date (anyOf 1) | string | Alternative | The date when spending for this purchase order begins. Format: date-time |
spend_start_date (anyOf 2) | null | Alternative | |
spend_total_amount | JSON | Required within parent | |
spend_total_amount (anyOf 1) | Model | Alternative | Expand Hold Bill — response body — amount Total amount of the purchase order, calculated based on frequency and date range for recurring purchases. Read only: true |
spend_total_amount (anyOf 2) | null | Alternative | |
three_way_match_enabled | boolean | Required within parent | Whether three-way match is enabled for the purchase order. Read only: true |
transaction_ids | array | Required within parent | List of unique identifiers for attached transactions. This does not include transactions on attached bills. Read only: true |
transaction_ids[] | string | Each item | Format: uuid |
user_id | JSON | Required within parent | |
user_id (anyOf 1) | string | Alternative | Unique identifier for the user who created the spend request. This value will only be present for Ramp-created purchase orders. Format: uuid |
user_id (anyOf 2) | null | Alternative | |
vendor_id | JSON | Required within parent | |
vendor_id (anyOf 1) | string | Alternative | Unique identifier for the vendor. Format: uuid Read only: true |
vendor_id (anyOf 2) | null | Alternative | |
withholding_default_rate | JSON | Required within parent | |
withholding_default_rate (anyOf 1) | string | Alternative | Default retainage withholding rate for the purchase order, expressed as a fractional decimal. For example, 0.10 means 10%. Format: decimal Maximum: 1 Minimum: 0 |
withholding_default_rate (anyOf 2) | null | Alternative |
Referenced models: Hold Bill — response body — accounting field selections item, Create a purchase order — response body — line items item, Hold Bill — response body — amount, Fetch a purchase order — response body — ship to address address1, address2, city, country, postal code, state
Create 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 |
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
| 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. 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 purchse order. Read only: true |
archived_at | JSON | Required within parent | |
archived_at (anyOf 1) | string | Alternative | Format: date-time |
archived_at (anyOf 2) | null | Alternative | |
bill_ids | array | Required within parent | List of unique identifiers for attached bills. Read only: true |
bill_ids[] | string | Each item | Format: uuid |
billing_status | JSON | Optional | |
billing_status (anyOf 1) | string | Alternative | Known values: CLOSED, DELETED, FULLY_BILLED, OPEN, PARTIALLY_BILLED Read only: true |
billing_status (anyOf 2) | null | Alternative | |
created_at | string | Required within parent | Format: date-time |
creation_source | string | Required within parent | Known values: ACCOUNTING_PROVIDER, DEVELOPER_API, EXTERNAL_IMPORT, RAMP |
custom_form_collection_response | JSON | Required within parent | |
custom_form_collection_response (anyOf 1) | Model | Alternative | Expand Fetch a custom form collection response by ID — response body — custom form collection response Custom form collection with an associated response log entry. Read only: true |
custom_form_collection_response (anyOf 2) | null | Alternative | |
entity_id | string | Required within parent | Associated business entity. Format: uuid |
external_id | JSON | Required within parent | |
external_id (anyOf 1) | string | Alternative | An ID that uniquely identifies the purchase order on the client's side. Must be unique per business and cannot be updated after creation. |
external_id (anyOf 2) | null | Alternative | |
id | string | Required within parent | Format: uuid |
item_receipt_ids | array | Required within parent | List of unique identifiers for item receipts matched to the purchase order. Read only: true |
item_receipt_ids[] | string | Each item | Format: uuid |
line_items | array | Required within parent | List of line items on the purchase order. |
line_items[] | Model | Each item | Expand Fetch a purchase order — response body — line items item |
memo | JSON | Required within parent | |
memo (anyOf 1) | string | Alternative | Memo of the purchase order. |
memo (anyOf 2) | null | Alternative | |
name | JSON | Required within parent | |
name (anyOf 1) | string | Alternative | The name of the spend request associated with the purchase order. |
name (anyOf 2) | null | Alternative | |
net_payment_terms | JSON | Required within parent | |
net_payment_terms (anyOf 1) | JSON | Alternative | |
net_payment_terms (anyOf 1) (anyOf 1) | integer | Alternative | The required time an invoice needs to be paid after receipt. |
net_payment_terms (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
net_payment_terms (anyOf 2) | null | Alternative | |
owner_id | JSON | Required within parent | |
owner_id (anyOf 1) | string | Alternative | Unique identifier for the owner of the spend request. This value will only be present for Ramp-created purchase orders. Format: uuid |
owner_id (anyOf 2) | null | Alternative | |
promise_date | JSON | Required within parent | |
promise_date (anyOf 1) | string | Alternative | The date the vendor will deliver the goods or services. Format: date-time |
promise_date (anyOf 2) | null | Alternative | |
purchase_order_number | JSON | Required within parent | |
purchase_order_number (anyOf 1) | string | Alternative | |
purchase_order_number (anyOf 2) | null | Alternative | |
ramp_url | string | Required within parent | A stable URL that links to the purchase order in the Ramp web application. Read only: true |
receipt_status | string | Required within parent | Known values: FULLY_RECEIVED, NOT_RECEIVED, OVER_RECEIVED, PARTIALLY_RECEIVED |
remote_id | JSON | Required within parent | |
remote_id (anyOf 1) | string | Alternative | The accounting remote identifier of the purchase order. Read only: true |
remote_id (anyOf 2) | null | Alternative | |
ship_to_address | JSON | Required within parent | |
ship_to_address (anyOf 1) | Model | Alternative | Expand Fetch a purchase order — response body — ship to address address1, address2, city, country, postal code, state Delivery address for the purchase order. |
ship_to_address (anyOf 2) | null | Alternative | |
ship_to_company_name | JSON | Required within parent | |
ship_to_company_name (anyOf 1) | string | Alternative | Company name associated with the delivery address. |
ship_to_company_name (anyOf 2) | null | Alternative | |
shipping_contact_email | JSON | Required within parent | |
shipping_contact_email (anyOf 1) | string | Alternative | Email address of the delivery contact. |
shipping_contact_email (anyOf 2) | null | Alternative | |
shipping_contact_first_name | JSON | Required within parent | |
shipping_contact_first_name (anyOf 1) | string | Alternative | First name of the delivery contact. |
shipping_contact_first_name (anyOf 2) | null | Alternative | |
shipping_contact_last_name | JSON | Required within parent | |
shipping_contact_last_name (anyOf 1) | string | Alternative | Last name of the delivery contact. |
shipping_contact_last_name (anyOf 2) | null | Alternative | |
shipping_contact_phone_number | JSON | Required within parent | |
shipping_contact_phone_number (anyOf 1) | string | Alternative | Phone number of the delivery contact. |
shipping_contact_phone_number (anyOf 2) | null | Alternative | |
spend_end_date | JSON | Required within parent | |
spend_end_date (anyOf 1) | string | Alternative | The date when spending for this purchase order ends. Format: date-time |
spend_end_date (anyOf 2) | null | Alternative | |
spend_program_id | JSON | Required within parent | |
spend_program_id (anyOf 1) | string | Alternative | Unique identifier for the spend program associated with the purchase order. This value will only be null for purchase orders imported from an accounting provider. Format: uuid Read only: true |
spend_program_id (anyOf 2) | null | Alternative | |
spend_request_id | JSON | Required within parent | |
spend_request_id (anyOf 1) | string | Alternative | Unique identifier for the spend request associated with the purchase order. This value will only be null for purchase orders imported from an accounting provider. Format: uuid |
spend_request_id (anyOf 2) | null | Alternative | |
spend_start_date | JSON | Required within parent | |
spend_start_date (anyOf 1) | string | Alternative | The date when spending for this purchase order begins. Format: date-time |
spend_start_date (anyOf 2) | null | Alternative | |
spend_total_amount | JSON | Required within parent | |
spend_total_amount (anyOf 1) | Model | Alternative | Expand Hold Bill — response body — amount Total amount of the purchase order, calculated based on frequency and date range for recurring purchases. Read only: true |
spend_total_amount (anyOf 2) | null | Alternative | |
three_way_match_enabled | boolean | Required within parent | Whether three-way match is enabled for the purchase order. Read only: true |
transaction_ids | array | Required within parent | List of unique identifiers for attached transactions. This does not include transactions on attached bills. Read only: true |
transaction_ids[] | string | Each item | Format: uuid |
user_id | JSON | Required within parent | |
user_id (anyOf 1) | string | Alternative | Unique identifier for the user who created the spend request. This value will only be present for Ramp-created purchase orders. Format: uuid |
user_id (anyOf 2) | null | Alternative | |
vendor_id | JSON | Required within parent | |
vendor_id (anyOf 1) | string | Alternative | Unique identifier for the vendor. Format: uuid Read only: true |
vendor_id (anyOf 2) | null | Alternative | |
withholding_default_rate | JSON | Required within parent | |
withholding_default_rate (anyOf 1) | string | Alternative | Default retainage withholding rate for the purchase order, expressed as a fractional decimal. For example, 0.10 means 10%. Format: decimal Maximum: 1 Minimum: 0 |
withholding_default_rate (anyOf 2) | null | Alternative |
Referenced models: Hold Bill — response body — accounting field selections item, Fetch a custom form collection response by ID — response body — custom form collection response, Fetch a purchase order — response body — line items item, Hold Bill — response body — amount, Fetch a purchase order — response body — ship to address address1, address2, city, country, postal code, state
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
Fetch a purchase order — response body — line items item custom field values item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
column_display_name | string | Required within parent | The display name of the column |
column_id | string | Required within parent | The id of the column |
is_archived | boolean | Required within parent | Whether the custom field has been archived Default: false |
value | JSON | Required within parent | The contents of the cell discriminator: {"mapping": {"boolean": "#/components/schemas/BooleanCellContentsForDisplay", "custom_table": "#/components/schemas/CustomTableReferenceCellContentsForDisplay", "date": "#/components/schemas/DatetimeCellContentsForDisplay", "native_table": "#/components/schemas/NativeTableReferenceCellContentsForDisplay", "number": "#/components/schemas/NumberCellContentsForDisplay", "text": "#/components/schemas/TextCellContentsForDisplay"}, "propertyName": "type"} |
value (anyOf 1) | Model | Alternative | Expand Get a business entity — response body — custom record fields item value type boolean |
value (anyOf 2) | Model | Alternative | Expand Get a business entity — response body — custom record fields item value type custom table |
value (anyOf 3) | Model | Alternative | Expand Get a business entity — response body — custom record fields item value type date |
value (anyOf 4) | Model | Alternative | Expand Get a business entity — response body — custom record fields item value type native table |
value (anyOf 5) | Model | Alternative | Expand Get a business entity — response body — custom record fields item value type number |
value (anyOf 6) | Model | Alternative | Expand Get a business entity — response body — custom record fields item value type text |
Referenced models: Get a business entity — response body — custom record fields item value type boolean, Get a business entity — response body — custom record fields item value type date, Get a business entity — response body — custom record fields item value type custom table, Get a business entity — response body — custom record fields item value type native table, Get a business entity — response body — custom record fields item value type number, Get a business entity — response body — custom record fields item value type text
Fetch a purchase order — response body — ship to address address1, address2, city, country, postal code, state
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
address1 | string | Required within parent | |
address2 | JSON | Required within parent | |
address2 (anyOf 1) | string | Alternative | Default: null |
address2 (anyOf 2) | null | Alternative | |
city | string | Required within parent | |
country | string | Required within parent | |
postal_code | JSON | Required within parent | |
postal_code (anyOf 1) | string | Alternative | Default: null |
postal_code (anyOf 2) | null | Alternative | |
state | JSON | Required within parent | |
state (anyOf 1) | string | Alternative | Default: null |
state (anyOf 2) | null | Alternative |
List purchase orders — 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 Create a purchase order — 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, Create a purchase order — response body
Update a purchase order — 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 purchase order at the body level. Will be updated in an 'all or nothing' manner. Generally, only a single vendor accounting field is supported. |
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 | Memo for the purchase order. |
memo (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | Name of the purchase order. Must contain a non-whitespace character. Omit to preserve the current name, or set to null to clear it. Pattern: \s*\S |
name (anyOf 2) | null | Alternative | |
owner_id | string | Optional | Unique identifier of the new owner of the purchase order. The purchase order must be approved. Format: uuid |
spend_end_date | string | Optional | The date when spending for this purchase order ends. Format: date |
spend_start_date | string | Optional | The date when spending for this purchase order begins. Format: date |
withholding_default_rate | JSON | Optional | |
withholding_default_rate (anyOf 1) | JSON | Alternative | Default retainage withholding rate for the purchase order, expressed as a fractional decimal. For example, 0.10 means 10%. Minimum: 0 Less than: 1 |
withholding_default_rate (anyOf 1) (oneOf 1) | string | Alternative | Format: decimal |
withholding_default_rate (anyOf 1) (oneOf 2) | number | Alternative | |
withholding_default_rate (anyOf 2) | null | Alternative |
Referenced models: Create a bill — request body — body accounting field selections item
Update a single line item on an existing purchase order — 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 line item. Will be updated in an 'all or nothing' manner. |
accounting_field_selections[] | Model | Each item | Expand Create a bill — request body — body accounting field selections item |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Description of the line item. |
description (anyOf 2) | null | Alternative | |
end_date | JSON | Optional | |
end_date (anyOf 1) | string | Alternative | The date when spending for this line item ends. Omit to preserve the current date; set to null to clear it. Format: date |
end_date (anyOf 2) | null | Alternative | |
start_date | JSON | Optional | |
start_date (anyOf 1) | string | Alternative | The date when spending for this line item begins. Omit to preserve the current date; set to null to clear it. Format: date |
start_date (anyOf 2) | null | Alternative | |
unit_price | JSON | Optional | Unit price of the line item. |
unit_price (oneOf 1) | string | Alternative | Format: decimal |
unit_price (oneOf 2) | number | Alternative | |
unit_quantity | JSON | Optional | Quantity of the line item. |
unit_quantity (oneOf 1) | string | Alternative | Format: decimal |
unit_quantity (oneOf 2) | number | Alternative | |
withholding_rate | JSON | Optional | |
withholding_rate (anyOf 1) | JSON | 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%. Minimum: 0 Less than: 1 |
withholding_rate (anyOf 1) (oneOf 1) | string | Alternative | Format: decimal |
withholding_rate (anyOf 1) (oneOf 2) | number | Alternative | |
withholding_rate (anyOf 2) | null | Alternative |
Referenced models: Create a bill — request body — body accounting field selections item