| 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 |
| authorizedAmountAsMoney | 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 |
| capturedAmountAsMoney | 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 |
| voidedAmountAsMoney | 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 |
| refundedAmountAsMoney | Gets the refunded amount as a Money object. Represents the sum of refunded amounts across all top-level transactions on the invoice. | Money |
| settledAmountAsMoney | 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 |
| outstandingAmountAsMoney | Gets the outstanding amount as a Money object. Represents the grand total minus the settled amount — the balance not yet settled. | Money |
| itemTotalAsMoney | Gets the item total as a Money object. Represents the sum of all items' Amount values. | Money |
| shippingTotalAsMoney | 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 |
| handlingTotalAsMoney | 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 |
| insuranceTotalAsMoney | 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 |
| discountTotalAsMoney | Gets the discount total as a Money object. Represents the sum of discount values across all line items, including shipping, handling, etc. | Money |
| taxTotalAsMoney | Gets the tax total as a Money object. Represents the sum of tax values across all line items, including shipping, handling, etc. | Money |
| surchargeTotalAsMoney | Gets the surcharge total as a Money object. Represents the surcharge total. | Money |
| totalAsMoney | 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 |
| currencyCode | Get the currency code | string |
| open | Is the invoice open? | bool |
| draft | Is the invoice in draft status (amount not yet finalized)? | bool |
| paid | Is the invoice paid? | bool |
| refunded | Is the invoice refunded? | bool |
| void | Is the invoice voided? | bool |
| lineItems | Gets all line items | Collection |
| displayStatus | Get the display friendly status of the invoice | string |
| refundable | Can the invoice be refunded? | bool |
| id | int | |
| status | string | |
| externalId | string | |
| purchaseOrderNumber | string | |
| itemTotal | Represents the sum of all items' Amount values. | string |
| shippingTotal | Represents the net shipping total. Tax and discount on shipping are tracked in Tax Total and Discount Total. | string |
| handlingTotal | Represents the net handling total. Tax and discount on handling are tracked in Tax Total and Discount Total. | string |
| insuranceTotal | Represents the net insurance total. Tax and discount on insurance are tracked in Tax Total and Discount Total. | string |
| discountTotal | Represents the sum of discount values across all line items, including shipping, handling, etc. | string |
| taxTotal | Represents the sum of tax values across all line items, including shipping, handling, etc. | string |
| surchargeTotal | Represents the surcharge total. | string |
| total | Represents the final value calculated as `Item Total + Shipping Total + Handling Total + Insurance Total - Discount Total + Tax Total + Surcharge Total`. | string |
| created | Date the record was created. | DateTime |
| modified | Last modification date for the record. | DateTime |
| taxCalculated | DateTime | |
| paymentMethod | BasePaymentMethod | |
| billingAddress | Address | |
| sourceEntity | string | |
| sourceRecordId | int | |
| currency | Currency | |
| person | Person | |
| site | Site | |
| items | Collection (Item) | |
| transactions | Collection (Transaction) | |
| taxTransactions | Collection (Transaction) | |
| refunds | Collection (Refund) | |
| customFieldValues | Collection (InvoiceCustomFieldValue) | |
| customFields | Get the custom fields for this entity | array |
Invoices\Models\Api\Invoice
Invoice