TRANXACT.AI Help

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.

Type REST6 operationsBase path /api/scm/po-typesPublished as /api/v1/po-types

Download specification (OpenAPI 3.1) Screen: Purchase Order Types

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 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.
Tablescm.po_types · 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

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

GET/api/scm/po-typesList purchase order types

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",
      "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

NameTypeDescription
idstring (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.

FieldTypeRequiredDescription
codetextYesCode
nametextYesName
kindtextNoKind
Allowed: standard blanket release subcontract return service consignment
number_prefixtextNoNumber 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_digitsintegerNoDigits in the number
next_numberbigintNoNext number
default_warehouse_iduuidNoDefault warehouse
default_payment_terms_iduuidNoDefault payment terms
approval_modetextNoApproval
Allowed: By the company’s approval rules No approval needed
receipt_modetextNoGoods receipt
Allowed: Received as goods Not received (a service, invoiced to the order)
invoice_matchingtextNoInvoice matching
Allowed: As the item, supplier or company says Two-way (order and invoice) Three-way (order, receipt and invoice) No matching
is_defaultbooleanNoDefault type for new orders
is_activebooleanNoActive
descriptiontextNoDescription

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

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
codetextYesCode
nametextYesName
kindtextNoKind
Allowed: standard blanket release subcontract return service consignment
number_prefixtextNoNumber 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_digitsintegerNoDigits in the number
next_numberbigintNoNext number
default_warehouse_iduuidNoDefault warehouse
default_payment_terms_iduuidNoDefault payment terms
approval_modetextNoApproval
Allowed: By the company’s approval rules No approval needed
receipt_modetextNoGoods receipt
Allowed: Received as goods Not received (a service, invoiced to the order)
invoice_matchingtextNoInvoice matching
Allowed: As the item, supplier or company says Two-way (order and invoice) Three-way (order, receipt and invoice) No matching
is_defaultbooleanNoDefault type for new orders
is_activebooleanNoActive
descriptiontextNoDescription

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

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/po-types/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/po-types/{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, preview, withLines

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/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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
codetextread, writeCode
nametextread, writeName
kindtextread, writeKind
Allowed: standard blanket release subcontract return service consignment
number_prefixtextread, writeNumber 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_digitsintegerread, writeDigits in the number
next_numberbigintread, writeNext number
default_warehouse_iduuidread, writeDefault warehouse
default_payment_terms_iduuidread, writeDefault payment terms
approval_modetextread, writeApproval
Allowed: By the company’s approval rules No approval needed
receipt_modetextread, writeGoods receipt
Allowed: Received as goods Not received (a service, invoiced to the order)
invoice_matchingtextread, writeInvoice matching
Allowed: As the item, supplier or company says Two-way (order and invoice) Three-way (order, receipt and invoice) No matching
is_defaultbooleanread, writeDefault type for new orders
is_activebooleanread, writeActive
descriptiontextread, writeDescription
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
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

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 Order Types 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.