TRANXACT.AI Help

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.

Type REST6 operationsBase path /api/crm/customer-financialsPublished as /api/v1/customer-financials

Download specification (OpenAPI 3.1) Screen: Customer · Financial

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 · 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.
Tablecrm.customer_financials · 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-financialsList customer · financial

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_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

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_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.

FieldTypeRequiredDescription
account_iduuidYesAccount
site_iduuidNoSite (empty = the whole account)
org_unit_iduuidNoOrg unit id
currencytextNoCurrency
payment_terms_iduuidNoPayment 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_methodtextNoPayment method
Allowed: check ach wire card direct_debit cash bill_of_exchange
bank_nametextNoBank name
bank_account_last4textNoBank account last4
mandate_referencetextNoMandate reference
mandate_signed_ondateNoMandate signed on
invoice_groupingtextNoInvoices 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_cycletextNoStatement cycle
Allowed: none weekly monthly quarterly
dunning_profiletextNoDunning profile
is_dunning_exemptbooleanNoExempt from dunning
late_fee_pctnumericNoLate fee %
standard_discount_pctnumericNoStandard discount %
early_settlement_discount_pctnumericNoEarly settlement discount %
rebate_schemetextNoRebate scheme
withholding_tax_pctnumericNoWithholding tax %
tax_registration_notextNoTax registration no
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_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

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_iduuidNoSite (empty = the whole account)
org_unit_iduuidNoOrg unit id
currencytextNoCurrency
payment_terms_iduuidNoPayment 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_methodtextNoPayment method
Allowed: check ach wire card direct_debit cash bill_of_exchange
bank_nametextNoBank name
bank_account_last4textNoBank account last4
mandate_referencetextNoMandate reference
mandate_signed_ondateNoMandate signed on
invoice_groupingtextNoInvoices 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_cycletextNoStatement cycle
Allowed: none weekly monthly quarterly
dunning_profiletextNoDunning profile
is_dunning_exemptbooleanNoExempt from dunning
late_fee_pctnumericNoLate fee %
standard_discount_pctnumericNoStandard discount %
early_settlement_discount_pctnumericNoEarly settlement discount %
rebate_schemetextNoRebate scheme
withholding_tax_pctnumericNoWithholding tax %
tax_registration_notextNoTax registration no
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_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

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

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
account_iduuidread, writeAccount
site_iduuidread, writeSite (empty = the whole account)
org_unit_iduuidread, writeOrg unit id
currencytextread, writeCurrency
payment_terms_iduuidread, writePayment 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_methodtextread, writePayment method
Allowed: check ach wire card direct_debit cash bill_of_exchange
bank_nametextread, writeBank name
bank_account_last4textread, writeBank account last4
mandate_referencetextread, writeMandate reference
mandate_signed_ondateread, writeMandate signed on
invoice_groupingtextread, writeInvoices 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_cycletextread, writeStatement cycle
Allowed: none weekly monthly quarterly
dunning_profiletextread, writeDunning profile
is_dunning_exemptbooleanread, writeExempt from dunning
late_fee_pctnumericread, writeLate fee %
standard_discount_pctnumericread, writeStandard discount %
early_settlement_discount_pctnumericread, writeEarly settlement discount %
rebate_schemetextread, writeRebate scheme
withholding_tax_pctnumericread, writeWithholding tax %
tax_registration_notextread, writeTax registration no
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 · Financial 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.