CRM · Utility Collections
Collections Worklist
Every account with money past due, worst first, with the next step: a notice, a final notice, a disconnect order — or, for life support, a call. Run collections to send the notices and charge the late fees.
/api/crm/util-collectionsDownload specification (OpenAPI 3.1) Screen: Collections Worklist
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 › Collections Worklist 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. |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
5 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/crm/util-collectionsRead collections worklist
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/crm/util-collections" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/util-collections/runRun
Request body
The keys this action reads (* = required; "one of" lists the only values):
as_ofResponse
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-collections/run" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"as_of":"value"}'POST/api/crm/util-collections/accounts/{id}/disconnectAccounts disconnect
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):
scheduled_date, noteResponse
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-collections/accounts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/disconnect" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"scheduled_date":"value","note":"value"}'POST/api/crm/util-collections/accounts/{id}/write-offAccounts write off
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):
reasonResponse
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-collections/accounts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/write-off" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"reason":"value"}'POST/api/crm/util-collections/accounts/{id}/holdAccounts hold
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):
until, reasonResponse
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-collections/accounts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/hold" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"until":"value","reason":"value"}'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 › Collections Worklist 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.