Supply Chain · Procurement Control
Material at Subcontractors
What the company owns and is not holding: material issued to a subcontractor, what they consumed, returned and spoiled, and what is still out there.
/api/scm/subcontract-issuesPublished as /api/v1/subcontract-issuesDownload specification (OpenAPI 3.1) Screen: Material at Subcontractors
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 › Material at Subcontractors 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.subcontract_issues · 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
8 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/scm/subcontract-issuesList material at subcontractors
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",
"issue_no": "ISS-000001",
"po_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"production_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"production_operation_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"lot_no": "LOT-000001",
"uom": "text",
"qty_required": "12.0000",
"qty_issued": "12.0000",
"qty_consumed": "12.0000",
"qty_returned": "12.0000"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/scm/subcontract-issues?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/scm/subcontract-issues/{id}Read one subcontract issue
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",
"issue_no": "ISS-000001",
"po_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"production_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"production_operation_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"lot_no": "LOT-000001",
"uom": "text",
"qty_required": "12.0000",
"qty_issued": "12.0000",
"qty_consumed": "12.0000",
"qty_returned": "12.0000"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/scm/subcontract-issues/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/subcontract-issuesCreate a subcontract issue
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
issue_no | text | Yes | Issue no |
po_id | uuid | No | Subcontracting purchase order |
supplier_id | uuid | Yes | Subcontractor |
production_order_id | uuid | No | Production order |
production_operation_id | uuid | No | Production operation id |
item_id | uuid | Yes | Item |
lot_no | text | No | Lot |
uom | text | No | Unit |
qty_required | numeric | No | Required |
qty_issued | numeric | No | Qty issued |
qty_consumed | numeric | No | Qty consumed |
qty_returned | numeric | No | Qty returned |
qty_scrapped | numeric | No | Qty scrapped |
unit_cost | numeric | No | Unit cost |
issued_at | timestamp with time zone | No | Issued at |
expected_back | date | No | Expected back |
bin_id | uuid | No | Bin id |
status | text | No | Status |
notes | text | No | Notes |
Sample body
{
"issue_no": "ISS-000001",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"po_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"production_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"production_operation_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"lot_no": "LOT-000001"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"issue_no": "ISS-000001",
"po_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"production_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"production_operation_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"lot_no": "LOT-000001",
"uom": "text",
"qty_required": "12.0000",
"qty_issued": "12.0000",
"qty_consumed": "12.0000",
"qty_returned": "12.0000"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/scm/subcontract-issues" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"issue_no":"ISS-000001","supplier_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","item_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","po_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","production_order_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","production_operation_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","lot_no":"LOT-000001"}'PUT/api/scm/subcontract-issues/{id}Change a subcontract issue
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 |
|---|---|---|---|
issue_no | text | Yes | Issue no |
po_id | uuid | No | Subcontracting purchase order |
supplier_id | uuid | Yes | Subcontractor |
production_order_id | uuid | No | Production order |
production_operation_id | uuid | No | Production operation id |
item_id | uuid | Yes | Item |
lot_no | text | No | Lot |
uom | text | No | Unit |
qty_required | numeric | No | Required |
qty_issued | numeric | No | Qty issued |
qty_consumed | numeric | No | Qty consumed |
qty_returned | numeric | No | Qty returned |
qty_scrapped | numeric | No | Qty scrapped |
unit_cost | numeric | No | Unit cost |
issued_at | timestamp with time zone | No | Issued at |
expected_back | date | No | Expected back |
bin_id | uuid | No | Bin id |
status | text | No | Status |
notes | text | No | Notes |
Sample body
{
"issue_no": "ISS-000001",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"issue_no": "ISS-000001",
"po_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"production_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"production_operation_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"lot_no": "LOT-000001",
"uom": "text",
"qty_required": "12.0000",
"qty_issued": "12.0000",
"qty_consumed": "12.0000",
"qty_returned": "12.0000"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/scm/subcontract-issues/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"issue_no":"ISS-000001","supplier_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'DELETE/api/scm/subcontract-issues/{id}Delete a subcontract issue
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/subcontract-issues/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/subcontract-issues/{id}/issueIssue
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):
quantity, binId, expectedBackResponse
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/subcontract-issues/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/issue" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"quantity":"value","binId":"value","expectedBack":"value"}'POST/api/scm/subcontract-issues/{id}/returnReturn
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):
consumed, returned, scrappedResponse
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/subcontract-issues/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/return" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"consumed":"value","returned":"value","scrapped":"value"}'POST/api/scm/subcontract-issues/{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/subcontract-issues/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 subcontract issue, 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 only | Org unit id |
issue_no | text | read, write | Issue no |
po_id | uuid | read, write | Subcontracting purchase order |
supplier_id | uuid | read, write | Subcontractor |
production_order_id | uuid | read, write | Production order |
production_operation_id | uuid | read, write | Production operation id |
item_id | uuid | read, write | Item |
lot_no | text | read, write | Lot |
uom | text | read, write | Unit |
qty_required | numeric | read, write | Required |
qty_issued | numeric | read, write | Qty issued |
qty_consumed | numeric | read, write | Qty consumed |
qty_returned | numeric | read, write | Qty returned |
qty_scrapped | numeric | read, write | Qty scrapped |
unit_cost | numeric | read, write | Unit cost |
issued_at | timestamp with time zone | read, write | Issued at |
issued_by | uuid | read only | Issued by |
expected_back | date | read, write | Expected back |
bin_id | uuid | read, write | Bin id |
status | text | read, write | Status |
notes | text | read, write | Notes |
created_at | timestamp with time zone | read only | Created at |
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 |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
po_line_id | uuid | read only | Po line id |
qty_per | numeric | read only | Qty per |
moves_stock | boolean | read only | Moves stock |
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 › Material at Subcontractors 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.