Get contractor payments for a company
GET {{baseUrl}}/v1/companies/:company_id/contractor_payments?start_date=<string>&end_date=<string>&contractor_uuid=<string>&group_by_date=<boolean>&page=<number>&per=<number>
Returns an object containing individual contractor payments, within a given time period, including totals.
scope: payrolls:read
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
start_date | string | (Required) The time period for which to retrieve contractor payments | |
end_date | string | (Required) The time period for which to retrieve contractor payments. If left empty, defaults to today's date. | |
contractor_uuid | string | The UUID of the contractor. When specified, will load all payments for that contractor. | |
group_by_date | string | Display contractor payments results group by check date if set to true. | |
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
{"total":{"reimbursements":"110.0","wages":"1840.0"},"contractor_payments":[{"contractor_id":1234,"reimbursement_total":"110.0","wage_total":"1840.0","payments":[{"id":"04552eb9-7829-4b18-ae96-6983552948df","bonus":"20.0","date":"2020-10-19","hours":"40.0","payment_method":"Direct Deposit","reimbursement":"100.0","hourly_rate":"18.0","may_cancel":true,"wage":"0.0","wage_type":"Hourly","wage_total":"740.00","contractor_id":1234,"contractor_uuid":"bc57832c-d8bc-43a7-ae99-3a03380ff037"},{"id":"25cfeb96-17fc-4fdf-8941-57f3fb9eea00","bonus":"100.0","date":"2020-10-19","hours":"0.00","payment_method":"Direct Deposit","reimbursement":"10.0","hourly_rate":"0.0","may_cancel":true,"wage":"1000.0","wage_type":"Fixed","wage_total":"1100.0","contractor_id":1234,"contractor_uuid":"bc57832c-d8bc-43a7-ae99-3a03380ff037"}]}]}