TRANXACT.AI Help

HRMS · Trips & Expense Reports

Expense Reports

Every line is checked against the policy for its type on submission, and the breach is named on the line — which rule, and by how much.

Type REST12 operationsBase path /api/hrms/expense-reportsPublished as /api/v1/expense-reports

Download specification (OpenAPI 3.1) Screen: Expense Reports

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 Reports 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_reports · 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

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

GET/api/hrms/expense-reportsList expense reports

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",
      "report_no": "REP-000001",
      "employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "travel_request_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "title": "Example",
      "period_start": "2026-10-30",
      "period_end": "2026-10-30",
      "currency": "USD",
      "total_amount": "1250.00",
      "reimbursable": "1250.00",
      "company_paid": "1250.00",
      "advance_applied": "1250.00",
      "violation_count": 10,
      "cost_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
    }
  ],
  "count": 1
}

Sample request

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

Path parameters

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "report_no": "REP-000001",
  "employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "travel_request_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "title": "Example",
  "period_start": "2026-10-30",
  "period_end": "2026-10-30",
  "currency": "USD",
  "total_amount": "1250.00",
  "reimbursable": "1250.00",
  "company_paid": "1250.00",
  "advance_applied": "1250.00",
  "violation_count": 10,
  "cost_center_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-reports/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/expense-reportsCreate a expense reports

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
employee_iduuidNoClaimant
travel_request_iduuidNoAgainst travel request
titletextYesTitle
period_startdateNoFrom
period_enddateNoTo
currencytextNoCurrency
advance_appliednumericNoAdvance applied — Set by Accounting when the advance is settled, and taken off what is reimbursed.
cost_center_iduuidNoCost center
claimant_iduuidNoSubmitted by
submitted_on_behalfbooleanNoOn somebody else’s behalf — Normal for executives, and exactly the case a control framework asks about.
project_iduuidNoProject
wbs_element_iduuidNoWork package
period_codetextNoAccounting period
notestextNoNotes

Sample body

{
  "title": "Example",
  "employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "travel_request_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "period_start": "2026-10-30",
  "period_end": "2026-10-30"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "report_no": "REP-000001",
  "employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "travel_request_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "title": "Example",
  "period_start": "2026-10-30",
  "period_end": "2026-10-30",
  "currency": "USD",
  "total_amount": "1250.00",
  "reimbursable": "1250.00",
  "company_paid": "1250.00",
  "advance_applied": "1250.00",
  "violation_count": 10,
  "cost_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/hrms/expense-reports" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"title":"Example","employee_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","travel_request_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","period_start":"2026-10-30","period_end":"2026-10-30"}'
PUT/api/hrms/expense-reports/{id}Change a expense reports

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
employee_iduuidNoClaimant
travel_request_iduuidNoAgainst travel request
titletextYesTitle
period_startdateNoFrom
period_enddateNoTo
currencytextNoCurrency
advance_appliednumericNoAdvance applied — Set by Accounting when the advance is settled, and taken off what is reimbursed.
cost_center_iduuidNoCost center
claimant_iduuidNoSubmitted by
submitted_on_behalfbooleanNoOn somebody else’s behalf — Normal for executives, and exactly the case a control framework asks about.
project_iduuidNoProject
wbs_element_iduuidNoWork package
period_codetextNoAccounting period
notestextNoNotes

Sample body

{
  "title": "Example",
  "employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "report_no": "REP-000001",
  "employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "travel_request_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "title": "Example",
  "period_start": "2026-10-30",
  "period_end": "2026-10-30",
  "currency": "USD",
  "total_amount": "1250.00",
  "reimbursable": "1250.00",
  "company_paid": "1250.00",
  "advance_applied": "1250.00",
  "violation_count": 10,
  "cost_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Sample request

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

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

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

acknowledge

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-reports/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/submit" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"acknowledge":"value"}'
POST/api/hrms/expense-reports/{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):

acknowledge, accepted, reason

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-reports/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/approve" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"acknowledge":"value","accepted":"value","reason":"value"}'
GET/api/hrms/expense-reports/{parentId}/linesLines

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/hrms/expense-reports/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/expense-reports/{parentId}/linesLines

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, 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/hrms/expense-reports/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines" \
  -H "Authorization: Bearer $TOKEN"
PUT/api/hrms/expense-reports/{parentId}/lines/{lineId}Lines

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (uuid)The record's lineId, 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/hrms/expense-reports/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/hrms/expense-reports/{parentId}/lines/{lineId}Lines

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (uuid)The record's lineId, 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/hrms/expense-reports/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"

Data model

Every field of a expense reports, 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
report_notextread onlyReport no
employee_iduuidread, writeClaimant
travel_request_iduuidread, writeAgainst travel request
titletextread, writeTitle
period_startdateread, writeFrom
period_enddateread, writeTo
currencytextread, writeCurrency
total_amountnumericread onlyTotal amount
reimbursablenumericread onlyReimbursable
company_paidnumericread onlyCompany paid
advance_appliednumericread, writeAdvance applied — Set by Accounting when the advance is settled, and taken off what is reimbursed.
violation_countintegerread onlyViolation count
cost_center_iduuidread, writeCost center
statustextread onlyStatus
submitted_attimestamp with time zoneread onlySubmitted at
approved_byuuidread onlyApproved by
approved_attimestamp with time zoneread onlyApproved at
rejection_reasontextread onlyRejection reason
journal_iduuidread onlyJournal id
created_attimestamp with time zoneread onlyCreated at
org_unit_iduuidread onlyOrg unit id
claimant_iduuidread, writeSubmitted by
submitted_on_behalfbooleanread, writeOn somebody else’s behalf — Normal for executives, and exactly the case a control framework asks about.
project_iduuidread, writeProject
wbs_element_iduuidread, writeWork package
period_codetextread, writeAccounting period
total_approvednumericread onlyTotal approved
due_to_companynumericread onlyDue to company
tax_reclaimablenumericread onlyTax reclaimable
billable_amountnumericread onlyBillable amount
audit_statustextread onlyAudit status
audit_reasontextread onlyAudit reason
auditor_iduuidread onlyAuditor id
audited_attimestamp with time zoneread onlyAudited at
audit_findingstextread onlyAudit findings
risk_scorenumericread onlyRisk score
policy_violationsjsonbread onlyPolicy violations
ap_invoice_iduuidread onlyAp invoice id
ap_payment_iduuidread onlyAp payment id
payroll_run_iduuidread onlyPayroll run id
paid_attimestamp with time zoneread onlyPaid at
notestextread, writeNotes
exchange_ratenumericread onlyExchange rate
base_total_amountnumericread onlyBase total amount
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 HRMS › Expense Reports 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.