Each tariff (salesTariffs) is built upon a calculation type (new enforced price, % increment, value increment), under which specified products are categorized.
For each product added to the tariff (salesTariffLines), a value indicator is determined based on the calculation type.
Moreover, it’s feasible to modulate the value indicator according to ranges of minimum to maximum quantities (salesTariffLineStretch)
SalesTariff
Quick Links
Accounts Accounting Entries Products Customers Sales quotes Sales invoices Suppliers Purchase invoices| HTTP | Operation | Type | Object |
|---|---|---|---|
| Query | salesTariffById |
||
| Query | salesTariffs |
Description
Sales Tariffs, known as SalesTariff in the API context and Prices in the product interface, form the structural framework essential for crafting and administering pricing strategies within sales endeavors.
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? |
salesTariffs
| Fields | Type | Description | Length |
|---|---|---|---|
| id | UUID | Id | |
| creationDate | DateTime | Creation Date | |
| modificationDate | DateTime | Modification Date | |
| code | String | Sales tariff code | 10 |
| name | String | Name of tariff | 20 |
| type |
|
Type of tariff | |
| startDate | DateTime | Start date for tariff | |
| endDate | DateTime | End date for tariff | |
| enabled | Boolean | Whether tariff is enabled | |
| lines[] | Array | Collection of tariff lines |
Info
- endDate: Specifies when the sales tariff will no longer be applicable. Useful for seasonal or temporary tariffs.
- startDate: Specifies when the sales tariff will become applicable. Useful for seasonal or temporary tariffs.
- enabled: A boolean flag indicating whether the tariff line is currently active or not.
- type :
PRICE: Allows for enforcing a price that replaces the base price of the item.MARGIN: Allows for applying a percentage increase or decrease to the base price.INCREMENT: Allows for adding or subtracting an amount to the base price.
salesTariffs/salesTariffLines
| 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 | Enabled Status | |
| indicatorValue | Decimal | Indicator Value depending of type of tariff | |
| stretchs[] | Array | List of Tariff Line Stretches |
Info
- indicatorValue: A decimal value that affects the item’s price, depending on the
typefield (PRICE,MARGIN,INCREMENT). - startDate: The start date of the validity period for this sales tariff line.
- endDate: The end date of the validity period for this sales tariff line.
- stretchs[]: An array containing the different stretches or phases within the sales tariff line.
salesTariffs/salesTariffLines/salesTariffLineStretch
| Fields | Type | Description | Length |
|---|---|---|---|
| id | UUID | Id | |
| creationDate | DateTime | Creation Date | |
| modificationDate | DateTime | Modification Date | |
| fromUnits | Decimal | From Units | |
| toUnits | Decimal | To Units | |
| indicatorValue | Decimal | Indicator Value |
Info
- fromUnits: Specifies the starting unit range for which this sales tariff line is applicable.
- toUnits: Specifies the ending unit range for which this sales tariff line is applicable. This field may be left empty to indicate no upper limit.