Skip to main content

Payroll Export File Ep

GET 
/v1/payroll/export_file

Payroll Export File V1 Endpoint - Export Payroll Data to Excel

Exports payroll data to an Excel file, providing comprehensive payroll details for drivers over specified periods. This feature is essential for payroll analysis, record-keeping, and processing.


Request​

date: datetime | None
The specific date for which payroll data is requested. If not provided, the system defaults to the most recent payroll period.

download_format: str | None = None
The format of the downloaded file, allowing users to specify the version or format of the Excel file (e.g., .xlsx or .xls). If not provided, the system defaults to a standard format.


Response​

Payroll excel file export: An Excel file containing detailed payroll information structured into the following columns:

  • driver_name: Name of the driver.
  • driver_source_id: Unique identifier of the driver in the source system.
  • period_start_date: Start date of the pay period.
  • period_end_date: End date of the pay period.
  • period_hours_worked: Total hours worked by the driver in the pay period.
  • period_pay_earned: Total pay earned by the driver in the pay period.
  • payroll_config: Payroll configuration applied to the pay period.
  • period_status: Status of the pay period (e.g., open, approved, error).
  • period_last_updated: Timestamp when the pay period was last updated.
  • shift_start: Scheduled start time of the driver's shift.
  • shift_actual_start: Actual start time of the driver's shift.
  • shift_actual_end: Actual end time of the driver's shift.
  • payroll_type: Type of payroll item (e.g., regular, overtime).
  • grouping: Category or grouping of the payroll item.
  • order_number: Order number associated with the payroll item.
  • pay_item_name: Name of the pay item.
  • special_pay_override: Indicates if there is a special pay override.
  • quantity: Quantity for the payroll item (e.g., hours worked, miles driven).
  • rate: Pay rate for the payroll item.
  • total_pay: Total pay calculated for the payroll item.
  • overridden_datetime: Timestamp when any override was applied to the payroll item.
  • overridden_user: User who applied an override to the payroll item.
  • adder: Indicates if the payroll item is an additive.
  • auto_pay_overwrite: Indicates if there is an automatic pay overwrite.
  • override_reason: Reason for any pay override.
  • original_quantity: Original quantity before any overrides.
  • override_quantity: Overridden quantity.
  • original_shift_actual_start: Original actual start time of the shift before any overrides.
  • override_shift_actual_start: Overridden actual start time of the shift.
  • original_shift_actual_end: Original actual end time of the shift before any overrides.
  • override_shift_actual_end: Overridden actual end time of the shift.
  • driver_id: Unique identifier of the driver.
  • shift_id: Unique identifier of the shift.
  • driver_source_system: Source system of the driver information.
  • order_id: Unique identifier of the order associated with the payroll item.
  • base: Base amount for the payroll calculation.
  • unit: Unit of measurement for the payroll item (e.g., hours, miles).
  • note: Any notes or comments associated with the payroll item.
  • tractor_number: Tractor number assigned to the driver.

Responses​

Successful Response

Loading...