# Checkbook Checks
> A Checkbook Check is a single check within a Checkbook.

## The Checkbook Check object
### Example
```json
{
  "check_number": 1,
  "checkbook_id": "checkbook_7iudxhxum6vlkcjxmi8y",
  "created_at": "2020-01-31T23:59:59Z",
  "id": "checkbook_check_klgh3z50guf6jcnfhibb",
  "status": "pending_deposit",
  "type": "checkbook_check"
}
```
### Attributes
- `check_number` (integer)
  The check number printed on the check.

- `checkbook_id` (string)
  The identifier of the Checkbook the check belongs to.

- `created_at` (string)
  The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Checkbook Check was created.

- `id` (string)
  The Checkbook Check's identifier.

- `status` (enum)
  The status of the Checkbook Check.
  Cases:
  * `pending_deposit` (The check has not yet been deposited.)
  * `deposited` (The check has been deposited.)
  * `stopped` (The check has been stopped and can no longer be deposited.)
  * `requires_attention` (The check requires attention from an Increase operator.)

- `type` (string)
  A constant representing the object's type. For this resource it will always be `checkbook_check`.

## List Checkbook Checks
GET /checkbook_checks

### Example
```curl
curl \
  --url "${INCREASE_URL}/checkbook_checks" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"
```

### Query Parameters
- `cursor` (string, optional)
  Return the page of entries after this one.

- `limit` (integer, optional)
  Limit the size of the list that is returned. The default (and maximum) is 100 objects.
  Default: `100`

- `checkbook_id` (string, optional)
  Filter Checkbook Checks to those belonging to the specified Checkbook.

- `account_number_id` (string, optional)
  Filter Checkbook Checks to those drawn on the specified Account Number.

- `check_number` (integer, optional)
  Filter Checkbook Checks to the one with the specified check number.

### Returns a Checkbook Check List object:
```json
{
  "data": [
    {
      "check_number": 1,
      "checkbook_id": "checkbook_7iudxhxum6vlkcjxmi8y",
      "created_at": "2020-01-31T23:59:59Z",
      "id": "checkbook_check_klgh3z50guf6jcnfhibb",
      "status": "pending_deposit",
      "type": "checkbook_check"
    }
  ],
  "next_cursor": "v57w5d"
}
```

## Retrieve a Checkbook Check
GET /checkbook_checks/{checkbook_check_id}

### Example
```curl
curl \
  --url "${INCREASE_URL}/checkbook_checks/checkbook_check_klgh3z50guf6jcnfhibb" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"
```
### Path Parameters
- `checkbook_check_id` (string, required)
  The identifier of the Checkbook Check.

## Stop a Checkbook Check
POST /checkbook_checks/{checkbook_check_id}/stop
> Stop a Checkbook Check. A stopped check cannot be deposited.
### Example
```curl
curl -X "POST" \
  --url "${INCREASE_URL}/checkbook_checks/checkbook_check_klgh3z50guf6jcnfhibb/stop" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"
```
### Path Parameters
- `checkbook_check_id` (string, required)
  The identifier of the Checkbook Check to stop.