TRANXACT.AI Help

Supply Chain · Purchase Charges

Purchase Charge Conditions

The conditions of the purchase order pricing procedure (PO-STD): the gross price, discounts and surcharges, the charges (freight, packing and forwarding, insurance, inspection, customs duty and the Social Welfare Surcharge) and the GST heads. Each charge says whether the supplier bills it or somebody else is paid, its SAC code for GST, its GL account and which landed cost charge it becomes on receipt. Liquidated damages (LD): 0.5% of the late goods’ net value for every week late, at most 5% of the order’s net value, no VAT/GST, found for an order by its own condition records.

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

Download specification (OpenAPI 3.1) Screen: Purchase Charge Conditions

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 Charge Conditions 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.
Tablecrm.pricing_condition_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/purchase-condition-typesList purchase charge conditions

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",
      "class": "Price (the gross price)",
      "calc": "Percent of the line value (or of the value after an earlier step)",
      "source": "text",
      "access_sequence_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "is_active": true,
      "description": "text",
      "created_at": "2026-10-30T09:00:00Z",
      "charge_kind": "Freight",
      "charge_to": "On this document (billed by the customer’s or supplier’s invoice)",
      "applies_to": "Purchase orders",
      "landed_cost_charge_type_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
    }
  ],
  "count": 1
}

Sample request

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

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",
  "class": "Price (the gross price)",
  "calc": "Percent of the line value (or of the value after an earlier step)",
  "source": "text",
  "access_sequence_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "is_active": true,
  "description": "text",
  "created_at": "2026-10-30T09:00:00Z",
  "charge_kind": "Freight",
  "charge_to": "On this document (billed by the customer’s or supplier’s invoice)",
  "applies_to": "Purchase orders",
  "landed_cost_charge_type_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-condition-types/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/purchase-condition-typesCreate a purchase condition types

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
codetextYesCode
nametextYesName
classtextNoClass
Allowed: Price (the gross price) Discount Surcharge Charge on the order GST (from the GST engine) Liquidated damages (penalty for late delivery)
calctextNoCalculated as
Allowed: Percent of the line value (or of the value after an earlier step) Amount (once per document; once per line when the record names an item) Amount per unit ordered
sourcetextNoSource
access_sequence_iduuidNoAccess sequence
is_activebooleanNoActive
descriptiontextNoDescription
charge_kindtextNoKind of charge
Allowed: Freight Insurance Packing and forwarding Inspection Customs duty Handling Other
charge_totextNoPaid to
Allowed: On this document (billed by the customer’s or supplier’s invoice) Accrued (paid to a carrier, customs or another party)
applies_totextNoUsed on
Allowed: Purchase orders Sales and purchase documents
landed_cost_charge_type_iduuidNoLanded cost charge

Sample body

{
  "code": "COD-000001",
  "name": "Example",
  "class": "Price (the gross price)",
  "calc": "Percent of the line value (or of the value after an earlier step)",
  "source": "text",
  "access_sequence_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "class": "Price (the gross price)",
  "calc": "Percent of the line value (or of the value after an earlier step)",
  "source": "text",
  "access_sequence_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "is_active": true,
  "description": "text",
  "created_at": "2026-10-30T09:00:00Z",
  "charge_kind": "Freight",
  "charge_to": "On this document (billed by the customer’s or supplier’s invoice)",
  "applies_to": "Purchase orders",
  "landed_cost_charge_type_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/scm/purchase-condition-types" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code":"COD-000001","name":"Example","class":"Price (the gross price)","calc":"Percent of the line value (or of the value after an earlier step)","source":"text","access_sequence_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'
PUT/api/scm/purchase-condition-types/{id}Change a purchase condition types

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
classtextNoClass
Allowed: Price (the gross price) Discount Surcharge Charge on the order GST (from the GST engine) Liquidated damages (penalty for late delivery)
calctextNoCalculated as
Allowed: Percent of the line value (or of the value after an earlier step) Amount (once per document; once per line when the record names an item) Amount per unit ordered
sourcetextNoSource
access_sequence_iduuidNoAccess sequence
is_activebooleanNoActive
descriptiontextNoDescription
charge_kindtextNoKind of charge
Allowed: Freight Insurance Packing and forwarding Inspection Customs duty Handling Other
charge_totextNoPaid to
Allowed: On this document (billed by the customer’s or supplier’s invoice) Accrued (paid to a carrier, customs or another party)
applies_totextNoUsed on
Allowed: Purchase orders Sales and purchase documents
landed_cost_charge_type_iduuidNoLanded cost charge

Sample body

{
  "code": "COD-000001",
  "name": "Example"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "class": "Price (the gross price)",
  "calc": "Percent of the line value (or of the value after an earlier step)",
  "source": "text",
  "access_sequence_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "is_active": true,
  "description": "text",
  "created_at": "2026-10-30T09:00:00Z",
  "charge_kind": "Freight",
  "charge_to": "On this document (billed by the customer’s or supplier’s invoice)",
  "applies_to": "Purchase orders",
  "landed_cost_charge_type_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/scm/purchase-condition-types/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code":"COD-000001","name":"Example"}'
DELETE/api/scm/purchase-condition-types/{id}Delete a purchase condition types

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-condition-types/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/purchase-condition-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/purchase-condition-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 condition types, 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
classtextread, writeClass
Allowed: Price (the gross price) Discount Surcharge Charge on the order GST (from the GST engine) Liquidated damages (penalty for late delivery)
calctextread, writeCalculated as
Allowed: Percent of the line value (or of the value after an earlier step) Amount (once per document; once per line when the record names an item) Amount per unit ordered
sourcetextread, writeSource
access_sequence_iduuidread, writeAccess sequence
is_activebooleanread, writeActive
descriptiontextread, writeDescription
created_attimestamp with time zoneread onlyCreated at
charge_kindtextread, writeKind of charge
Allowed: Freight Insurance Packing and forwarding Inspection Customs duty Handling Other
charge_totextread, writePaid to
Allowed: On this document (billed by the customer’s or supplier’s invoice) Accrued (paid to a carrier, customs or another party)
applies_totextread, writeUsed on
Allowed: Purchase orders Sales and purchase documents
landed_cost_charge_type_iduuidread, writeLanded cost charge
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 Charge Conditions 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.