POST accounts_receivable/quick_sale

Available from CRM.COM R13.0.0

This method performs a sales of physical goods for an account owner. Multiple traceable and non-traceable physical goods can be sold within a single call.

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

(mandatory)

Accounts Receivable Identifier

The identifier of the accounts receivable from which the money will be transferred. The allowed accounts receivable identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the accounts receivable

number

(semi-optional)

String

The number of the accounts receivable

name

(semi-optional)

String

The name of the accounts receivable

type_identifier

(optional)

Financial transaction type identifier

The financial transaction type of the sale's invoice. The allowed financial transaction type identifier field are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the financial transaction type

name

(semi-optional)

String

The name of the financial transaction type

alternative_code

(semi-optional)

String

The alternative code of the financial transaction type

category_identifier

(optional)

Financial transaction category identifier

The financial transaction category of the sales invoice. The allowed financial transaction category identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the financial transaction category

name

(semi-optional)

String

The name of the financial transaction category

code

(semi-optional)

String

The code of the financial transaction category

due_on

(optional)

Date

The date that the credit period for that specific invoice is ending.

intended_currency_identifier

(optional)

Currency Identifier

The currency that the user was intended to use for the invoice. If specified then it is validated against the currency of the specified accounts receivable and if they don't match then an error is thrown. Note that the intended currency is not saved within CRM.COM; it is just used for validation purposes. The allowed currency identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the currency

code

(semi-optional)

String

The code of the currency

notes

(optional)

String

Shared notes for the sales invoice

back_office_code

(optional)

String

A back office code for the sales invoice. If specified then it should be unique

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

quick_sale_items_set

(mandatory)

Set of invoice item objects

The physical goods sold to the account owner through this sale

fields_set

(optional)

List of Strings, comma separated

A list of fields that should be included in the results. If not specified then all the available fields will be returned

Referred Parameter Objects

quick_sale_item parameter object data

Name

Type

Description

product_identifier

(mandatory)

Products identifier

The 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

From CRM.COM R15.0.0, the price plan will be automatically applied through the pricing strategy

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

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

Restrictions

It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

Name	Type	Description
accounts_receivable	Accounts Receivable Object	The accounts receivable of the customer to which the physical goods were sold
invoice	Invoice Object	The Invoice of the quick sale
expenses_set	Set of Expenses	A list of Expenses that the account owner was invoiced because of the sale
quick_sale_items_set	Set of Quick Sale Items objects	A list of items which were sold to the account owner

Referred Objects Response Data

accounts_receivable object response data

Name	Type	Description
id	String	The ID of the retrieved accounts receivable
number	String	The number of the retrieved accounts receivable
name	String	The name of the retrieved accounts receivable
life_cycle_state	String	The life cycle state of the accounts receivable. One of the following values is returned: ACTIVE, SUSPENDED, TERMINATED
account_owner	Contact information object	The contact information owning the accounts receivable

Referred Objects Response Data

contact_information object response data

Name	Type	Description
id	String	The ID of the retrieved contact information
type	String	The type of the retrieved contact information which can be PERSON or COMPANY
life_cycle_state	String	The lifecycle state of the retrieved contact information which can be MARKETING or FINANCIAL
name	String	The full name of the retrieved contact information
first_name	String	The first name of the retrieved contact information
middle_name	String	The middle name of the retrieved contact information
last_name	String	The last name of the retrieved contact information
title	String	The title of the retrieved contact information
company_name	Sting	The company name of the retrieved contact information
demographics	Demographics Object	The demographics information of the retrieved contact information
company_profile	Company profile object	The company profile of the retrieve contact information

Referred Objects Response Data

demographics object response data

Name	Type	Description
gender	String	The gender of the retrieved contact information which can be MALE or FEMALE
id_number	String	The ID number of the retrieved contact information
id_number_expiration_date	Date	The ID number's expiration date of the retrieved contact information Available from CRM.COM R14.0.0
passport_number	String	The passport number of the retrieved contact information
passport_number_expiration_date	Date	The passport's expiration date of the retrieved contact information Available from CRM.COM R14.0.0
social_security_number	String	The social security number of the retrieved contact information
date_of_birth	Date of Birth Object	The date of birth of the retrieved contact information
name_day	Name Day Object	The name day of the retrieved contact information
country_of_residence	Country Object	The country of residence of the retrieved contact information
id_issued_by_country	Country Object	The ID issued country of retrieved contact information
passport_issued_by_country	Country Object	The passport issued country of retrieved contact information
industry	Industry Object	The industry of retrieved contact information
industry_sector	Industry sector Object	The sector of retrieved contact information

