Name | Type | Description |
action
(mandatory) | String | Defines if a new or existing information will be updated.The supported values are the following: ADD, UPDATE, REMOVE |
credit_note_item_identifier (mandatory and applicable only on update or remove) | Credit Note Item Identifier | The identifier of the credit note item to be updated. The allowed credit note item identifier fields are the following: | Include Page |
|---|
| credit_note_item_identifier |
|---|
| credit_note_item_identifier |
|---|
|
|
product_identifier (mandatory and applicable only on add) | Products identifier | The product that will be related with the installed item. The allowed product identifier fields are the following:| Include Page |
|---|
| product_identifier |
|---|
| product_identifier |
|---|
|
|
quantity (mandatory and applicable on add, optional on update) | number | The quantity of the product.Applicable only if the product is not traceable |
cost (semi-optional and applicable on add, optional on update) | number | The cost of the product. Cost cannot be specified if the sub total is specified |
discount_percentage (optional and applicable on add and update) | number | The discount percentage that is applied. Discount percentage cannot be specified if the discount amount is specified. |
discount_amount (optional and applicable on add and update) | number | The discount amount that is applied. Discount amount cannot be specified if the discount percentage is specified |
vat_rate_identifier (optional and applicable on add and update) | VAT rate identifier | The VAT rate that should be applied. If not specified then the VAT rate specified on the product will be applied. The allowed VAT rate identifier fields are the following: | Include Page |
|---|
| vat_rate_identifier |
|---|
| vat_rate_identifier |
|---|
|
| Tip |
|---|
Deprecated from CRM.COM R12.0.0 |
|
sub_total (semi-optional and applicable on add, optional on update) | number | The total amount that will be credited for the specified product. Sub total cannot be specified if the cost is specified |
udf_string_1 (optional and applicable on add and update) | String | User Defined Field of type String |
udf_string_2 (optional and applicable on add and update) | String | User Defined Field of type String |
udf_string_3 (optional and applicable on add and update) | String | User Defined Field of type String |
udf_string_4 (optional and applicable on add and update) | String | User Defined Field of type String |
udf_string_5 (optional and applicable on add and update) | String | User Defined Field of type String |
udf_string_6 (optional and applicable on add and update) | String | User Defined Field of type String |
udf_string_7 (optional and applicable on add and update) | String | User Defined Field of type String |
udf_string_8 (optional and applicable on add and update) | String | User Defined Field of type String |
udf_float_1 (optional and applicable on add and update) | Float | User Defined Field of type Float |
udf_float_2 (optional and applicable on add and update) | Float | User Defined Field of type Float |
udf_float_3 (optional and applicable on add and update) | Float | User Defined Field of type Float |
udf_float_4 (optional and applicable on add and update) | Float | User Defined Field of type Float |
udf_date_1 (optional and applicable on add and update) | Date | User Defined Field of type Date |
udf_date_2 (optional and applicable on add and update) | Date | User Defined Field of type Date |
udf_date_3 (optional and applicable on add and update) | Date | User Defined Field of type Date |
udf_date_4 (optional and applicable on add and update) | Date | User Defined Field of type Date |
installed_items_set (mandatory based on conditions, applicable on add or remove) | Set of Installed Items | Defines a set of Installed Items which are returned credited through the related Credit Note. Applicable and mandatory (at least one installed item must be specified) only if the physical good sold is a traceable item. | Include Page |
|---|
| Web API - Updating Sets |
|---|
| Web API - Updating Sets |
|---|
|
| Tip |
|---|
Available from CRM.COM R17.0.0 |
|