Pay & Compensation
Payroll Calendars
List Company Payroll Calendar
Changed onList all payroll calendars for the company within the requested cycle.
Authentication
This endpoint accepts any one of the following token types:
- Company-scoped access token (OAuth2AuthorizationCode) — obtained through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
- Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page. See Authorization for customers.
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/{cycle}
Request
- Base URL: https://gateway.remote.com
- URL: https://gateway.remote.com/v1/payroll-calendars/{cycle}
- Auth: HTTP bearer and OAuth 2 (authorization code, authorization URL /auth/oauth2/authorize, token URL /auth/oauth2/token, scopes: https://gateway.remote.com/company.manage, payroll_calendar:read, payroll, all:write, all:read)
Path parameters
cyclestring required
The cycle for which to list the payroll calendars. Format: YYYY-MM
Query parameters
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,
"global_payroll_supported": 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"
}
],
"owned_by_remote": true
}
],
"total_count": 1,
"total_pages": 1
}Changes
- info
added the optional property
////to the response with the status
- info