Supply Chain · Reachable by link
Supplier Sites
One supplier, several places: where invoices come from (billing), where the goods leave from (shipping), where the payment goes and where orders are sent. Purposes are independent ticks because one address is very often several of them.
/api/scm/supplier-sitesPublished as /api/v1/supplier-sitesOverview
| 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 › Supplier Sites 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.supplier_sites · 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/supplier-sitesList supplier sites
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",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"site_no": "SIT-000001",
"name": "Example",
"address_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"is_ordering": true,
"is_ship_from": true,
"is_invoice_from": true,
"is_payment": true,
"is_rfq": true,
"is_returns": true,
"is_primary": true,
"buying_org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"order_delivery": "email"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/scm/supplier-sites?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/scm/supplier-sites/{id}Read one supplier sites
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",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"site_no": "SIT-000001",
"name": "Example",
"address_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"is_ordering": true,
"is_ship_from": true,
"is_invoice_from": true,
"is_payment": true,
"is_rfq": true,
"is_returns": true,
"is_primary": true,
"buying_org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"order_delivery": "email"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/scm/supplier-sites/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/supplier-sitesCreate a supplier sites
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
supplier_id | uuid | Yes | Supplier |
site_no | text | Yes | Site number |
name | text | Yes | Name — What people call it: Head office, Pune factory, Accounts receivable. |
address_id | uuid | No | Or choose from the address book |
is_ordering | boolean | No | Ordering address (orders are sent here) — A new purchase order is addressed to it. |
is_ship_from | boolean | No | Shipping / dispatch address (goods leave from here) — A new purchase order takes it as where the goods ship from. |
is_invoice_from | boolean | No | Billing / invoicing address (invoices come from here) — A new supplier invoice takes it as the address the bill comes from. |
is_payment | boolean | No | Remit-to (payment goes here) — A new supplier invoice takes it as where the payment is sent. |
is_rfq | boolean | No | RFQ address (quotations are sought here) — Where requests for quotation are sent for this supplier. |
is_returns | boolean | No | Returns address (rejected goods go back here) — Where goods failed at receipt or inspection are shipped back to the supplier. |
is_primary | boolean | No | Default for its purposes — A new purchase order or supplier invoice takes it. One default per purpose. |
buying_org_unit_id | uuid | No | Buying org unit id |
order_delivery | text | No | Orders sent by Allowed: email edi portal post fax api none |
order_email | text | No | Order email |
edi_identifier | text | No | Edi identifier |
customer_number_at_supplier | text | No | Our account number with them |
buyer_id | uuid | No | Buyer id |
incoterm | text | No | Incoterm |
incoterm_place | text | No | Incoterm place |
freight_terms | text | No | Freight terms Allowed: prepaid collect prepaid_and_add third_party ex_works |
ship_via | text | No | Ship via |
lead_time_days | integer | No | Lead time (days) |
country_of_origin | text | No | Country of origin |
port_of_loading | text | No | Port of loading |
invoice_currency | text | No | Invoice currency |
tax_registration_no | text | No | Tax registration |
invoice_country | text | No | Invoices from country |
contact_name | text | No | Contact |
phone | text | No | Phone |
email | text | No | |
status | text | No | Status Allowed: active on_hold inactive pending_approval blocked |
hold_reason | text | No | Hold reason |
notes | text | No | Notes |
effective_from | date | No | In force from — The date this version of the row takes effect. Leave it as today unless you are dating a change ahead. |
effective_to | date | No | Until — Leave empty for open-ended. Setting it ends this version rather than deleting it. |
Sample body
{
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"site_no": "SIT-000001",
"name": "Example",
"address_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"is_ordering": true,
"is_ship_from": true,
"is_invoice_from": true
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"site_no": "SIT-000001",
"name": "Example",
"address_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"is_ordering": true,
"is_ship_from": true,
"is_invoice_from": true,
"is_payment": true,
"is_rfq": true,
"is_returns": true,
"is_primary": true,
"buying_org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"order_delivery": "email"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/scm/supplier-sites" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"supplier_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","site_no":"SIT-000001","name":"Example","address_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","is_ordering":true,"is_ship_from":true,"is_invoice_from":true}'PUT/api/scm/supplier-sites/{id}Change a supplier sites
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 |
|---|---|---|---|
supplier_id | uuid | Yes | Supplier |
site_no | text | Yes | Site number |
name | text | Yes | Name — What people call it: Head office, Pune factory, Accounts receivable. |
address_id | uuid | No | Or choose from the address book |
is_ordering | boolean | No | Ordering address (orders are sent here) — A new purchase order is addressed to it. |
is_ship_from | boolean | No | Shipping / dispatch address (goods leave from here) — A new purchase order takes it as where the goods ship from. |
is_invoice_from | boolean | No | Billing / invoicing address (invoices come from here) — A new supplier invoice takes it as the address the bill comes from. |
is_payment | boolean | No | Remit-to (payment goes here) — A new supplier invoice takes it as where the payment is sent. |
is_rfq | boolean | No | RFQ address (quotations are sought here) — Where requests for quotation are sent for this supplier. |
is_returns | boolean | No | Returns address (rejected goods go back here) — Where goods failed at receipt or inspection are shipped back to the supplier. |
is_primary | boolean | No | Default for its purposes — A new purchase order or supplier invoice takes it. One default per purpose. |
buying_org_unit_id | uuid | No | Buying org unit id |
order_delivery | text | No | Orders sent by Allowed: email edi portal post fax api none |
order_email | text | No | Order email |
edi_identifier | text | No | Edi identifier |
customer_number_at_supplier | text | No | Our account number with them |
buyer_id | uuid | No | Buyer id |
incoterm | text | No | Incoterm |
incoterm_place | text | No | Incoterm place |
freight_terms | text | No | Freight terms Allowed: prepaid collect prepaid_and_add third_party ex_works |
ship_via | text | No | Ship via |
lead_time_days | integer | No | Lead time (days) |
country_of_origin | text | No | Country of origin |
port_of_loading | text | No | Port of loading |
invoice_currency | text | No | Invoice currency |
tax_registration_no | text | No | Tax registration |
invoice_country | text | No | Invoices from country |
contact_name | text | No | Contact |
phone | text | No | Phone |
email | text | No | |
status | text | No | Status Allowed: active on_hold inactive pending_approval blocked |
hold_reason | text | No | Hold reason |
notes | text | No | Notes |
effective_from | date | No | In force from — The date this version of the row takes effect. Leave it as today unless you are dating a change ahead. |
effective_to | date | No | Until — Leave empty for open-ended. Setting it ends this version rather than deleting it. |
Sample body
{
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"site_no": "SIT-000001"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"site_no": "SIT-000001",
"name": "Example",
"address_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"is_ordering": true,
"is_ship_from": true,
"is_invoice_from": true,
"is_payment": true,
"is_rfq": true,
"is_returns": true,
"is_primary": true,
"buying_org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"order_delivery": "email"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/scm/supplier-sites/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"supplier_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","site_no":"SIT-000001"}'DELETE/api/scm/supplier-sites/{id}Delete a supplier sites
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/supplier-sites/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/supplier-sites/{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/supplier-sites/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 supplier sites, 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 |
supplier_id | uuid | read, write | Supplier |
site_no | text | read, write | Site number |
name | text | read, write | Name — What people call it: Head office, Pune factory, Accounts receivable. |
address_id | uuid | read, write | Or choose from the address book |
is_ordering | boolean | read, write | Ordering address (orders are sent here) — A new purchase order is addressed to it. |
is_ship_from | boolean | read, write | Shipping / dispatch address (goods leave from here) — A new purchase order takes it as where the goods ship from. |
is_invoice_from | boolean | read, write | Billing / invoicing address (invoices come from here) — A new supplier invoice takes it as the address the bill comes from. |
is_payment | boolean | read, write | Remit-to (payment goes here) — A new supplier invoice takes it as where the payment is sent. |
is_rfq | boolean | read, write | RFQ address (quotations are sought here) — Where requests for quotation are sent for this supplier. |
is_returns | boolean | read, write | Returns address (rejected goods go back here) — Where goods failed at receipt or inspection are shipped back to the supplier. |
is_primary | boolean | read, write | Default for its purposes — A new purchase order or supplier invoice takes it. One default per purpose. |
buying_org_unit_id | uuid | read, write | Buying org unit id |
order_delivery | text | read, write | Orders sent by Allowed: email edi portal post fax api none |
order_email | text | read, write | Order email |
edi_identifier | text | read, write | Edi identifier |
customer_number_at_supplier | text | read, write | Our account number with them |
buyer_id | uuid | read, write | Buyer id |
incoterm | text | read, write | Incoterm |
incoterm_place | text | read, write | Incoterm place |
freight_terms | text | read, write | Freight terms Allowed: prepaid collect prepaid_and_add third_party ex_works |
ship_via | text | read, write | Ship via |
lead_time_days | integer | read, write | Lead time (days) |
country_of_origin | text | read, write | Country of origin |
port_of_loading | text | read, write | Port of loading |
invoice_currency | text | read, write | Invoice currency |
tax_registration_no | text | read, write | Tax registration |
invoice_country | text | read, write | Invoices from country |
contact_name | text | read, write | Contact |
phone | text | read, write | Phone |
email | text | read, write | |
status | text | read, write | Status Allowed: active on_hold inactive pending_approval blocked |
hold_reason | text | read, write | Hold reason |
notes | text | read, write | Notes |
created_at | timestamp with time zone | read only | Created at |
effective_from | date | read, write | In force from — The date this version of the row takes effect. Leave it as today unless you are dating a change ahead. |
effective_to | date | read, write | Until — Leave empty for open-ended. Setting it ends this version rather than deleting it. |
org_unit_id | uuid | read only | Org unit id |
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 |
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 › Supplier Sites 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.