Skip to main content

Payroll Export V1 Ep

POST 
/v1/payroll/export

Fetch Payroll Information

Retrieves detailed payroll information for a specified pay period, including individual payroll items and total pay earned. This endpoint supports querying by date, status, and driver identifier for precise payroll analysis and reporting.

Required Scopes (idpr)

Request​

date: datetime | None = None
The start date of the pay period to query. If not specified, defaults to the current period.

status: str | None = None
Payroll status. Valid statuses include "open", "approved", "error", and "sent".

driver_id: str | None = None
Driver Identifier. Limits the response to include only the specified driver's payroll details.

updated_after: datetime | None = None
Returns records updated after this date.


Response​

start_date: datetime
The start date of the payroll period.

payroll_configs: list[IdName]
List of payroll configurations.

Show Child Attributes

id: str
Configuration ID.

name: str
Configuration name.

driver_source_id: str
If received from integration, the identifier inside the source system.

driver_source_system: str
If received from integration, the source system name.

driver_name: str
Driver name on payroll.

end_date: datetime
End date of the payroll period.

pay_earned: float = 0
Amount of money earned during this pay period.

hours_worked: float
Hours worked by the driver during this period.

updated: datetime
Timestamp of the last update to the payroll.

status: str
The current status of the payroll. Valid statuses are "open", "approved", "error", and "sent".

detail: list
A list containing detailed payroll entries, each with the following structure and descriptions:

Show Child Attributes

payroll_config_id: str
ID of the payroll configuration.

payroll_config: str | None = None
Name of the payroll configuration.

payroll_type: str
Type of payroll entry (e.g., "regular", "overtime").

grouping: str
Used to group payroll details (e.g., by department or job role).

special_id: str | None = None
An optional unique identifier for special cases.

shift_id: str | None = None
Identifier for the shift, if applicable.

shift_start: datetime | None = None
Planned start time of the shift.

shift_actual_start: datetime | None = None
Actual start time of the shift.

shift_actual_end: datetime | None = None
Actual end time of the shift.

order_id: str | None = None
Order identifier associated with the payroll detail.

order_number: str | None = None
Order number associated with the payroll detail.

order_type: str | None = None
Type of order (e.g., "sales", "return").

pay_item_name: str
Name of the pay item (e.g., "Regular Hours").

quantity: float | None = None
Quantity of the pay item (e.g., hours worked).

override_quantity: float | None = None
Manually overridden quantity, if applicable.

unit: str
Unit of measure for the quantity (e.g., hours, pieces).

rate_type: str | None = None
Type of rate applied (e.g., "standard", "premium").

rate: float
Rate of pay.

base: float
Base amount for calculations.

total_pay: float | None = None
Total pay calculated for the payroll item.

override_total_pay: float | None = None
Manually overridden total pay, if applicable.

payload: list[str] = []
Additional data or metadata associated with the payroll item.

has_error: bool = False
Indicates whether there is an error on this payroll detail.

overridden_datetime: datetime | None
Timestamp of when a detail was overridden.

overridden_user: str | None = None
User who made an override.

adder: bool = False
Indicates whether the payroll detail is an additive item to the total pay.

note: str | None = None
Notes or comments associated with the payroll detail.

Deprecated

sent: datetime | None
Deprecated. Always null.

Responses​

Successful Response

[
  {
    "driver_name": "string",
    "driver_source_id": "string",
    "driver_source_system": "string",
    "end_date": "2025-12-17T21:49:50.595Z",
    "hours_worked": 0,
    "pay_earned": 0,
    "payroll_configs": [
      {
        "id": "string",
        "name": "string"
      }
    ],
    "start_date": "2025-12-17T21:49:50.595Z",
    "status": "string",
    "updated": "2025-12-17T21:49:50.595Z",
    "detail": [
      {
        "payroll_config_id": "string",
        "payroll_config": "string",
        "payroll_type": "string",
        "grouping": "string",
        "shift_id": "string",
        "special_id": "string",
        "shift_start": "2025-12-17T21:49:50.595Z",
        "shift_actual_start": "2025-12-17T21:49:50.595Z",
        "shift_actual_end": "2025-12-17T21:49:50.595Z",
        "order_id": "string",
        "order_number": 0,
        "order_type": "string",
        "pay_item_name": "string",
        "quantity": 0,
        "override_quantity": 0,
        "unit": "string",
        "rate_type": "string",
        "rate": 0,
        "base": 0,
        "total_pay": 0,
        "override_total_pay": 0,
        "payload": [
          "string"
        ],
        "overridden_datetime": "2025-12-17T21:49:50.595Z",
        "override_reason": "string",
        "overridden_user": "string",
        "adder": false,
        "note": "string",
        "threshold_interval": "Shift"
      }
    ]
  }
]
Loading...