| Property |
REQUIRED |
Comments |
Example |
| BEES Customer |
BEES Force |
| output object |
true |
false |
|
|
| output.scope string |
true |
false |
The level where charge should be applied.
Allowed values:
ORDER | LINE_ITEM
|
LINE_ITEM |
| output.applyTo string |
true |
false |
The field that should receive the charge.
Allowed values:
BASE_PRICE | TOTAL | DISCOUNT_AMOUNT
|
TOTAL |
| output.type string |
true |
false |
Type of the charge to be applied like amount or percentage.
Allowed values:
PERCENT | AMOUNT | $ | %
|
PERCENT |
| output.ratio string |
false |
false |
Type of calculation when the payment method is bank slip.
Allowed values:
FIXED | PRO_RATA | LINEAR
|
PRO_RATA |
| output.value number |
false |
false |
The value of the charge to be applied with limit of 15 decimal numbers. |
23.45 |
| output.ranges array[object] |
false |
false |
The range to apply the charge. |
|
| output.ranges.from number |
true |
false |
The from where to start applying the charge |
1 |
| output.ranges.value number |
true |
false |
The value on the respective index of the charge to be applied |
10 |
| output.vendorItemIds array[string] |
false |
false |
The list of the skus that will receive the charge. |
['VENDOR_SKU_001', VENDOR_SKU_002'] |