TRANXACT.AI Help

Accounting · Permits & Licensing

Permits & Licences

What has been issued, when it expires, and what is due for renewal.

Type REST12 operationsBase path /api/accounting/permitsPublished as /api/v1/permits

Download specification (OpenAPI 3.1) Screen: Permits & Licences

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 › Permits & Licences 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.permits · 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

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

GET/api/accounting/permitsList permits & licences

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",
      "permit_no": "PER-000001",
      "application_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "permit_type_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "holder_name": "Example",
      "holder_email": "someone@example.com",
      "address": "text",
      "parcel_no": "PAR-000001",
      "issued_on": "2026-10-30",
      "valid_from": "2026-10-30",
      "expires_on": "2026-10-30",
      "status": "draft",
      "status_note": "draft",
      "renewed_by_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
    }
  ],
  "count": 1
}

Sample request

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

Path parameters

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "permit_no": "PER-000001",
  "application_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "permit_type_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "holder_name": "Example",
  "holder_email": "someone@example.com",
  "address": "text",
  "parcel_no": "PAR-000001",
  "issued_on": "2026-10-30",
  "valid_from": "2026-10-30",
  "expires_on": "2026-10-30",
  "status": "draft",
  "status_note": "draft",
  "renewed_by_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

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

Sample request

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

Request body

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

permitTypeId, applicantName, email, phone, address, parcelNo, description, quantity

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/permits/apply" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"permitTypeId":"value","applicantName":"value","email":"value","phone":"value","address":"value","parcelNo":"value"}'
POST/api/accounting/permits/expire-dueExpire due

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/accounting/permits/expire-due" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/permits/{id}/renewRenew

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/accounting/permits/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/renew" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/permits/{id}/suspendSuspend

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/accounting/permits/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/suspend" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"note":"value"}'
POST/api/accounting/permits/{id}/reinstateReinstate

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/accounting/permits/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/reinstate" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"note":"value"}'
POST/api/accounting/permits/{id}/revokeRevoke

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/accounting/permits/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/revoke" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"note":"value"}'
POST/api/accounting/permitsPost permits & licences

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/accounting/permits" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/permits/{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/permits/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'
PUT/api/accounting/permits/{id}Put permits & licences

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

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/accounting/permits/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"

Data model

Every field of a permit, 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
permit_notextread onlyPermit no
application_iduuidread onlyApplication id
permit_type_iduuidread onlyPermit type id
holder_nametextread onlyHolder name
holder_emailtextread onlyHolder email
addresstextread onlyAddress
parcel_notextread onlyParcel no
issued_ondateread onlyIssued on
valid_fromdateread onlyValid from
expires_ondateread onlyExpires on
statustextread onlyStatus
status_notetextread onlyStatus note
renewed_by_iduuidread onlyRenewed by 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 Accounting › Permits & Licences 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.