| Property | Description | Returns |
|---|---|---|
| currency | Get the currency | Currency |
| unitAmountAsMoney | 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 |
| unitDiscountAsMoney | Gets the discount for a single unit (quantity = 1) as a Money object. Represents the discount value per unit. | Money |
| unitTaxAsMoney | Gets the tax for a single unit (quantity = 1) as a Money object. Represents the tax value per unit. | Money |
| unitTotalAsMoney | 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 |
| amountAsMoney | Gets the amount for the entire quantity as a Money object. Represents the value before applying tax and discount (`Unit Amount × Quantity`). | Money |
| discountAsMoney | Gets the discount for the entire quantity as a Money object. Represents the total discount applied (`Unit Discount × Quantity`). | Money |
| taxAsMoney | Gets the tax for the entire quantity as a Money object. Represents the total tax calculated (`Unit Tax × Quantity`). | Money |
| totalAsMoney | Gets the total for the entire quantity as a Money object. Represents the final value calculated as `Amount - Discount + Tax`. | Money |
| quantityRefunded | Get the quantity refunded | int |
| pendingOrSuccessfullyRefundedItems | Get the pending or successfully refunded items | array |
| taxableType | Could this item be taxed? | bool |
| refundableType | 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 |
| id | int | |
| type | string | |
| code | string | |
| text | string | |
| quantity | int | |
| quantityUnit | string | |
| amount | Represents the value before applying tax and discount (`Unit Amount × Quantity`). | string |
| discount | Represents the total discount applied (`Unit Discount × Quantity`). | string |
| tax | Represents the total tax calculated (`Unit Tax × Quantity`). | string |
| taxRate | The percentage rate used to calculate the tax (e.g., 10.0000). | string |
| created | Date the record was created. | DateTime |
| modified | Last modification date for the record. | DateTime |
| invoice | Invoice | |
| refundItems | Collection (RefundItem) |
Invoices\Models\Api\Item
Item