Skip to content

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

FieldTypePresenceDescription and constraints
$objectRoot
line_itemsarrayRequired within parentList of line items to add to the purchase order. Existing line items attached to the purchase order won't be modified
line_items[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
archived_reasonJSONOptional
archived_reason (anyOf 1)stringAlternativeReason for archiving the purchase order.
archived_reason (anyOf 2)nullAlternative

Create a purchase order — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
accounting_field_selectionsarrayOptionalList of accounting field options selected to code the purchase order. Generally, only a single vendor accounting field is supported.
accounting_field_selections[]ModelEach itemExpand Create a bill — request body — body accounting field selections item
currencystringRequired within parentCurrency 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_idstringRequired within parentUnique identifier of associated business entity.
Format: uuid
external_idJSONOptional
external_id (anyOf 1)stringAlternativeAn 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)nullAlternative
line_itemsarrayRequired within parentList of purchase order line items.
line_items[]ModelEach itemExpand Create a purchase order — request body — body line items item
memoJSONOptional
memo (anyOf 1)stringAlternativeMemo for the purchase order.
Default: null
memo (anyOf 2)nullAlternative
nameJSONOptional
name (anyOf 1)stringAlternativeName of the purchase order. Must contain a non-whitespace character.
Default: null
Pattern: \s*\S
name (anyOf 2)nullAlternative
net_payment_termsJSONOptional
net_payment_terms (anyOf 1)integerAlternativeThe required time an invoice needs to be paid after receipt in days.
Default: null
net_payment_terms (anyOf 2)nullAlternative
owner_idJSONOptional
owner_id (anyOf 1)stringAlternativeUnique identifier for the owner of the purchase order. Defaults to the API caller when not provided.
Default: null
Format: uuid
owner_id (anyOf 2)nullAlternative
promise_dateJSONOptional
promise_date (anyOf 1)stringAlternativeThe date the vendor will deliver the goods or services.
Default: null
Format: date
promise_date (anyOf 2)nullAlternative
purchase_order_numberJSONOptional
purchase_order_number (anyOf 1)stringAlternativeUnique 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)nullAlternative
spend_end_dateJSONOptional
spend_end_date (anyOf 1)stringAlternativeThe date when spending for this purchase order ends.
Default: null
Format: date
spend_end_date (anyOf 2)nullAlternative
spend_start_dateJSONOptional
spend_start_date (anyOf 1)stringAlternativeThe date when spending for this purchase order begins.
Default: null
Format: date
spend_start_date (anyOf 2)nullAlternative
three_way_match_enabledbooleanRequired within parentWhether three-way match is enabled for the purchase order. I.e. whether an item receipt will be attached to indicate goods were received.
vendor_idJSONOptional
vendor_id (anyOf 1)stringAlternativeUnique identifier for the vendor.
Default: null
Format: uuid
vendor_id (anyOf 2)nullAlternative
withholding_default_rateJSONOptional
withholding_default_rate (anyOf 1)JSONAlternativeDefault 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)stringAlternativeFormat: decimal
withholding_default_rate (anyOf 1) (oneOf 2)numberAlternative
withholding_default_rate (anyOf 2)nullAlternative

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

FieldTypePresenceDescription and constraints
$objectRoot
accounting_field_selectionsarrayOptionalList of accounting field options selected to code the line item.
accounting_field_selections[]ModelEach itemExpand Create a bill — request body — body accounting field selections item
descriptionJSONOptional
description (anyOf 1)stringAlternativeDescription of the line item.
Default: null
description (anyOf 2)nullAlternative
end_dateJSONOptional
end_date (anyOf 1)stringAlternativeThe date when spending for this line item ends.
Default: null
Format: date
end_date (anyOf 2)nullAlternative
external_idJSONOptional
external_id (anyOf 1)stringAlternativeAn 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)nullAlternative
start_dateJSONOptional
start_date (anyOf 1)stringAlternativeThe date when spending for this line item begins.
Default: null
Format: date
start_date (anyOf 2)nullAlternative
unit_priceJSONRequired within parentUnit price of the line item.
unit_price (oneOf 1)stringAlternativeFormat: decimal
unit_price (oneOf 2)numberAlternative
unit_quantityJSONRequired within parentQuantity of the line item. Supports fractional values as a JSON number or decimal string.
unit_quantity (oneOf 1)stringAlternativeFormat: decimal
unit_quantity (oneOf 2)numberAlternative
withholding_rateJSONOptional
withholding_rate (anyOf 1)JSONAlternativeRetainage 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)stringAlternativeFormat: decimal
withholding_rate (anyOf 1) (oneOf 2)numberAlternative
withholding_rate (anyOf 2)nullAlternative

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

