CRM · Utility Billing
Leak Adjustments
Credits for water lost to a repaired customer-side leak, by the company's policy: how much was billed, the account's normal use, the excess and the credit, who asked, who approved, and the bill that shows it. Asked for from a posted bill (Utility Bills › Leak adjustment).
/api/crm/util-leak-adjustmentsPublished as /api/v1/util-leak-adjustmentsDownload specification (OpenAPI 3.1) Screen: Leak Adjustments
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 › Leak Adjustments 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. |
| Table | crm.util_leak_adjustments · kept per company (and organisational unit where it has one) |
| Record | Read only; key id |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
9 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/crm/util-leak-adjustmentsList leak adjustments
Query parameters
| Name | Description | Example |
|---|---|---|
limit | Rows per page (50 by default, at most 200) | limit=100 |
offset | Rows to skip | offset=200 |
q | Free-text search over the search columns | q=acme |
sort | column:asc or column:desc, several separated by commas | sort=created_at:desc |
filter | A JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sorted | filter={"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",
"adjustment_no": "ADJ-000001",
"service_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"bill_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"service_type": "text",
"method": "text",
"billed_qty": "12.0000",
"normal_qty": "12.0000",
"excess_qty": "12.0000",
"billed_amount": "1250.00",
"adjusted_amount": "1250.00",
"credit_amount": "1250.00",
"reason": "text"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/crm/util-leak-adjustments?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/crm/util-leak-adjustments/{id}Read one leak adjustment
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (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",
"adjustment_no": "ADJ-000001",
"service_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"bill_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"service_type": "text",
"method": "text",
"billed_qty": "12.0000",
"normal_qty": "12.0000",
"excess_qty": "12.0000",
"billed_amount": "1250.00",
"adjusted_amount": "1250.00",
"credit_amount": "1250.00",
"reason": "text"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/crm/util-leak-adjustments/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/util-leak-adjustments/requestRequest
Request body
The keys this action reads (* = required; "one of" lists the only values):
bill_id, service_type, normal_qty, 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-leak-adjustments/request" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"bill_id":"value","service_type":"value","normal_qty":"value","reason":"value"}'POST/api/crm/util-leak-adjustments/{id}/approveApprove
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):
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-leak-adjustments/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/approve" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"note":"value"}'POST/api/crm/util-leak-adjustments/{id}/refuseRefuse
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):
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-leak-adjustments/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/refuse" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"note":"value"}'POST/api/crm/util-leak-adjustmentsPost leak adjustments
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-leak-adjustments" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/util-leak-adjustments/{id}/copyCopy
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):
overrides, preview, withLinesResponse
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-leak-adjustments/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-leak-adjustments/{id}Put leak adjustments
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (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-leak-adjustments/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/crm/util-leak-adjustments/{id}Delete leak adjustments
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (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-leak-adjustments/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a leak adjustment, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
org_unit_id | uuid | read only | Org unit id |
adjustment_no | text | read only | Adjustment no |
service_account_id | uuid | read only | Service account id |
bill_id | uuid | read only | Bill id |
service_type | text | read only | Service type |
method | text | read only | Method |
billed_qty | numeric | read only | Billed qty |
normal_qty | numeric | read only | Normal qty |
excess_qty | numeric | read only | Excess qty |
billed_amount | numeric | read only | Billed amount |
adjusted_amount | numeric | read only | Adjusted amount |
credit_amount | numeric | read only | Credit amount |
reason | text | read only | Reason |
status | text | read only | Status |
requested_by | uuid | read only | Requested by |
requested_at | timestamp with time zone | read only | Requested at |
decided_by | uuid | read only | Decided by |
decided_at | timestamp with time zone | read only | Decided at |
decision_note | text | read only | Decision note |
credit_memo_id | uuid | read only | Credit memo id |
to_credit_balance | numeric | read only | To credit balance |
journal_id | uuid | read only | Journal id |
shown_on_bill_id | uuid | read only | Shown on bill id |
created_at | timestamp with time zone | read only | Created at |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
xf_text_1 | text | read only | Xf text 1 |
xf_text_2 | text | read only | Xf text 2 |
xf_text_3 | text | read only | Xf text 3 |
xf_text_4 | text | read only | Xf text 4 |
xf_text_5 | text | read only | Xf text 5 |
xf_num_1 | numeric | read only | Xf num 1 |
xf_num_2 | numeric | read only | Xf num 2 |
xf_num_3 | numeric | read only | Xf num 3 |
xf_date_1 | date | read only | Xf date 1 |
xf_date_2 | date | read only | Xf date 2 |
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 › Leak Adjustments 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.