v1

latestOpenAPI 3.1.02026-07-242735131.1 MB

Payroll Calendars

List EOR Payroll Calendar

List all active payroll calendars for EOR.

Scopes

Category	Read only Scope	Write only Scope (read access implicit)
Manage payroll runs (payroll)	View payroll calendars (payroll_calendar:read)	-

get/v1/payroll-calendars

Query parameters

country_codestring

Filter payroll calendars by country code

yearstring

Filter payroll calendars by year

pageinteger

Starts fetching records after the given page

page_sizeinteger

Number of items per page

Response

Success

Example response

{
  "current_page": 1,
  "payroll_calendars": [
    {
      "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"
        ]
      },
      "cycle_frequency": "monthly",
      "cycles": [
        {
          "employee_inclusion_cutoff_date": "2021-01-20",
          "end_date": "2021-01-31",
          "input_cutoff_date": "2021-01-15",
          "payment_date": "2021-01-25",
          "start_date": "2021-01-01"
        }
      ],
      "id": "8f7d9b2e-3a1c-4f5d-9e8b-7c6d5a4b3f2e"
    }
  ],
  "total_count": 1,
  "total_pages": 1
}