Supply Chain · Items & Suppliers
Quota Arrangements
For each item, how its demand is split between suppliers, in which part of the company and for what period. A requisition line that names no vendor is proposed the supplier furthest below its share: the one whose allocated quantity plus the line’s, divided by its share, is lowest. Shares in force at the same time may add up to 100% at most. Quota arrangements are asked first; then the Source List’s fixed source, an outline agreement (Contracts), and the item’s Purchasing record.
/api/scm/quota-arrangementsPublished as /api/v1/quota-arrangementsDownload specification (OpenAPI 3.1) Screen: Quota Arrangements
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 › Quota Arrangements 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.quota_arrangements · 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/quota-arrangementsList quota arrangements
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",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"quota_pct": "1250.00",
"allocated_qty": "12.0000",
"priority": 10,
"valid_from": "2026-10-30",
"valid_to": "2026-10-30",
"notes": "text",
"created_at": "2026-10-30T09:00:00Z",
"created_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"updated_at": "2026-10-30T09:00:00Z",
"updated_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/scm/quota-arrangements?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/scm/quota-arrangements/{id}Read one quota arrangement
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",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"quota_pct": "1250.00",
"allocated_qty": "12.0000",
"priority": 10,
"valid_from": "2026-10-30",
"valid_to": "2026-10-30",
"notes": "text",
"created_at": "2026-10-30T09:00:00Z",
"created_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"updated_at": "2026-10-30T09:00:00Z",
"updated_by": "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/quota-arrangements/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/quota-arrangementsCreate a quota arrangement
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
org_unit_id | uuid | No | Unit — Leave blank for the whole company. An arrangement for a unit applies in that unit and every unit beneath it. |
item_id | uuid | Yes | Item |
supplier_id | uuid | Yes | Supplier |
quota_pct | numeric | Yes | Share (%) — This supplier’s share of the item’s demand. The shares in force at once may add up to 100 at most. |
allocated_qty | numeric | No | Allocated so far — Counted up as requisition lines take this supplier. Set it to carry a quota over from elsewhere. |
priority | integer | No | Priority — Between suppliers equally far below their share, the lower number goes first. |
valid_from | date | No | Valid from — Leave blank: from now on. |
valid_to | date | No | Valid to — Leave blank: with no end date. |
notes | text | No | Notes |
Sample body
{
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"quota_pct": "1250.00",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"allocated_qty": "12.0000",
"priority": 10,
"valid_from": "2026-10-30"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"quota_pct": "1250.00",
"allocated_qty": "12.0000",
"priority": 10,
"valid_from": "2026-10-30",
"valid_to": "2026-10-30",
"notes": "text",
"created_at": "2026-10-30T09:00:00Z",
"created_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"updated_at": "2026-10-30T09:00:00Z",
"updated_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/scm/quota-arrangements" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"item_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","supplier_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","quota_pct":"1250.00","org_unit_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","allocated_qty":"12.0000","priority":10,"valid_from":"2026-10-30"}'PUT/api/scm/quota-arrangements/{id}Change a quota arrangement
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 |
|---|---|---|---|
org_unit_id | uuid | No | Unit — Leave blank for the whole company. An arrangement for a unit applies in that unit and every unit beneath it. |
item_id | uuid | Yes | Item |
supplier_id | uuid | Yes | Supplier |
quota_pct | numeric | Yes | Share (%) — This supplier’s share of the item’s demand. The shares in force at once may add up to 100 at most. |
allocated_qty | numeric | No | Allocated so far — Counted up as requisition lines take this supplier. Set it to carry a quota over from elsewhere. |
priority | integer | No | Priority — Between suppliers equally far below their share, the lower number goes first. |
valid_from | date | No | Valid from — Leave blank: from now on. |
valid_to | date | No | Valid to — Leave blank: with no end date. |
notes | text | No | Notes |
Sample body
{
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"quota_pct": "1250.00",
"allocated_qty": "12.0000",
"priority": 10,
"valid_from": "2026-10-30",
"valid_to": "2026-10-30",
"notes": "text",
"created_at": "2026-10-30T09:00:00Z",
"created_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"updated_at": "2026-10-30T09:00:00Z",
"updated_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/scm/quota-arrangements/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"item_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","supplier_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'DELETE/api/scm/quota-arrangements/{id}Delete a quota arrangement
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/quota-arrangements/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/quota-arrangements/{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/quota-arrangements/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 quota arrangement, 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 |
org_unit_id | uuid | read, write | Unit — Leave blank for the whole company. An arrangement for a unit applies in that unit and every unit beneath it. |
item_id | uuid | read, write | Item |
supplier_id | uuid | read, write | Supplier |
quota_pct | numeric | read, write | Share (%) — This supplier’s share of the item’s demand. The shares in force at once may add up to 100 at most. |
allocated_qty | numeric | read, write | Allocated so far — Counted up as requisition lines take this supplier. Set it to carry a quota over from elsewhere. |
priority | integer | read, write | Priority — Between suppliers equally far below their share, the lower number goes first. |
valid_from | date | read, write | Valid from — Leave blank: from now on. |
valid_to | date | read, write | Valid to — Leave blank: with no end date. |
notes | text | read, write | Notes |
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 › Quota Arrangements 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.