Magidoc

CreditMemo
Object

Fields

#

_id

ID !
Non-null

workspaceId

ID !
Non-null

customerInvoiceId

The credited invoice. Null for a standalone memo, which credits the customer and no invoice.

sourceInvoiceId

linkedInvoiceId

standalone

sourceInvoiceDocumentNumber

customerAccountId

customerAccountName

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

ownerId

Written by assignFinanceOwnerReviewer's creditMemo branch alongside reviewerId. Null on every memo nobody has been assigned to, which is most of them — an assignment is a routing fact, not a lifecycle one.

reviewerId

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.

documentNumber

Non-null

status

Non-null

amount

Non-null

balance

subtotal

taxTotal

transactionDate

remainingCredit

lines

applyTaxAfterDiscount

billingEmail

customFields

emailStatus

freeFormAddress

linkedTransactions

printStatus

privateNote

shippingAddress

shipFromAddress

taxExemptionExternalId

applications

approvalRoute

approvalChain

invoiceBalance

Non-null

currencyConversion

paymentState

reason

approvedAt

approvedBy

rejectedAt

rejectedBy

approvalNote

appliedAt

appliedBy

journalId

createdAt

Non-null

modifiedAt

Non-null

createdBy

ID !
Non-null

modifiedBy

ID !
Non-null

Usages

#

References

#

  • Field getCreditMemos from Query
  • Field getFinanceCreditMemos from Query