TRANXACT.AI Help

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.

Type REST6 operationsBase path /api/crm/customer-creditPublished as /api/v1/customer-credit

Download specification (OpenAPI 3.1) Screen: Customer · Credit Profile

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 · 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.
Tablecrm.customer_credit · 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-creditList customer · credit profile

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

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

FieldTypeRequiredDescription
account_iduuidYesAccount
org_unit_iduuidNoOrg unit id
credit_limitnumericNoCredit limit
currencytextNoCurrency
order_limitnumericNoSingle order limit
includes_open_ordersbooleanNoOpen orders count towards it
includes_undeliveredbooleanNoUndelivered goods count towards it
credit_ratingtextNoExternal rating
rating_agencytextNoRating agency
rating_datedateNoRating date
internal_scorenumericNoInternal score
risk_categorytextNoRisk category
Allowed: low moderate elevated high prohibited
on_limit_breachtextNoWhen the limit is reached
Allowed: allow warn hold reject
is_on_credit_holdbooleanNoOn credit hold
hold_reasontextNoHold reason
hold_placed_ondateNoHold placed on
hold_placed_byuuidNoHold placed by
has_credit_insurancebooleanNoCredit insured
insurertextNoInsurer
insured_amountnumericNoInsured amount
has_guaranteebooleanNoGuaranteed
guarantee_expiresdateNoGuarantee expires
requires_prepaymentbooleanNoPrepayment required
requires_letter_of_creditbooleanNoLetter of credit required
reviewed_ondateNoLast reviewed
reviewed_byuuidNoReviewed by
next_review_ondateNoNext review
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",
  "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

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
org_unit_iduuidNoOrg unit id
credit_limitnumericNoCredit limit
currencytextNoCurrency
order_limitnumericNoSingle order limit
includes_open_ordersbooleanNoOpen orders count towards it
includes_undeliveredbooleanNoUndelivered goods count towards it
credit_ratingtextNoExternal rating
rating_agencytextNoRating agency
rating_datedateNoRating date
internal_scorenumericNoInternal score
risk_categorytextNoRisk category
Allowed: low moderate elevated high prohibited
on_limit_breachtextNoWhen the limit is reached
Allowed: allow warn hold reject
is_on_credit_holdbooleanNoOn credit hold
hold_reasontextNoHold reason
hold_placed_ondateNoHold placed on
hold_placed_byuuidNoHold placed by
has_credit_insurancebooleanNoCredit insured
insurertextNoInsurer
insured_amountnumericNoInsured amount
has_guaranteebooleanNoGuaranteed
guarantee_expiresdateNoGuarantee expires
requires_prepaymentbooleanNoPrepayment required
requires_letter_of_creditbooleanNoLetter of credit required
reviewed_ondateNoLast reviewed
reviewed_byuuidNoReviewed by
next_review_ondateNoNext review
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",
  "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

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

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
account_iduuidread, writeAccount
org_unit_iduuidread, writeOrg unit id
credit_limitnumericread, writeCredit limit
currencytextread, writeCurrency
order_limitnumericread, writeSingle order limit
includes_open_ordersbooleanread, writeOpen orders count towards it
includes_undeliveredbooleanread, writeUndelivered goods count towards it
credit_ratingtextread, writeExternal rating
rating_agencytextread, writeRating agency
rating_datedateread, writeRating date
internal_scorenumericread, writeInternal score
risk_categorytextread, writeRisk category
Allowed: low moderate elevated high prohibited
on_limit_breachtextread, writeWhen the limit is reached
Allowed: allow warn hold reject
is_on_credit_holdbooleanread, writeOn credit hold
hold_reasontextread, writeHold reason
hold_placed_ondateread, writeHold placed on
hold_placed_byuuidread, writeHold placed by
has_credit_insurancebooleanread, writeCredit insured
insurertextread, writeInsurer
insured_amountnumericread, writeInsured amount
has_guaranteebooleanread, writeGuaranteed
guarantee_expiresdateread, writeGuarantee expires
requires_prepaymentbooleanread, writePrepayment required
requires_letter_of_creditbooleanread, writeLetter of credit required
reviewed_ondateread, writeLast reviewed
reviewed_byuuidread, writeReviewed by
next_review_ondateread, writeNext review
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.
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 · Credit Profile 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.