CRM · Reachable by link
Customer Addresses
One customer, several places: where it orders from, where the invoice goes, where the goods go and which warehouse takes them in. Purposes are independent ticks because one address is very often both ship-to and bill-to.
/api/crm/customer-sitesPublished as /api/v1/customer-sitesDownload specification (OpenAPI 3.1) Screen: Customer Addresses
Overview
| Package | CRM |
|---|---|
| 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 CRM › Customer Addresses 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 | crm.customer_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/crm/customer-sitesList customer addresses
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",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"site_no": "SIT-000001",
"name": "Example",
"address_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"is_sold_to": true,
"is_ship_to": true,
"is_bill_to": true,
"is_payer": true,
"is_install_at": true,
"is_service_at": true,
"is_primary": true,
"selling_org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"ship_via": "text"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/crm/customer-sites?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/crm/customer-sites/{id}Read one customer 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",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"site_no": "SIT-000001",
"name": "Example",
"address_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"is_sold_to": true,
"is_ship_to": true,
"is_bill_to": true,
"is_payer": true,
"is_install_at": true,
"is_service_at": true,
"is_primary": true,
"selling_org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"ship_via": "text"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/crm/customer-sites/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/customer-sitesCreate a customer sites
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
account_id | uuid | Yes | Account |
site_no | text | Yes | Site number |
name | text | Yes | Name — What people call it: Head office, Pune warehouse, Accounts payable. |
address_id | uuid | No | Or choose from the address book |
is_sold_to | boolean | No | Ordering address (sold-to) — Places and signs the order. |
is_ship_to | boolean | No | Shipping address (ship-to) — Receives the goods. |
is_bill_to | boolean | No | Invoicing address (bill-to) — Receives the invoice. |
is_payer | boolean | No | Sends the money |
is_install_at | boolean | No | Equipment lives here |
is_service_at | boolean | No | Serviced here |
is_primary | boolean | No | Default for its purposes — A new quotation, order, delivery or invoice for this customer takes it. One default per purpose. |
selling_org_unit_id | uuid | No | Sold by which business unit |
ship_via | text | No | Ship via |
freight_terms | text | No | Freight terms Allowed: prepaid collect prepaid_and_add third_party ex_works |
incoterm | text | No | Incoterm |
delivery_lead_days | integer | No | Delivery lead days |
delivery_window | text | No | Receiving notes — What the days and hours do not say: closed the last Friday of the month, lunch 12:00-13:00. |
delivery_instructions | text | No | Delivery instructions |
requires_appointment | boolean | No | Delivery needs an appointment |
source_warehouse_id | uuid | No | Normally served from |
invoice_delivery | text | No | Invoice sent by Allowed: email post edi portal none |
invoice_email | text | No | Invoice email |
requires_po_number | boolean | No | Their PO number is required |
customer_reference | text | No | Customer reference |
tax_registration_no | text | No | Tax registration |
tax_jurisdiction | text | No | Tax jurisdiction |
is_tax_exempt | boolean | No | Tax exempt |
tax_exemption_no | text | No | Exemption number |
tax_exemption_expires | date | No | Exemption expires |
contact_id | uuid | No | Contact id |
phone | text | No | Phone |
email | text | No | |
status | text | No | Status Allowed: active on_hold closed pending |
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
{
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"site_no": "SIT-000001",
"name": "Example",
"address_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"is_sold_to": true,
"is_ship_to": true,
"is_bill_to": true
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"site_no": "SIT-000001",
"name": "Example",
"address_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"is_sold_to": true,
"is_ship_to": true,
"is_bill_to": true,
"is_payer": true,
"is_install_at": true,
"is_service_at": true,
"is_primary": true,
"selling_org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"ship_via": "text"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/customer-sites" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"account_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","site_no":"SIT-000001","name":"Example","address_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","is_sold_to":true,"is_ship_to":true,"is_bill_to":true}'PUT/api/crm/customer-sites/{id}Change a customer 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 |
|---|---|---|---|
account_id | uuid | Yes | Account |
site_no | text | Yes | Site number |
name | text | Yes | Name — What people call it: Head office, Pune warehouse, Accounts payable. |
address_id | uuid | No | Or choose from the address book |
is_sold_to | boolean | No | Ordering address (sold-to) — Places and signs the order. |
is_ship_to | boolean | No | Shipping address (ship-to) — Receives the goods. |
is_bill_to | boolean | No | Invoicing address (bill-to) — Receives the invoice. |
is_payer | boolean | No | Sends the money |
is_install_at | boolean | No | Equipment lives here |
is_service_at | boolean | No | Serviced here |
is_primary | boolean | No | Default for its purposes — A new quotation, order, delivery or invoice for this customer takes it. One default per purpose. |
selling_org_unit_id | uuid | No | Sold by which business unit |
ship_via | text | No | Ship via |
freight_terms | text | No | Freight terms Allowed: prepaid collect prepaid_and_add third_party ex_works |
incoterm | text | No | Incoterm |
delivery_lead_days | integer | No | Delivery lead days |
delivery_window | text | No | Receiving notes — What the days and hours do not say: closed the last Friday of the month, lunch 12:00-13:00. |
delivery_instructions | text | No | Delivery instructions |
requires_appointment | boolean | No | Delivery needs an appointment |
source_warehouse_id | uuid | No | Normally served from |
invoice_delivery | text | No | Invoice sent by Allowed: email post edi portal none |
invoice_email | text | No | Invoice email |
requires_po_number | boolean | No | Their PO number is required |
customer_reference | text | No | Customer reference |
tax_registration_no | text | No | Tax registration |
tax_jurisdiction | text | No | Tax jurisdiction |
is_tax_exempt | boolean | No | Tax exempt |
tax_exemption_no | text | No | Exemption number |
tax_exemption_expires | date | No | Exemption expires |
contact_id | uuid | No | Contact id |
phone | text | No | Phone |
email | text | No | |
status | text | No | Status Allowed: active on_hold closed pending |
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
{
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"site_no": "SIT-000001"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"site_no": "SIT-000001",
"name": "Example",
"address_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"is_sold_to": true,
"is_ship_to": true,
"is_bill_to": true,
"is_payer": true,
"is_install_at": true,
"is_service_at": true,
"is_primary": true,
"selling_org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"ship_via": "text"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/crm/customer-sites/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"account_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","site_no":"SIT-000001"}'DELETE/api/crm/customer-sites/{id}Delete a customer 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/crm/customer-sites/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/customer-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/crm/customer-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 customer 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 |
account_id | uuid | read, write | Account |
site_no | text | read, write | Site number |
name | text | read, write | Name — What people call it: Head office, Pune warehouse, Accounts payable. |
address_id | uuid | read, write | Or choose from the address book |
is_sold_to | boolean | read, write | Ordering address (sold-to) — Places and signs the order. |
is_ship_to | boolean | read, write | Shipping address (ship-to) — Receives the goods. |
is_bill_to | boolean | read, write | Invoicing address (bill-to) — Receives the invoice. |
is_payer | boolean | read, write | Sends the money |
is_install_at | boolean | read, write | Equipment lives here |
is_service_at | boolean | read, write | Serviced here |
is_primary | boolean | read, write | Default for its purposes — A new quotation, order, delivery or invoice for this customer takes it. One default per purpose. |
selling_org_unit_id | uuid | read, write | Sold by which business unit |
ship_via | text | read, write | Ship via |
freight_terms | text | read, write | Freight terms Allowed: prepaid collect prepaid_and_add third_party ex_works |
incoterm | text | read, write | Incoterm |
delivery_lead_days | integer | read, write | Delivery lead days |
delivery_window | text | read, write | Receiving notes — What the days and hours do not say: closed the last Friday of the month, lunch 12:00-13:00. |
delivery_instructions | text | read, write | Delivery instructions |
requires_appointment | boolean | read, write | Delivery needs an appointment |
source_warehouse_id | uuid | read, write | Normally served from |
invoice_delivery | text | read, write | Invoice sent by Allowed: email post edi portal none |
invoice_email | text | read, write | Invoice email |
requires_po_number | boolean | read, write | Their PO number is required |
customer_reference | text | read, write | Customer reference |
tax_registration_no | text | read, write | Tax registration |
tax_jurisdiction | text | read, write | Tax jurisdiction |
is_tax_exempt | boolean | read, write | Tax exempt |
tax_exemption_no | text | read, write | Exemption number |
tax_exemption_expires | date | read, write | Exemption expires |
contact_id | uuid | read, write | Contact id |
phone | text | read, write | Phone |
email | text | read, write | |
status | text | read, write | Status Allowed: active on_hold closed pending |
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 CRM › Customer Addresses 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.