Supply Chain · Purchase Charges
Purchase Charge Records
The values: 5% off this supplier's orders, 20 a unit off this item, freight of 500 on every order, customs duty at 10% and the Social Welfare Surcharge at 10% on an importer's goods. The condition's access sequence decides which record applies to each line.
/api/scm/purchase-condition-recordsPublished as /api/v1/purchase-condition-recordsDownload specification (OpenAPI 3.1) Screen: Purchase Charge Records
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 Charge Records 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 | crm.pricing_condition_records · 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/purchase-condition-recordsList purchase charge records
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",
"condition_type_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"pricing_group_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"category_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"price_list_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"min_quantity": "12.0000",
"value": "1250.00",
"valid_from": "2026-10-30",
"valid_to": "2026-10-30",
"is_active": true,
"notes": "text",
"created_at": "2026-10-30T09:00:00Z"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/scm/purchase-condition-records?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/scm/purchase-condition-records/{id}Read one purchase condition records
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",
"condition_type_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"pricing_group_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"category_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"price_list_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"min_quantity": "12.0000",
"value": "1250.00",
"valid_from": "2026-10-30",
"valid_to": "2026-10-30",
"is_active": true,
"notes": "text",
"created_at": "2026-10-30T09:00:00Z"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/scm/purchase-condition-records/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/purchase-condition-recordsCreate a purchase condition records
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
condition_type_id | uuid | Yes | Condition |
account_id | uuid | No | Account id |
pricing_group_id | uuid | No | Pricing group id |
item_id | uuid | No | Item |
category_id | uuid | No | Item category |
price_list_id | uuid | No | Price list id |
min_quantity | numeric | No | From quantity |
value | numeric | Yes | Value |
valid_from | date | No | Valid from |
valid_to | date | No | Valid to |
is_active | boolean | No | Active |
notes | text | No | Notes |
supplier_id | uuid | No | Supplier |
Sample body
{
"condition_type_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"value": "1250.00",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"pricing_group_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"category_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"condition_type_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"pricing_group_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"category_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"price_list_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"min_quantity": "12.0000",
"value": "1250.00",
"valid_from": "2026-10-30",
"valid_to": "2026-10-30",
"is_active": true,
"notes": "text",
"created_at": "2026-10-30T09:00:00Z"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/scm/purchase-condition-records" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"condition_type_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","value":"1250.00","account_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","pricing_group_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","item_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","category_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'PUT/api/scm/purchase-condition-records/{id}Change a purchase condition records
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 |
|---|---|---|---|
condition_type_id | uuid | Yes | Condition |
account_id | uuid | No | Account id |
pricing_group_id | uuid | No | Pricing group id |
item_id | uuid | No | Item |
category_id | uuid | No | Item category |
price_list_id | uuid | No | Price list id |
min_quantity | numeric | No | From quantity |
value | numeric | Yes | Value |
valid_from | date | No | Valid from |
valid_to | date | No | Valid to |
is_active | boolean | No | Active |
notes | text | No | Notes |
supplier_id | uuid | No | Supplier |
Sample body
{
"condition_type_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"value": "1250.00"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"condition_type_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"pricing_group_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"category_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"price_list_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"min_quantity": "12.0000",
"value": "1250.00",
"valid_from": "2026-10-30",
"valid_to": "2026-10-30",
"is_active": true,
"notes": "text",
"created_at": "2026-10-30T09:00:00Z"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/scm/purchase-condition-records/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"condition_type_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","value":"1250.00"}'DELETE/api/scm/purchase-condition-records/{id}Delete a purchase condition records
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/purchase-condition-records/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/purchase-condition-records/{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/purchase-condition-records/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 records, 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 |
condition_type_id | uuid | read, write | Condition |
account_id | uuid | read, write | Account id |
pricing_group_id | uuid | read, write | Pricing group id |
item_id | uuid | read, write | Item |
category_id | uuid | read, write | Item category |
price_list_id | uuid | read, write | Price list id |
min_quantity | numeric | read, write | From quantity |
value | numeric | read, write | Value |
valid_from | date | read, write | Valid from |
valid_to | date | read, write | Valid to |
is_active | boolean | read, write | Active |
notes | text | read, write | Notes |
created_at | timestamp with time zone | read only | Created at |
supplier_id | uuid | read, write | Supplier |
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 Charge Records 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.