TRANXACT.AI Help

Accounting · Travel & Expense

Expense Types

What may be claimed, what evidence it needs, and whether the tax on it is recoverable at all. Entertainment usually is not, and reclaiming it is an assessment waiting to happen.

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

Download specification (OpenAPI 3.1) Screen: Expense 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 › Expense 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.
Tablescm.expense_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/expense-typesList expense 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",
      "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "code": "COD-000001",
      "name": "Example",
      "category": "text",
      "gl_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "tax_code_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "tax_recoverable": true,
      "receipt_required_above": "1250.00",
      "requires_attendees": true,
      "requires_purpose": true,
      "requires_project": true,
      "calculation": "actual",
      "is_billable_default": true
    }
  ],
  "count": 1
}

Sample request

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

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",
  "code": "COD-000001",
  "name": "Example",
  "category": "text",
  "gl_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "tax_code_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "tax_recoverable": true,
  "receipt_required_above": "1250.00",
  "requires_attendees": true,
  "requires_purpose": true,
  "requires_project": true,
  "calculation": "actual",
  "is_billable_default": true
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
codetextYesCode
nametextYesName
categorytextNoCategory
gl_account_iduuidNoExpense account
tax_code_iduuidNoTax code
tax_recoverablebooleanNoTax recoverable
receipt_required_abovenumericNoReceipt required above — Zero means always, which is right for some categories and hostile for others.
requires_attendeesbooleanNoRequires attendees
requires_purposebooleanNoRequires a business purpose
requires_projectbooleanNoRequires a project
calculationtextNoCalculation
Allowed: actual per_diem per_km per_mile fixed tiered
is_billable_defaultbooleanNoBillable by default
is_taxable_benefitbooleanNoTaxable benefit
sort_orderintegerNoSort order
is_activebooleanNoActive
descriptiontextNoDescription

Sample body

{
  "code": "COD-000001",
  "name": "Example",
  "category": "text",
  "gl_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "tax_code_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "tax_recoverable": true
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "category": "text",
  "gl_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "tax_code_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "tax_recoverable": true,
  "receipt_required_above": "1250.00",
  "requires_attendees": true,
  "requires_purpose": true,
  "requires_project": true,
  "calculation": "actual",
  "is_billable_default": true
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/accounting/expense-types" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code":"COD-000001","name":"Example","category":"text","gl_account_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","tax_code_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","tax_recoverable":true}'
PUT/api/accounting/expense-types/{id}Change a expense 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
categorytextNoCategory
gl_account_iduuidNoExpense account
tax_code_iduuidNoTax code
tax_recoverablebooleanNoTax recoverable
receipt_required_abovenumericNoReceipt required above — Zero means always, which is right for some categories and hostile for others.
requires_attendeesbooleanNoRequires attendees
requires_purposebooleanNoRequires a business purpose
requires_projectbooleanNoRequires a project
calculationtextNoCalculation
Allowed: actual per_diem per_km per_mile fixed tiered
is_billable_defaultbooleanNoBillable by default
is_taxable_benefitbooleanNoTaxable benefit
sort_orderintegerNoSort order
is_activebooleanNoActive
descriptiontextNoDescription

Sample body

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "category": "text",
  "gl_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "tax_code_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "tax_recoverable": true,
  "receipt_required_above": "1250.00",
  "requires_attendees": true,
  "requires_purpose": true,
  "requires_project": true,
  "calculation": "actual",
  "is_billable_default": true
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/accounting/expense-types/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code":"COD-000001","name":"Example"}'
DELETE/api/accounting/expense-types/{id}Delete a expense 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/expense-types/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/expense-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/expense-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 expense 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
org_unit_iduuidread onlyOrg unit id
codetextread, writeCode
nametextread, writeName
categorytextread, writeCategory
gl_account_iduuidread, writeExpense account
tax_code_iduuidread, writeTax code
tax_recoverablebooleanread, writeTax recoverable
receipt_required_abovenumericread, writeReceipt required above — Zero means always, which is right for some categories and hostile for others.
requires_attendeesbooleanread, writeRequires attendees
requires_purposebooleanread, writeRequires a business purpose
requires_projectbooleanread, writeRequires a project
calculationtextread, writeCalculation
Allowed: actual per_diem per_km per_mile fixed tiered
is_billable_defaultbooleanread, writeBillable by default
is_taxable_benefitbooleanread, writeTaxable benefit
sort_orderintegerread, writeSort order
is_activebooleanread, writeActive
descriptiontextread, writeDescription
created_attimestamp with time zoneread onlyCreated at
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
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by

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 › Expense 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.