CRM · Reachable by link
Customer · Credit Profile
The limit, what it is made of, what happens when it is reached, and what security is held against it. Reviewed on its own cycle by different people.
/api/crm/customer-creditPublished as /api/v1/customer-creditDownload specification (OpenAPI 3.1) Screen: Customer · Credit Profile
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 · Credit Profile 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_credit · 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-creditList customer · credit profile
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",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"credit_limit": "1250.00",
"currency": "USD",
"order_limit": "1250.00",
"includes_open_orders": true,
"includes_undelivered": true,
"credit_rating": "text",
"rating_agency": "text",
"rating_date": "2026-10-30",
"internal_score": "1250.00",
"risk_category": "low",
"on_limit_breach": "allow"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/crm/customer-credit?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/crm/customer-credit/{id}Read one customer credit
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",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"credit_limit": "1250.00",
"currency": "USD",
"order_limit": "1250.00",
"includes_open_orders": true,
"includes_undelivered": true,
"credit_rating": "text",
"rating_agency": "text",
"rating_date": "2026-10-30",
"internal_score": "1250.00",
"risk_category": "low",
"on_limit_breach": "allow"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/crm/customer-credit/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/customer-creditCreate a customer credit
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
account_id | uuid | Yes | Account |
org_unit_id | uuid | No | Org unit id |
credit_limit | numeric | No | Credit limit |
currency | text | No | Currency |
order_limit | numeric | No | Single order limit |
includes_open_orders | boolean | No | Open orders count towards it |
includes_undelivered | boolean | No | Undelivered goods count towards it |
credit_rating | text | No | External rating |
rating_agency | text | No | Rating agency |
rating_date | date | No | Rating date |
internal_score | numeric | No | Internal score |
risk_category | text | No | Risk category Allowed: low moderate elevated high prohibited |
on_limit_breach | text | No | When the limit is reached Allowed: allow warn hold reject |
is_on_credit_hold | boolean | No | On credit hold |
hold_reason | text | No | Hold reason |
hold_placed_on | date | No | Hold placed on |
hold_placed_by | uuid | No | Hold placed by |
has_credit_insurance | boolean | No | Credit insured |
insurer | text | No | Insurer |
insured_amount | numeric | No | Insured amount |
has_guarantee | boolean | No | Guaranteed |
guarantee_expires | date | No | Guarantee expires |
requires_prepayment | boolean | No | Prepayment required |
requires_letter_of_credit | boolean | No | Letter of credit required |
reviewed_on | date | No | Last reviewed |
reviewed_by | uuid | No | Reviewed by |
next_review_on | date | No | Next review |
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",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"credit_limit": "1250.00",
"currency": "USD",
"order_limit": "1250.00"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"credit_limit": "1250.00",
"currency": "USD",
"order_limit": "1250.00",
"includes_open_orders": true,
"includes_undelivered": true,
"credit_rating": "text",
"rating_agency": "text",
"rating_date": "2026-10-30",
"internal_score": "1250.00",
"risk_category": "low",
"on_limit_breach": "allow"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/customer-credit" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"account_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","org_unit_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","credit_limit":"1250.00","currency":"USD","order_limit":"1250.00"}'PUT/api/crm/customer-credit/{id}Change a customer credit
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 |
org_unit_id | uuid | No | Org unit id |
credit_limit | numeric | No | Credit limit |
currency | text | No | Currency |
order_limit | numeric | No | Single order limit |
includes_open_orders | boolean | No | Open orders count towards it |
includes_undelivered | boolean | No | Undelivered goods count towards it |
credit_rating | text | No | External rating |
rating_agency | text | No | Rating agency |
rating_date | date | No | Rating date |
internal_score | numeric | No | Internal score |
risk_category | text | No | Risk category Allowed: low moderate elevated high prohibited |
on_limit_breach | text | No | When the limit is reached Allowed: allow warn hold reject |
is_on_credit_hold | boolean | No | On credit hold |
hold_reason | text | No | Hold reason |
hold_placed_on | date | No | Hold placed on |
hold_placed_by | uuid | No | Hold placed by |
has_credit_insurance | boolean | No | Credit insured |
insurer | text | No | Insurer |
insured_amount | numeric | No | Insured amount |
has_guarantee | boolean | No | Guaranteed |
guarantee_expires | date | No | Guarantee expires |
requires_prepayment | boolean | No | Prepayment required |
requires_letter_of_credit | boolean | No | Letter of credit required |
reviewed_on | date | No | Last reviewed |
reviewed_by | uuid | No | Reviewed by |
next_review_on | date | No | Next review |
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",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"credit_limit": "1250.00",
"currency": "USD",
"order_limit": "1250.00",
"includes_open_orders": true,
"includes_undelivered": true,
"credit_rating": "text",
"rating_agency": "text",
"rating_date": "2026-10-30",
"internal_score": "1250.00",
"risk_category": "low",
"on_limit_breach": "allow"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/crm/customer-credit/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"account_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","org_unit_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'DELETE/api/crm/customer-credit/{id}Delete a customer credit
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-credit/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/customer-credit/{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-credit/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 credit, 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 |
org_unit_id | uuid | read, write | Org unit id |
credit_limit | numeric | read, write | Credit limit |
currency | text | read, write | Currency |
order_limit | numeric | read, write | Single order limit |
includes_open_orders | boolean | read, write | Open orders count towards it |
includes_undelivered | boolean | read, write | Undelivered goods count towards it |
credit_rating | text | read, write | External rating |
rating_agency | text | read, write | Rating agency |
rating_date | date | read, write | Rating date |
internal_score | numeric | read, write | Internal score |
risk_category | text | read, write | Risk category Allowed: low moderate elevated high prohibited |
on_limit_breach | text | read, write | When the limit is reached Allowed: allow warn hold reject |
is_on_credit_hold | boolean | read, write | On credit hold |
hold_reason | text | read, write | Hold reason |
hold_placed_on | date | read, write | Hold placed on |
hold_placed_by | uuid | read, write | Hold placed by |
has_credit_insurance | boolean | read, write | Credit insured |
insurer | text | read, write | Insurer |
insured_amount | numeric | read, write | Insured amount |
has_guarantee | boolean | read, write | Guaranteed |
guarantee_expires | date | read, write | Guarantee expires |
requires_prepayment | boolean | read, write | Prepayment required |
requires_letter_of_credit | boolean | read, write | Letter of credit required |
reviewed_on | date | read, write | Last reviewed |
reviewed_by | uuid | read, write | Reviewed by |
next_review_on | date | read, write | Next review |
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 · Credit Profile 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.