List all checks

Your Conductor secret key using Bearer auth (e.g., "Authorization: Bearer {{YOUR_SECRET_KEY}}").

The ID of the EndUser to receive this request (e.g., "Conductor-End-User-Id: {{END_USER_ID}}").

Filter for specific checks by their QuickBooks-assigned unique identifier(s).

IMPORTANT: If you include this parameter, QuickBooks will ignore all other query parameters.

Filter for specific checks by their ref-number(s), case-sensitive. In QuickBooks, ref-numbers are not required to be unique and can be arbitrarily changed by the QuickBooks user.

IMPORTANT: If you include this parameter, QuickBooks will ignore all other query parameters.

The maximum number of objects to return. Ranging from 1 to 150, defaults to 150. Use this parameter in conjunction with the cursor parameter to paginate through results. The response will include a nextCursor field, which can be used as the cursor parameter value in subsequent requests to fetch the next set of results.

The pagination token to fetch the next set of results when paginating with the limit parameter. Retrieve this value from the nextCursor field in the previous response. If omitted, the API returns the first page of results.

Filter for checks updated on or after this date and time, in ISO 8601 format (YYYY-MM-DDTHH:mm:ss). If you only provide a date (YYYY-MM-DD), the time is assumed to be 00:00:00 of that day.

Filter for checks updated on or before this date and time, in ISO 8601 format (YYYY-MM-DDTHH:mm:ss). If you only provide a date (YYYY-MM-DD), the time is assumed to be 23:59:59 of that day.

Filter for checks created on or after this date, in ISO 8601 format (YYYY-MM-DD).

Filter for checks created on or before this date, in ISO 8601 format (YYYY-MM-DD).

Filter for checks to this payee or payees. These are the people or companies who will receive these checks.

Filter for checks from this account or accounts.

Filter for checks whose refNumber contains this substring. For checks, this is the check number. NOTE: If you use this parameter, you cannot also use refNumberStartsWith or refNumberEndsWith.

Filter for checks whose refNumber starts with this substring. For checks, this is the check number. NOTE: If you use this parameter, you cannot also use refNumberContains or refNumberEndsWith.

Filter for checks whose refNumber ends with this substring. For checks, this is the check number. NOTE: If you use this parameter, you cannot also use refNumberContains or refNumberStartsWith.

Filter for checks whose refNumber is greater than or equal to this value. If omitted, the range will begin with the first number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.

Filter for checks whose refNumber is less than or equal to this value. If omitted, the range will end with the last number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.

Filter for checks in this currency or currencies.

Whether to include line items in the response. Defaults to true.

Whether to include linked transactions in the response. Defaults to false. For example, a payment linked to the corresponding check.

The type of object. This value is always "list".

The endpoint URL where this list can be accessed.

The array of checks.

The nextCursor is a pagination token returned in the response when you use the limit parameter in your request. To retrieve subsequent pages of results, include this token as the value of the cursor request parameter in your following API calls. The nextCursor value remains constant throughout the pagination process for a specific list instance; continue to use the same nextCursor token in each request to fetch additional pages.

The number of objects remaining to be fetched.

Indicates whether there are more objects to be fetched.