CRM · Reachable by link
Customer · Financial
Terms, payment method, how invoices are grouped and what happens when they do not pay — at account level, or overridden per site.
/api/crm/customer-financialsPublished as /api/v1/customer-financialsDownload specification (OpenAPI 3.1) Screen: Customer · Financial
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 · Financial 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_financials · 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-financialsList customer · financial
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_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"currency": "USD",
"payment_terms_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"payment_method": "check",
"bank_name": "Example",
"bank_account_last4": "text",
"mandate_reference": "text",
"mandate_signed_on": "2026-10-30",
"invoice_grouping": "per_order",
"statement_cycle": "none",
"dunning_profile": "text"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/crm/customer-financials?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/crm/customer-financials/{id}Read one customer financials
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_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"currency": "USD",
"payment_terms_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"payment_method": "check",
"bank_name": "Example",
"bank_account_last4": "text",
"mandate_reference": "text",
"mandate_signed_on": "2026-10-30",
"invoice_grouping": "per_order",
"statement_cycle": "none",
"dunning_profile": "text"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/crm/customer-financials/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/customer-financialsCreate a customer financials
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
account_id | uuid | Yes | Account |
site_id | uuid | No | Site (empty = the whole account) |
org_unit_id | uuid | No | Org unit id |
currency | text | No | Currency |
payment_terms_id | uuid | No | Payment terms — The terms agreed with this customer, from the date this record is effective. A new term later is a new record from its own date: this one is kept for the documents raised under it. |
payment_method | text | No | Payment method Allowed: check ach wire card direct_debit cash bill_of_exchange |
bank_name | text | No | Bank name |
bank_account_last4 | text | No | Bank account last4 |
mandate_reference | text | No | Mandate reference |
mandate_signed_on | date | No | Mandate signed on |
invoice_grouping | text | No | Invoices grouped — Some customers refuse an invoice per delivery. This is where that is recorded. Allowed: per_order per_delivery per_site consolidated_monthly per_po |
statement_cycle | text | No | Statement cycle Allowed: none weekly monthly quarterly |
dunning_profile | text | No | Dunning profile |
is_dunning_exempt | boolean | No | Exempt from dunning |
late_fee_pct | numeric | No | Late fee % |
standard_discount_pct | numeric | No | Standard discount % |
early_settlement_discount_pct | numeric | No | Early settlement discount % |
rebate_scheme | text | No | Rebate scheme |
withholding_tax_pct | numeric | No | Withholding tax % |
tax_registration_no | text | No | Tax registration no |
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_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"currency": "USD",
"payment_terms_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"site_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"currency": "USD",
"payment_terms_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"payment_method": "check",
"bank_name": "Example",
"bank_account_last4": "text",
"mandate_reference": "text",
"mandate_signed_on": "2026-10-30",
"invoice_grouping": "per_order",
"statement_cycle": "none",
"dunning_profile": "text"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/customer-financials" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"account_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","site_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","org_unit_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","currency":"USD","payment_terms_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'PUT/api/crm/customer-financials/{id}Change a customer financials
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_id | uuid | No | Site (empty = the whole account) |
org_unit_id | uuid | No | Org unit id |
currency | text | No | Currency |
payment_terms_id | uuid | No | Payment terms — The terms agreed with this customer, from the date this record is effective. A new term later is a new record from its own date: this one is kept for the documents raised under it. |
payment_method | text | No | Payment method Allowed: check ach wire card direct_debit cash bill_of_exchange |
bank_name | text | No | Bank name |
bank_account_last4 | text | No | Bank account last4 |
mandate_reference | text | No | Mandate reference |
mandate_signed_on | date | No | Mandate signed on |
invoice_grouping | text | No | Invoices grouped — Some customers refuse an invoice per delivery. This is where that is recorded. Allowed: per_order per_delivery per_site consolidated_monthly per_po |
statement_cycle | text | No | Statement cycle Allowed: none weekly monthly quarterly |
dunning_profile | text | No | Dunning profile |
is_dunning_exempt | boolean | No | Exempt from dunning |
late_fee_pct | numeric | No | Late fee % |
standard_discount_pct | numeric | No | Standard discount % |
early_settlement_discount_pct | numeric | No | Early settlement discount % |
rebate_scheme | text | No | Rebate scheme |
withholding_tax_pct | numeric | No | Withholding tax % |
tax_registration_no | text | No | Tax registration no |
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_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"site_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"currency": "USD",
"payment_terms_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"payment_method": "check",
"bank_name": "Example",
"bank_account_last4": "text",
"mandate_reference": "text",
"mandate_signed_on": "2026-10-30",
"invoice_grouping": "per_order",
"statement_cycle": "none",
"dunning_profile": "text"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/crm/customer-financials/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"account_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","site_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'DELETE/api/crm/customer-financials/{id}Delete a customer financials
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-financials/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/customer-financials/{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-financials/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 financials, 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_id | uuid | read, write | Site (empty = the whole account) |
org_unit_id | uuid | read, write | Org unit id |
currency | text | read, write | Currency |
payment_terms_id | uuid | read, write | Payment terms — The terms agreed with this customer, from the date this record is effective. A new term later is a new record from its own date: this one is kept for the documents raised under it. |
payment_method | text | read, write | Payment method Allowed: check ach wire card direct_debit cash bill_of_exchange |
bank_name | text | read, write | Bank name |
bank_account_last4 | text | read, write | Bank account last4 |
mandate_reference | text | read, write | Mandate reference |
mandate_signed_on | date | read, write | Mandate signed on |
invoice_grouping | text | read, write | Invoices grouped — Some customers refuse an invoice per delivery. This is where that is recorded. Allowed: per_order per_delivery per_site consolidated_monthly per_po |
statement_cycle | text | read, write | Statement cycle Allowed: none weekly monthly quarterly |
dunning_profile | text | read, write | Dunning profile |
is_dunning_exempt | boolean | read, write | Exempt from dunning |
late_fee_pct | numeric | read, write | Late fee % |
standard_discount_pct | numeric | read, write | Standard discount % |
early_settlement_discount_pct | numeric | read, write | Early settlement discount % |
rebate_scheme | text | read, write | Rebate scheme |
withholding_tax_pct | numeric | read, write | Withholding tax % |
tax_registration_no | text | read, write | Tax registration no |
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. |
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 · Financial 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.