Supply Chain · Purchase Order Types
Purchase Order Types
What each kind of purchase order does: its own numbers, the warehouse and payment terms it starts with, whether it needs approval, whether it is received, and the invoice matching it needs. Orders of no type behave as they always have.
/api/scm/po-typesPublished as /api/v1/po-typesDownload specification (OpenAPI 3.1) Screen: Purchase Order Types
Overview
| Package | Supply Chain |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The caller's roles must hold Supply Chain › Purchase Order Types 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. |
| Table | scm.po_types · kept per company (and organisational unit where it has one) |
| Record | Created, changed and (where the screen allows) deleted; key id |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
6 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/scm/po-typesList purchase order types
Query parameters
| Name | Description | Example |
|---|---|---|
limit | Rows per page (50 by default, at most 200) | limit=100 |
offset | Rows to skip | offset=200 |
q | Free-text search over the search columns | q=acme |
sort | column:asc or column:desc, several separated by commas | sort=created_at:desc |
filter | A JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sorted | filter={"col":"status","op":"eq","value":"open"} |
<field>=<value> | Shorthand for "field is value" |
Response 200
{
"rows": [
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"kind": "standard",
"number_prefix": "text",
"number_digits": 10,
"next_number": "1250.00",
"default_warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"default_payment_terms_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"approval_mode": "By the company’s approval rules",
"receipt_mode": "Received as goods",
"invoice_matching": "As the item, supplier or company says",
"is_default": true,
"is_active": true
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/scm/po-types?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/scm/po-types/{id}Read one purchase order type
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"kind": "standard",
"number_prefix": "text",
"number_digits": 10,
"next_number": "1250.00",
"default_warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"default_payment_terms_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"approval_mode": "By the company’s approval rules",
"receipt_mode": "Received as goods",
"invoice_matching": "As the item, supplier or company says",
"is_default": true,
"is_active": true
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/scm/po-types/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/po-typesCreate a purchase order type
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
code | text | Yes | Code |
name | text | Yes | Name |
kind | text | No | Kind Allowed: standard blanket release subcontract return service consignment |
number_prefix | text | No | Number prefix — Orders of this type are numbered from their own series, e.g. SVC-00001. Leave blank to use the company’s purchase order numbers. |
number_digits | integer | No | Digits in the number |
next_number | bigint | No | Next number |
default_warehouse_id | uuid | No | Default warehouse |
default_payment_terms_id | uuid | No | Default payment terms |
approval_mode | text | No | Approval Allowed: By the company’s approval rules No approval needed |
receipt_mode | text | No | Goods receipt Allowed: Received as goods Not received (a service, invoiced to the order) |
invoice_matching | text | No | Invoice matching Allowed: As the item, supplier or company says Two-way (order and invoice) Three-way (order, receipt and invoice) No matching |
is_default | boolean | No | Default type for new orders |
is_active | boolean | No | Active |
description | text | No | Description |
Sample body
{
"code": "COD-000001",
"name": "Example",
"kind": "standard",
"number_prefix": "text",
"number_digits": 10,
"next_number": "1250.00"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"kind": "standard",
"number_prefix": "text",
"number_digits": 10,
"next_number": "1250.00",
"default_warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"default_payment_terms_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"approval_mode": "By the company’s approval rules",
"receipt_mode": "Received as goods",
"invoice_matching": "As the item, supplier or company says",
"is_default": true,
"is_active": true
}Sample request
curl -X POST "https://demo.tranxact.ai/api/scm/po-types" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"COD-000001","name":"Example","kind":"standard","number_prefix":"text","number_digits":10,"next_number":"1250.00"}'PUT/api/scm/po-types/{id}Change a purchase order type
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
Only the fields to change; fields left out keep their value.
| Field | Type | Required | Description |
|---|---|---|---|
code | text | Yes | Code |
name | text | Yes | Name |
kind | text | No | Kind Allowed: standard blanket release subcontract return service consignment |
number_prefix | text | No | Number prefix — Orders of this type are numbered from their own series, e.g. SVC-00001. Leave blank to use the company’s purchase order numbers. |
number_digits | integer | No | Digits in the number |
next_number | bigint | No | Next number |
default_warehouse_id | uuid | No | Default warehouse |
default_payment_terms_id | uuid | No | Default payment terms |
approval_mode | text | No | Approval Allowed: By the company’s approval rules No approval needed |
receipt_mode | text | No | Goods receipt Allowed: Received as goods Not received (a service, invoiced to the order) |
invoice_matching | text | No | Invoice matching Allowed: As the item, supplier or company says Two-way (order and invoice) Three-way (order, receipt and invoice) No matching |
is_default | boolean | No | Default type for new orders |
is_active | boolean | No | Active |
description | text | No | Description |
Sample body
{
"code": "COD-000001",
"name": "Example"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"kind": "standard",
"number_prefix": "text",
"number_digits": 10,
"next_number": "1250.00",
"default_warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"default_payment_terms_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"approval_mode": "By the company’s approval rules",
"receipt_mode": "Received as goods",
"invoice_matching": "As the item, supplier or company says",
"is_default": true,
"is_active": true
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/scm/po-types/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"COD-000001","name":"Example"}'DELETE/api/scm/po-types/{id}Delete a purchase order type
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (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/po-types/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/po-types/{id}/copyCopy
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (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, preview, withLinesResponse
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/po-types/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'Data model
Every field of a purchase order type, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
code | text | read, write | Code |
name | text | read, write | Name |
kind | text | read, write | Kind Allowed: standard blanket release subcontract return service consignment |
number_prefix | text | read, write | Number prefix — Orders of this type are numbered from their own series, e.g. SVC-00001. Leave blank to use the company’s purchase order numbers. |
number_digits | integer | read, write | Digits in the number |
next_number | bigint | read, write | Next number |
default_warehouse_id | uuid | read, write | Default warehouse |
default_payment_terms_id | uuid | read, write | Default payment terms |
approval_mode | text | read, write | Approval Allowed: By the company’s approval rules No approval needed |
receipt_mode | text | read, write | Goods receipt Allowed: Received as goods Not received (a service, invoiced to the order) |
invoice_matching | text | read, write | Invoice matching Allowed: As the item, supplier or company says Two-way (order and invoice) Three-way (order, receipt and invoice) No matching |
is_default | boolean | read, write | Default type for new orders |
is_active | boolean | read, write | Active |
description | text | read, write | Description |
created_at | timestamp with time zone | read only | Created at |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
xf_text_1 | text | read only | Xf text 1 |
xf_text_2 | text | read only | Xf text 2 |
xf_text_3 | text | read only | Xf text 3 |
xf_text_4 | text | read only | Xf text 4 |
xf_text_5 | text | read only | Xf text 5 |
xf_num_1 | numeric | read only | Xf num 1 |
xf_num_2 | numeric | read only | Xf num 2 |
xf_num_3 | numeric | read only | Xf num 3 |
xf_date_1 | date | read only | Xf date 1 |
xf_date_2 | date | read only | Xf date 2 |
Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold Supply Chain › Purchase Order Types for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused 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.