TRANXACT.AI Help

Accounting · Permits & Licensing

Permit Types

What can be applied for: the fee (a base and an amount per unit), how long it lasts, whether it can be renewed, whether an inspection is needed and whether the public may apply online.

Type REST6 operationsBase path /api/accounting/permit-typesPublished as /api/v1/permit-types

Download specification (OpenAPI 3.1) Screen: Permit Types

Overview

PackageAccounting
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 Accounting › Permit Types 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.
Tablegov.permit_types · 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/accounting/permit-typesList permit types

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",
      "code": "COD-000001",
      "name": "Example",
      "category": "permit",
      "base_fee": "1250.00",
      "fee_per_unit": "1250.00",
      "unit_label": "text",
      "renewal_fee": "1250.00",
      "validity_months": 10,
      "renewable": true,
      "renewal_window_days": 10,
      "requires_inspection": true,
      "public_intake": true,
      "required_documents": []
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/accounting/permit-types?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/accounting/permit-types/{id}Read one permit type

Path parameters

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "category": "permit",
  "base_fee": "1250.00",
  "fee_per_unit": "1250.00",
  "unit_label": "text",
  "renewal_fee": "1250.00",
  "validity_months": 10,
  "renewable": true,
  "renewal_window_days": 10,
  "requires_inspection": true,
  "public_intake": true,
  "required_documents": []
}

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

Sample request

curl "https://demo.tranxact.ai/api/accounting/permit-types/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/permit-typesCreate a permit type

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
codetextYesCode
nametextYesName
categorytextNoKind
Allowed: permit license registration certificate
base_feenumericNoBase fee
fee_per_unitnumericNoFee per unit
unit_labeltextNoUnit — sq ft, seat, vehicle ...
renewal_feenumericNoRenewal fee — Empty: worked out as for a new one.
validity_monthsintegerNoValid for (months) — Empty: no expiry.
renewablebooleanNoCan be renewed
renewal_window_daysintegerNoRenewal opens (days before expiry)
requires_inspectionbooleanNoNeeds an inspection
public_intakebooleanNoThe public may apply online
required_documents_textNoDocuments required — Separated by commas.
standard_conditionstextNoStandard conditions — One per line; copied onto each permit.
revenue_account_notextNoRevenue account
descriptiontextNoDescription
is_activebooleanNoActive

Sample body

{
  "code": "COD-000001",
  "name": "Example",
  "category": "permit",
  "base_fee": "1250.00",
  "fee_per_unit": "1250.00",
  "unit_label": "text"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "category": "permit",
  "base_fee": "1250.00",
  "fee_per_unit": "1250.00",
  "unit_label": "text",
  "renewal_fee": "1250.00",
  "validity_months": 10,
  "renewable": true,
  "renewal_window_days": 10,
  "requires_inspection": true,
  "public_intake": true,
  "required_documents": []
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/accounting/permit-types" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code":"COD-000001","name":"Example","category":"permit","base_fee":"1250.00","fee_per_unit":"1250.00","unit_label":"text"}'
PUT/api/accounting/permit-types/{id}Change a permit type

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
codetextYesCode
nametextYesName
categorytextNoKind
Allowed: permit license registration certificate
base_feenumericNoBase fee
fee_per_unitnumericNoFee per unit
unit_labeltextNoUnit — sq ft, seat, vehicle ...
renewal_feenumericNoRenewal fee — Empty: worked out as for a new one.
validity_monthsintegerNoValid for (months) — Empty: no expiry.
renewablebooleanNoCan be renewed
renewal_window_daysintegerNoRenewal opens (days before expiry)
requires_inspectionbooleanNoNeeds an inspection
public_intakebooleanNoThe public may apply online
required_documents_textNoDocuments required — Separated by commas.
standard_conditionstextNoStandard conditions — One per line; copied onto each permit.
revenue_account_notextNoRevenue account
descriptiontextNoDescription
is_activebooleanNoActive

Sample body

{
  "code": "COD-000001",
  "name": "Example"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "category": "permit",
  "base_fee": "1250.00",
  "fee_per_unit": "1250.00",
  "unit_label": "text",
  "renewal_fee": "1250.00",
  "validity_months": 10,
  "renewable": true,
  "renewal_window_days": 10,
  "requires_inspection": true,
  "public_intake": true,
  "required_documents": []
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/accounting/permit-types/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code":"COD-000001","name":"Example"}'
DELETE/api/accounting/permit-types/{id}Delete a permit type

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/accounting/permit-types/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/permit-types/{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/accounting/permit-types/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 permit type, 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
codetextread, writeCode
nametextread, writeName
categorytextread, writeKind
Allowed: permit license registration certificate
base_feenumericread, writeBase fee
fee_per_unitnumericread, writeFee per unit
unit_labeltextread, writeUnit — sq ft, seat, vehicle ...
renewal_feenumericread, writeRenewal fee — Empty: worked out as for a new one.
validity_monthsintegerread, writeValid for (months) — Empty: no expiry.
renewablebooleanread, writeCan be renewed
renewal_window_daysintegerread, writeRenewal opens (days before expiry)
requires_inspectionbooleanread, writeNeeds an inspection
public_intakebooleanread, writeThe public may apply online
required_documents_textread, writeDocuments required — Separated by commas.
standard_conditionstextread, writeStandard conditions — One per line; copied onto each permit.
revenue_account_notextread, writeRevenue account
descriptiontextread, writeDescription
is_activebooleanread, writeActive
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 Accounting › Permit Types 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.