Get a check
Fetches one check with everything needed to print it: the bank account it is drawn on, the company writing it, the payee, and the MICR line.
Authorization
AuthorizationstringrequiredPath parameters
checkIdstringrequiredThe check to fetch. A Snowflake id sent as a decimal string.
Response
200 · The check, with the records it refers to embedded.
idstringThe check.
companyIdstringThe management company that wrote the check.
checkNumberintegerThe number printed on the check.
vendorIdstringThe vendor the check is made out to. Absent when the payee is not a vendor.
ownerIdstringThe owner the check is made out to. Absent when the payee is not an owner.
tenantIdstringThe tenant the check is made out to. Absent when the payee is not a tenant.
bankAccountIdstringThe bank account the check is drawn on. Money leaves this account when the check clears.
amountnumberThe face value of the check, in dollars and cents — money paid out by the company.
amountStringstringThe same amount written out in words, as printed on the check line.
memostringThe memo printed on the check. Absent when none was set.
datestring · date-timeThe date printed on the check, in the company's timezone.
createdOnstring · date-timeWhen the check record was created, in the company's timezone.
transactionIdstringThe accounting transaction this check paid. Absent when the check is not tied to one.
voidedbooleantrue once the check has been voided.
voidReasonstringWhy the check was voided. Absent unless a reason was given.
dataHeadersstring[]Column headings for the stub table printed under the check. Each entry in billPayments[].data is keyed by one of these headings.
billPaymentsobject[]One row per item the check pays, as printed on the stub.
bankAccountobjectThe account the check is drawn on. Account and routing numbers are masked to their last four digits.
companyobjectThe management company whose name and address are printed on the check.
vendorobjectThe vendor payee, as the full vendor record. Absent when the payee is not a vendor.
ownerobjectThe owner payee, as the full owner record. Absent when the payee is not an owner.
tenantobjectThe tenant payee, as the full tenant record. Absent when the payee is not a tenant.
micrCodestringThe magnetic ink line printed along the bottom of the check. It is composed as c<checkNumber>c A<routingNumber>A <accountNumber>C and carries the bank account's full routing and account numbers, unlike the bankAccount object above, which masks both to their last four digits. Omitted from the example here for that reason.