Create a purchase order — response body

FieldTypePresenceDescription and constraints
$objectRoot
accounting_field_selectionsarrayRequired within parentList of accounting field options selected to code the purchase order.
Read only: true
accounting_field_selections[]ModelEach itemExpand Hold Bill — response body — accounting field selections item
amountModelRequired within parentExpand Hold Bill — response body — amount
Amount of the purchse order.
Read only: true
archived_atJSONRequired within parent
archived_at (anyOf 1)stringAlternativeFormat: date-time
archived_at (anyOf 2)nullAlternative
bill_idsarrayRequired within parentList of unique identifiers for attached bills.
Read only: true
bill_ids[]stringEach itemFormat: uuid
billing_statusJSONOptional
billing_status (anyOf 1)stringAlternativeKnown values: CLOSED, DELETED, FULLY_BILLED, OPEN, PARTIALLY_BILLED
Read only: true
billing_status (anyOf 2)nullAlternative
created_atstringRequired within parentFormat: date-time
creation_sourcestringRequired within parentKnown values: ACCOUNTING_PROVIDER, DEVELOPER_API, EXTERNAL_IMPORT, RAMP
entity_idstringRequired within parentAssociated business entity.
Format: uuid
external_idJSONRequired within parent
external_id (anyOf 1)stringAlternativeAn 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)nullAlternative
idstringRequired within parentFormat: uuid
item_receipt_idsarrayRequired within parentList of unique identifiers for item receipts matched to the purchase order.
Read only: true
item_receipt_ids[]stringEach itemFormat: uuid
line_itemsarrayRequired within parentList of line items on the purchase order.
line_items[]ModelEach itemExpand Create a purchase order — response body — line items item
memoJSONRequired within parent
memo (anyOf 1)stringAlternativeMemo of the purchase order.
memo (anyOf 2)nullAlternative
nameJSONRequired within parent
name (anyOf 1)stringAlternativeThe name of the spend request associated with the purchase order.
name (anyOf 2)nullAlternative
net_payment_termsJSONRequired within parent
net_payment_terms (anyOf 1)JSONAlternative
net_payment_terms (anyOf 1) (anyOf 1)integerAlternativeThe required time an invoice needs to be paid after receipt.
net_payment_terms (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
net_payment_terms (anyOf 2)nullAlternative
owner_idJSONRequired within parent
owner_id (anyOf 1)stringAlternativeUnique 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)nullAlternative
promise_dateJSONRequired within parent
promise_date (anyOf 1)stringAlternativeThe date the vendor will deliver the goods or services.
Format: date-time
promise_date (anyOf 2)nullAlternative
purchase_order_numberJSONRequired within parent
purchase_order_number (anyOf 1)stringAlternative
purchase_order_number (anyOf 2)nullAlternative
ramp_urlstringRequired within parentA stable URL that links to the purchase order in the Ramp web application.
Read only: true
receipt_statusstringRequired within parentKnown values: FULLY_RECEIVED, NOT_RECEIVED, OVER_RECEIVED, PARTIALLY_RECEIVED
remote_idJSONRequired within parent
remote_id (anyOf 1)stringAlternativeThe accounting remote identifier of the purchase order.
Read only: true
remote_id (anyOf 2)nullAlternative
ship_to_addressJSONRequired within parent
ship_to_address (anyOf 1)ModelAlternativeExpand 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)nullAlternative
ship_to_company_nameJSONRequired within parent
ship_to_company_name (anyOf 1)stringAlternativeCompany name associated with the delivery address.
ship_to_company_name (anyOf 2)nullAlternative
shipping_contact_emailJSONRequired within parent
shipping_contact_email (anyOf 1)stringAlternativeEmail address of the delivery contact.
shipping_contact_email (anyOf 2)nullAlternative
shipping_contact_first_nameJSONRequired within parent
shipping_contact_first_name (anyOf 1)stringAlternativeFirst name of the delivery contact.
shipping_contact_first_name (anyOf 2)nullAlternative
shipping_contact_last_nameJSONRequired within parent
shipping_contact_last_name (anyOf 1)stringAlternativeLast name of the delivery contact.
shipping_contact_last_name (anyOf 2)nullAlternative
shipping_contact_phone_numberJSONRequired within parent
shipping_contact_phone_number (anyOf 1)stringAlternativePhone number of the delivery contact.
shipping_contact_phone_number (anyOf 2)nullAlternative
spend_end_dateJSONRequired within parent
spend_end_date (anyOf 1)stringAlternativeThe date when spending for this purchase order ends.
Format: date-time
spend_end_date (anyOf 2)nullAlternative
spend_program_idJSONRequired within parent
spend_program_id (anyOf 1)stringAlternativeUnique 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)nullAlternative
spend_request_idJSONRequired within parent
spend_request_id (anyOf 1)stringAlternativeUnique 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)nullAlternative
spend_start_dateJSONRequired within parent
spend_start_date (anyOf 1)stringAlternativeThe date when spending for this purchase order begins.
Format: date-time
spend_start_date (anyOf 2)nullAlternative
spend_total_amountJSONRequired within parent
spend_total_amount (anyOf 1)ModelAlternativeExpand 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)nullAlternative
three_way_match_enabledbooleanRequired within parentWhether three-way match is enabled for the purchase order.
Read only: true
transaction_idsarrayRequired within parentList of unique identifiers for attached transactions. This does not include transactions on attached bills.
Read only: true
transaction_ids[]stringEach itemFormat: uuid
user_idJSONRequired within parent
user_id (anyOf 1)stringAlternativeUnique 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)nullAlternative
vendor_idJSONRequired within parent
vendor_id (anyOf 1)stringAlternativeUnique identifier for the vendor.
Format: uuid
Read only: true
vendor_id (anyOf 2)nullAlternative
withholding_default_rateJSONRequired within parent
withholding_default_rate (anyOf 1)stringAlternativeDefault 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)nullAlternative

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

