v4

latestOpenAPI 3.1.02026-08-031873791.4 MB

Paper Checks

Get paper check

Retrieve a specific paper check by ID.

Returns the full details of a paper check including the associated transaction information, payee details, and current status.

get/public/v1/paper-checks/{paper_check_id}/

Path parameters

paper_check_idinteger required

Response

idinteger required

Unique identifier for the paper check

created_atstring date-time required

Date when the paper check was created (returned as date only)

transaction_datestring date required

Date of the underlying transaction

source_record_type'direct_expense' | 'vendor_payment' | 'vendor_prepayment' | 'customer_refund' required

Allowed source record types for paper checks.

source_record_idinteger required

ID of the source record (e.g., the VendorPayment ID)

source_record_numberinteger required

Number of the source record (e.g., vendor payment number)

check_numberstring required

The check number printed on the physical check

company_idinteger required

ID of the company issuing the check

company_namestring required

Name of the company issuing the check

memostring required

Memo or description for the check

amountstring required

Amount of the check

currency_iso_4217_code'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL' required

account_numberinteger required

Number of the bank account the check is drawn from

account_namestring required

Name of the bank account the check is drawn from

payee_namestring nullable

Name of the payee (vendor or customer receiving the check)

customer_idinteger nullable

ID of the customer if this is a customer refund check

customer_namestring nullable

Name of the customer if this is a customer refund check

vendor_idinteger nullable

ID of the vendor if this is a vendor payment check

vendor_namestring nullable

Name of the vendor if this is a vendor payment check

record_status'printed' | 'not_printed' | 'archived' required

Status of the paper check: 'not_printed' (queued), 'printed', or 'archived'

Example response

{
  "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"
}