Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Remote Payslips API

The Payslips API from Remote — 4 operation(s) for payslips.

Remote Payslips API is one of 101 APIs that Remote publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Payslips. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 4 operations across 4 paths, and defines 21 schemas. It is described by OpenAPI 3.0.0, at version 0.1.0.

Requests are made against 2 base URLs: https://gateway.remote.com/, https://gateway.remote-sandbox.com/.

4 operations 4 paths 21 schemas 4 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
0.1.0
Base URL
https://gateway.remote.com/v1/
Authentication
HTTP Basic, HTTP Bearer, HTTP Bearer, OAuth 2.0, OAuth 2.0, OAuth 2.0, OAuth 2.0
Resource Areas
1

Authentication & Security 7

Remote Payslips API declares 7 security schemes for authenticating requests. It accepts HTTP basic authentication (BasicAuth). It accepts HTTP bearer tokens (ClientToken). It accepts HTTP bearer tokens (CustomerAPIToken). It supports OAuth 2.0 (OAuth2) using the authorizationCode and clientCredentials flows, exposing 77 scopes. It supports OAuth 2.0 (OAuth2Assertion) using the clientCredentials flow, exposing 21 scopes. It supports OAuth 2.0 (OAuth2AuthorizationCode) using the authorizationCode flow, exposing 73 scopes. It supports OAuth 2.0 (OAuth2ClientCredentials) using the clientCredentials flow, exposing 18 scopes. By default, every request must be authenticated.

  • BasicAuth — Authenticate using the basic authentication for partners. Use the CLIENTID as login and CLIENTSECRET as password.
  • ClientToken — Authenticate a partner using only the the provided clienttoken. This authentication method only allows accessing marketing endpoints.
  • CustomerAPIToken — Authenticate using API Key generated by the customer in their Integration Settings page.
  • OAuth2 — Authenticate using OAuth 2.0 protocol.
  • OAuth2Assertion — Authenticate as the employee using the urn:ietf:params:oauth:grant-type:jwt-bearer grant in the OAuth2 protocol.
  • OAuth2AuthorizationCode — Authenticate as the token authorizer using authorizationcode / refreshtoken grants in the OAuth 2.0 protocol.
  • OAuth2ClientCredentials — Authenticate using clientcredentials grant in the OAuth 2.0 protocol.

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 4 GET. Each is listed below with its method, path, parameters, and response codes.

Payslips 4
GET
/v1/employee/payslips
List approved payslip files for the authenticated employee
get_v1_employee_payslips 2 params → 200401403404
GET
/v1/employee/payslip-files
List payslip files for the authenticated employee
get_v1_employee_payslip-files 2 params → 200401403404
GET
/v1/payslips/{payslip_id}/pdf
Download payslip in the PDF format
get_v1_payslips_payslip_id_pdf 2 params → 200400401404422429
GET
/v1/payslips
List payslips
get_v1_payslips 7 params → 200400401404422429

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are Payslip (6 properties), PayslipFile (6 properties), PayslipItem (5 properties), PayslipFileNetSalary (5 properties). Each schema is shown below with its type and property counts.

PayslipDownloadResponse
string
The binary content of the payslip file.
ParameterError
object
3 properties 3 required
Decimal
string
A decimal number represented as a string to preserve precision. Supports negative values and fractional digits.
Date
string
UTC date in [ISO 8601](https://en.wikipedia.org/wiki/ISO8601) format
PayslipItem
object
A payslip with file, payslip, payroll run, and payroll output metadata.
5 properties 3 required
UnauthorizedResponse
object
Returned when the request does not include valid authentication credentials. Ensure you are passing a valid OAuth2 access token or API token in the Authorizati…
1 property 1 required
UnprocessableEntityResponse
object
CurrencyCode
string
Currency code of the SWIFT fee. Only present when processingfee is set.
BadRequestResponse
object
Returned when the request is malformed or contains invalid parameters. The message may be a simple string or a structured object with a code and detailed messa…
ListPayslipsResponse
object
Response schema listing many payslips
1 property
PayslipFile
object
A single payslip file with its associated payroll run metadata.
6 properties 2 required
ActionError
object
3 properties 3 required
ForbiddenResponse
object
Returned when the authenticated user or token does not have permission to perform the requested action. Check that the token has the required OAuth2 scopes and…
1 property 1 required
NotFoundResponse
object
Returned when the requested resource does not exist or is not accessible with the current authentication credentials.
1 property
ListPayslipFilesResponse
object
Response schema listing many payslipfiles
1 property
UuidSlug
string
Identifier of the employment being terminated.
PayslipFileCurrency
object
2 properties 2 required
Payslip
object
A payslip issued to an employee for a specific payroll period.
6 properties 3 required
TooManyRequestsResponse
object
Returned when the API rate limit has been exceeded (HTTP 429). Wait before retrying. Check the Retry-After response header for the recommended wait time.
1 property
PayslipFileNetSalary
object
Net salary amount including source/converted amounts, currencies and conversion rate. Shape produced by Tiger.Billing.Value.Amount.build/1.
5 properties
ListEmployeePayslipsResponse
object
Response schema listing many payslips
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

remote-payslips-api-openapi.yml Raw ↑

Other APIs Remote publishes across the network.

Remote Address Details API
Remote Administrative Details API
Remote Background Checks API
Remote Bank Account Details API
Remote Basic Information API
Remote Benefit Offers API
Remote Benefit Offers By Employment API
Remote Benefit Renewals API
Remote Benefits API
Remote Billing Address Details API
Remote Billing API
Remote Billing Documents API