Skip to end of banner
Go to start of banner

quick_sale_item_parameters

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 23 Current »

 quick_sale_item parameter object data

Name

Type

Description

product_identifier

(mandatory)

Products identifierThe product that will be related with the sale. 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

From CRM.COM R14.0.0 this parameter is used only when the quantity of the specified physical good equals to 1

installed_items_set

(mandatory based on conditions)

Set of Installed Items object

The installed items sold to the account owner. Mandatory only if the physical good sold is a traceable item.

Available from CRM.COM R14.0.0. Used only when the quantity of the traceable items are more than 1 and will be sold to a Partner who owns at least one warehouse


quantity

(mandatory based on conditions)

Number

The quantity of the physical good. Mandatory only if the sold physical good is a non-traceable item.

From CRM.COM R14.0.0, the quantity is also mandatory if the sold physical good is a traceable item which will be sold to a Partner who owns at least one warehouse

price_plan_identifier

(optional)

Price Plan Identifier

The Price Plan based on which the sold physical good will be invoiced. If not specified then a default Price Plan is used as defined in active Inventory Definitions. The allowed Price Plan identifiers fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the price plan

code

(semi-optional)

String

The code of the price plan

From CRM.COM R14.0.0, if the requested product is included in the agreed pricing agreement (price plan) of an Accounts, then the specified price plan should be the agreed one. If not specified, then the agreed price plan will be used by default. Otherwise, the default Price Plan is used as defined in active Inventory Definitions. This applies for quick sales of Accounts Receivables that are members of an Account Group. If no such pricing agreement exists, the process will remain as is

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

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 Accounts Receivable selected is related to a Partner that owns a warehouse as well. Only the Warehouses which are not owned by any Partner Group can be provided.

Name

Type

Description

id

(semi-optional)

String

The ID of the warehouse

name

(semi-optional)

String

The name of the warehouse

alternative_code

(semi-optional)

String

The alternative code of  the warehouse

Available from CRM.COM R14.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. Only the Warehouses owned by the specified Partner Group can be provided.

Name

Type

Description

id

(semi-optional)

String

The ID of the warehouse

name

(semi-optional)

String

The name of the warehouse

alternative_code

(semi-optional)

String

The alternative code of  the warehouse

Available from CRM.COM R14.0.0

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

Referred Parameter Objects Data

 quick_sale_installed_item parameter object data

Name

Type

Description

installed_item_identifier

(mandatory)

String

An existing installed item that will be sold to the account owner.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

 

      

       

  • No labels