| Method | Description | Returns |
|---|---|---|
| getSourceRecord() | Get the source record related to this invoice | Model |
| getPendingTransaction() | Does the invoice have a pending transaction? | Transaction |
| getCaptureTransaction() | Get the capture transaction. This is the transaction which has captured the funds. | Transaction |
| getSettledAmount() | Get the amount which has been settled. This includes authorized and captured amounts. | Money |
| getAmountAuthorized() | Get the amount authorized. Deducts any amounts which have been voided or captured. | Money |
| getAmountCaptured() | Gets the amount captured. Deducts amount refunded amounts. | Money |
| getAmountVoided() | Gets the amount which has been voided (which was previously authorized) | Money |
| getAmountRefunded() | Gets the amount which has been refunded | Money |
| getOutstandingAmount() | Get the outstanding amount | Money |
| getTotalAsMoney() | Get the total as a Money object | Money |
| getCurrencyCode() | Get the currency code | string |
| getId() | int | |
| isOpen() | Is the invoice open? | bool |
| getStatus() | string | |
| getExternalId() | string | |
| getPurchaseOrderNumber() | string | |
| getItemTotal() | string | |
| getDiscountTotal() | string | |
| getSurchargeTotal() | string | |
| getShippingTotal() | string | |
| getInsuranceTotal() | string | |
| getHandlingTotal() | string | |
| getTaxTotal() | string | |
| getTotal() | string | |
| getCreated() | Date the record was created. | DateTime |
| getModified() | Last modification date for the record. | DateTime |
| getPaymentMethod() | BasePaymentMethod | |
| getBillingAddress() | Address | |
| getSourceEntity() | string | |
| getSourceRecordId() | int | |
| getCurrency() | Currency | |
| getPerson() | Person | |
| getSite() | Site | |
| getItems() | Collection (Item) | |
| getTransactions() | Collection (Transaction) | |
| 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\Backend\Invoice
Invoice