TRANXACT.AI Help

CRM · Utilities

Premises

Every place that takes service: address, parcel (APN), district, read route and walk order, map point, and the services it can take.

Type REST6 operationsBase path /api/crm/util-premisesPublished as /api/v1/util-premises

Download specification (OpenAPI 3.1) Screen: Premises

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 › Premises 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_premises · 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

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

GET/api/crm/util-premisesList premises

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",
      "premise_no": "PRE-000001",
      "address_line1": "text",
      "address_line2": "text",
      "city": "text",
      "region": "text",
      "postal_code": "POS-000001",
      "country": "US",
      "parcel_apn": "text",
      "district": "text",
      "premise_type": "residential",
      "route_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "route_seq": 10
    }
  ],
  "count": 1
}

Sample request

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

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",
  "premise_no": "PRE-000001",
  "address_line1": "text",
  "address_line2": "text",
  "city": "text",
  "region": "text",
  "postal_code": "POS-000001",
  "country": "US",
  "parcel_apn": "text",
  "district": "text",
  "premise_type": "residential",
  "route_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "route_seq": 10
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
premise_notextYesPremise no
address_line1textYesAddress
address_line2textNoAddress line 2
citytextNoCity
regiontextNoState / region
postal_codetextNoPostal code
countrytextNoCountry
parcel_apntextNoParcel (APN)
districttextNoDistrict
premise_typetextNoType
Allowed: residential commercial industrial municipal institutional vacant_lot
route_iduuidNoRead route
route_seqintegerNoWalk order
latitudenumericNoLatitude
longitudenumericNoLongitude
service_types_textNoServices it can take — water, sewer, electric, gas, refuse, stormwater
is_activebooleanNoActive
notestextNoNotes

Sample body

{
  "premise_no": "PRE-000001",
  "address_line1": "text",
  "address_line2": "text",
  "city": "text",
  "region": "text",
  "postal_code": "POS-000001"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "premise_no": "PRE-000001",
  "address_line1": "text",
  "address_line2": "text",
  "city": "text",
  "region": "text",
  "postal_code": "POS-000001",
  "country": "US",
  "parcel_apn": "text",
  "district": "text",
  "premise_type": "residential",
  "route_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "route_seq": 10
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/crm/util-premises" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"premise_no":"PRE-000001","address_line1":"text","address_line2":"text","city":"text","region":"text","postal_code":"POS-000001"}'
PUT/api/crm/util-premises/{id}Change a util premises

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
premise_notextYesPremise no
address_line1textYesAddress
address_line2textNoAddress line 2
citytextNoCity
regiontextNoState / region
postal_codetextNoPostal code
countrytextNoCountry
parcel_apntextNoParcel (APN)
districttextNoDistrict
premise_typetextNoType
Allowed: residential commercial industrial municipal institutional vacant_lot
route_iduuidNoRead route
route_seqintegerNoWalk order
latitudenumericNoLatitude
longitudenumericNoLongitude
service_types_textNoServices it can take — water, sewer, electric, gas, refuse, stormwater
is_activebooleanNoActive
notestextNoNotes

Sample body

{
  "premise_no": "PRE-000001",
  "address_line1": "text"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "premise_no": "PRE-000001",
  "address_line1": "text",
  "address_line2": "text",
  "city": "text",
  "region": "text",
  "postal_code": "POS-000001",
  "country": "US",
  "parcel_apn": "text",
  "district": "text",
  "premise_type": "residential",
  "route_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "route_seq": 10
}

Sample request

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

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-premises/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/util-premises/{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-premises/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 util premises, 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
premise_notextread, writePremise no
address_line1textread, writeAddress
address_line2textread, writeAddress line 2
citytextread, writeCity
regiontextread, writeState / region
postal_codetextread, writePostal code
countrytextread, writeCountry
parcel_apntextread, writeParcel (APN)
districttextread, writeDistrict
premise_typetextread, writeType
Allowed: residential commercial industrial municipal institutional vacant_lot
route_iduuidread, writeRead route
route_seqintegerread, writeWalk order
latitudenumericread, writeLatitude
longitudenumericread, writeLongitude
service_types_textread, writeServices it can take — water, sewer, electric, gas, refuse, stormwater
is_activebooleanread, writeActive
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 › Premises 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.