# List Checks

Lists all Checks

Endpoint: GET /checks
Version: v1
Security: apiKeyAuth, bearerAuth

## Header parameters:

  - `vbasoftware-database` (string, required)
    Target database

## Query parameters:

  - `page` (integer)
    Page

  - `pageSize` (integer)
    Page Size

  - `sortBy` (string)
    Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., 'Property1:desc,Property2:asc,Property3:asc' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.

## Response 200 fields (text/plain):

  - `data` (array,null)

  - `data.check_ID` (integer, required)
    ID of the check. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `data.acH_Number` (string,null)
    ACH (Automated Clearing House) number of the check.

  - `data.account_Key` (integer,null)
    The account key associated with the check.

  - `data.address2_On_Check` (string,null)
    The second address line on the check.

  - `data.address_On_Check` (string,null)
    Address line 1 listed on the check.

  - `data.adjustment` (number,null)
    An adjustment amount assigned to the check.

  - `data.admin_Amt` (number,null)
    Indicates any administrative fee associated with the check.

  - `data.amount_Due` (number,null)
    Amount that was written on the check.

  - `data.check_Batch` (integer,null)
    Identifies which batch the check belongs to.

  - `data.check_Date` (string,null)
    Date that was written on the check.

  - `data.check_Number` (string,null)
    Number of the check.

  - `data.check_Paid_Date` (string,null)
    The date the check was paid.

  - `data.check_Status` (string,null)
    Indicates the status of the check.

  - `data.check_Type` (string,null)
    Indicates the type associated with the check.

  - `data.city_On_Check` (string,null)
    City of the check's address.

  - `data.cleared_Amount` (number,null)
    The amount that was cleared.

  - `data.cleared_Date` (string,null)
    The date the check cleared.

  - `data.country_ID_On_Check` (string,null)
    The country ID on the check.

  - `data.create_Date` (string,null)
    The date the check was created.

  - `data.create_User` (string,null)
    The user that created the check.

  - `data.date_Printed` (string,null)
    Date when the check was printed.

  - `data.entry_Date` (string)
    Date record was first added to the system

  - `data.entry_User` (string,null)
    User that first added the record to the system

  - `data.generated_835` (boolean, required)
    Flag that determines if an 835 was generated. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `data.interest` (number,null)
    The interest amount of the check.

  - `data.memo` (string,null)
    Memo line of the check.

  - `data.name_On_Address` (string,null)
    The name associated with the address on the check.

  - `data.name_On_Check` (string,null)
    Name that was written on the check.

  - `data.paid_Amount` (number,null)
    The amount paid of the check.

  - `data.pay_To_Account_Key` (integer,null)
    The account the check was paid to.

  - `data.pay_To_ID` (string,null)
    Pay_To_ID is the ID based on the Send_Check_To. 'P' = Payee_ID, 'V' = Provider_ID, 'S'= Subscriber_ID, 'G' = Group_ID, 'B' = Beneficiary_ID

  - `data.payee_ID` (string,null)
    ID of the Payee associated with the check.

  - `data.payment_Method` (string,null)
    Identifies the check as a check or wire transfer.

  - `data.payor_ID` (string,null)
    ID of the Payor associated with the check.

  - `data.reconcile_Key` (integer,null)
    The reconcile key associated with the check.

  - `data.send_Check_To` (string,null)
    A code identifying who the check is sent to.

  - `data.signature_Key` (integer,null)
    The signature key associated with the check.

  - `data.state_On_Check` (string,null)
    State of the check's address.

  - `data.update_Date` (string)
    Date the record was last updated in the system

  - `data.update_User` (string,null)
    User that last updated the record in the system

  - `data.wire_Transfer_Date` (string,null)
    The date of the wire transfer.

  - `data.zip_On_Check` (string,null)
    Zip code of the check's address.

  - `error` (object)

  - `error.detail` (string,null)
    A human-readable explanation specific to this occurrence of the problem.

  - `error.instance` (string,null)
    A URI reference that identifies the specific occurrence of the problem.It may
or may not yield further information if dereferenced.

  - `error.status` (integer)
    The HTTP status code([RFC7231], Section 6) generated by the origin server for
this occurrence of the problem.

  - `error.title` (string,null)
    A short, human-readable summary of the problem type.It SHOULD NOT change from
occurrence to occurrence of the problem, except for purposes of localization(e.g.,
using proactive content negotiation; see[RFC7231], Section 3.4).

  - `error.type` (string,null)
    A URI reference [RFC3986] that identifies the problem type. This specification
encourages that, when dereferenced, it provide human-readable documentation for
the problem type (e.g., using HTML [W3C.REC-html5-20141028]). When this member
is not present, its value is assumed to be "about:blank".

  - `debug` (object)

  - `debug.activityID` (string, required)


## Response 401 fields