| Method | Description | Returns |
|---|---|---|
| getSourceRecord() | Get the source record related to this invoice | Model |
| getAuthorizedAmountAsMoney() | Gets the authorized amount as a Money object. Represents the sum of authorized amounts across all top-level transactions on the invoice, minus any amounts that were subsequently voided or captured. | Money |
| getCapturedAmountAsMoney() | Gets the captured amount as a Money object. Represents the sum of captured amounts across all top-level transactions on the invoice, minus any amounts that were subsequently refunded. | Money |
| getVoidedAmountAsMoney() | Gets the voided amount as a Money object. Represents the sum of voided amounts (previously authorized) across all top-level transactions on the invoice. | Money |
| getRefundedAmountAsMoney() | Gets the refunded amount as a Money object. Represents the sum of refunded amounts across all top-level transactions on the invoice. | Money |
| getSettledAmountAsMoney() | Gets the settled amount as a Money object. Represents the sum of authorized and captured amounts across all top-level transactions on the invoice. | Money |
| getOutstandingAmountAsMoney() | Gets the outstanding amount as a Money object. Represents the grand total minus the settled amount — the balance not yet settled. | Money |
| getItemTotalAsMoney() | Gets the item total as a Money object. Represents the sum of all items' Amount values. | Money |
| getShippingTotalAsMoney() | Gets the shipping total as a Money object. Represents the net shipping total. Tax and discount on shipping are tracked in Tax Total and Discount Total. | Money |
| getHandlingTotalAsMoney() | Gets the handling total as a Money object. Represents the net handling total. Tax and discount on handling are tracked in Tax Total and Discount Total. | Money |
| getInsuranceTotalAsMoney() | Gets the insurance total as a Money object. Represents the net insurance total. Tax and discount on insurance are tracked in Tax Total and Discount Total. | Money |
| getDiscountTotalAsMoney() | Gets the discount total as a Money object. Represents the sum of discount values across all line items, including shipping, handling, etc. | Money |
| getTaxTotalAsMoney() | Gets the tax total as a Money object. Represents the sum of tax values across all line items, including shipping, handling, etc. | Money |
| getSurchargeTotalAsMoney() | Gets the surcharge total as a Money object. Represents the surcharge total. | Money |
| getTotalAsMoney() | Gets the grand total as a Money object. Represents the final value calculated as `Item Total + Shipping Total + Handling Total + Insurance Total - Discount Total + Tax Total + Surcharge Total`. | Money |
| getCurrencyCode() | Get the currency code | string |
| isOpen() | Is the invoice open? | bool |
| isDraft() | Is the invoice in draft status (amount not yet finalized)? | bool |
| isPaid() | Is the invoice paid? | bool |
| isRefunded() | Is the invoice refunded? | bool |
| isVoid() | Is the invoice voided? | bool |
| getLineItems() | Gets all line items | Collection |
| getDisplayStatus() | Get the display friendly status of the invoice | string |
| isRefundable() | Can the invoice be refunded? | bool |
| getId() | int | |
| getStatus() | string | |
| getExternalId() | string | |
| getPurchaseOrderNumber() | string | |
| getItemTotal() | Represents the sum of all items' Amount values. | string |
| getShippingTotal() | Represents the net shipping total. Tax and discount on shipping are tracked in Tax Total and Discount Total. | string |
| getHandlingTotal() | Represents the net handling total. Tax and discount on handling are tracked in Tax Total and Discount Total. | string |
| getInsuranceTotal() | Represents the net insurance total. Tax and discount on insurance are tracked in Tax Total and Discount Total. | string |
| getDiscountTotal() | Represents the sum of discount values across all line items, including shipping, handling, etc. | string |
| getTaxTotal() | Represents the sum of tax values across all line items, including shipping, handling, etc. | string |
| getSurchargeTotal() | Represents the surcharge total. | string |
| getTotal() | Represents the final value calculated as `Item Total + Shipping Total + Handling Total + Insurance Total - Discount Total + Tax Total + Surcharge Total`. | string |
| getCreated() | Date the record was created. | DateTime |
| getModified() | Last modification date for the record. | DateTime |
| getTaxCalculated() | DateTime | |
| getPaymentMethod() | BasePaymentMethod | |
| getBillingAddress() | Address | |
| getSourceEntity() | string | |
| getSourceRecordId() | int | |
| getCurrency() | Currency | |
| getPerson() | Person | |
| getSite() | Site | |
| getItems() | Collection (Item) | |
| getTaxTransactions() | Collection (Transaction) | |
| getRefunds() | Collection (Refund) | |
| getCustomFieldValues() | Collection (InvoiceCustomFieldValue) | |
| getCustomFieldValue(CustomField $customField) | Get the value for a custom field | CustomFieldValue |
| getCustomFieldValueByName(string $customFieldName) | Get the value for a custom field by the custom field name | CustomFieldValue |
| getCustomFieldContent(string $customFieldName) | Get the content for the custom field identified by the specified name | Content |
| getCustomFieldContentOrDefault(string $customFieldName) | Get the (default) content for the custom field identified by the specified name | Content |
| getCustomFieldBoolean(string $customFieldName, ?bool|null $default) | Get the (default) content of the custom field as boolean value | bool |
| getCustomFieldText(string $customFieldName, ?string|null $default) | Get the (default) content of the custom field as text | string |
| getCustomFieldImage(string $customFieldName) | Get the (default) image contained in the custom field | Image |
| getCustomFieldFile(string $customFieldName) | Get the (default) file contained in the custom field | File |
| getCustomFields() | Get the custom fields for this entity | array |
| hasCustomField(string $customFieldName) | Check if the entity has a custom field with the specified name | bool |
| 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 |
Invoices\Models\Frontend\Invoice
Invoice