List compensations.

Returns a list of payroll compensations of people for an authorized company. Compensations listed include base salary (excluding proration), hourly, one time compensation, recurring compensation, and bonuses.

Query Params
date

A start date from which compensations are run. The duration (end_date - start_date) must be equal to or smaller than a month. The format is ISO-8601. Default is the first day of the current month in case end_date is not provided, or the first day of the month of the provided end_date.

date

An end date to which compensations are run. The duration (end_date - start_date) must be equal or smaller than a month. Format is ISO-8601. Default is the last day of the current month in case start_date is not provided, or the last day of the month of the provided start_date.

string

Filter results matching one or more provided person ids that belong to the company.

string
number
1 to 100

The amount of resources to be returned per one request. It can range between 1 and 100, and the default is 100.

string

The pagination cursor to navigate over to the next list of resources. If you pass a specific limit to your request, or you rely on the default value of the number of resources to be returned, then your subsequent call has to include the cursor in order to retrieve the next list of resources. If cursor is missing, the first page is returned.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Bearer
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json