Referred Objects Response Data

date_of_birth object response data

Name	Type	Description
day	Integer	The day of the retrieved date of birth
month	Integer	The month of the retrieved date of birth
year	Integer	The year of the retrieved date of birth

name_day object response data

Name	Type	Description
day	Integer	The day of the retrieved name day
month	Integer	The month of the retrieved name day

country object response data

Name	Type	Description
id	String	The id of the retrieved country
name	String	The name of the retrieved country
alternative_code	String	The alternative code of the retrieved country
dialing_code	String	The dialing code of the retrieved country Available from CRM.COM R15.1.0
two_character_code	String	The two character code of the retrieved country
three_character_code	String	The three character code of the retrieved country
country_flag	Image Object	The flag of the retrieved country Available from CRM.COM R15.1.0

Referred Objects Response Data

country_flag object response data

Name	Type	Description
id	String	The ID of the retrieved country flag
file	File Object	The information of the attached file

Referred Objects Response Data

file object response data

Name	Type	Description
file_name	String	The name of the file
file_content_url	String	The url that can be used to access the actual content of the file
file_mime_type	String	The mime type of the attached file

industry object response data

Name	Type	Description
id	String	The id of the retrieved industry
name	String	The name of the retrieved industry
code	String	The code of the retrieved industry

industry sector object response data

Name	Type	Description
id	String	The id of the retrieved industry sector
name	String	The name of the retrieved industry sector
alternative_code	String	The alternative code of the retrieved industry sector

company profile object response data

Name	Type	Description
profile_year	Number	The profile year of the retrieved contact information
annual_turnover	Number	The annual turnover of the retrieved contact information
established_date	Date	The established date of the retrieved contact information
number_of_employees	Number	The number of employees of the retrieved contact information
registration_number	String	The registration number of the retrieved contact information
vat_registration_number	String	The vat registration number of the retrieved contact information
vat_registered_by	String	The vat registration by of the retrieved contact information
vat_registration_date	Date	The vat registration date of the retrieved contact information
tax_reference_number	String	The tax referenece number of the retrieved contact information
registered_in_country	Country Object	The country of residence of the retrieved contact information
industry	Industry Object	The industry of retrieved contact information
industry_sector	Industry sector Object	The sector of retrieved contact information

Referred Objects Response Data

country object response data

Name	Type	Description
id	String	The id of the retrieved country
name	String	The name of the retrieved country
alternative_code	String	The alternative code of the retrieved country
dialing_code	String	The dialing code of the retrieved country Available from CRM.COM R15.1.0
two_character_code	String	The two character code of the retrieved country
three_character_code	String	The three character code of the retrieved country
country_flag	Image Object	The flag of the retrieved country Available from CRM.COM R15.1.0

Referred Objects Response Data

country_flag object response data

Name	Type	Description
id	String	The ID of the retrieved country flag
file	File Object	The information of the attached file

Referred Objects Response Data

file object response data

Name	Type	Description
file_name	String	The name of the file
file_content_url	String	The url that can be used to access the actual content of the file
file_mime_type	String	The mime type of the attached file

industry object response data

Name	Type	Description
id	String	The id of the retrieved industry
name	String	The name of the retrieved industry
code	String	The code of the retrieved industry

industry sector object response data

Name	Type	Description
id	String	The id of the retrieved industry sector
name	String	The name of the retrieved industry sector
alternative_code	String	The alternative code of the retrieved industry sector

invoice object response data

