Queue checks for later printing - DualEntry Documentation

Authorizations

X-API-KEY

string

header

required

Body

application/json

Request body for queuing checks for later batch printing.

Use this endpoint when you want to queue multiple checks to be printed together in a batch. The checks will be created with status NOT_PRINTED.

transaction_ids

integer[]

required

List of transaction IDs to create paper checks for. Each transaction must be a printable type and must not already have an active paper check.

Example:

[12345, 12346, 12347]

Response

integer

required

Unique identifier for the paper check

Example:

12345

created_at

string<date-time>

required

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

Example:

"2024-01-15"

transaction_date

string<date>

required

Date of the underlying transaction

Example:

"2024-01-15"

source_record_type

enum<string>

required

Type of the source record (e.g., 'direct_expense', 'vendor_payment', 'customer_refund')

Available options:

direct_expense,

vendor_payment,

vendor_prepayment,

customer_refund

Example:

"vendor_payment"

source_record_id

integer

required

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

Example:

789

source_record_number

integer

required

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

Example:

1001

check_number

string

required

The check number printed on the physical check

Example:

"10542"

company_id

integer

required

ID of the company issuing the check

Example:

456

company_name

string

required

Name of the company issuing the check

Example:

"Acme Corporation"

memo

string

required

Memo or description for the check

Example:

"Payment for Invoice #1234"

amount

string

required

Amount of the check

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$

Example:

"1500.00"

currency_iso_4217_code

enum<string>

required

ISO 4217 currency code for the check amount

Available options:

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

Example:

"USD"

account_number

integer

required

Number of the bank account the check is drawn from

Example:

321

account_name

string

required

Name of the bank account the check is drawn from

Example:

"Operating Account"

record_status

enum<string>

required

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

Available options:

printed,

not_printed,

archived

Example:

"printed"

payee_name

string | null

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

Example:

"ABC Suppliers Inc."

customer_id

integer | null

ID of the customer if this is a customer refund check

Example:

567

customer_name

string | null

Name of the customer if this is a customer refund check

Example:

"John Smith"

vendor_id

integer | null

ID of the vendor if this is a vendor payment check

Example:

890

vendor_name

string | null

Name of the vendor if this is a vendor payment check

Example:

"ABC Suppliers Inc."

Documentation Index

Authorizations

Body

Response