| Property | Description | Returns |
|---|---|---|
| sourceRecord | Get the source record related to this invoice | Model |
| pendingTransaction | Does the invoice have a pending transaction? | Transaction |
| captureTransaction | Get the capture transaction. This is the transaction which has captured the funds. | Transaction |
| settledAmount | Get the amount which has been settled. This includes authorized and captured amounts. | Money |
| amountAuthorized | Get the amount authorized. Deducts any amounts which have been voided or captured. | Money |
| amountCaptured | Gets the amount captured. Deducts amount refunded amounts. | Money |
| amountVoided | Gets the amount which has been voided (which was previously authorized) | Money |
| amountRefunded | Gets the amount which has been refunded | Money |
| outstandingAmount | Get the outstanding amount | Money |
| totalAsMoney | Get the total as a Money object | Money |
| currencyCode | Get the currency code | string |
| id | int | |
| open | Is the invoice open? | bool |
| status | string | |
| externalId | string | |
| purchaseOrderNumber | string | |
| itemTotal | string | |
| discountTotal | string | |
| surchargeTotal | string | |
| shippingTotal | string | |
| insuranceTotal | string | |
| handlingTotal | string | |
| taxTotal | string | |
| total | string | |
| created | Date the record was created. | DateTime |
| modified | Last modification date for the record. | DateTime |
| paymentMethod | BasePaymentMethod | |
| billingAddress | Address | |
| sourceEntity | string | |
| sourceRecordId | int | |
| currency | Currency | |
| person | Person | |
| site | Site | |
| items | Collection (Item) | |
| transactions | Collection (Transaction) | |
| customFieldValues | Collection (InvoiceCustomFieldValue) | |
| customFields | Get the custom fields for this entity | array |
Invoices\Models\Api\Invoice
Invoice