Name	Type	Description
id	String	The ID of the retrieved invoice
number	String	The number of the retrieved invoice
reference_number	String	The reference number of the retrieved invoice
life_cycle_state	String	The life cycle state of the invoice. One of the following values is returned: DRAFT, REJECTED, POSTED, CANCELLED
issued_on	Date	The date that the invoice was issued
posted_on	Date	The date that the invoice was posted
due_on	Date	The date that the credit period for that specific invoice is ending.
total_amount	Number	The total amount of the invoice
outstanding_amount	Number	The total outstanding amount of the invoice
unsettled_amount	Number	The total unsettled amount of the invoice
currency_rate_period	Currency Rate Period object	The currency rate period based on which the invoice's amounts were calculated Available from CRM.COM R10.0.0

Referred Objects Response Data

currency rate period object response data

Name	Type	Description
id	String	The ID of the retrieved currency rate period
rate	Number	The exchange rate of the currency rate period
inverse_rate	Number	The inverse exchange rate of the currency rate period
from_date	Date	The date from which the exchange rate is valid
to_date	Date	The date until which the exchange rate is valid
currency	Currency Object	The Currency with which the returned exchange rate information refers to

Referred Objects Response Data

currency object response data

Name	Type	Description
id	String	The ID of the retrieved currency
code	String	The code of the retrieved currency
prefix_symbol	String	The prefix symbol for the specified currency
suffix_symbol	String	The suffix symbol for the specified currency
life_cycle_state	String	The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE Available from CRM.COM R14.0.0
integer_part_name	String	The integer part name for the specified currency
decimal_part_name	String	The decimal part name for the specified currency

product object response data

Name	Type	Description
Id	String	The ID of the product
code	String	The code of product
alternative_code	String	The alternative code of product
description	String	The description of product
priority_level	Integer	The priority level of the product Available from CRM.COM R12.3.0
global_rate	Global Rate Object	The global rate of the retrieved product Available from CRM.COM R15.0.0
product_type	Product type object	The type of the product

Referred Objects Response Data

product_type object data response

Name	Type	Description
Id	String	The ID of the retrieved product type
name	String	The Name of the retrieved product type
alternative_code	String	The Alternative Code of the retrieved product type
description	String	The Description of the retrieved product type
classification	String	The Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS
service_type	String	The Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE
physical_good_type	String	The physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE
composition_method	String	The Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE
used_for_provisioning	Boolean	The flag shows if the retrieved product type is used for provisioning
udr_type	Usage Detail Record Type	The UDR type related with the product type. This is applicable only if the product type is classified as SERVICES and the service type is set to USAGE
meter_reading_type	Meter Reading Type	The Meter Reading type related with the product type. This is applicable only for traceable physical goods Available from CRM.COM R14.0.0

Referred Objects Response Data

usage_detail_record_type object data response

Name	Type	Description
Id	String	The ID of the retrieved usage detail record type
name	String	The Name of the retrieved usage detail record type
alternative_code	String	The Alternative Code of the retrieved usage detail record type
description	String	The Description of the retrieved usage detail record type
unit_of_measurement	String	The Unit of measurement of the retrieved usage detail record type

Referred Objects Response Data

unit_of_measurement object response data

Name	Type	Description
id	String	The identifier of the Unit of measurement
name	String	The name of the Unit of measurement
description	String	The description of the Unit of measurement
alternative_code	String	The alternative code of the Unit of measurement

meter_reading_type object data response

Name	Type	Description
Id	String	The ID of the retrieved meter reading type
name	String	The Name of the retrieved meter reading type
alternative_code	String	The Alternative Code of the retrieved meter reading type
classification	String	The Classification of the retrieved meter reading type
description	String	The Description of the retrieved meter reading type
unit_of_measurement	String	The Unit of measurement of the retrieved meter reading type

Referred Objects Response Data

unit_of_measurement object response data

Name	Type	Description
id	String	The identifier of the Unit of measurement
name	String	The name of the Unit of measurement
description	String	The description of the Unit of measurement
alternative_code	String	The alternative code of the Unit of measurement

global rate object response data

Name	Type	Description
id	String	The ID of the retrieved rate
rate_model	String	The price plan rate model which can be one of the following: QUANTITYBASED QUANTITYANDPERIODBASED BILLABLEPERIODBASED DURATIONBASED FLATFEEBASED USAGEBASED From CRM.COM R17.0.0, QUANTITYANDMATURITYBASED is renamed to QUANTITYANDPERIODBASED
global_base_amount	Number	The base price of the product in the Global Price Plan
base_rate_applied_per	String	The value for 'Base Rate Applied per' Available when the rate model is 'Quantity & Quantity Based' and it is a selection between Period Period_Item
uot	String	The 'UOT' applicable for the rate Seconds Minute Hour Day Week Month Year Available for one-time services
time_period	Time Period Object	The period and unit of time for which the base amount is applicable for. This is available only on termed services rates.
uom	String	The 'UOM' applicable for the rate Available when the product type is of Usage Service Classification

