v4

latestOpenAPI 3.1.02026-08-031873791.4 MB

Paper Checks

Print check immediately

Create and immediately print a paper check for a transaction.

This endpoint creates a paper check record and generates the PDF in a single operation. The check is immediately marked as PRINTED.

When to use:

When you need to print a single check right away
For on-demand check printing workflows

Alternative: Use POST /print-later/ to queue checks for batch printing.

Supported transaction types:

Direct expenses
Vendor payments
Vendor prepayments
Customer refunds

Returns: The created paper check details along with the PDF content encoded in base64.

post/public/v1/paper-checks/print-now/

Request body

transaction_idinteger required

ID of the transaction to print a check for. Must be a printable transaction type (direct expense, vendor payment, vendor prepayment, or customer refund).

template_idinteger nullable

Optional ID of a PaperCheckTemplate to use for formatting. If not provided, the default template will be used.

Example request

{
  "transaction_id": 12345,
  "template_id": 1
}

Response

Created

pdf_contentstring required

Base64-encoded PDF content of the printed check

Example response

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