List paper checks

Retrieve a paginated list of paper checks with filtering options.

Paper checks represent physical checks that can be printed for vendor payments, direct expenses, vendor prepayments, or customer refunds.

Common use cases:

List all queued checks ready to print: ?record_status=not_printed
List checks for a specific vendor: ?vendor_id=123
List checks within a date range: ?start_date=2024-01-01&end_date=2024-01-31

searchstring nullable

idinteger[] nullable

Filter by paper check IDs

record_statusstring[] nullable

Filter by status: 'not_printed', 'printed', or 'archived'

company_idinteger[] nullable

Filter by company IDs

transaction_typePaperCheckSourceRecordType[] nullable

Filter by transaction type: 'direct_expense', 'vendor_payment', 'vendor_prepayment', 'customer_refund'

vendor_idinteger[] nullable

Filter by vendor IDs (for vendor-related checks)

customer_idinteger[] nullable

Filter by customer IDs (for customer refund checks)

account_idinteger[] nullable

Filter by bank account IDs

start_datestring date nullable

Filter checks created on or after this date (YYYY-MM-DD)

end_datestring date nullable

Filter checks created on or before this date (YYYY-MM-DD)

orderingstring nullable

limitinteger

Number of records to return per page (capped at 100)

offsetinteger

Number of records to skip before starting to return results

Response

OK

countinteger required

Example response

{
  "items": [
    {
      "id": 12345,
      "created_at": "2024-01-15",
      "transaction_date": "2024-01-15",
      "source_record_id": 789,
      "source_record_number": 1001,
      "check_number": "10542",
      "company_id": 456,
      "company_name": "Acme Corporation",
      "memo": "Payment for Invoice #1234",
      "amount": "1500.00",
      "account_number": 321,
      "account_name": "Operating Account",
      "payee_name": "ABC Suppliers Inc.",
      "customer_id": 567,
      "customer_name": "John Smith",
      "vendor_id": 890,
      "vendor_name": "ABC Suppliers Inc.",
      "record_status": "printed"
    }
  ]
}

v4

List paper checks

Query parameters

Response

Example response