Referred Objects Response Data

period object response data

Name

Type

Description

time_period_value

Number

The time period value

time_period_uot

String

The time period unit of time. The supported values are the following:

MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS

quick sale item object response data

Name	Type	Description
quantity	Number	The quantity of the purchased non-traceable physical good
product	Product object	The purchased non-traceable physical good
installed_item	Installed Item Object	The purchased traceable physical good
stock_out_warehouse_transaction	Warehouse Transaction	The stock out warehouse transaction that was applied in order to move the installed item out of the warehouse while selling it to the customer
stock_movement_warehouse_transaction	Warehouse Transaction	The stock movement warehouse transcation that was applied in order to move the installed item out of the warehouse while selling it to the partner, and move it in the partner's warehouse (if applicable) Available from CRM.COM R14.0.0

Referred Objects Response Data

product object response data

Name	Type	Description
Id	String	The ID of the product
code	String	The code of product
alternative_code	String	The alternative code of product
description	String	The description of product
priority_level	Integer	The priority level of the product Available from CRM.COM R12.3.0
global_rate	Global Rate Object	The global rate of the retrieved product Available from CRM.COM R15.0.0
product_type	Product type object	The type of the product

Referred Objects Response Data

product_type object data response

Name	Type	Description
Id	String	The ID of the retrieved product type
name	String	The Name of the retrieved product type
alternative_code	String	The Alternative Code of the retrieved product type
description	String	The Description of the retrieved product type
classification	String	The Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS
service_type	String	The Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE
physical_good_type	String	The physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE
composition_method	String	The Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE
used_for_provisioning	Boolean	The flag shows if the retrieved product type is used for provisioning
udr_type	Usage Detail Record Type	The UDR type related with the product type. This is applicable only if the product type is classified as SERVICES and the service type is set to USAGE
meter_reading_type	Meter Reading Type	The Meter Reading type related with the product type. This is applicable only for traceable physical goods Available from CRM.COM R14.0.0

Referred Objects Response Data

usage_detail_record_type object data response

Name	Type	Description
Id	String	The ID of the retrieved usage detail record type
name	String	The Name of the retrieved usage detail record type
alternative_code	String	The Alternative Code of the retrieved usage detail record type
description	String	The Description of the retrieved usage detail record type
unit_of_measurement	String	The Unit of measurement of the retrieved usage detail record type

Referred Objects Response Data

unit_of_measurement object response data

Name	Type	Description
id	String	The identifier of the Unit of measurement
name	String	The name of the Unit of measurement
description	String	The description of the Unit of measurement
alternative_code	String	The alternative code of the Unit of measurement

meter_reading_type object data response

Name	Type	Description
Id	String	The ID of the retrieved meter reading type
name	String	The Name of the retrieved meter reading type
alternative_code	String	The Alternative Code of the retrieved meter reading type
classification	String	The Classification of the retrieved meter reading type
description	String	The Description of the retrieved meter reading type
unit_of_measurement	String	The Unit of measurement of the retrieved meter reading type

Referred Objects Response Data

unit_of_measurement object response data

Name	Type	Description
id	String	The identifier of the Unit of measurement
name	String	The name of the Unit of measurement
description	String	The description of the Unit of measurement
alternative_code	String	The alternative code of the Unit of measurement

global rate object response data

Name	Type	Description
id	String	The ID of the retrieved rate
rate_model	String	The price plan rate model which can be one of the following: QUANTITYBASED QUANTITYANDPERIODBASED BILLABLEPERIODBASED DURATIONBASED FLATFEEBASED USAGEBASED From CRM.COM R17.0.0, QUANTITYANDMATURITYBASED is renamed to QUANTITYANDPERIODBASED
global_base_amount	Number	The base price of the product in the Global Price Plan
base_rate_applied_per	String	The value for 'Base Rate Applied per' Available when the rate model is 'Quantity & Quantity Based' and it is a selection between Period Period_Item
uot	String	The 'UOT' applicable for the rate Seconds Minute Hour Day Week Month Year Available for one-time services
time_period	Time Period Object	The period and unit of time for which the base amount is applicable for. This is available only on termed services rates.
uom	String	The 'UOM' applicable for the rate Available when the product type is of Usage Service Classification

