Magidoc

Receipt
Object

Fields

#

_id

ID !
Non-null

workspaceId

ID !
Non-null

documentNumber

The receipt's own number, drawn from the workspace's receipt series when it is created. Null on receipts stored before receipts were numbered, and on imported payments, which carry their source's identity instead. Voiding suffixes it with -VOID.

customerInvoiceId

The single invoice this payment settles. Null when it settles none — a bill payment, a customer deposit, or an import whose linked invoice has not resolved. Read allocations for the per-invoice links.

customerAccountId

customerAccountName

The customer's name, joined from the CRM account customerAccountId points at. Null when the receipt names no customer, or names one this workspace cannot resolve — a deleted account, or one that is not its own.

depositAccountId

projectId

projectName

Name of the project this document is filed against, resolved at read time and scoped to what the requesting member may see. Null when the project no longer exists or is not visible to them — clients render their unlinked fallback for both, and must never assume the name of a project the reader cannot open.

amount

Non-null

allocations

unappliedAmount

Non-null

invoiceBalance

Non-null

currencyConversion

paymentState

journalId

paymentDate

Non-null

method

paymentMethodId

linkedTransactions

note

processPayment

reference

voidedAt

Set once the receipt is voided. Its allocations and amount stay as the record of what it did, so this is what tells a reader the cash is no longer in the ledger.

voidedBy

voidReason

reversalJournalId

The journal that reversed this receipt out of the ledger.

createdAt

Non-null

modifiedAt

Non-null

createdBy

ID !
Non-null

modifiedBy

ID !
Non-null

Usages

#

References

#

  • Field getFinanceReceipts from Query