TRANXACT.AI Help

Accounting · Permits & Licensing

Permit Applications

Applications from staff and from the public: review, inspection, fee, decision, issue.

Type REST13 operationsBase path /api/accounting/permit-applicationsPublished as /api/v1/permit-applications

Download specification (OpenAPI 3.1) Screen: Permit Applications

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 Applications 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_applications · 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

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

GET/api/accounting/permit-applicationsList permit applications

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",
      "application_no": "APP-000001",
      "permit_type_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "renewal_of_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "channel": "text",
      "status": "draft",
      "applicant_name": "Example",
      "applicant_email": "someone@example.com",
      "applicant_phone": "+1 555 0100",
      "address": "text",
      "parcel_no": "PAR-000001",
      "description": "text",
      "quantity": "12.0000"
    }
  ],
  "count": 1
}

Sample request

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

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",
  "application_no": "APP-000001",
  "permit_type_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "renewal_of_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "channel": "text",
  "status": "draft",
  "applicant_name": "Example",
  "applicant_email": "someone@example.com",
  "applicant_phone": "+1 555 0100",
  "address": "text",
  "parcel_no": "PAR-000001",
  "description": "text",
  "quantity": "12.0000"
}

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

Sample request

curl "https://demo.tranxact.ai/api/accounting/permit-applications/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/permit-applications/{id}/reviewReview

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

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

reference

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

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

scheduledFor, inspectorId

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-applications/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/inspection" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"scheduledFor":"value","inspectorId":"value"}'
POST/api/accounting/permit-applications/{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/accounting/permit-applications/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/approve" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"note":"value"}'
POST/api/accounting/permit-applications/{id}/denyDeny

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

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

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

validFrom

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-applications/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/issue" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"validFrom":"value"}'
POST/api/accounting/permit-applicationsPost permit applications

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/permit-applications" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/permit-applications/{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-applications/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/permit-applications/{id}Put permit applications

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

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

Data model

Every field of a permit application, 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
application_notextread onlyApplication no
permit_type_iduuidread onlyPermit type id
renewal_of_iduuidread onlyRenewal of id
channeltextread onlyChannel
statustextread onlyStatus
applicant_nametextread onlyApplicant name
applicant_emailtextread onlyApplicant email
applicant_phonetextread onlyApplicant phone
addresstextread onlyAddress
parcel_notextread onlyParcel no
descriptiontextread onlyDescription
quantitynumericread onlyQuantity
fee_amountnumericread onlyFee amount
fee_paid_attimestamp with time zoneread onlyFee paid at
payment_reftextread onlyPayment ref
reviewer_iduuidread onlyReviewer id
decision_notetextread onlyDecision note
decided_attimestamp with time zoneread onlyDecided at
submitted_attimestamp with time zoneread onlySubmitted at
source_iptextread onlySource ip
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 Applications 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.