Referred Objects Response Data

period object response data

Name

Type

Description

time_period_value

Number

The time period value

time_period_uot

String

The time period unit of time. The supported values are the following:

MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS

installed item object response data

Name	Type	Description
id	String	The ID of the retrieved installed item
serial_number	String	The serial number of the retrieved installed item
alternative_code	String	The alternative code of the retrieved installed item
state	String	The state of the retrieved installed item, which can be EFFECTIVE or NOT_EFFECTIVE
state_classification	State Classification object	The state classification of the retrieved installed item, which defines the reason why the installed item was set as Not Effective Applicable only if the Installed Item was set as Not Effective through automation process Available from CRM.COM R14.0.0
product	Product object	The product of the retrieved installed item

Referred Objects Response Data

product object response data

Name	Type	Description
Id	String	The ID of the product
code	String	The code of product
alternative_code	String	The alternative code of product
description	String	The description of product
priority_level	Integer	The priority level of the product Available from CRM.COM R12.3.0
global_rate	Global Rate Object	The global rate of the retrieved product Available from CRM.COM R15.0.0
product_type	Product type object	The type of the product

Referred Objects Response Data

product_type object data response

Name	Type	Description
Id	String	The ID of the retrieved product type
name	String	The Name of the retrieved product type
alternative_code	String	The Alternative Code of the retrieved product type
description	String	The Description of the retrieved product type
classification	String	The Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS
service_type	String	The Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE
physical_good_type	String	The physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE
composition_method	String	The Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE
used_for_provisioning	Boolean	The flag shows if the retrieved product type is used for provisioning
udr_type	Usage Detail Record Type	The UDR type related with the product type. This is applicable only if the product type is classified as SERVICES and the service type is set to USAGE
meter_reading_type	Meter Reading Type	The Meter Reading type related with the product type. This is applicable only for traceable physical goods Available from CRM.COM R14.0.0

Referred Objects Response Data

usage_detail_record_type object data response

Name	Type	Description
Id	String	The ID of the retrieved usage detail record type
name	String	The Name of the retrieved usage detail record type
alternative_code	String	The Alternative Code of the retrieved usage detail record type
description	String	The Description of the retrieved usage detail record type
unit_of_measurement	String	The Unit of measurement of the retrieved usage detail record type

Referred Objects Response Data

unit_of_measurement object response data

Name	Type	Description
id	String	The identifier of the Unit of measurement
name	String	The name of the Unit of measurement
description	String	The description of the Unit of measurement
alternative_code	String	The alternative code of the Unit of measurement

meter_reading_type object data response

Name	Type	Description
Id	String	The ID of the retrieved meter reading type
name	String	The Name of the retrieved meter reading type
alternative_code	String	The Alternative Code of the retrieved meter reading type
classification	String	The Classification of the retrieved meter reading type
description	String	The Description of the retrieved meter reading type
unit_of_measurement	String	The Unit of measurement of the retrieved meter reading type

Referred Objects Response Data

unit_of_measurement object response data

Name	Type	Description
id	String	The identifier of the Unit of measurement
name	String	The name of the Unit of measurement
description	String	The description of the Unit of measurement
alternative_code	String	The alternative code of the Unit of measurement

global rate object response data

Name	Type	Description
id	String	The ID of the retrieved rate
rate_model	String	The price plan rate model which can be one of the following: QUANTITYBASED QUANTITYANDPERIODBASED BILLABLEPERIODBASED DURATIONBASED FLATFEEBASED USAGEBASED From CRM.COM R17.0.0, QUANTITYANDMATURITYBASED is renamed to QUANTITYANDPERIODBASED
global_base_amount	Number	The base price of the product in the Global Price Plan
base_rate_applied_per	String	The value for 'Base Rate Applied per' Available when the rate model is 'Quantity & Quantity Based' and it is a selection between Period Period_Item
uot	String	The 'UOT' applicable for the rate Seconds Minute Hour Day Week Month Year Available for one-time services
time_period	Time Period Object	The period and unit of time for which the base amount is applicable for. This is available only on termed services rates.
uom	String	The 'UOM' applicable for the rate Available when the product type is of Usage Service Classification