FieldTypePresenceDescription and constraints
$objectRoot
accounting_field_selectionsarrayRequired within parentList of accounting field options selected to code the purchase order line item.
Read only: true
accounting_field_selections[]ModelEach itemExpand Hold Bill — response body — accounting field selections item
amountModelRequired within parentExpand Hold Bill — response body — amount
Amount of the line item.
Read only: true
descriptionJSONRequired within parent
description (anyOf 1)stringAlternativeDescription of the line item.
description (anyOf 2)nullAlternative
end_dateJSONRequired within parent
end_date (anyOf 1)stringAlternativeThe date when spending for this line item ends.
Format: date
end_date (anyOf 2)nullAlternative
external_idJSONRequired within parent
external_id (anyOf 1)stringAlternativeCustomer-provided external identifier of the line item.
external_id (anyOf 2)nullAlternative
idstringRequired within parentUnique identifier for the line item.
Format: uuid
quantityJSONRequired within parent
quantity (anyOf 1)JSONAlternative
quantity (anyOf 1) (anyOf 1)numberAlternativeQuantity of the line item.
quantity (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
quantity (anyOf 2)nullAlternative
remote_idJSONRequired within parent
remote_id (anyOf 1)stringAlternativeThe accounting remote identifier of the line item.
Read only: true
remote_id (anyOf 2)nullAlternative
start_dateJSONRequired within parent
start_date (anyOf 1)stringAlternativeThe date when spending for this line item begins.
Format: date
start_date (anyOf 2)nullAlternative
unit_priceJSONRequired within parent
unit_price (anyOf 1)ModelAlternativeExpand Hold Bill — response body — amount
Unit price of the line item.
Read only: true
unit_price (anyOf 2)nullAlternative
withholding_rateJSONRequired within parent
withholding_rate (anyOf 1)stringAlternativeRetainage 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)nullAlternative

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

