invoice_item_update_parameters

Owned by George Rossides (Unlicensed)
Last updated: May 15, 2019 by Georgia Kountouri
 invoice_item parameter object data

Name

Type

Description

action

(mandatory)

StringE

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:

Name

Type

Description

id

(mandatory)

String

The ID of the invoice item

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:

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

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:

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

Deprecated from CRM.COM R17.0.0

quantity

(mandatory and applicable on add, optional on update)

number

The quantity of the product

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

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.

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

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:

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

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

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

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)

Set of Installed Items

Defines a set of Installed Items to be sold to the account owner through the related Invoice.  Applicable and mandatory (at least one installed item must be specified) only if the physical good sold is a traceable item.

Available from CRM.COM R17.0.0

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