Get Contractor Payments
Retrieve a contractor payment by contractorPaymentID, or list payments for a company, optionally filtered by contractorID.
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
Query Parameters
Company ID of the employer
ID of the contractor payment to retrieve. When present, the endpoint returns that single payment and list filters (contractorID, status, paymentGroupID) are ignored.
When listing payments (omit contractorPaymentID), filter to this contractor. Ignored when contractorPaymentID is present.
Filter by status of contractor payment. Provide one of the following statuses: pending, pre-processed, processed
pending, pre-processed, processed Filter by contractor payment group
The pagination cursor to start at
Limit the amount of data returned
Response
200