Creates a Purchase order

Create a standalone purchase order (e.g. pushed by an ERP integrator), not linked to any purchase request. The purchase order is pinned to the company's ACTIVE purchase order template version; template fields are addressed by their stable field_key and validated against that version: unknown field keys, missing required fields and reference values that do not resolve in the company are all rejected with a field-keyed 422.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Company identifier, refers to /api/me endpoint.

string
required
string

Identifier of the vendor (Finance contact) by internal Factorial id. Vendors synced from an external system must be resolved to their Factorial id first (e.g. via the vendors read endpoint).

string
required

Currency code in ISO 4217 format.

string

Purchase order date. Defaults to today when omitted.

string

Deadline date for the purchase order delivery or completion.

string
enum

Status of the purchase order. Defaults to draft. processing is an internal transient status and is rejected.

Allowed:
string

Description or notes about the purchase order.

string
enum

Preferred payment method for this purchase order.

Allowed:
header_field_values
object

Map of field_key => value for the header fields of the ACTIVE purchase order template version. Only custom (non-predefined, non-computed) field keys are accepted; predefined fields (vendor, order_date, currency, due_date, payment_method, legal_entity) are populated from the corresponding top-level parameters. Reference fields (employee, cost_center, project, tax_rate, team) take the referenced internal id as the value.

line_items
array

Line items of the purchase order, each addressed by the line-item field keys of the ACTIVE template version (e.g. concept, quantity, unit_price, tax_rate). Computed keys (subtotal, tax_amount, total, discount_amount) are derived server-side and rejected as input.

line_items
Response

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json