Fetch a purchase order — response body

FieldTypePresenceDescription and constraints
$objectRoot
accounting_field_selectionsarrayRequired within parentList of accounting field options selected to code the purchase order.
Read only: true
accounting_field_selections[]ModelEach itemExpand Hold Bill — response body — accounting field selections item
amountModelRequired within parentExpand Hold Bill — response body — amount
Amount of the purchse order.
Read only: true
archived_atJSONRequired within parent
archived_at (anyOf 1)stringAlternativeFormat: date-time
archived_at (anyOf 2)nullAlternative
bill_idsarrayRequired within parentList of unique identifiers for attached bills.
Read only: true
bill_ids[]stringEach itemFormat: uuid
billing_statusJSONOptional
billing_status (anyOf 1)stringAlternativeKnown values: CLOSED, DELETED, FULLY_BILLED, OPEN, PARTIALLY_BILLED
Read only: true
billing_status (anyOf 2)nullAlternative
created_atstringRequired within parentFormat: date-time
creation_sourcestringRequired within parentKnown values: ACCOUNTING_PROVIDER, DEVELOPER_API, EXTERNAL_IMPORT, RAMP
custom_form_collection_responseJSONRequired within parent
custom_form_collection_response (anyOf 1)ModelAlternativeExpand 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)nullAlternative
entity_idstringRequired within parentAssociated business entity.
Format: uuid
external_idJSONRequired within parent
external_id (anyOf 1)stringAlternativeAn 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)nullAlternative
idstringRequired within parentFormat: uuid
item_receipt_idsarrayRequired within parentList of unique identifiers for item receipts matched to the purchase order.
Read only: true
item_receipt_ids[]stringEach itemFormat: uuid
line_itemsarrayRequired within parentList of line items on the purchase order.
line_items[]ModelEach itemExpand Fetch a purchase order — response body — line items item
memoJSONRequired within parent
memo (anyOf 1)stringAlternativeMemo of the purchase order.
memo (anyOf 2)nullAlternative
nameJSONRequired within parent
name (anyOf 1)stringAlternativeThe name of the spend request associated with the purchase order.
name (anyOf 2)nullAlternative
net_payment_termsJSONRequired within parent
net_payment_terms (anyOf 1)JSONAlternative
net_payment_terms (anyOf 1) (anyOf 1)integerAlternativeThe required time an invoice needs to be paid after receipt.
net_payment_terms (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
net_payment_terms (anyOf 2)nullAlternative
owner_idJSONRequired within parent
owner_id (anyOf 1)stringAlternativeUnique 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)nullAlternative
promise_dateJSONRequired within parent
promise_date (anyOf 1)stringAlternativeThe date the vendor will deliver the goods or services.
Format: date-time
promise_date (anyOf 2)nullAlternative
purchase_order_numberJSONRequired within parent
purchase_order_number (anyOf 1)stringAlternative
purchase_order_number (anyOf 2)nullAlternative
ramp_urlstringRequired within parentA stable URL that links to the purchase order in the Ramp web application.
Read only: true
receipt_statusstringRequired within parentKnown values: FULLY_RECEIVED, NOT_RECEIVED, OVER_RECEIVED, PARTIALLY_RECEIVED
remote_idJSONRequired within parent
remote_id (anyOf 1)stringAlternativeThe accounting remote identifier of the purchase order.
Read only: true
remote_id (anyOf 2)nullAlternative
ship_to_addressJSONRequired within parent
ship_to_address (anyOf 1)ModelAlternativeExpand 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)nullAlternative
ship_to_company_nameJSONRequired within parent
ship_to_company_name (anyOf 1)stringAlternativeCompany name associated with the delivery address.
ship_to_company_name (anyOf 2)nullAlternative
shipping_contact_emailJSONRequired within parent
shipping_contact_email (anyOf 1)stringAlternativeEmail address of the delivery contact.
shipping_contact_email (anyOf 2)nullAlternative
shipping_contact_first_nameJSONRequired within parent
shipping_contact_first_name (anyOf 1)stringAlternativeFirst name of the delivery contact.
shipping_contact_first_name (anyOf 2)nullAlternative
shipping_contact_last_nameJSONRequired within parent
shipping_contact_last_name (anyOf 1)stringAlternativeLast name of the delivery contact.
shipping_contact_last_name (anyOf 2)nullAlternative
shipping_contact_phone_numberJSONRequired within parent
shipping_contact_phone_number (anyOf 1)stringAlternativePhone number of the delivery contact.
shipping_contact_phone_number (anyOf 2)nullAlternative
spend_end_dateJSONRequired within parent
spend_end_date (anyOf 1)stringAlternativeThe date when spending for this purchase order ends.
Format: date-time
spend_end_date (anyOf 2)nullAlternative
spend_program_idJSONRequired within parent
spend_program_id (anyOf 1)stringAlternativeUnique 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)nullAlternative
spend_request_idJSONRequired within parent
spend_request_id (anyOf 1)stringAlternativeUnique 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)nullAlternative
spend_start_dateJSONRequired within parent
spend_start_date (anyOf 1)stringAlternativeThe date when spending for this purchase order begins.
Format: date-time
spend_start_date (anyOf 2)nullAlternative
spend_total_amountJSONRequired within parent
spend_total_amount (anyOf 1)ModelAlternativeExpand 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)nullAlternative
three_way_match_enabledbooleanRequired within parentWhether three-way match is enabled for the purchase order.
Read only: true
transaction_idsarrayRequired within parentList of unique identifiers for attached transactions. This does not include transactions on attached bills.
Read only: true
transaction_ids[]stringEach itemFormat: uuid
user_idJSONRequired within parent
user_id (anyOf 1)stringAlternativeUnique 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)nullAlternative
vendor_idJSONRequired within parent
vendor_id (anyOf 1)stringAlternativeUnique identifier for the vendor.
Format: uuid
Read only: true
vendor_id (anyOf 2)nullAlternative
withholding_default_rateJSONRequired within parent
withholding_default_rate (anyOf 1)stringAlternativeDefault 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)nullAlternative

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

