TRANXACT.AI Help

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.

Type REST6 operationsBase path /api/crm/customer-sitesPublished as /api/v1/customer-sites

Download specification (OpenAPI 3.1) Screen: Customer Addresses

Overview

PackageCRM
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 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.
Tablecrm.customer_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/crm/customer-sitesList customer addresses

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

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

FieldTypeRequiredDescription
account_iduuidYesAccount
site_notextYesSite number
nametextYesName — What people call it: Head office, Pune warehouse, Accounts payable.
address_iduuidNoOr choose from the address book
is_sold_tobooleanNoOrdering address (sold-to) — Places and signs the order.
is_ship_tobooleanNoShipping address (ship-to) — Receives the goods.
is_bill_tobooleanNoInvoicing address (bill-to) — Receives the invoice.
is_payerbooleanNoSends the money
is_install_atbooleanNoEquipment lives here
is_service_atbooleanNoServiced here
is_primarybooleanNoDefault for its purposes — A new quotation, order, delivery or invoice for this customer takes it. One default per purpose.
selling_org_unit_iduuidNoSold by which business unit
ship_viatextNoShip via
freight_termstextNoFreight terms
Allowed: prepaid collect prepaid_and_add third_party ex_works
incotermtextNoIncoterm
delivery_lead_daysintegerNoDelivery lead days
delivery_windowtextNoReceiving notes — What the days and hours do not say: closed the last Friday of the month, lunch 12:00-13:00.
delivery_instructionstextNoDelivery instructions
requires_appointmentbooleanNoDelivery needs an appointment
source_warehouse_iduuidNoNormally served from
invoice_deliverytextNoInvoice sent by
Allowed: email post edi portal none
invoice_emailtextNoInvoice email
requires_po_numberbooleanNoTheir PO number is required
customer_referencetextNoCustomer reference
tax_registration_notextNoTax registration
tax_jurisdictiontextNoTax jurisdiction
is_tax_exemptbooleanNoTax exempt
tax_exemption_notextNoExemption number
tax_exemption_expiresdateNoExemption expires
contact_iduuidNoContact id
phonetextNoPhone
emailtextNoEmail
statustextNoStatus
Allowed: active on_hold closed pending
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

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

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
account_iduuidYesAccount
site_notextYesSite number
nametextYesName — What people call it: Head office, Pune warehouse, Accounts payable.
address_iduuidNoOr choose from the address book
is_sold_tobooleanNoOrdering address (sold-to) — Places and signs the order.
is_ship_tobooleanNoShipping address (ship-to) — Receives the goods.
is_bill_tobooleanNoInvoicing address (bill-to) — Receives the invoice.
is_payerbooleanNoSends the money
is_install_atbooleanNoEquipment lives here
is_service_atbooleanNoServiced here
is_primarybooleanNoDefault for its purposes — A new quotation, order, delivery or invoice for this customer takes it. One default per purpose.
selling_org_unit_iduuidNoSold by which business unit
ship_viatextNoShip via
freight_termstextNoFreight terms
Allowed: prepaid collect prepaid_and_add third_party ex_works
incotermtextNoIncoterm
delivery_lead_daysintegerNoDelivery lead days
delivery_windowtextNoReceiving notes — What the days and hours do not say: closed the last Friday of the month, lunch 12:00-13:00.
delivery_instructionstextNoDelivery instructions
requires_appointmentbooleanNoDelivery needs an appointment
source_warehouse_iduuidNoNormally served from
invoice_deliverytextNoInvoice sent by
Allowed: email post edi portal none
invoice_emailtextNoInvoice email
requires_po_numberbooleanNoTheir PO number is required
customer_referencetextNoCustomer reference
tax_registration_notextNoTax registration
tax_jurisdictiontextNoTax jurisdiction
is_tax_exemptbooleanNoTax exempt
tax_exemption_notextNoExemption number
tax_exemption_expiresdateNoExemption expires
contact_iduuidNoContact id
phonetextNoPhone
emailtextNoEmail
statustextNoStatus
Allowed: active on_hold closed pending
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

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

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

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
account_iduuidread, writeAccount
site_notextread, writeSite number
nametextread, writeName — What people call it: Head office, Pune warehouse, Accounts payable.
address_iduuidread, writeOr choose from the address book
is_sold_tobooleanread, writeOrdering address (sold-to) — Places and signs the order.
is_ship_tobooleanread, writeShipping address (ship-to) — Receives the goods.
is_bill_tobooleanread, writeInvoicing address (bill-to) — Receives the invoice.
is_payerbooleanread, writeSends the money
is_install_atbooleanread, writeEquipment lives here
is_service_atbooleanread, writeServiced here
is_primarybooleanread, writeDefault for its purposes — A new quotation, order, delivery or invoice for this customer takes it. One default per purpose.
selling_org_unit_iduuidread, writeSold by which business unit
ship_viatextread, writeShip via
freight_termstextread, writeFreight terms
Allowed: prepaid collect prepaid_and_add third_party ex_works
incotermtextread, writeIncoterm
delivery_lead_daysintegerread, writeDelivery lead days
delivery_windowtextread, writeReceiving notes — What the days and hours do not say: closed the last Friday of the month, lunch 12:00-13:00.
delivery_instructionstextread, writeDelivery instructions
requires_appointmentbooleanread, writeDelivery needs an appointment
source_warehouse_iduuidread, writeNormally served from
invoice_deliverytextread, writeInvoice sent by
Allowed: email post edi portal none
invoice_emailtextread, writeInvoice email
requires_po_numberbooleanread, writeTheir PO number is required
customer_referencetextread, writeCustomer reference
tax_registration_notextread, writeTax registration
tax_jurisdictiontextread, writeTax jurisdiction
is_tax_exemptbooleanread, writeTax exempt
tax_exemption_notextread, writeExemption number
tax_exemption_expiresdateread, writeExemption expires
contact_iduuidread, writeContact id
phonetextread, writePhone
emailtextread, writeEmail
statustextread, writeStatus
Allowed: active on_hold closed pending
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 CRM › Customer Addresses 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.