Skip to main content

Special Pay Request Overview Ep

POST 
/v1/payroll/special_pay_request/overview

Special Pay Request Overview

Retrieve special pay requests for a set of orders. Accepts either order numbers or order IDs — if order IDs are provided, the corresponding order numbers are resolved automatically.

Required Scopes (idpr)

Request​

status: SpecialPayStatus | None = None
Filter results by special pay request status. If not specified, returns all statuses.

order_numbers: list[int] | None = None
List of order numbers to retrieve special pay requests for. Either this or order_ids must be provided.

order_ids: list[str] | None = None
List of order IDs to retrieve special pay requests for. Either this or order_numbers must be provided.


Response​

Returns a list of special pay request objects, each containing:

id: str | None
Internal identifier for the special pay request.

driver_id: str | None
Identifier of the driver associated with the request.

driver_name: str | None
Name of the driver.

date: datetime | None
Date when the special pay was earned.

pay_name: str | None
Name of the special pay type.

rate: float | None
Pay rate for the special pay item.

unit: str | None
Unit of measurement for the rate.

quantity: float
Quantity or amount for the special pay item.

status: str
Current status of the special pay request.

driver_schedule_id: str | None
Identifier of the associated driver shift.

created_by: str | None
User who created the request.

created_on: datetime | None
Timestamp when the request was created.

approved_by: str | None
User who approved the request.

approved_on: datetime | None
Timestamp when the request was approved.

updated_by: str | None
User who last updated the request.

updated_on: datetime | None
Timestamp when the request was last updated.

extra_fields: list[SpecialPayExtraFieldView]
Additional custom fields configured for the special pay type.

note: str | None
Optional note or description.

note_updated_by: str | None
User who last updated the note.

note_updated_on: datetime | None
Timestamp when the note was last updated.

order_number: str | None
Associated order number.

site_ids: list[str] | None
Associated site/location IDs.

actions: list[SpecialPayRequestAction]
Available actions for the request based on current status and permissions.

Responses​

Successful Response

[
  {
    "id": "string",
    "driver_id": "string",
    "driver_name": "string",
    "date": "2026-03-19T20:39:32.926Z",
    "pay_name": "string",
    "rate": 0,
    "unit": "string",
    "quantity": 0,
    "status": "string",
    "driver_schedule_id": "string",
    "created_by": "string",
    "created_on": "2026-03-19T20:39:32.926Z",
    "approved_by": "string",
    "approved_on": "2026-03-19T20:39:32.926Z",
    "updated_by": "string",
    "updated_on": "2026-03-19T20:39:32.927Z",
    "extra_fields": [
      {
        "id": "string",
        "name": "string",
        "type": "string",
        "payload": {}
      }
    ],
    "note": "string",
    "note_updated_by": "string",
    "note_updated_on": "2026-03-19T20:39:32.927Z",
    "order_number": "string",
    "site_ids": [
      "string"
    ],
    "actions": [
      {
        "status": "string",
        "username": "string",
        "date": "2026-03-19T20:39:32.927Z",
        "reason": "string"
      }
    ],
    "fli_id": "string",
    "fli_out_of_sync": true
  }
]
Loading...