Search employee advance requests

Operation ID: searchEmployeeAdvanceRequests

Group: Accounting › Employee Advances

Open in the interactive reference

POST /accounting/employee-advances/search

Read-only: A read that takes its filters in the body. Changes nothing, and ignores Idempotency-Key.

Searches employee advance requests. The filters are status, employee, legal entity, category, and request number. Each match is returned in full, newest first.

Unlike GET accounting/employee-advances, each item includes employeeName, the trip dates, notes, the decision note, and the issued payment.

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.

Request body

Required, application/json: searchEmployeeAdvanceRequestsInput.

Field Type Required Description
filters object no Search filters, nested as one object. All are optional and are ANDed; omit the whole object to match every request. Example: {"status":"pendingApproval"}.
filters.status string no Restrict to requests in this lifecycle status: draft, pendingApproval, approved, rejected or issued.
filters.employeeId string no Restrict to requests from this employee (a UUID). A uuid that matches no employee returns an empty page, not an error.
filters.entityId string no Restrict to requests in this entity (a UUID). A uuid that matches no entity returns an empty page, not an error.
filters.categoryId string no Restrict to requests drawing from this AdvancePaymentCategory (a UUID). A uuid that matches no category returns an empty page, not an error.
filters.advanceRequestNumber string no Exact match on the request's document number (ADV-...).
page object no Pagination controls. Omit for the first page. Example: {"size":50}.
page.cursor string no Opaque forward cursor from a previous response's pagination.nextCursor; omit for the first page.
page.size number no Maximum number of requests to return. Defaults to 50, capped at 200. 
{
  "filters": {
    "status": "pendingApproval"
  },
  "page": {
    "size": 50
  }
}

Response

200 Success

Under data (searchEmployeeAdvanceRequestsOutput):

Field Type Required Description
items array<object> yes Matching advance requests for this page, newest first.
items[].id string yes
items[].advanceRequestNumber string no
items[].employeeId string yes
items[].employeeName string no
items[].entityId string yes
items[].categoryId string yes
items[].amount object yes
items[].amount.amount string yes
items[].amount.currency string yes
items[].purpose string yes
items[].tripStart date no
items[].tripEnd date no
items[].notes string no
items[].status string yes
items[].requestDate date yes
items[].decisionNote string no
items[].outboundPaymentId string no
items[].outboundPaymentHeaderNumber string no
items[].outboundPaymentApplicationStatus string no
pagination object yes Pagination cursor for this page.
pagination.nextCursor string no Opaque cursor to pass as page.cursor for the next page; absent on the last page.
pagination.hasMore boolean yes True when more matches remain beyond this page. 
{
  "data": {
    "items": [
      {
        "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>"
      }
    ],
    "pagination": {
      "nextCursor": "<nextCursor>",
      "hasMore": true
    }
  },
  "diagnostics": [
    {
      "code": "<code>",
      "message": "<message>",
      "severity": "error",
      "path": [
        "<path>"
      ],
      "details": "<details>"
    }
  ]
}

Statuses