Discount Object Fields
Learn about the fields used to model discounts.
These field references describe the fields in a discount object. Specify the discount in the transaction or transaction-line object.
Fields
The following fields are available:
| Field | Description |
|---|---|
discount_code | The discount code. Use this field to track the relationship between transaction-level discounts and discounts on individual transaction lines. The value must be unique within the transaction, even when specified at the transaction-line level. |
discount_description | The discount description. |
discount_amount | The discount amount for tax-exclusive prices. Use this field if your prices do not include tax. |
discount_total_amount | The discount amount for tax-inclusive prices. Use this field if your prices include tax. |
Considerations
Note the following considerations:
- Specify only one of
discount.discount_amountordiscount.discount_total_amount, based on whether you use tax-exclusive or tax-inclusive prices. The service calculates both amounts and returns them in the response. - If you specify a discount at the transaction level, the service duplicates it for each transaction line.
Updated 16 days ago
Did this page help you?