Search check queue

get

https://{tenant}.onechurchsoftware.com/api/checks/queue

Retrieve the check payments queued for printing (or already printed) from a register account, most recent first.

Required permission: Full Read Accounting

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

int32

required

≥ 1

The id of the register (bank) account whose check queue to return.

pending

boolean

If true, returns only checks still waiting to print; if false, only checks already printed.

memo

string

Return checks whose memo contains the given text.

payee

int32

≥ 1

The id of a payee (person or business). Returns checks paid to that payee.

reference

string

Return checks whose check number contains the given text.

date.start

date

Return checks dated on or after this date.

date.end

date

Return checks dated on or before this date.

amount.start

double

Return checks of at least this amount.

amount.end

double

Return checks of at most this amount.

status

string

Comma-delimited list of status ids or codes (je_status_draft, je_status_posted, je_status_voided).

skip

int32

≥ 0

The number of records to skip before returning results, used for paging.

limit

int32

≥ 0

The maximum number of records to return per page. Defaults to 50.

sort.property

string

The field to sort the results by. The default field depends on the endpoint.

sort.dir

string

enum

The sort direction: "asc" or "desc".

Allowed:

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

Authentication is required, or the Ocs-Api-Key header is missing or invalid.

200OK