FieldTypePresenceDescription and constraints
$objectRoot
accounting_field_selectionsarrayRequired within parentList of accounting field options selected to code the purchase order line item.
Read only: true
accounting_field_selections[]ModelEach itemExpand Hold Bill — response body — accounting field selections item
amountModelRequired within parentExpand Hold Bill — response body — amount
Amount of the line item.
Read only: true
custom_field_valuesarrayRequired within parentCustom field values associated with this purchase order line item.
Read only: true
custom_field_values[]ModelEach itemExpand Fetch a purchase order — response body — line items item custom field values item
descriptionJSONRequired within parent
description (anyOf 1)stringAlternativeDescription of the line item.
description (anyOf 2)nullAlternative
end_dateJSONRequired within parent
end_date (anyOf 1)stringAlternativeThe date when spending for this line item ends.
Format: date
end_date (anyOf 2)nullAlternative
external_idJSONRequired within parent
external_id (anyOf 1)stringAlternativeCustomer-provided external identifier of the line item.
external_id (anyOf 2)nullAlternative
idstringRequired within parentUnique identifier for the line item.
Format: uuid
quantityJSONRequired within parent
quantity (anyOf 1)JSONAlternative
quantity (anyOf 1) (anyOf 1)numberAlternativeQuantity of the line item.
quantity (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
quantity (anyOf 2)nullAlternative
remote_idJSONRequired within parent
remote_id (anyOf 1)stringAlternativeThe accounting remote identifier of the line item.
Read only: true
remote_id (anyOf 2)nullAlternative
start_dateJSONRequired within parent
start_date (anyOf 1)stringAlternativeThe date when spending for this line item begins.
Format: date
start_date (anyOf 2)nullAlternative
unit_priceJSONRequired within parent
unit_price (anyOf 1)ModelAlternativeExpand Hold Bill — response body — amount
Unit price of the line item.
Read only: true
unit_price (anyOf 2)nullAlternative
withholding_rateJSONRequired within parent
withholding_rate (anyOf 1)stringAlternativeRetainage 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)nullAlternative

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

