TRANXACT.AI Help

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

Type REST9 operationsBase path /api/crm/util-leak-adjustmentsPublished as /api/v1/util-leak-adjustments

Download specification (OpenAPI 3.1) Screen: Leak Adjustments

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 › 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.
Tablecrm.util_leak_adjustments · 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

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

GET/api/crm/util-leak-adjustmentsList leak adjustments

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",
      "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

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",
  "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, 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-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

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

note

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

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

note

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

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

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

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

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
adjustment_notextread onlyAdjustment no
service_account_iduuidread onlyService account id
bill_iduuidread onlyBill id
service_typetextread onlyService type
methodtextread onlyMethod
billed_qtynumericread onlyBilled qty
normal_qtynumericread onlyNormal qty
excess_qtynumericread onlyExcess qty
billed_amountnumericread onlyBilled amount
adjusted_amountnumericread onlyAdjusted amount
credit_amountnumericread onlyCredit amount
reasontextread onlyReason
statustextread onlyStatus
requested_byuuidread onlyRequested by
requested_attimestamp with time zoneread onlyRequested at
decided_byuuidread onlyDecided by
decided_attimestamp with time zoneread onlyDecided at
decision_notetextread onlyDecision note
credit_memo_iduuidread onlyCredit memo id
to_credit_balancenumericread onlyTo credit balance
journal_iduuidread onlyJournal id
shown_on_bill_iduuidread onlyShown on bill id
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 › Leak Adjustments 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.