Retrieve an employee advance request

Operation ID: getEmployeeAdvanceRequest

Group: Accounting › Employee Advances

Open in the interactive reference

GET /accounting/employee-advances/{id}

Read-only: Reads and returns; changes nothing.

Retrieves an employee advance request. Use the request's id, not its advanceRequestNumber.

The response has the request's amount, status, and the approver's decision note. Once the request has been issued, it also has the payment made for it.

POST accounting/employee-advances/search returns the same fields for each request.

Parameters

Name In Type Required Description
Api-Version header string · v1 yes The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version v1.
id path string yes Id of the advance request to fetch (a UUID); bound from the :id path segment. Example: "b81f4a22-6d90-4c53-8e17-9f2a4b6c8d05".

Response

200 Success

Under data (getEmployeeAdvanceRequestOutput):

Field Type Required Description
id string yes Id of the advance request (a UUID).
advanceRequestNumber string no System-generated document number (ADV-...).
employeeId string yes Id (a UUID) of the requesting employee.
employeeName string no Display name of the requesting employee.
entityId string yes Id (a UUID) of the entity the request belongs to.
categoryId string yes Id (a UUID) of the AdvancePaymentCategory this request draws from.
amount object yes Requested amount: the total of the request's purpose lines.
amount.amount string yes
amount.currency string yes
purpose string yes What the advance is for. A request split across several purposes lists them comma-separated, e.g. 'Travel, Per Diem'.
tripStart date no First day of the trip the advance covers.
tripEnd date no Last day of the trip the advance covers.
notes string no Free-text notes from the requester.
status string yes Lifecycle status: draft, pendingApproval, approved, rejected or issued.
requestDate date yes Date the request was submitted.
decisionNote string no Approver note recorded on approval or rejection.
outboundPaymentId string no Id (a UUID) of the OutboundPaymentHeaderBase created when this request was issued, if any.
outboundPaymentHeaderNumber string no Document number of the issued payment, if any.
outboundPaymentApplicationStatus string no Application status of the issued payment (unapplied/partiallyApplied/applied), if any. 
{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "advanceRequestNumber": "<advanceRequestNumber>",
    "employeeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "employeeName": "<employeeName>",
    "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "categoryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "amount": {
      "amount": "<amount>",
      "currency": "<currency>"
    },
    "purpose": "<purpose>",
    "tripStart": "2026-01-15",
    "tripEnd": "2026-01-15",
    "notes": "<notes>",
    "status": "<status>",
    "requestDate": "2026-01-15",
    "decisionNote": "<decisionNote>",
    "outboundPaymentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "outboundPaymentHeaderNumber": "<outboundPaymentHeaderNumber>",
    "outboundPaymentApplicationStatus": "<outboundPaymentApplicationStatus>"
  },
  "diagnostics": [
    {
      "code": "<code>",
      "message": "<message>",
      "severity": "error",
      "path": [
        "<path>"
      ],
      "details": "<details>"
    }
  ]
}

Errors

Code Status
NOT_FOUND 400

Statuses