TRANXACT.AI Help

Accounting · Services and actions

Expenses

The expenses service of Accounting: 10 operation(s).

Type REST10 operationsBase path /api/accounting/expenses

Download specification (OpenAPI 3.1)

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 › Expenses 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.
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

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

POST/api/accounting/expenses/compute/per-diemCompute per diem

Request body

The keys this action reads (* = required; "one of" lists the only values):

country, city, grade, fromDate*, toDate, mealsProvided

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/expenses/compute/per-diem" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"country":"value","city":"value","grade":"value","fromDate":"value","toDate":"value","mealsProvided":"value"}'
POST/api/accounting/expenses/compute/mileageCompute mileage

Request body

The keys this action reads (* = required; "one of" lists the only values):

country, distance, distanceUnit, vehicleType, grade, date, yearToDateDistance

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/expenses/compute/mileage" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"country":"value","distance":"value","distanceUnit":"value","vehicleType":"value","grade":"value","date":"value"}'
POST/api/accounting/expenses/reports/{id}/check-policyReports check policy

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/expenses/reports/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/check-policy" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/expenses/reports/{id}/compute-taxReports compute tax

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/expenses/reports/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/compute-tax" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/expenses/reports/{id}/adjudicateReports adjudicate

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

lineAdjustments*: [{ reason, lineNo, amount }]

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/expenses/reports/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/adjudicate" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"lineAdjustments":"value","lineNo":"value","amount":"value"}'
POST/api/accounting/expenses/reports/{id}/settle-advanceReports settle advance

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/expenses/reports/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/settle-advance" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/expenses/reports/{id}/reimburseReports reimburse

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

via, bankAccountNo, payableAccountNo, payrollRunId, paidOn; via one of bank|payroll

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/expenses/reports/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/reimburse" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"via":"value","bankAccountNo":"value","payableAccountNo":"value","payrollRunId":"value","paidOn;":"value"}'
POST/api/accounting/expenses/audit/selectAudit select

Request body

The keys this action reads (* = required; "one of" lists the only values):

threshold, randomSamplePct

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/expenses/audit/select" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"threshold":"value","randomSamplePct":"value"}'
POST/api/accounting/expenses/reports/{id}/auditReports audit

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

outcome, findings; outcome one of clean|queried|adjusted|referred

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/expenses/reports/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/audit" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"outcome":"value","findings;":"value"}'
POST/api/accounting/expenses/receipts/{id}/matchReceipts match

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

tolerance, dayWindow

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/expenses/receipts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/match" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"tolerance":"value","dayWindow":"value"}'

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