Reimbursements

Lists all reimbursements

Changed on

Surfaces reimbursement requests created from approved charges or manual submissions, including subsidiary and freshness filters for payroll sync. Use pagination cursors for large populations and pair with retrieve-a-reimbursement when a row needs detailed audit context.

get/reimbursements

Request

Query parameters

limitinteger

Maximum number of rows to return in the page.

cursorstring

If defined, a cursor to retrieve the next page.

Example:iLQvkEj3sh3UiweC

Pagination cursor to navigate through the full response.

subsidiary_idstring uuid

Subsidiary to be used when filtering data

updated.gtstring date-time
Example:2023-01-01T00:00:00Z

Filter reimbursements updated after this timestamp

Response

OK

Example response

{
  "reimbursements": [
    {
      "items": [
        {
          "description": "API Reimbursement",
          "account_code": "11112",
          "amount": {
            "amount": "1.01",
            "currency": "USD"
          },
          "tax_rate": {
            "percentage": "0",
            "tax_amount": {
              "amount": "1.01",
              "currency": "USD"
            },
            "country": "US"
          }
        }
      ],
      "external_references": [
        {
          "type": "xyzSystemId",
          "id": "234",
          "url": "https://xyzsystempage.com/ids/234"
        }
      ],
      "exchange_rate": {
        "base": "USD",
        "target": "USD"
      }
    }
  ],
  "pagination": {
    "next_cursor": "iLQvkEj3sh3UiweC"
  }
}

Changes

    • breaking

      the ///////////////// response's property type changed from number to string, and format from no format to number for status

    • breaking

      the ////////////////// response's property type changed from number to string, and format from no format to number for status

    • warning

      added the new DRAFT enum value to the /// response property for the response status

    • info

      added the optional property /// to the response with the status