TRANXACT.AI Help

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.

Type REST6 operationsBase path /api/scm/supplier-sitesPublished as /api/v1/supplier-sites

Download specification (OpenAPI 3.1) Screen: Supplier Sites

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 › 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.
Tablescm.supplier_sites · 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/supplier-sitesList supplier sites

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

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

FieldTypeRequiredDescription
supplier_iduuidYesSupplier
site_notextYesSite number
nametextYesName — What people call it: Head office, Pune factory, Accounts receivable.
address_iduuidNoOr choose from the address book
is_orderingbooleanNoOrdering address (orders are sent here) — A new purchase order is addressed to it.
is_ship_frombooleanNoShipping / dispatch address (goods leave from here) — A new purchase order takes it as where the goods ship from.
is_invoice_frombooleanNoBilling / invoicing address (invoices come from here) — A new supplier invoice takes it as the address the bill comes from.
is_paymentbooleanNoRemit-to (payment goes here) — A new supplier invoice takes it as where the payment is sent.
is_rfqbooleanNoRFQ address (quotations are sought here) — Where requests for quotation are sent for this supplier.
is_returnsbooleanNoReturns address (rejected goods go back here) — Where goods failed at receipt or inspection are shipped back to the supplier.
is_primarybooleanNoDefault for its purposes — A new purchase order or supplier invoice takes it. One default per purpose.
buying_org_unit_iduuidNoBuying org unit id
order_deliverytextNoOrders sent by
Allowed: email edi portal post fax api none
order_emailtextNoOrder email
edi_identifiertextNoEdi identifier
customer_number_at_suppliertextNoOur account number with them
buyer_iduuidNoBuyer id
incotermtextNoIncoterm
incoterm_placetextNoIncoterm place
freight_termstextNoFreight terms
Allowed: prepaid collect prepaid_and_add third_party ex_works
ship_viatextNoShip via
lead_time_daysintegerNoLead time (days)
country_of_origintextNoCountry of origin
port_of_loadingtextNoPort of loading
invoice_currencytextNoInvoice currency
tax_registration_notextNoTax registration
invoice_countrytextNoInvoices from country
contact_nametextNoContact
phonetextNoPhone
emailtextNoEmail
statustextNoStatus
Allowed: active on_hold inactive pending_approval blocked
hold_reasontextNoHold reason
notestextNoNotes
effective_fromdateNoIn force from — The date this version of the row takes effect. Leave it as today unless you are dating a change ahead.
effective_todateNoUntil — 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

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
supplier_iduuidYesSupplier
site_notextYesSite number
nametextYesName — What people call it: Head office, Pune factory, Accounts receivable.
address_iduuidNoOr choose from the address book
is_orderingbooleanNoOrdering address (orders are sent here) — A new purchase order is addressed to it.
is_ship_frombooleanNoShipping / dispatch address (goods leave from here) — A new purchase order takes it as where the goods ship from.
is_invoice_frombooleanNoBilling / invoicing address (invoices come from here) — A new supplier invoice takes it as the address the bill comes from.
is_paymentbooleanNoRemit-to (payment goes here) — A new supplier invoice takes it as where the payment is sent.
is_rfqbooleanNoRFQ address (quotations are sought here) — Where requests for quotation are sent for this supplier.
is_returnsbooleanNoReturns address (rejected goods go back here) — Where goods failed at receipt or inspection are shipped back to the supplier.
is_primarybooleanNoDefault for its purposes — A new purchase order or supplier invoice takes it. One default per purpose.
buying_org_unit_iduuidNoBuying org unit id
order_deliverytextNoOrders sent by
Allowed: email edi portal post fax api none
order_emailtextNoOrder email
edi_identifiertextNoEdi identifier
customer_number_at_suppliertextNoOur account number with them
buyer_iduuidNoBuyer id
incotermtextNoIncoterm
incoterm_placetextNoIncoterm place
freight_termstextNoFreight terms
Allowed: prepaid collect prepaid_and_add third_party ex_works
ship_viatextNoShip via
lead_time_daysintegerNoLead time (days)
country_of_origintextNoCountry of origin
port_of_loadingtextNoPort of loading
invoice_currencytextNoInvoice currency
tax_registration_notextNoTax registration
invoice_countrytextNoInvoices from country
contact_nametextNoContact
phonetextNoPhone
emailtextNoEmail
statustextNoStatus
Allowed: active on_hold inactive pending_approval blocked
hold_reasontextNoHold reason
notestextNoNotes
effective_fromdateNoIn force from — The date this version of the row takes effect. Leave it as today unless you are dating a change ahead.
effective_todateNoUntil — 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

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

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
supplier_iduuidread, writeSupplier
site_notextread, writeSite number
nametextread, writeName — What people call it: Head office, Pune factory, Accounts receivable.
address_iduuidread, writeOr choose from the address book
is_orderingbooleanread, writeOrdering address (orders are sent here) — A new purchase order is addressed to it.
is_ship_frombooleanread, writeShipping / dispatch address (goods leave from here) — A new purchase order takes it as where the goods ship from.
is_invoice_frombooleanread, writeBilling / invoicing address (invoices come from here) — A new supplier invoice takes it as the address the bill comes from.
is_paymentbooleanread, writeRemit-to (payment goes here) — A new supplier invoice takes it as where the payment is sent.
is_rfqbooleanread, writeRFQ address (quotations are sought here) — Where requests for quotation are sent for this supplier.
is_returnsbooleanread, writeReturns address (rejected goods go back here) — Where goods failed at receipt or inspection are shipped back to the supplier.
is_primarybooleanread, writeDefault for its purposes — A new purchase order or supplier invoice takes it. One default per purpose.
buying_org_unit_iduuidread, writeBuying org unit id
order_deliverytextread, writeOrders sent by
Allowed: email edi portal post fax api none
order_emailtextread, writeOrder email
edi_identifiertextread, writeEdi identifier
customer_number_at_suppliertextread, writeOur account number with them
buyer_iduuidread, writeBuyer id
incotermtextread, writeIncoterm
incoterm_placetextread, writeIncoterm place
freight_termstextread, writeFreight terms
Allowed: prepaid collect prepaid_and_add third_party ex_works
ship_viatextread, writeShip via
lead_time_daysintegerread, writeLead time (days)
country_of_origintextread, writeCountry of origin
port_of_loadingtextread, writePort of loading
invoice_currencytextread, writeInvoice currency
tax_registration_notextread, writeTax registration
invoice_countrytextread, writeInvoices from country
contact_nametextread, writeContact
phonetextread, writePhone
emailtextread, writeEmail
statustextread, writeStatus
Allowed: active on_hold inactive pending_approval blocked
hold_reasontextread, writeHold reason
notestextread, writeNotes
created_attimestamp with time zoneread onlyCreated at
effective_fromdateread, writeIn force from — The date this version of the row takes effect. Leave it as today unless you are dating a change ahead.
effective_todateread, writeUntil — Leave empty for open-ended. Setting it ends this version rather than deleting it.
org_unit_iduuidread onlyOrg unit id
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

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 › Supplier Sites 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.