Skip to main content
Payroll export documents are tenant-owned and read-only through the Public API.

Supported formats

Endpoints

List export documents

Filter metadata by tenant, type, start month, and end month.

Get export document

Read filename, media type, covered period, and timestamps.

Download export document

Download the available file by document ID.

Availability rule

fileName is nullable. When it is null, no file was produced and the client should not call the download endpoint blindly.

Contract boundary

The public contract does not define export generation, deletion, a universal generation schedule, a universal retention period, or one required polling interval.

Payroll retrieval guide

Implement metadata selection, availability checks, downloads, retries, and downstream import tracking.
Last modified on August 27, 2026