TRANXACT.AI Help

HRMS · Trips & Expense Reports

Per Diem Rates

Lodging, meals and incidentals by destination.

Type REST6 operationsBase path /api/hrms/per-diem-ratesPublished as /api/v1/per-diem-rates

Download specification (OpenAPI 3.1) Screen: Per Diem Rates

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 › Per Diem Rates 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.per_diem_rates · 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/per-diem-ratesList per diem rates

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",
      "country": "US",
      "city": "text",
      "currency": "USD",
      "lodging": "1250.00",
      "meals": "1250.00",
      "incidentals": "1250.00",
      "valid_from": "2026-10-30",
      "valid_to": "2026-10-30",
      "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "code": "COD-000001",
      "name": "Example",
      "region": "text",
      "grade": "text"
    }
  ],
  "count": 1
}

Sample request

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

Path parameters

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "country": "US",
  "city": "text",
  "currency": "USD",
  "lodging": "1250.00",
  "meals": "1250.00",
  "incidentals": "1250.00",
  "valid_from": "2026-10-30",
  "valid_to": "2026-10-30",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "region": "text",
  "grade": "text"
}

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

Sample request

curl "https://demo.tranxact.ai/api/hrms/per-diem-rates/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/per-diem-ratesCreate a per diem rates

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
countrytextNoCountry
citytextNoCity — Leave blank for the country default.
currencytextNoCurrency
lodgingnumericNoLodging
mealsnumericNoMeals
incidentalsnumericNoIncidentals
valid_fromdateNoValid from
valid_todateNoValid to
codetextNoCode
nametextNoName
regiontextNoRegion
gradetextNoGrade
breakfast_deduction_pctnumericNoBreakfast provided, deduct % — Taken off the meals component, not the whole rate: a conference that fed everybody lunch does not reduce the hotel.
lunch_deduction_pctnumericNoLunch provided, deduct %
dinner_deduction_pctnumericNoDinner provided, deduct %
first_last_day_pctnumericNoFirst and last day %
tax_free_limitnumericNoTax-free ceiling — Above it, a per diem is a benefit in kind and has to reach payroll.
sourcetextNoPublished by
is_activebooleanNoActive

Sample body

{
  "country": "US",
  "city": "text",
  "currency": "USD",
  "lodging": "1250.00"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "country": "US",
  "city": "text",
  "currency": "USD",
  "lodging": "1250.00",
  "meals": "1250.00",
  "incidentals": "1250.00",
  "valid_from": "2026-10-30",
  "valid_to": "2026-10-30",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "region": "text",
  "grade": "text"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/hrms/per-diem-rates" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"country":"US","city":"text","currency":"USD","lodging":"1250.00"}'
PUT/api/hrms/per-diem-rates/{id}Change a per diem rates

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
countrytextNoCountry
citytextNoCity — Leave blank for the country default.
currencytextNoCurrency
lodgingnumericNoLodging
mealsnumericNoMeals
incidentalsnumericNoIncidentals
valid_fromdateNoValid from
valid_todateNoValid to
codetextNoCode
nametextNoName
regiontextNoRegion
gradetextNoGrade
breakfast_deduction_pctnumericNoBreakfast provided, deduct % — Taken off the meals component, not the whole rate: a conference that fed everybody lunch does not reduce the hotel.
lunch_deduction_pctnumericNoLunch provided, deduct %
dinner_deduction_pctnumericNoDinner provided, deduct %
first_last_day_pctnumericNoFirst and last day %
tax_free_limitnumericNoTax-free ceiling — Above it, a per diem is a benefit in kind and has to reach payroll.
sourcetextNoPublished by
is_activebooleanNoActive

Sample body

{
  "country": "US",
  "city": "text"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "country": "US",
  "city": "text",
  "currency": "USD",
  "lodging": "1250.00",
  "meals": "1250.00",
  "incidentals": "1250.00",
  "valid_from": "2026-10-30",
  "valid_to": "2026-10-30",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "region": "text",
  "grade": "text"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/hrms/per-diem-rates/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"country":"US","city":"text"}'
DELETE/api/hrms/per-diem-rates/{id}Delete a per diem rates

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/per-diem-rates/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/per-diem-rates/{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/per-diem-rates/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 per diem rates, 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
countrytextread, writeCountry
citytextread, writeCity — Leave blank for the country default.
currencytextread, writeCurrency
lodgingnumericread, writeLodging
mealsnumericread, writeMeals
incidentalsnumericread, writeIncidentals
valid_fromdateread, writeValid from
valid_todateread, writeValid to
org_unit_iduuidread onlyOrg unit id
codetextread, writeCode
nametextread, writeName
regiontextread, writeRegion
gradetextread, writeGrade
breakfast_deduction_pctnumericread, writeBreakfast provided, deduct % — Taken off the meals component, not the whole rate: a conference that fed everybody lunch does not reduce the hotel.
lunch_deduction_pctnumericread, writeLunch provided, deduct %
dinner_deduction_pctnumericread, writeDinner provided, deduct %
first_last_day_pctnumericread, writeFirst and last day %
tax_free_limitnumericread, writeTax-free ceiling — Above it, a per diem is a benefit in kind and has to reach payroll.
sourcetextread, writePublished by
is_activebooleanread, writeActive
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 › Per Diem Rates 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.