| Method | Description | Returns |
|---|---|---|
| getCurrency() | Get the currency | Currency |
| getUnitAmountAsMoney() | Gets the amount for a single unit (quantity = 1) as a Money object. Represents the value per unit before tax and discount are applied. | Money |
| getUnitDiscountAsMoney() | Gets the discount for a single unit (quantity = 1) as a Money object. Represents the discount value per unit. | Money |
| getUnitTaxAsMoney() | Gets the tax for a single unit (quantity = 1) as a Money object. Represents the tax value per unit. | Money |
| getUnitTotalAsMoney() | Gets the total for a single unit (quantity = 1) as a Money object. Represents the final value per unit calculated as `Unit Amount - Unit Discount + Unit Tax`. | Money |
| getAmountAsMoney() | Gets the amount for the entire quantity as a Money object. Represents the value before applying tax and discount (`Unit Amount × Quantity`). | Money |
| getDiscountAsMoney() | Gets the discount for the entire quantity as a Money object. Represents the total discount applied (`Unit Discount × Quantity`). | Money |
| getTaxAsMoney() | Gets the tax for the entire quantity as a Money object. Represents the total tax calculated (`Unit Tax × Quantity`). | Money |
| getTotalAsMoney() | Gets the total for the entire quantity as a Money object. Represents the final value calculated as `Amount - Discount + Tax`. | Money |
| getQuantityRefunded() | Get the quantity refunded | int |
| getPendingOrSuccessfullyRefundedItems() | Get the pending or successfully refunded items | array |
| isTaxableType() | Could this item be taxed? | bool |
| isRefundableType() | Is this item type eligible to be included in a refund? Type-level check only — independent of the parent invoice's refundability state (see {@see \Invoices\Models\Invoice::isRefundable()} for that). | bool |
| getId() | int | |
| getType() | string | |
| getCode() | string | |
| getText() | string | |
| getQuantity() | int | |
| getQuantityUnit() | string | |
| getAmount() | Represents the value before applying tax and discount (`Unit Amount × Quantity`). | string |
| getDiscount() | Represents the total discount applied (`Unit Discount × Quantity`). | string |
| getTax() | Represents the total tax calculated (`Unit Tax × Quantity`). | string |
| getTaxRate() | The percentage rate used to calculate the tax (e.g., 10.0000). | string |
| getCreated() | Date the record was created. | DateTime |
| getModified() | Last modification date for the record. | DateTime |
| getInvoice() | Invoice | |
| getRefundItems() | Collection (RefundItem) | |
| 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\Item
Item