List payments

get

https://sandbox.checkhq.com/payments

Query Params

payroll

string

Return all payments, including debits and credits, related to a particular payroll ID

payroll_item

string

Return payments related to a particular parent payroll_item ID

contractor_payment

string

Return payments related to a particular parent contractor payment ID

company

string

Return payments related to a particular company ID

direction

string

enum

Return payments with direction

Allowed:

amount_min

string

Return payments where amount ≥ an amount

amount_max

string

Return payments where amount ≤ an amount

type

string

enum

Return payments with type

Allowed:

completion_date_after

date

Return payments whose expected completion date is on or after the specified date

completion_date_before

date

Return payments whose expected completion date is on or before the specified date

limit

int32

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

Responses

Language

Credentials

Header

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400