CHcheckhq

List contractor payments

Changed on

Returns a list of payments for the specified contractor from approved, managed payrolls. Payments on draft payrolls and on external payrolls are omitted. For external payroll contractor payments, use List external payrolls.

get/contractors/{contractor}/payments

Request

Path parameters

contractorstring required

ID of the contractor to return payments for

Query parameters

payrollstring

Return payments for the payroll specified by this payroll ID.

limitinteger

Number of payments returned per page. The maximum value is 25.

statusstring

Filters to only show payments for payrolls with the specified status. If multiple status params are provided, payments with any of the statuses will be returned. Accepted values are pending, processing, failed, or paid.

startstring date

Return payments from payrolls with a payday on or after this date (YYYY-MM-DD)

endstring date

Return payments from payrolls with a payday on or before this date (YYYY-MM-DD)

Response

200

Changes

  • 5a54f5eb888bRevision changes
    • info

      added the new optional query request parameter end

    • info

      added the new optional query request parameter start