forked from LiveCarta/PayPal-PHP-Server-SDK
49 lines
2.3 KiB
Markdown
49 lines
2.3 KiB
Markdown
|
|
# Amount Breakdown
|
|
|
|
The breakdown of the amount. Breakdown provides details such as total item amount, total tax amount, shipping, handling, insurance, and discounts, if any.
|
|
|
|
## Structure
|
|
|
|
`AmountBreakdown`
|
|
|
|
## Fields
|
|
|
|
| Name | Type | Tags | Description | Getter | Setter |
|
|
| --- | --- | --- | --- | --- | --- |
|
|
| `itemTotal` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getItemTotal(): ?Money | setItemTotal(?Money itemTotal): void |
|
|
| `shipping` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getShipping(): ?Money | setShipping(?Money shipping): void |
|
|
| `handling` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getHandling(): ?Money | setHandling(?Money handling): void |
|
|
| `taxTotal` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getTaxTotal(): ?Money | setTaxTotal(?Money taxTotal): void |
|
|
| `insurance` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getInsurance(): ?Money | setInsurance(?Money insurance): void |
|
|
| `shippingDiscount` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getShippingDiscount(): ?Money | setShippingDiscount(?Money shippingDiscount): void |
|
|
| `discount` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getDiscount(): ?Money | setDiscount(?Money discount): void |
|
|
|
|
## Example (as JSON)
|
|
|
|
```json
|
|
{
|
|
"item_total": {
|
|
"currency_code": "currency_code0",
|
|
"value": "value6"
|
|
},
|
|
"shipping": {
|
|
"currency_code": "currency_code0",
|
|
"value": "value6"
|
|
},
|
|
"handling": {
|
|
"currency_code": "currency_code2",
|
|
"value": "value8"
|
|
},
|
|
"tax_total": {
|
|
"currency_code": "currency_code4",
|
|
"value": "value0"
|
|
},
|
|
"insurance": {
|
|
"currency_code": "currency_code2",
|
|
"value": "value8"
|
|
}
|
|
}
|
|
```
|
|
|