TRANXACT.AI Help

CRM · Utility Cashiering & Payments

Utility Payments

Every payment on a utility account — counter, mail, lockbox, bank, portal, autopay — what it paid, what became a credit, and any void.

Type REST8 operationsBase path /api/crm/util-paymentsPublished as /api/v1/util-payments

Download specification (OpenAPI 3.1) Screen: Utility Payments

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 › Utility Payments 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_payments · 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

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

GET/api/crm/util-paymentsList utility payments

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",
      "payment_no": "PAY-000001",
      "service_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "session_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "channel": "text",
      "tender": "text",
      "amount": "1250.00",
      "currency": "USD",
      "applied_amount": "1250.00",
      "unapplied_amount": "1250.00",
      "card_last4": "text",
      "check_no": "CHE-000001",
      "reference": "text"
    }
  ],
  "count": 1
}

Sample request

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

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",
  "payment_no": "PAY-000001",
  "service_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "session_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "channel": "text",
  "tender": "text",
  "amount": "1250.00",
  "currency": "USD",
  "applied_amount": "1250.00",
  "unapplied_amount": "1250.00",
  "card_last4": "text",
  "check_no": "CHE-000001",
  "reference": "text"
}

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

Sample request

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

Request body

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

channel, service_account_id, amount, tender, check_no, reference, received_at; channel one of mail|bank|counter

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-payments/record" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"channel":"value","service_account_id":"value","amount":"value","tender":"value","check_no":"value","reference":"value"}'
POST/api/crm/util-payments/{id}/void-requestVoid request

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):

reason

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-payments/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/void-request" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"reason":"value"}'
POST/api/crm/util-paymentsPost utility payments

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-payments" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/util-payments/{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-payments/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-payments/{id}Put utility payments

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-payments/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/crm/util-payments/{id}Delete utility payments

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-payments/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"

Data model

Every field of a utility payment, 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
payment_notextread onlyPayment no
service_account_iduuidread onlyService account id
session_iduuidread onlySession id
channeltextread onlyChannel
tendertextread onlyTender
amountnumericread onlyAmount
currencytextread onlyCurrency
applied_amountnumericread onlyApplied amount
unapplied_amountnumericread onlyUnapplied amount
card_last4textread onlyCard last4
check_notextread onlyCheck no
referencetextread onlyReference
external_reftextread onlyExternal ref
received_attimestamp with time zoneread onlyReceived at
statustextread onlyStatus
credit_journal_iduuidread onlyCredit journal id
void_reasontextread onlyVoid reason
void_requested_byuuidread onlyVoid requested by
void_requested_attimestamp with time zoneread onlyVoid requested at
void_approved_byuuidread onlyVoid approved by
void_approved_attimestamp with time zoneread onlyVoid approved at
taken_byuuidread onlyTaken by
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 › Utility Payments 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.