Get contractor payments for a company

get

https://api.gusto-demo.com/v1/companies/{company_id}/contractor_payments

Returns an object containing individual contractor payments, within a given time period, including totals.

scope: payrolls:read

Path Params

company_id

string

required

The UUID of the company

Query Params

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

boolean

Display contractor payments results group by check date if set to true.

page

integer

The page that is requested. When unspecified, will load all objects unless endpoint forces pagination.

per

integer

Number of objects per page. For majority of endpoints will default to 25

Headers

X-Gusto-API-Version

string

enum

Defaults to 2024-03-01

Determines the date-based API version associated with your API call. If none is provided, your application's minimum API version is used.

Allowed:

Responses

404

Not Found

The requested resource does not exist. Make sure the provided UUID is valid.

200A JSON object containing contractor payments information