Get contractor payment groups for a company
GET {{baseUrl}}/v1/companies/:company_id/contractor_payment_groups?start_date=<string>&end_date=<string>&page=<number>&per=<number>
Returns a list of minimal contractor payment groups within a given time period, including totals but not associated contractor payments.
scope: payrolls:read
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
start_date | string | The time period for which to retrieve contractor payment groups. Defaults to 6 months ago. | |
end_date | string | The time period for which to retrieve contractor payment groups. Defaults to today's date. | |
page | string | The page that is requested. When unspecified, will load all objects unless endpoint forces pagination. | |
per | string | Number of objects per page. For majority of endpoints will default to 25 |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
X-Gusto-API-Version | string | Determines the date-based API version associated with your API call. If none is provided, your application's minimum API version is used. | |
Accept | string |
RESPONSES
status: OK
[{"uuid":"7f2337f9-9b78-44b9-aeed-be4777b833a8","company_uuid":"c54046f7-1be4-4c54-8194-f4842c30c86d","check_date":"2024-03-15","debit_date":"2024-03-11","status":"Funded","creation_token":"a51a3500-3200-43af-a738-169d4b66a9db","totals":{"debit_amount":"740.00","wage_amount":"720.00","reimbursement_amount":"20.00"}},{"uuid":"56260b3d-c375-415c-b77a-75d99f717193","company_uuid":"c54046f7-1be4-4c54-8194-f4842c30c86d","check_date":"2024-05-02","debit_date":"2024-04-26","status":"Unfunded","creation_token":"45ef81bb-ae24-4ad1-b2c6-6e563a4c30ed","totals":{"debit_amount":"2365.00","wage_amount":"2270.00","reimbursement_amount":"95.00"}}]