Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


The installed item which is returned by the account owner with this credit note. Mandatory only if the physical good sold is a traceable item. The allowed installed item identifier fields are the following:

installed
Expand
titlecredit_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:

Include Page
product_identifier
product

_identifier

installed_item_identifier

(mandatory based on conditions)

Installed Item identifier
Include Page
installed_item_identifier

_

item_

identifier

Tip

Available from CRM.COM R17.0.0

quantity

(mandatory based on conditions)

numberThe quantity of the product. Applicable only if a product is credited, not an installed item

cost

(semi-optional)

numberThe cost of the product. Cost cannot be specified if the sub total is specified

discount_percentage

(optional)

numberThe discount percentage that is applied. Discount percentage cannot be specified if the discount amount is specified.

discount_amount

(optional)

numberThe 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:

Include Page
vat_rate_identifier
vat_rate_identifier

Tip

Deprecated from CRM.COM R12.0.0


sub_total

(semi-optional)

numberThe 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.

Include Page
Web API - Updating Sets
Web API - Updating Sets

Tip

Available from CRM.COM R17.0.0


Anchor
credit_note_item referred objects parameters
credit_note_item referred objects parameters
Referred Parameter Objects Data

Include Page
financial_transaction_installed_item_parameters
financial_transaction_installed_item_parameters