Skip to navigation
Pay Setup Recurring Earnings

Get Employee Earnings [Batch]

View as Markdown

Summary Description

This function will allow the API user to GET a list of all active earnings associated with the employee record.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

companyIdstringRequired
employeeIdstringRequired

Headers

testModestringOptional
If true all responses are mocked and generated randomly
AcceptstringOptional

Query parameters

filterstringOptional

The API Filter, by defining specific conditions, enables developers to fine-tune data from API calls for more precise results, enhancing application efficiency and user-friendliness. For more information review the Filtering page

limitintegerOptional

Number of results per page. Default Value: 250 Maximum Value: 250

offsetintegerOptional
Pagination offset

Response

Successful response