TRANXACT.AI Help

CRM · Utility Collections

Payment Arrangements

Past-due balances split into installments: requested from the portal or set up by staff, paid down by payments, broken when one is missed.

Type REST10 operationsBase path /api/crm/util-arrangementsPublished as /api/v1/util-arrangements

Download specification (OpenAPI 3.1) Screen: Payment Arrangements

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 › Payment Arrangements 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.util_arrangements · kept per company (and organisational unit where it has one)
RecordRead only; key id
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

10 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/crm/util-arrangementsList payment arrangements

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",
      "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "arrangement_no": "ARR-000001",
      "service_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "total_amount": "1250.00",
      "down_payment": "1250.00",
      "installments": 10,
      "start_date": "2026-10-30",
      "status": "draft",
      "requested_via": "text",
      "approved_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "approved_at": "2026-10-30T09:00:00Z",
      "broken_at": "2026-10-30T09:00:00Z",
      "notes": "text"
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/crm/util-arrangements?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/crm/util-arrangements/{id}Read one payment arrangement

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "arrangement_no": "ARR-000001",
  "service_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "total_amount": "1250.00",
  "down_payment": "1250.00",
  "installments": 10,
  "start_date": "2026-10-30",
  "status": "draft",
  "requested_via": "text",
  "approved_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "approved_at": "2026-10-30T09:00:00Z",
  "broken_at": "2026-10-30T09:00:00Z",
  "notes": "text"
}

404 when no record with that id is visible to the caller.

Sample request

curl "https://demo.tranxact.ai/api/crm/util-arrangements/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/util-arrangements/createCreate

Request body

The keys this action reads (* = required; "one of" lists the only values):

service_account_id, total_amount, down_payment, installments, start_date, notes

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/util-arrangements/create" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"service_account_id":"value","total_amount":"value","down_payment":"value","installments":"value","start_date":"value","notes":"value"}'
POST/api/crm/util-arrangements/{id}/approveApprove

Path parameters

NameTypeDescription
idstring (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/util-arrangements/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/approve" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/util-arrangements/{id}/declineDecline

Path parameters

NameTypeDescription
idstring (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/util-arrangements/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/decline" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/util-arrangements/{id}/cancelCancel

Path parameters

NameTypeDescription
idstring (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/util-arrangements/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/cancel" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/util-arrangementsPost payment arrangements

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/util-arrangements" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/util-arrangements/{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/util-arrangements/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'
PUT/api/crm/util-arrangements/{id}Put payment arrangements

Path parameters

NameTypeDescription
idstring (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 PUT "https://demo.tranxact.ai/api/crm/util-arrangements/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/crm/util-arrangements/{id}Delete payment arrangements

Path parameters

NameTypeDescription
idstring (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 DELETE "https://demo.tranxact.ai/api/crm/util-arrangements/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"

Data model

Every field of a payment arrangement, 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
org_unit_iduuidread onlyOrg unit id
arrangement_notextread onlyArrangement no
service_account_iduuidread onlyService account id
total_amountnumericread onlyTotal amount
down_paymentnumericread onlyDown payment
installmentsintegerread onlyInstallments
start_datedateread onlyStart date
statustextread onlyStatus
requested_viatextread onlyRequested via
approved_byuuidread onlyApproved by
approved_attimestamp with time zoneread onlyApproved at
broken_attimestamp with time zoneread onlyBroken at
notestextread onlyNotes
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
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

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 › Payment Arrangements 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.