TRANXACT.AI Help

Supply Chain · Requisitions & Orders

Purchase Orders

Read and maintain purchase orders records (scm.purchase_orders).

Type REST21 operationsBase path /api/scm/purchase-ordersPublished as /api/v1/purchase-orders

Download specification (OpenAPI 3.1) Screen: Purchase Orders

Overview

PackageSupply Chain
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe caller's roles must hold Supply Chain › Purchase Orders on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen.
Tablescm.purchase_orders · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; key id
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

21 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/scm/purchase-ordersList purchase orders

Query parameters

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"col":"status","op":"eq","value":"open"}
<field>=<value>Shorthand for "field is value" 

Response 200

{
  "rows": [
    {
      "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "po_no": "PO-000001",
      "supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "requisition_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "order_date": "2026-10-30",
      "promised_date": "2026-10-30",
      "currency": "USD",
      "status": "draft",
      "total": "1250.00",
      "buyer_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "created_at": "2026-10-30T09:00:00Z",
      "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "cost_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "profit_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/scm/purchase-orders?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/scm/purchase-orders/{id}Read one purchase orders

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "po_no": "PO-000001",
  "supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "requisition_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "order_date": "2026-10-30",
  "promised_date": "2026-10-30",
  "currency": "USD",
  "status": "draft",
  "total": "1250.00",
  "buyer_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "created_at": "2026-10-30T09:00:00Z",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "cost_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "profit_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

404 when no record with that id is visible to the caller.

Sample request

curl "https://demo.tranxact.ai/api/scm/purchase-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/purchase-ordersCreate a purchase orders

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
supplier_iduuidYesSupplier id
order_datedateNoOrder date
promised_datedateNoPromised date
currencytextNoCurrency — The lines priced in the order’s currency follow it, at the rate on file unless you give one.
statustextNoStatus
totalnumericNoTotal
buyer_iduuidNoBuyer id
exchange_ratenumericNoExchange rate — What one unit of the order currency is worth in the company’s own. It sets the total in the company’s currency, which approval limits are judged on.
po_type_iduuidNoPo type id
payment_terms_iduuidNoPayment terms — When the supplier is paid. Invoices against this order fall due by these terms, their discount tiers and fixed days included.

Sample body

{
  "supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "order_date": "2026-10-30",
  "promised_date": "2026-10-30",
  "currency": "USD",
  "status": "draft"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "po_no": "PO-000001",
  "supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "requisition_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "order_date": "2026-10-30",
  "promised_date": "2026-10-30",
  "currency": "USD",
  "status": "draft",
  "total": "1250.00",
  "buyer_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "created_at": "2026-10-30T09:00:00Z",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "cost_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "profit_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/scm/purchase-orders" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"supplier_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","order_date":"2026-10-30","promised_date":"2026-10-30","currency":"USD","status":"draft"}'
PUT/api/scm/purchase-orders/{id}Change a purchase orders

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
supplier_iduuidYesSupplier id
order_datedateNoOrder date
promised_datedateNoPromised date
currencytextNoCurrency — The lines priced in the order’s currency follow it, at the rate on file unless you give one.
statustextNoStatus
totalnumericNoTotal
buyer_iduuidNoBuyer id
exchange_ratenumericNoExchange rate — What one unit of the order currency is worth in the company’s own. It sets the total in the company’s currency, which approval limits are judged on.
po_type_iduuidNoPo type id
payment_terms_iduuidNoPayment terms — When the supplier is paid. Invoices against this order fall due by these terms, their discount tiers and fixed days included.

Sample body

{
  "supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "order_date": "2026-10-30"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "po_no": "PO-000001",
  "supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "requisition_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "order_date": "2026-10-30",
  "promised_date": "2026-10-30",
  "currency": "USD",
  "status": "draft",
  "total": "1250.00",
  "buyer_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "created_at": "2026-10-30T09:00:00Z",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "cost_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "profit_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/scm/purchase-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"supplier_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","order_date":"2026-10-30"}'
DELETE/api/scm/purchase-orders/{id}Delete a purchase orders

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{ "deleted": true }

Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.

Sample request

curl -X DELETE "https://demo.tranxact.ai/api/scm/purchase-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
GET/api/scm/purchase-orders/{id}/subcontract-componentsSubcontract components

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/scm/purchase-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/subcontract-components" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/purchase-orders/{id}/subcontract-componentsSubcontract components

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/scm/purchase-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/subcontract-components" \
  -H "Authorization: Bearer $TOKEN"
GET/api/scm/purchase-orders/new-defaultsNew defaults

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/scm/purchase-orders/new-defaults" \
  -H "Authorization: Bearer $TOKEN"
GET/api/scm/purchase-orders/price-forPrice for

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/scm/purchase-orders/price-for" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/purchase-orders/{id}/copyCopy

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

overrides

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/scm/purchase-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value"}'
GET/api/scm/purchase-orders/{id}/approvalsApprovals

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/scm/purchase-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/approvals" \
  -H "Authorization: Bearer $TOKEN"
GET/api/scm/purchase-orders/{id}/approval-previewApproval preview

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/scm/purchase-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/approval-preview" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/purchase-orders/{id}/submit-for-approvalSubmit for approval

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/scm/purchase-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/submit-for-approval" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/purchase-orders/{id}/openOpen

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/scm/purchase-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/open" \
  -H "Authorization: Bearer $TOKEN"
GET/api/scm/purchase-orders/{parentId}/linesLines

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/scm/purchase-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/purchase-orders/{parentId}/linesLines

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/scm/purchase-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines" \
  -H "Authorization: Bearer $TOKEN"
PUT/api/scm/purchase-orders/{parentId}/lines/{lineId}Lines

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (uuid)The record's lineId, as a list returns it.

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X PUT "https://demo.tranxact.ai/api/scm/purchase-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/scm/purchase-orders/{parentId}/lines/{lineId}Lines

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (uuid)The record's lineId, as a list returns it.

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X DELETE "https://demo.tranxact.ai/api/scm/purchase-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
GET/api/scm/purchase-orders/{id}/linesLines

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/scm/purchase-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/purchase-orders/create-with-linesCreate with lines

Request body

The keys this action reads (* = required; "one of" lists the only values):

orgUnitId, org_unit_id, documentNo, exchangeRate, poTypeId, po_type_id, supplierId*, promisedDate, currency, costCenterId, profitCenterId, locationId, warehouseId; lines*: [{ quantity, unitPrice, itemId, uom, currency, exchangeRate, costCenterId, base }]

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/scm/purchase-orders/create-with-lines" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"orgUnitId":"value","org_unit_id":"value","documentNo":"value","exchangeRate":"value","poTypeId":"value","po_type_id":"value"}'
POST/api/scm/purchase-orders/{id}/receiveReceive

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

lines, exchangeRate

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/scm/purchase-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/receive" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"lines":"value","exchangeRate":"value"}'

Data model

Every field of a purchase orders, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
po_notextread onlyPo no
supplier_iduuidread, writeSupplier id
requisition_iduuidread onlyRequisition id
order_datedateread, writeOrder date
promised_datedateread, writePromised date
currencytextread, writeCurrency — The lines priced in the order’s currency follow it, at the rate on file unless you give one.
statustextread, writeStatus
totalnumericread, writeTotal
buyer_iduuidread, writeBuyer id
created_attimestamp with time zoneread onlyCreated at
org_unit_iduuidread onlyOrganizational unit — Decides which approval rules apply. Changing it on an order that is waiting for approval, or already approved, sends it to the approvers for the new unit.
cost_center_iduuidread onlyCost center id
profit_center_iduuidread onlyProfit center id
location_iduuidread onlyLocation
warehouse_iduuidread onlyReceive into warehouse
cancelled_attimestamp with time zoneread onlyCancelled at
cancelled_byuuidread onlyCancelled by
cancel_reasontextread onlyCancel reason
reversed_by_iduuidread onlyReversed by id
reverses_iduuidread onlyReverses id
is_subcontractbooleanread onlyIs subcontract
production_order_iduuidread onlyProduction order id
production_operation_iduuidread onlyProduction operation id
sales_order_iduuidread onlySales order id
config_iduuidread onlyConfig id
exchange_ratenumericread, writeExchange rate — What one unit of the order currency is worth in the company’s own. It sets the total in the company’s currency, which approval limits are judged on.
base_totalnumericread onlyBase total
approval_statustextread onlyApproval status
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
supplier_ack_statustextread onlySupplier ack status
supplier_ack_attimestamp with time zoneread onlySupplier ack at
is_drop_shipbooleanread onlyIs drop ship
ship_to_account_iduuidread onlyShip to account id
ship_to_nametextread onlyShip to name
ship_to_addresstextread onlyShip to address
project_iduuidread onlyProject id
po_type_iduuidread, writePo type id
payment_terms_iduuidread, writePayment terms — When the supplier is paid. Invoices against this order fall due by these terms, their discount tiers and fixed days included.
charges_totalnumericread onlyCharges total
accrued_charges_totalnumericread onlyAccrued charges total

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold Supply Chain › Purchase Orders for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused by the same validation as the screen; the error names the field and why

Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.