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 |
invoice_item_identifier (mandatory and applicable only on update or remove) | Invoice Item Identifier | The identifier of the invoice item to be updated. The allowed invoice item identifier fields are the following: | Include Page |
|---|
| invoice_item_identifier |
|---|
| invoice_item_identifier |
|---|
|
|
product_identifier (mandatory and applicable only on add) | Products identifier | The product that will be related with the invoice item. The allowed product identifier fields are the following:| Include Page |
|---|
| product_identifier |
|---|
| product_identifier |
|---|
|
|
installed_item_identifier (mandatory based on conditions) | Installed Item identifier | The installed item sold to the account owner. Mandatory only if the physical good sold is a traceable item. The allowed installed item identifier fields are the following: | Include Page |
|---|
| installed_item_identifier |
|---|
| installed_item_identifier |
|---|
|
|
quantity (mandatory and applicable on add, optional on update) | number | The quantity of the product | Tip |
|---|
From CRM.COM R15.0.0, the quantity is applicable if the product provided is non-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 | Tip |
|---|
From CRM.COM R15.0.0, the cost or sub-total will be automatically provided by the pricing strategy thus they are not mandatory. If provided, then the specified value will be considered |
|
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. | Tip |
|---|
From CRM.COM R15.0.0, discount_percentage should not be available for stockable physical goods. |
|
discount_amount (optional and applicable on add and update) | number | The discount amount that is applied. Discount am | Tip |
|---|
From CRM.COM R15.0.0, discount_amount should not be available for stockable physical goods. |
ount 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 invoiced for the specified product. Sub total cannot be specified if the cost is specified | Tip |
|---|
From CRM.COM R15.0.0, the cost or sub-total will be automatically provided by the pricing strategy thus they are not mandatory. If provided, then the specified value will be considered |
| from_warehouse (optional on conditions) | String | The warehouse from which the installed items will be sold to the Partner. Applicable and mandatory only if the product is a stockable item based on the inventory definitions. Only the Warehouses which are owned by an Internal Group can be provided.
| Include Page |
|---|
warehouse_identifier | warehouse_identifier | | Tip |
|---|
Available from CRM.COM R15.0.0 |
to_warehouse (optional on conditions) | String | The warehouse to which the installed items sold to the Partner are moved to. Applicable and mandatory only if the Accounts Receivable selected is related to a Partner owning a Warehouse and the product is a stockable item based on the inventory definitions. Only the Warehouses owned by the specified Partner Group can be provided.| Include Page |
|---|
warehouse_identifier | warehouse_identifier | | Tip |
|---|
Available from CRM.COM R15.0.0 |
additive_discount_definition_identifier (optional) | String | The identifier of the additive discount (ad hoc) definition that will be applied on the product of the invoice. Applicable only on products which are stockable. The allowed additive discount identifier fields are the following: | Include Page |
|---|
| additive_discount_definition_identifier | additive_discount_definition_identifier | | Tip |
|---|
Available from CRM.COM R15.0.0 |
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 |