Supply Chain · Electronic Data Interchange
EDI Document Maps
Per partner and document: inbound or outbound, what it makes or is made from, how items are named, and whether an inbound document is processed on arrival or held for review.
/api/scm/edi-document-mapsPublished as /api/v1/edi-document-mapsDownload specification (OpenAPI 3.1) Screen: EDI Document Maps
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 › EDI Document Maps 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.edi_document_maps · 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/edi-document-mapsList edi document maps
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",
"map_code": "MAP-000001",
"partner_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"doc_type": "850",
"direction": "inbound",
"business_object": "sales_order",
"item_qualifier": "VP",
"auto_process": true,
"is_active": true,
"options": {},
"notes": "text",
"created_at": "2026-10-30T09:00:00Z",
"created_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/scm/edi-document-maps?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/scm/edi-document-maps/{id}Read one edi document map
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",
"map_code": "MAP-000001",
"partner_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"doc_type": "850",
"direction": "inbound",
"business_object": "sales_order",
"item_qualifier": "VP",
"auto_process": true,
"is_active": true,
"options": {},
"notes": "text",
"created_at": "2026-10-30T09:00:00Z",
"created_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/edi-document-maps/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/edi-document-mapsCreate a edi document map
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
map_code | text | Yes | Map code |
partner_id | uuid | No | Partner — Empty applies to every partner without a map of its own. |
doc_type | text | Yes | Document Allowed: 850 855 856 810 997 ORDERS ORDRSP DESADV INVOIC CONTRL |
direction | text | Yes | Direction Allowed: inbound outbound |
business_object | text | Yes | Record Allowed: sales_order purchase_order po_confirmation sales_order_confirmation inbound_delivery shipment ap_invoice ar_invoice acknowledgement |
item_qualifier | text | No | How items are named — VP vendor part, BP buyer part, UP UPC, EN EAN, IN/SA our item number. Allowed: VP BP UP EN IN SA |
auto_process | boolean | No | Process on arrival |
is_active | boolean | No | Active |
notes | text | No | Notes |
Sample body
{
"map_code": "MAP-000001",
"doc_type": "850",
"direction": "inbound",
"business_object": "sales_order",
"partner_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"item_qualifier": "VP",
"auto_process": true,
"is_active": true
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"map_code": "MAP-000001",
"partner_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"doc_type": "850",
"direction": "inbound",
"business_object": "sales_order",
"item_qualifier": "VP",
"auto_process": true,
"is_active": true,
"options": {},
"notes": "text",
"created_at": "2026-10-30T09:00:00Z",
"created_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/scm/edi-document-maps" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"map_code":"MAP-000001","doc_type":"850","direction":"inbound","business_object":"sales_order","partner_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","item_qualifier":"VP","auto_process":true,"is_active":true}'PUT/api/scm/edi-document-maps/{id}Change a edi document map
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 |
|---|---|---|---|
map_code | text | Yes | Map code |
partner_id | uuid | No | Partner — Empty applies to every partner without a map of its own. |
doc_type | text | Yes | Document Allowed: 850 855 856 810 997 ORDERS ORDRSP DESADV INVOIC CONTRL |
direction | text | Yes | Direction Allowed: inbound outbound |
business_object | text | Yes | Record Allowed: sales_order purchase_order po_confirmation sales_order_confirmation inbound_delivery shipment ap_invoice ar_invoice acknowledgement |
item_qualifier | text | No | How items are named — VP vendor part, BP buyer part, UP UPC, EN EAN, IN/SA our item number. Allowed: VP BP UP EN IN SA |
auto_process | boolean | No | Process on arrival |
is_active | boolean | No | Active |
notes | text | No | Notes |
Sample body
{
"map_code": "MAP-000001",
"doc_type": "850"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"map_code": "MAP-000001",
"partner_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"doc_type": "850",
"direction": "inbound",
"business_object": "sales_order",
"item_qualifier": "VP",
"auto_process": true,
"is_active": true,
"options": {},
"notes": "text",
"created_at": "2026-10-30T09:00:00Z",
"created_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/scm/edi-document-maps/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"map_code":"MAP-000001","doc_type":"850"}'DELETE/api/scm/edi-document-maps/{id}Delete a edi document map
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/edi-document-maps/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/edi-document-maps/{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/edi-document-maps/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 edi document map, 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 |
map_code | text | read, write | Map code |
partner_id | uuid | read, write | Partner — Empty applies to every partner without a map of its own. |
doc_type | text | read, write | Document Allowed: 850 855 856 810 997 ORDERS ORDRSP DESADV INVOIC CONTRL |
direction | text | read, write | Direction Allowed: inbound outbound |
business_object | text | read, write | Record Allowed: sales_order purchase_order po_confirmation sales_order_confirmation inbound_delivery shipment ap_invoice ar_invoice acknowledgement |
item_qualifier | text | read, write | How items are named — VP vendor part, BP buyer part, UP UPC, EN EAN, IN/SA our item number. Allowed: VP BP UP EN IN SA |
auto_process | boolean | read, write | Process on arrival |
is_active | boolean | read, write | Active |
options | jsonb | read only | Options |
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 › EDI Document Maps 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.