TRANXACT.AI Help

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.

Type REST6 operationsBase path /api/scm/edi-document-mapsPublished as /api/v1/edi-document-maps

Download specification (OpenAPI 3.1) Screen: EDI Document Maps

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

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

GET/api/scm/edi-document-mapsList edi document maps

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

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

FieldTypeRequiredDescription
map_codetextYesMap code
partner_iduuidNoPartner — Empty applies to every partner without a map of its own.
doc_typetextYesDocument
Allowed: 850 855 856 810 997 ORDERS ORDRSP DESADV INVOIC CONTRL
directiontextYesDirection
Allowed: inbound outbound
business_objecttextYesRecord
Allowed: sales_order purchase_order po_confirmation sales_order_confirmation inbound_delivery shipment ap_invoice ar_invoice acknowledgement
item_qualifiertextNoHow 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_processbooleanNoProcess on arrival
is_activebooleanNoActive
notestextNoNotes

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

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
map_codetextYesMap code
partner_iduuidNoPartner — Empty applies to every partner without a map of its own.
doc_typetextYesDocument
Allowed: 850 855 856 810 997 ORDERS ORDRSP DESADV INVOIC CONTRL
directiontextYesDirection
Allowed: inbound outbound
business_objecttextYesRecord
Allowed: sales_order purchase_order po_confirmation sales_order_confirmation inbound_delivery shipment ap_invoice ar_invoice acknowledgement
item_qualifiertextNoHow 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_processbooleanNoProcess on arrival
is_activebooleanNoActive
notestextNoNotes

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

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/edi-document-maps/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/edi-document-maps/{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/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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
map_codetextread, writeMap code
partner_iduuidread, writePartner — Empty applies to every partner without a map of its own.
doc_typetextread, writeDocument
Allowed: 850 855 856 810 997 ORDERS ORDRSP DESADV INVOIC CONTRL
directiontextread, writeDirection
Allowed: inbound outbound
business_objecttextread, writeRecord
Allowed: sales_order purchase_order po_confirmation sales_order_confirmation inbound_delivery shipment ap_invoice ar_invoice acknowledgement
item_qualifiertextread, writeHow 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_processbooleanread, writeProcess on arrival
is_activebooleanread, writeActive
optionsjsonbread onlyOptions
notestextread, writeNotes
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
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

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 › EDI Document Maps 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.