TRANXACT.AI Help

HRMS · Trips & Expense Reports

Expense Policy

The caps, the daily limits and the receipt thresholds each claim is measured against. A claim above its linked travel request’s estimate is always flagged on the claim — that rule is built in and needs no policy here.

Type REST6 operationsBase path /api/hrms/expense-policiesPublished as /api/v1/expense-policies

Download specification (OpenAPI 3.1) Screen: Expense Policy

Overview

PackageHRMS
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 HRMS › Expense Policy 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_policies · 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/hrms/expense-policiesList expense policy

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",
      "expense_type": "text",
      "max_amount": "1250.00",
      "max_per_day": "1250.00",
      "requires_receipt_above": "1250.00",
      "requires_approval_above": "1250.00",
      "requires_pre_approval": true,
      "gl_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "guidance": "text",
      "is_active": true,
      "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "expense_type_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
    }
  ],
  "count": 1
}

Sample request

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

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",
  "expense_type": "text",
  "max_amount": "1250.00",
  "max_per_day": "1250.00",
  "requires_receipt_above": "1250.00",
  "requires_approval_above": "1250.00",
  "requires_pre_approval": true,
  "gl_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "guidance": "text",
  "is_active": true,
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "expense_type_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/hrms/expense-policies/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/expense-policiesCreate a expense policies

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
codetextYesPolicy code
nametextYesName
expense_typetextYesApplies to
max_amountnumericNoMaximum for one line
max_per_daynumericNoMaximum per day
requires_receipt_abovenumericNoReceipt required above
requires_approval_abovenumericNoExtra approval above
requires_pre_approvalbooleanNoNeeds pre-approval
gl_account_iduuidNoPosts to
guidancetextNoGuidance
is_activebooleanNoActive
expense_type_iduuidNoExpense type (master)
countrytextNoCountry — Blank means any, which keeps the rule count small.
citytextNoCity
gradetextNoGrade
worker_typetextNoWorker type
currencytextNoCurrency
limit_typetextNoLimit is
Allowed: per_transaction per_day per_night per_person per_trip per_month
limit_amountnumericNoLimit
enforcementtextNoEnforcement — A policy that can only refuse gets worked around; one that can only warn is ignored.
Allowed: block approve warn inform none
approver_roletextNoEscalate to role
justification_requiredbooleanNoJustification required
advance_days_requiredintegerNoBook at least (days) ahead — A flight booked two days out costs about three times one booked three weeks out.
cabin_class_allowedtextNoCabin classes allowed
flight_hours_thresholdnumericNoAbove flight hours
valid_fromdateNoFrom
valid_todateNoTo
priorityintegerNoPriority
descriptiontextNoDescription

Sample body

{
  "code": "COD-000001",
  "name": "Example",
  "expense_type": "text",
  "max_amount": "1250.00",
  "max_per_day": "1250.00",
  "requires_receipt_above": "1250.00",
  "requires_approval_above": "1250.00"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "expense_type": "text",
  "max_amount": "1250.00",
  "max_per_day": "1250.00",
  "requires_receipt_above": "1250.00",
  "requires_approval_above": "1250.00",
  "requires_pre_approval": true,
  "gl_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "guidance": "text",
  "is_active": true,
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "expense_type_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/hrms/expense-policies" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code":"COD-000001","name":"Example","expense_type":"text","max_amount":"1250.00","max_per_day":"1250.00","requires_receipt_above":"1250.00","requires_approval_above":"1250.00"}'
PUT/api/hrms/expense-policies/{id}Change a expense policies

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
codetextYesPolicy code
nametextYesName
expense_typetextYesApplies to
max_amountnumericNoMaximum for one line
max_per_daynumericNoMaximum per day
requires_receipt_abovenumericNoReceipt required above
requires_approval_abovenumericNoExtra approval above
requires_pre_approvalbooleanNoNeeds pre-approval
gl_account_iduuidNoPosts to
guidancetextNoGuidance
is_activebooleanNoActive
expense_type_iduuidNoExpense type (master)
countrytextNoCountry — Blank means any, which keeps the rule count small.
citytextNoCity
gradetextNoGrade
worker_typetextNoWorker type
currencytextNoCurrency
limit_typetextNoLimit is
Allowed: per_transaction per_day per_night per_person per_trip per_month
limit_amountnumericNoLimit
enforcementtextNoEnforcement — A policy that can only refuse gets worked around; one that can only warn is ignored.
Allowed: block approve warn inform none
approver_roletextNoEscalate to role
justification_requiredbooleanNoJustification required
advance_days_requiredintegerNoBook at least (days) ahead — A flight booked two days out costs about three times one booked three weeks out.
cabin_class_allowedtextNoCabin classes allowed
flight_hours_thresholdnumericNoAbove flight hours
valid_fromdateNoFrom
valid_todateNoTo
priorityintegerNoPriority
descriptiontextNoDescription

Sample body

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "expense_type": "text",
  "max_amount": "1250.00",
  "max_per_day": "1250.00",
  "requires_receipt_above": "1250.00",
  "requires_approval_above": "1250.00",
  "requires_pre_approval": true,
  "gl_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "guidance": "text",
  "is_active": true,
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "expense_type_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Sample request

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

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/hrms/expense-policies/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/expense-policies/{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/hrms/expense-policies/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 policies, 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, writePolicy code
nametextread, writeName
expense_typetextread, writeApplies to
max_amountnumericread, writeMaximum for one line
max_per_daynumericread, writeMaximum per day
requires_receipt_abovenumericread, writeReceipt required above
requires_approval_abovenumericread, writeExtra approval above
requires_pre_approvalbooleanread, writeNeeds pre-approval
gl_account_iduuidread, writePosts to
guidancetextread, writeGuidance
is_activebooleanread, writeActive
org_unit_iduuidread onlyOrg unit id
expense_type_iduuidread, writeExpense type (master)
countrytextread, writeCountry — Blank means any, which keeps the rule count small.
citytextread, writeCity
gradetextread, writeGrade
worker_typetextread, writeWorker type
currencytextread, writeCurrency
limit_typetextread, writeLimit is
Allowed: per_transaction per_day per_night per_person per_trip per_month
limit_amountnumericread, writeLimit
enforcementtextread, writeEnforcement — A policy that can only refuse gets worked around; one that can only warn is ignored.
Allowed: block approve warn inform none
approver_roletextread, writeEscalate to role
justification_requiredbooleanread, writeJustification required
advance_days_requiredintegerread, writeBook at least (days) ahead — A flight booked two days out costs about three times one booked three weeks out.
cabin_class_allowedtextread, writeCabin classes allowed
flight_hours_thresholdnumericread, writeAbove flight hours
valid_fromdateread, writeFrom
valid_todateread, writeTo
priorityintegerread, writePriority
descriptiontextread, writeDescription
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_attimestamp with time zoneread onlyCreated at
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 HRMS › Expense Policy 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.