Frontend | Backend | Api

Invoices\Models\Backend\Transaction

Transaction

Method Description Returns
getCurrency() Gets the currency of the transaction (from its invoice). Currency
getAmountAsMoney() Gets the amount as a Money object. Represents the raw transaction amount. Money
getCapturedAmountAsMoney() Gets the captured amount as a Money object. Represents the total captured by this transaction and its children, minus any amounts that were subsequently refunded. Money
getAuthorizedAmountAsMoney() Gets the authorized amount as a Money object. Represents the total authorized by this transaction and its children, minus any amounts that were subsequently voided or captured. Money
getVoidedAmountAsMoney() Gets the voided amount as a Money object. Represents the total voided by this transaction and its children. Money
getRefundedAmountAsMoney() Gets the refunded amount as a Money object. Represents the total refunded by this transaction and its children. Money
getErrorMessage() Get the error message from the transaction data if it exists. string
getId() int
getExternalId() string
getType() string
getStatus() string
getAmount() string
getData() array
getCreated() Date the record was created. DateTime
getInvoice() Invoice
getParent() Transaction
getChildren() Collection (Transaction)
isNewRecord() Check if the record is a new record bool
isHierarchicalModel() Check whether a model is a hierarchical model, i.e. can have children bool
isVersionedModel() Check whether a model is versioned bool