Skip to content

Ramp: Create a purchase order — request body — body

Create a purchase order: request body, field body. Complete fields and constraints for contract 2026-10-27.

API reference · Contract 2026-10-27

SDK schema: 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

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.