Payroll Runs
List Company Payroll Runs
Lists all payroll runs for a company
Scopes
| Category | Read only Scope | Write only Scope (read access implicit) |
|---|---|---|
| Manage payroll runs (payroll) | View payroll runs (payroll_run:read) | - |
get/v1/payroll-runs
Request
- Base URL: https://gateway.remote.com
- URL: https://gateway.remote.com/v1/payroll-runs
- 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_run:read, payroll, all:write, all:read)
Query parameters
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"
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.