Referred Objects Response Data

period object response data

Name

Type

Description

time_period_value

Number

The time period value

time_period_uot

String

The time period unit of time. The supported values are the following:

MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS

state classification object response data

Name	Type	Description
name	String	The name of the installed item's state classification
alternative_code	String	The alternative code of the installed item's state classification
description	String	The description of the installed item's state classification

warehouse transaction object response data

Name	Type	Description
id	String	The ID of the warehouse transaction that was created
number	String	The number of the warehouse transaction that was created
batch_number	String	The batch_number of the warehouse transaction that was created
life_cycle_state	String	The stated of the transaction which can be DRAFT or POSTED

Examples

Example 1

HTTP Method: Post

Request:

Body:

 {
   "token":"{{token}}",
   "accounts_receivable_identifier":{"number":"ACR0000012263"},
   "type_identifier":{"name":"Invoice"},
   "life_cycle_state":"POSTED",
   "category_identifier":{"name":"Invoice Categories"},
   "notes":"to be issued later",
   "udf_string_1":"udf string 1",
   "udf_string_2":"udf string 2",
   "udf_string_3":"udf string 3",
   "udf_string_4":"udf string 4",
   "udf_string_5":"udf string 5",
   "udf_string_6":"udf string 6",
   "udf_string_7":"udf string 7",
   "udf_string_8":"udf string 8",
   "udf_float_1":10,
   "udf_float_2":20,
   "udf_float_3":30,
   "udf_float_4":40,
   "udf_date_1":"2014-05-05T15:49:59",
   "udf_date_2":"2014-06-05T15:49:59",
   "udf_date_3":"2014-07-05T15:49:59",
   "udf_date_4":"2014-08-05T15:49:59",
   "quick_sale_items_set":
   [
      {
         "product_identifier": {"code": "Expense 1"}
      },
      {
         "product_identifier": {"code": "Antenna"},
         "quantity":3,
         "discount_percentage":5,
         "udf_string_1":"udf string 1",
         "udf_string_2":"udf string 2",
         "udf_string_3":"udf string 3",
         "udf_string_4":"udf string 4",
         "udf_string_5":"udf string 5",
         "udf_string_6":"udf string 6",
         "udf_string_7":"udf string 7",
         "udf_string_8":"udf string 8",
         "udf_float_1":10,
         "udf_float_2":20,
         "udf_float_3":30,
         "udf_float_4":40,
         "udf_date_1":"2014-05-05T15:49:59",
         "udf_date_2":"2014-06-05T15:49:59",
         "udf_date_3":"2014-07-05T15:49:59",
         "udf_date_4":"2014-08-05T15:49:59"
       },
 {
         "product_identifier": {"code": "Installation Kit"},
         "installed_item_identifier":{"serial_number": "IK_0001x"},
         "price_plan": {"code": "CPricePlan"},
         "udf_string_1":"udf string 1",
         "udf_string_2":"udf string 2",
         "udf_string_3":"udf string 3",
         "udf_string_4":"udf string 4",
         "udf_string_5":"udf string 5",
         "udf_string_6":"udf string 6",
         "udf_string_7":"udf string 7",
         "udf_string_8":"udf string 8",
         "udf_float_1":10,
         "udf_float_2":20,
         "udf_float_3":30,
         "udf_float_4":40,
         "udf_date_1":"2014-05-05T15:49:59",
         "udf_date_2":"2014-06-05T15:49:59",
         "udf_date_3":"2014-07-05T15:49:59",
         "udf_date_4":"2014-08-05T15:49:59"
       }
    ]
}

Response:

