credit_note_item parameter object data
Name | Type | Description |
product_identifier (mandatory) | Products identifier | The product that will be related with the installed item. The allowed product identifier fields are the following: Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the product | code (semi-optional) | String | The code of the product | alternative_code (semi-optional) | String | The alternative code of the product |
|
quantity (mandatory based on conditions) | number | The quantity of the product. Applicable only if a product is credited, not an installed item |
cost (semi-optional) | number | The cost of the product. Cost cannot be specified if the sub total is specified |
discount_percentage (optional) | number | The discount percentage that is applied. Discount percentage cannot be specified if the discount amount is specified. |
discount_amount (optional) | number | The discount amount that is applied. Discount amount cannot be specified if the discount percentage is specified |
vat_rate_identifier (optional) | 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: Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the VAT rate | name (semi-optional) | String | The name of the VAT rate | alternative_code (semi-optional) | String | The alternative code of the VAT rate |
|
sub_total (semi-optional) | 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) | String | User Defined Field of type String |
udf_string_2 (optional) | String | User Defined Field of type String |
udf_string_3 (optional) | String | User Defined Field of type String |
udf_string_4 (optional) | String | User Defined Field of type String |
udf_string_5 (optional) | String | User Defined Field of type String |
udf_string_6 (optional) | String | User Defined Field of type String |
udf_string_7 (optional) | String | User Defined Field of type String |
udf_string_8 (optional) | String | User Defined Field of type String |
udf_float_1 (optional) | Float | User Defined Field of type Float |
udf_float_2 (optional) | Float | User Defined Field of type Float |
udf_float_3 (optional) | Float | User Defined Field of type Float |
udf_float_4 (optional) | Float | User Defined Field of type Float |
udf_date_1 (optional) | Date | User Defined Field of type Date |
udf_date_2 (optional) | Date | User Defined Field of type Date |
udf_date_3 (optional) | Date | User Defined Field of type Date |
udf_date_4 (optional) | Date | User Defined Field of type Date |
installed_items_set (mandatory based on conditions) | 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 is a traceable item. If no records are specified in the set then nothing will be updated. To update a record use "action" : "update". To remove a record use "action" : "remove". To add a record use "action" : "add". Different actions can be used within the same set. For example:
"set": [
{
"action": "update",
...........
},
{
"action": "remove",
...........
},
{
"action": "add",
...........
}
]
|
Referred Parameter Objects Data
finacial_transaction_line_item parameter object data
Name | Type | Description |
installed_item_identifier (mandatory) | Installed Item identifier | The installed item which is related to the financial transaction line item. The allowed installed item identifier fields are the following: Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the installed item | serial_number (semi-optional) | String | The serial number of the installed item | alternative_code (semi-optional) | String | The alternative code of a installed item |
|