CRM · Accounts & Contacts
Accounts
Open a customer for its sites, selling context, financial terms, credit profile and account relationships — ship-to, bill-to and payer are frequently three different places.
/api/crm/accountsPublished as /api/v1/accountsOverview
| 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 › Accounts 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.accounts · 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
16 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/crm/accountsList accounts
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_no": "ACC-000001",
"name": "Example",
"account_type": "prospect",
"parent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"industry": "text",
"country": "US",
"currency": "USD",
"credit_limit": "1250.00",
"owner_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"is_active": true,
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/crm/accounts?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/crm/accounts/{id}Read one accounts
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_no": "ACC-000001",
"name": "Example",
"account_type": "prospect",
"parent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"industry": "text",
"country": "US",
"currency": "USD",
"credit_limit": "1250.00",
"owner_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"is_active": true,
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"warehouse_id": "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/crm/accounts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/accountsCreate a accounts
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
account_no | text | Yes | Account number — Left blank, the platform allocates the next one from the number range. |
name | text | Yes | Name |
account_type | text | No | Type Allowed: prospect customer partner distributor |
parent_id | uuid | No | Parent id |
industry | text | No | Industry |
country | text | No | Country |
currency | text | Yes | Currency |
credit_limit | numeric | No | Credit limit — Blank or 0: no limit. Checked when a sales order is created or confirmed, and when an opportunity closes won (AR-005); the Credit tab sets a limit per business unit and what happens when it is reached. |
is_active | boolean | No | Is active |
website | text | No | Website — The company’s web address, e.g. https://example.com |
phone | text | No | Main telephone |
email | text | No | General e-mail |
legal_name | text | No | Legal name — A change to the name, legal name or country here takes effect today; to date it otherwise, change it on the Party tab (Name, legal name and country). The registered address and the tax ids are kept on the Party tab. |
address_line1 | text | No | Address line1 |
city | text | No | City |
region | text | No | Region |
postal_code | text | No | Postal code |
employee_count | integer | No | Employees |
founded_year | integer | No | Founded (year) |
description | text | No | About the company |
name_ar | text | No | Name in Arabic |
cr_number | text | No | Cr number |
building_no | text | No | Building number — Four digits, from the national address. |
district | text | No | District |
additional_no | text | No | Additional number — The four-digit additional number of the national address. |
gstin | text | No | Gstin |
pan | text | No | PAN — India: five letters, four digits, a letter. |
state_code | text | No | GST state (place of supply) — India: the state supplies to this customer are made to. Same state as yours is CGST + SGST; another is IGST. Allowed: 01 Jammu and Kashmir 02 Himachal Pradesh 03 Punjab 04 Chandigarh 05 Uttarakhand 06 Haryana 07 Delhi 08 Rajasthan 09 Uttar Pradesh 10 Bihar 11 Sikkim 12 Arunachal Pradesh |
gst_registration_type | text | No | GST registration — India: regular for a registered customer (B2B), unregistered for a consumer (B2C). Allowed: regular composition unregistered sez_unit sez_developer overseas uin |
pincode | text | No | Pincode |
buyer_id_scheme | text | No | Buyer ID type (no VAT number) — For a customer with no VAT number. The CR number above is used as the CRN when this is empty. Allowed: TIN - tax identification number CRN - commercial registration MOM - MOMRAH license MLS - MHRSD license 700 - 700 number SAG - MISA license NAT - national ID GCC - GCC ID IQA - Iqama number PAS - passport OTH - other |
buyer_id_number | text | No | Buyer ID number — Letters and digits only. |
Sample body
{
"account_no": "ACC-000001",
"name": "Example",
"currency": "USD",
"account_type": "prospect",
"parent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"industry": "text",
"country": "US"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"account_no": "ACC-000001",
"name": "Example",
"account_type": "prospect",
"parent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"industry": "text",
"country": "US",
"currency": "USD",
"credit_limit": "1250.00",
"owner_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"is_active": true,
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/accounts" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"account_no":"ACC-000001","name":"Example","currency":"USD","account_type":"prospect","parent_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","industry":"text","country":"US"}'PUT/api/crm/accounts/{id}Change a accounts
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_no | text | Yes | Account number — Left blank, the platform allocates the next one from the number range. |
name | text | Yes | Name |
account_type | text | No | Type Allowed: prospect customer partner distributor |
parent_id | uuid | No | Parent id |
industry | text | No | Industry |
country | text | No | Country |
currency | text | Yes | Currency |
credit_limit | numeric | No | Credit limit — Blank or 0: no limit. Checked when a sales order is created or confirmed, and when an opportunity closes won (AR-005); the Credit tab sets a limit per business unit and what happens when it is reached. |
is_active | boolean | No | Is active |
website | text | No | Website — The company’s web address, e.g. https://example.com |
phone | text | No | Main telephone |
email | text | No | General e-mail |
legal_name | text | No | Legal name — A change to the name, legal name or country here takes effect today; to date it otherwise, change it on the Party tab (Name, legal name and country). The registered address and the tax ids are kept on the Party tab. |
address_line1 | text | No | Address line1 |
city | text | No | City |
region | text | No | Region |
postal_code | text | No | Postal code |
employee_count | integer | No | Employees |
founded_year | integer | No | Founded (year) |
description | text | No | About the company |
name_ar | text | No | Name in Arabic |
cr_number | text | No | Cr number |
building_no | text | No | Building number — Four digits, from the national address. |
district | text | No | District |
additional_no | text | No | Additional number — The four-digit additional number of the national address. |
gstin | text | No | Gstin |
pan | text | No | PAN — India: five letters, four digits, a letter. |
state_code | text | No | GST state (place of supply) — India: the state supplies to this customer are made to. Same state as yours is CGST + SGST; another is IGST. Allowed: 01 Jammu and Kashmir 02 Himachal Pradesh 03 Punjab 04 Chandigarh 05 Uttarakhand 06 Haryana 07 Delhi 08 Rajasthan 09 Uttar Pradesh 10 Bihar 11 Sikkim 12 Arunachal Pradesh |
gst_registration_type | text | No | GST registration — India: regular for a registered customer (B2B), unregistered for a consumer (B2C). Allowed: regular composition unregistered sez_unit sez_developer overseas uin |
pincode | text | No | Pincode |
buyer_id_scheme | text | No | Buyer ID type (no VAT number) — For a customer with no VAT number. The CR number above is used as the CRN when this is empty. Allowed: TIN - tax identification number CRN - commercial registration MOM - MOMRAH license MLS - MHRSD license 700 - 700 number SAG - MISA license NAT - national ID GCC - GCC ID IQA - Iqama number PAS - passport OTH - other |
buyer_id_number | text | No | Buyer ID number — Letters and digits only. |
Sample body
{
"account_no": "ACC-000001",
"name": "Example"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"account_no": "ACC-000001",
"name": "Example",
"account_type": "prospect",
"parent_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"industry": "text",
"country": "US",
"currency": "USD",
"credit_limit": "1250.00",
"owner_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"is_active": true,
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/crm/accounts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"account_no":"ACC-000001","name":"Example"}'DELETE/api/crm/accounts/{id}Delete a accounts
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/accounts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"GET/api/crm/accounts/{id}/profileProfile
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/crm/accounts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/profile" \
-H "Authorization: Bearer $TOKEN"GET/api/crm/accounts/{id}/sitesSites
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/crm/accounts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/sites" \
-H "Authorization: Bearer $TOKEN"GET/api/crm/accounts/{id}/payment-methodsPayment methods
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/crm/accounts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/payment-methods" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/accounts/{id}/payment-setupPayment setup
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):
email, contactNameResponse
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/accounts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/payment-setup" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"email":"value","contactName":"value"}'POST/api/crm/accounts/{id}/onboarding-activeOnboarding active
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
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/accounts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/onboarding-active" \
-H "Authorization: Bearer $TOKEN"PATCH/api/crm/accounts/{id}Patch accounts
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
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 PATCH "https://demo.tranxact.ai/api/crm/accounts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/accounts/{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/accounts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'GET/api/crm/accounts/{parentId}/contactsContacts
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/crm/accounts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/contacts" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/accounts/{parentId}/contactsContacts
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
No body is required.
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/accounts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/contacts" \
-H "Authorization: Bearer $TOKEN"PUT/api/crm/accounts/{parentId}/contacts/{lineId}Contacts
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (uuid) | The record's lineId, as a list returns it. |
No body is required.
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 PUT "https://demo.tranxact.ai/api/crm/accounts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/contacts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/crm/accounts/{parentId}/contacts/{lineId}Contacts
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (uuid) | The record's lineId, as a list returns it. |
No body is required.
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 DELETE "https://demo.tranxact.ai/api/crm/accounts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/contacts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a accounts, 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_no | text | read, write | Account number — Left blank, the platform allocates the next one from the number range. |
name | text | read, write | Name |
account_type | text | read, write | Type Allowed: prospect customer partner distributor |
parent_id | uuid | read, write | Parent id |
industry | text | read, write | Industry |
country | text | read, write | Country |
currency | text | read, write | Currency |
credit_limit | numeric | read, write | Credit limit — Blank or 0: no limit. Checked when a sales order is created or confirmed, and when an opportunity closes won (AR-005); the Credit tab sets a limit per business unit and what happens when it is reached. |
owner_id | uuid | read only | Owner id |
is_active | boolean | read, write | Is active |
org_unit_id | uuid | read only | Org unit id |
location_id | uuid | read only | Location id |
warehouse_id | uuid | read only | Warehouse 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_at | timestamp with time zone | read only | Created at |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
website | text | read, write | Website — The company’s web address, e.g. https://example.com |
phone | text | read, write | Main telephone |
email | text | read, write | General e-mail |
legal_name | text | read, write | Legal name — A change to the name, legal name or country here takes effect today; to date it otherwise, change it on the Party tab (Name, legal name and country). The registered address and the tax ids are kept on the Party tab. |
address_line1 | text | read, write | Address line1 |
city | text | read, write | City |
region | text | read, write | Region |
postal_code | text | read, write | Postal code |
employee_count | integer | read, write | Employees |
founded_year | integer | read, write | Founded (year) |
description | text | read, write | About the company |
name_ar | text | read, write | Name in Arabic |
cr_number | text | read, write | Cr number |
building_no | text | read, write | Building number — Four digits, from the national address. |
district | text | read, write | District |
additional_no | text | read, write | Additional number — The four-digit additional number of the national address. |
gstin | text | read, write | Gstin |
pan | text | read, write | PAN — India: five letters, four digits, a letter. |
state_code | text | read, write | GST state (place of supply) — India: the state supplies to this customer are made to. Same state as yours is CGST + SGST; another is IGST. Allowed: 01 Jammu and Kashmir 02 Himachal Pradesh 03 Punjab 04 Chandigarh 05 Uttarakhand 06 Haryana 07 Delhi 08 Rajasthan 09 Uttar Pradesh 10 Bihar 11 Sikkim 12 Arunachal Pradesh |
gst_registration_type | text | read, write | GST registration — India: regular for a registered customer (B2B), unregistered for a consumer (B2C). Allowed: regular composition unregistered sez_unit sez_developer overseas uin |
pincode | text | read, write | Pincode |
buyer_id_scheme | text | read, write | Buyer ID type (no VAT number) — For a customer with no VAT number. The CR number above is used as the CRN when this is empty. Allowed: TIN - tax identification number CRN - commercial registration MOM - MOMRAH license MLS - MHRSD license 700 - 700 number SAG - MISA license NAT - national ID GCC - GCC ID IQA - Iqama number PAS - passport OTH - other |
buyer_id_number | text | read, write | Buyer ID number — Letters and digits only. |
merged_into_id | uuid | read only | Merged into id |
onboarding_status | text | read only | Onboarding status |
onboarding_updated_at | timestamp with time zone | read only | Onboarding updated at |
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 › Accounts 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.