TRANXACT.AI Help

CRM · Utilities

Service Accounts

A customer's utility account: class, cycle, contact, paperless and autopay, the life-support flag, and the deposit and credit the utility holds. Open one for its 360 view.

Type REST12 operationsBase path /api/crm/util-accountsPublished as /api/v1/util-accounts

Download specification (OpenAPI 3.1) Screen: Service Accounts

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 › Service Accounts 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_service_accounts · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; key id
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

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

GET/api/crm/util-accountsList service accounts

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",
      "account_no": "ACC-000001",
      "customer_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "contact_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "account_class": "residential",
      "status": "draft",
      "billing_cycle_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "mailing_address": "text",
      "email": "someone@example.com",
      "phone": "+1 555 0100",
      "language": "text",
      "paperless": true,
      "autopay": true
    }
  ],
  "count": 1
}

Sample request

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

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",
  "account_no": "ACC-000001",
  "customer_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "contact_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "account_class": "residential",
  "status": "draft",
  "billing_cycle_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "mailing_address": "text",
  "email": "someone@example.com",
  "phone": "+1 555 0100",
  "language": "text",
  "paperless": true,
  "autopay": true
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
account_notextYesAccount no
customer_account_iduuidYesCustomer — An existing CRM customer. For somebody new, use Open account with a new customer.
contact_iduuidNoContact id
account_classtextNoClass
Allowed: residential commercial industrial municipal institutional
billing_cycle_iduuidNoBilling cycle
mailing_addresstextNoMailing address — Blank: bills go to the service address.
emailtextNoEmail
phonetextNoTelephone
languagetextNoLanguage — Two letters, e.g. en, es, ar.
paperlessbooleanNoPaperless billing
life_supportbooleanNoLife support / critical care — Never disconnected for non-payment while this is ticked.
life_support_notetextNoLife support note
collection_hold_untildateNoHold collections until
notestextNoNotes

Sample body

{
  "account_no": "ACC-000001",
  "customer_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "contact_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "account_class": "residential",
  "billing_cycle_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "mailing_address": "text"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "account_no": "ACC-000001",
  "customer_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "contact_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "account_class": "residential",
  "status": "draft",
  "billing_cycle_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "mailing_address": "text",
  "email": "someone@example.com",
  "phone": "+1 555 0100",
  "language": "text",
  "paperless": true,
  "autopay": true
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/crm/util-accounts" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"account_no":"ACC-000001","customer_account_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","contact_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","account_class":"residential","billing_cycle_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","mailing_address":"text"}'
PUT/api/crm/util-accounts/{id}Change a service account

Path parameters

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

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
account_notextYesAccount no
customer_account_iduuidYesCustomer — An existing CRM customer. For somebody new, use Open account with a new customer.
contact_iduuidNoContact id
account_classtextNoClass
Allowed: residential commercial industrial municipal institutional
billing_cycle_iduuidNoBilling cycle
mailing_addresstextNoMailing address — Blank: bills go to the service address.
emailtextNoEmail
phonetextNoTelephone
languagetextNoLanguage — Two letters, e.g. en, es, ar.
paperlessbooleanNoPaperless billing
life_supportbooleanNoLife support / critical care — Never disconnected for non-payment while this is ticked.
life_support_notetextNoLife support note
collection_hold_untildateNoHold collections until
notestextNoNotes

Sample body

{
  "account_no": "ACC-000001",
  "customer_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "account_no": "ACC-000001",
  "customer_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "contact_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "account_class": "residential",
  "status": "draft",
  "billing_cycle_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "mailing_address": "text",
  "email": "someone@example.com",
  "phone": "+1 555 0100",
  "language": "text",
  "paperless": true,
  "autopay": true
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/crm/util-accounts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"account_no":"ACC-000001","customer_account_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'
DELETE/api/crm/util-accounts/{id}Delete a service account

Path parameters

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

Response 200

{ "deleted": true }

Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.

Sample request

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

Request body

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

customer_name, name, customer_account_id, account_class, email, phone, address_line1, city, region, postal_code, billing_cycle_id, mailing_address, language, paperless, life_support, life_support_note, notes; account_class one of residential|commercial|industrial|municipal|institutional

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-accounts/create" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"customer_name":"value","name":"value","customer_account_id":"value","account_class":"value","email":"value","phone":"value"}'
GET/api/crm/util-accounts/{id}/overviewOverview

Path parameters

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

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/crm/util-accounts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/overview" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/util-accounts/{id}/start-serviceStart service

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-accounts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/start-service" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/util-accounts/{id}/stop-serviceStop service

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-accounts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/stop-service" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/util-accounts/{id}/transferTransfer

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

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

Data model

Every field of a service account, 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
account_notextread, writeAccount no
customer_account_iduuidread, writeCustomer — An existing CRM customer. For somebody new, use Open account with a new customer.
contact_iduuidread, writeContact id
account_classtextread, writeClass
Allowed: residential commercial industrial municipal institutional
statustextread onlyStatus
billing_cycle_iduuidread, writeBilling cycle
mailing_addresstextread, writeMailing address — Blank: bills go to the service address.
emailtextread, writeEmail
phonetextread, writeTelephone
languagetextread, writeLanguage — Two letters, e.g. en, es, ar.
paperlessbooleanread, writePaperless billing
autopaybooleanread onlyAutopay
life_supportbooleanread, writeLife support / critical care — Never disconnected for non-payment while this is ticked.
life_support_notetextread, writeLife support note
deposit_heldnumericread onlyDeposit held
credit_balancenumericread onlyCredit balance
collection_hold_untildateread, writeHold collections until
opened_ondateread onlyOpened on
closed_ondateread onlyClosed on
notestextread, writeNotes
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 › Service Accounts 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.