Sales Discounts, known as SalesDiscount in the API context and Discounts in the product interface.
This resource is crucial for managing discount strategies within your sales workflow.
It allows for the configuration of various types of discounts, such as volume-based discounts, seasonal discounts, or special promotional discounts, providing flexibility in sales promotions and revenue management.
SalesDiscount
| HTTP | Operation | Type | Object |
|---|---|---|---|
| Query | salesDiscountById |
||
| Query | salesDiscounts |
Description
Header
| Key | Value |
|---|---|
Authorization |
Bearer Current access Token How to find? |
X-TenantId |
Current tenant id How to find? |
X-OrganizationId |
Current organization Id How to find? |
x-api-key |
Primary or secondary subscription key of your app How to find? |
salesDiscounts
| Fields | Type | Description | Length |
|---|---|---|---|
| id | UUID | Id | |
| creationDate | DateTime | Creation Date | |
| modificationDate | DateTime | Modification Date | |
| code | String | Discount Group Code | 10 |
| name | String | Discount Group Name | 20 |
| startDate | DateTime | Start Date | |
| endDate | DateTime | End Date | |
| enabled | Boolean | Is Enabled | |
| lines[] | Array | List of Sales Discount Group Lines |
Info
- endDate: Specifies the date this discount group is supposed to end.
- startDate: Specifies the date this discount group becomes active.
- enabled: A boolean flag indicating whether this sales discount group is currently enabled or disabled.
- lines: An array containing the lines of products/services that are part of this discount group. These lines are represented by SalesDiscountGroupLineDto objects.
salesDiscounts/salesDiscountLines
| Fields | Type | Description | Length |
|---|---|---|---|
| id | UUID | Id | |
| creationDate | DateTime | Creation Date | |
| modificationDate | DateTime | Modification Date | |
| product | Product | Fields of Product | |
| productId | UUID | Product ID | |
| startDate | DateTime | Start Date | |
| endDate | DateTime | End Date | |
| enabled | Boolean | Is Enabled | |
| firstDiscount | Decimal | First Discount Rate | |
| stretchs[] | Array | List of Sales Discount Group Line Stretches |
Info
- firstDiscount: Specifies the first discount rate applied to products in this sales discount group line.
- productId: A unique identifier (UUID) for the product associated with the sales discount group line.
- stretchs: An array containing the stretches that are part of this discount group line. These stretches are represented by SalesDiscountGroupLineStretchDto objects.
salesDiscounts/salesDiscountLines/salesDiscountLineStretch
| Fields | Type | Description | Length |
|---|---|---|---|
| id | UUID | Id | |
| creationDate | DateTime | Creation Date | |
| modificationDate | DateTime | Modification Date | |
| fromUnits | Int | From Units | |
| toUnits | Int | To Units | |
| firstDiscount | Decimal | First Discount Rate |
Info
- firstDiscount: Specifies the first discount rate applied to the sales discount group line stretch.
- fromUnits: Specifies the starting unit count for the discount stretch.
- toUnits: Specifies the ending unit count for the discount stretch. The field is optional and can be left null to indicate that there is no upper limit on the number of units.