FieldTypePresenceDescription and constraints
$objectRoot
column_display_namestringRequired within parentThe display name of the column
column_idstringRequired within parentThe id of the column
is_archivedbooleanRequired within parentWhether the custom field has been archived
Default: false
valueJSONRequired within parentThe 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)ModelAlternativeExpand Get a business entity — response body — custom record fields item value type boolean
value (anyOf 2)ModelAlternativeExpand Get a business entity — response body — custom record fields item value type custom table
value (anyOf 3)ModelAlternativeExpand Get a business entity — response body — custom record fields item value type date
value (anyOf 4)ModelAlternativeExpand Get a business entity — response body — custom record fields item value type native table
value (anyOf 5)ModelAlternativeExpand Get a business entity — response body — custom record fields item value type number
value (anyOf 6)ModelAlternativeExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
address1stringRequired within parent
address2JSONRequired within parent
address2 (anyOf 1)stringAlternativeDefault: null
address2 (anyOf 2)nullAlternative
citystringRequired within parent
countrystringRequired within parent
postal_codeJSONRequired within parent
postal_code (anyOf 1)stringAlternativeDefault: null
postal_code (anyOf 2)nullAlternative
stateJSONRequired within parent
state (anyOf 1)stringAlternativeDefault: null
state (anyOf 2)nullAlternative

List purchase orders — response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentResources returned in this page.
data[]ModelEach itemExpand Create a purchase order — response body
pageModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
accounting_field_selectionsarrayOptionalList 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[]ModelEach itemExpand Create a bill — request body — body accounting field selections item
memoJSONOptional
memo (anyOf 1)stringAlternativeMemo for the purchase order.
memo (anyOf 2)nullAlternative
nameJSONOptional
name (anyOf 1)stringAlternativeName 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)nullAlternative
owner_idstringOptionalUnique identifier of the new owner of the purchase order. The purchase order must be approved.
Format: uuid
spend_end_datestringOptionalThe date when spending for this purchase order ends.
Format: date
spend_start_datestringOptionalThe date when spending for this purchase order begins.
Format: date
withholding_default_rateJSONOptional
withholding_default_rate (anyOf 1)JSONAlternativeDefault 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)stringAlternativeFormat: decimal
withholding_default_rate (anyOf 1) (oneOf 2)numberAlternative
withholding_default_rate (anyOf 2)nullAlternative

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

FieldTypePresenceDescription and constraints
$objectRoot
accounting_field_selectionsarrayOptionalList of accounting field options selected to code the line item. Will be updated in an 'all or nothing' manner.
accounting_field_selections[]ModelEach itemExpand Create a bill — request body — body accounting field selections item
descriptionJSONOptional
description (anyOf 1)stringAlternativeDescription of the line item.
description (anyOf 2)nullAlternative
end_dateJSONOptional
end_date (anyOf 1)stringAlternativeThe 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)nullAlternative
start_dateJSONOptional
start_date (anyOf 1)stringAlternativeThe 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)nullAlternative
unit_priceJSONOptionalUnit price of the line item.
unit_price (oneOf 1)stringAlternativeFormat: decimal
unit_price (oneOf 2)numberAlternative
unit_quantityJSONOptionalQuantity of the line item.
unit_quantity (oneOf 1)stringAlternativeFormat: decimal
unit_quantity (oneOf 2)numberAlternative
withholding_rateJSONOptional
withholding_rate (anyOf 1)JSONAlternativeRetainage 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)stringAlternativeFormat: decimal
withholding_rate (anyOf 1) (oneOf 2)numberAlternative
withholding_rate (anyOf 2)nullAlternative

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

Report an issue with this page

Necessary

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

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

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

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