Skip to main content
Reimbursement Details API

Authentication

All requests require an API key in the request headers. Headers:

Request

Path Parameters

Code Examples

Success Response

HTTP Status: 200 OK Response Fields:

Response Example

Error Responses

Authentication and permission failures are returned in the standard structured format shown below. Business-logic errors (such as the reimbursement not being found or access being denied) are returned with an HTTP 200 OK status and a string error message: { "ok": false, "error": "<message>" }.

Reimbursement Not Found

HTTP Status: 200 OK

Access Denied

HTTP Status: 200 OK

Authentication Errors

HTTP Status: 401 Unauthorized

Permission Errors

HTTP Status: 403 Forbidden

Best Practices

  • Use the id returned by the Reimbursement List API as the reimbursementId path parameter
  • trip is only present on MILEAGE items that have an associated trip; distance is reported in meters with an m suffix
  • Always check the ok flag in the response body in addition to the HTTP status code, since business-logic errors are returned with an HTTP 200 OK status
  • Access is limited to users with reimbursement read permission and an admin or bookkeeper role