TRANXACT.AI Help

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.

Type REST8 operationsBase path /api/scm/subcontract-issuesPublished as /api/v1/subcontract-issues

Download specification (OpenAPI 3.1) Screen: Material at Subcontractors

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 › 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.
Tablescm.subcontract_issues · 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

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

GET/api/scm/subcontract-issuesList material at subcontractors

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

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

FieldTypeRequiredDescription
issue_notextYesIssue no
po_iduuidNoSubcontracting purchase order
supplier_iduuidYesSubcontractor
production_order_iduuidNoProduction order
production_operation_iduuidNoProduction operation id
item_iduuidYesItem
lot_notextNoLot
uomtextNoUnit
qty_requirednumericNoRequired
qty_issuednumericNoQty issued
qty_consumednumericNoQty consumed
qty_returnednumericNoQty returned
qty_scrappednumericNoQty scrapped
unit_costnumericNoUnit cost
issued_attimestamp with time zoneNoIssued at
expected_backdateNoExpected back
bin_iduuidNoBin id
statustextNoStatus
notestextNoNotes

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

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
issue_notextYesIssue no
po_iduuidNoSubcontracting purchase order
supplier_iduuidYesSubcontractor
production_order_iduuidNoProduction order
production_operation_iduuidNoProduction operation id
item_iduuidYesItem
lot_notextNoLot
uomtextNoUnit
qty_requirednumericNoRequired
qty_issuednumericNoQty issued
qty_consumednumericNoQty consumed
qty_returnednumericNoQty returned
qty_scrappednumericNoQty scrapped
unit_costnumericNoUnit cost
issued_attimestamp with time zoneNoIssued at
expected_backdateNoExpected back
bin_iduuidNoBin id
statustextNoStatus
notestextNoNotes

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

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/subcontract-issues/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/subcontract-issues/{id}/issueIssue

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):

quantity, binId, expectedBack

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

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):

consumed, returned, scrapped

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

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

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
issue_notextread, writeIssue no
po_iduuidread, writeSubcontracting purchase order
supplier_iduuidread, writeSubcontractor
production_order_iduuidread, writeProduction order
production_operation_iduuidread, writeProduction operation id
item_iduuidread, writeItem
lot_notextread, writeLot
uomtextread, writeUnit
qty_requirednumericread, writeRequired
qty_issuednumericread, writeQty issued
qty_consumednumericread, writeQty consumed
qty_returnednumericread, writeQty returned
qty_scrappednumericread, writeQty scrapped
unit_costnumericread, writeUnit cost
issued_attimestamp with time zoneread, writeIssued at
issued_byuuidread onlyIssued by
expected_backdateread, writeExpected back
bin_iduuidread, writeBin id
statustextread, writeStatus
notestextread, writeNotes
created_attimestamp with time zoneread onlyCreated at
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
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
po_line_iduuidread onlyPo line id
qty_pernumericread onlyQty per
moves_stockbooleanread onlyMoves stock

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 › Material at Subcontractors 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.