{
  "data": {
    "quick_sale_items_set": [
      {
        "product": {
          "code": "Installation Kit",
          "product_type": {
            "service_type": null,
            "used_for_provisioning": true,
            "alternative_code": "IK",
            "composition_method": "FIXEDBUNDLE",
            "name": "Installation Kit",
            "description": "Provisioning Installation kit that can include traceable and non traceable products",
            "id": "380C41872DA048DEB1D57CF67D7550F6",
            "classification": "PHYSICALGOODS",
            "physical_good_type": "TRACEABLE"
          },
          "alternative_code": "IK",
          "description": "Installation Kit",
          "id": "D970FFF8F63F4A489108FB60A69657D1"
        },
        "installed_item": {
          "product": {
            "code": "Installation Kit",
            "product_type": {
              "service_type": null,
              "used_for_provisioning": true,
              "alternative_code": "IK",
              "composition_method": "FIXEDBUNDLE",
              "name": "Installation Kit",
              "description": "Provisioning Installation kit that can include traceable and non traceable products",
              "id": "380C41872DA048DEB1D57CF67D7550F6",
              "classification": "PHYSICALGOODS",
              "physical_good_type": "TRACEABLE"
            },
            "alternative_code": "IK",
            "description": "Installation Kit",
            "id": "D970FFF8F63F4A489108FB60A69657D1"
          },
          "alternative_code": "IK_0001x",
          "serial_number": "IK_0001x",
          "id": "47775A48DE41455AA1E02224C3D0B9AD",
          "state": "EFFECTIVE"
        },
        "quantity": 1,
        "stock_out_warehouse_transaction": {
          "number": "2415",
          "batch_number": null,
          "id": "1B279BEB03294E06BDF17E0F7488BF2D",
          "life_cycle_state": "POSTED"
        }
      },
      {
        "product": {
          "code": "Antenna",
          "product_type": {
            "service_type": null,
            "used_for_provisioning": false,
            "alternative_code": "001",
            "composition_method": "FLAT",
            "name": "Equipment",
            "description": null,
            "id": "EQ",
            "classification": "PHYSICALGOODS",
            "physical_good_type": "NONTRACEABLE"
          },
          "alternative_code": "A",
          "description": "Antenna",
          "id": "872C558604704AA29D8512A70B608573"
        },
        "installed_item": null,
        "quantity": 3,
        "stock_out_warehouse_transaction": null
      }
    ],
    "accounts_receivable": {
      "number": "ACR0000012263",
      "name": "ACR0000012263",
      "id": "828C4BC409DF4E5AAD2EA1EC3E68224B",
      "life_cycle_state": "ACTIVE",
      "account_owner": {
        "company_profile": null,
        "company_name": null,
        "name": null,
        "last_name": "Kyriakou",
        "id": "E4C44CF8ECBE4218B755EC2B490907C6",
        "life_cycle_state": "FINANCIAL",
        "middle_name": null,
        "title": null,
        "type": "PERSON",
        "first_name": "Stella",
        "demographics": {
          "name_day": {
            "month": null,
            "day": null
          },
          "id_number": null,
          "gender": null,
          "date_of_birth": {
            "month": null,
            "year": null,
            "day": null
          },
          "industry_sector": null,
          "passport_number": null,
          "industry": null,
          "social_security_number": null,
          "id_issued_by_country": null,
          "passport_issued_by_country": null
        }
      }
    },
    "expenses_set": [
      {
        "code": "Expense 1",
        "product_type": {
          "service_type": "EXPENSE",
          "used_for_provisioning": false,
          "alternative_code": "006",
          "composition_method": "FLAT",
          "name": "Fees",
          "description": "Fees One Time Services",
          "id": "6",
          "classification": "SERVICES",
          "physical_good_type": null
        },
        "alternative_code": "E1",
        "description": "Expense 1",
        "id": "A9917A7895044BEF9499DD6958539D33"
      }
    ],
    "invoice": {
      "posted_on": "2017-07-19T21:18:42",
      "number": "I00003481",
      "total_amount": 38.5,
      "unsettled_amount": 38.5,
      "issued_on": "2017-07-19T21:18:38",
      "currency_rate_period": null,
      "id": "92795A6DF9CF4338BF3BF0DA17D652FA",
      "life_cycle_state": "POSTED",
      "outstanding_amount": 0,
      "reference_number": "7449",
      "due_on": "2017-07-21T21:18:42"
    }
  },
  "status": {
    "code": "OK",
    "description": "",
    "message": ""
  }
}