Skip to main content
GET
Get Contractor Payments
This endpoint serves two usages on the same path. Pass companyID and contractorPaymentID to retrieve a single contractor payment. Omit contractorPaymentID to list payments for a company; you can optionally pass contractorID (and status or paymentGroupID) to filter that list. When contractorPaymentID is present, list filters such as contractorID are ignored.

Returns

Returns response status and the contractor payment (or a paginated list of contractor payments).

Authorizations

Authorization
string
header
required

Query Parameters

companyID
string
required

Company ID of the employer

contractorPaymentID
string

ID of the contractor payment to retrieve. When present, the endpoint returns that single payment and list filters (contractorID, status, paymentGroupID) are ignored.

contractorID
string

When listing payments (omit contractorPaymentID), filter to this contractor. Ignored when contractorPaymentID is present.

status
enum<string>

Filter by status of contractor payment. Provide one of the following statuses: pending, pre-processed, processed

Available options:
pending,
pre-processed,
processed
paymentGroupID
string

Filter by contractor payment group

start_at
string

The pagination cursor to start at

limit
string

Limit the amount of data returned

Response

200