Sign in

v1

latestOpenAPI 3.1.02026-07-242735131.1 MB
Payroll Runs

List Company Payroll Runs

Lists all payroll runs for a company

Scopes

CategoryRead only ScopeWrite only Scope (read access implicit)
Manage payroll runs (payroll)View payroll runs (payroll_run:read)-
get/v1/payroll-runs

Query parameters

payroll_periodstring date

UTC date in ISO 8601 format

Example:2021-07-01

Filters payroll runs where period_start or period_end match the given date

pageinteger

Starts fetching records after the given page

page_sizeinteger

Number of items per page

Response

Success

Example response

{
  "payroll_runs": [
    {
      "approval_date": "2021-01-15",
      "country": {
        "alpha_2_code": "PT",
        "code": "PRT",
        "contractor_products_available": [
          "standard",
          "plus",
          "cor"
        ],
        "country_subdivisions": [
          {
            "code": "PT-06",
            "name": "Coimbra",
            "subdivision_type": "District"
          },
          {
            "code": "PT-11",
            "name": "Lisboa",
            "subdivision_type": "District"
          }
        ],
        "employment_agreement_preview_available": true,
        "eor_onboarding": true,
        "locked_benefits": "after_first_hire",
        "name": "Portugal",
        "region": "Europe",
        "subregion": "Southern Europe",
        "supported_json_schemas": [
          "additional_documents",
          "address_details",
          "administrative_details",
          "employment-basic-information",
          "bank_account_details",
          "contract_details",
          "emergency_contact"
        ]
      },
      "currency_code": "USD",
      "cutoff_date": "2021-01-20",
      "expected_payout_date": "2021-01-25",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "period_end": "2021-01-31",
      "period_start": "2021-01-01",
      "status": "preparing",
      "total_payroll_cost": 1000,
      "type": "main"
    }
  ]
}