Skip to end of banner
Go to start of banner

POST jobs/add_subscription_services/create

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

Version 1 Next »

This method creates a job of fulfillment scope Add Subscription Services. Single job can be created by each call. Only customer jobs can be created through this method.


Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

type_identifier
(mandatory)

Job type identifier

The identifier of the type of the new job. The allowed job type identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the job type

name

(semi-optional)

String

The name of the job type

alternative_code

(semi-optional)

String

The alternative code of  the job type

status_identifier
(optional)

Job status identifier

The identifier of the status of the new job. If not specified then the default one will be used. The allowed job status identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the job status

name

(semi-optional)

String

The name of the job status

alternative_code

(semi-optional)

String

The alternative code of  the job status

category_identifier
(optional)

Job category identifier

The identifier of the category of the new job. The allowed job category identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the job category

name

(semi-optional)

String

The name of the job category

code

(semi-optional)

String

The code of  the job category

accounts_receivable_identifier

(mandatory)

Accounts receivable identifier

The identifier of the new job accounts receivable. 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

subscription_identifier

(mandatory)

Subscriptions Identifier

The identifier of the subscription on which the requested subscription services will be added through the new job. The allowed subscription identifier fields are the following:

Name

Type

Description

id 

(semi-optional)

String

The ID of subscription

number 

(semi-optional)

String

The number of subscription

contact_email

(optional)

String

The email of the customer related with the job, which will be used in order to communicate the job

contact_phone

(optional)

 String

 The phone of the customer related with the job, which will be used in order to communicate the job

description
(optional)

StringThe description of the new job

notes
(optional)

StringThe notes of the new job

start_date
(optional)

DateThe date that the job is created

owned_by_group_identifier
(optional)

The identifier of the owned by group information

The owned by group information of the job. The allowed group identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the group

name

(semi-optional)

String

The code of the group

alternative_code

(semi-optional)

String

The alternative code of  the group

privacy_level_identifier
(optional)

The identifier of the privacy level

The privacy level of the job. The allowed privacy level identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the privacy level

 

number

(semi-optional)

String

The number of the privacy level

service_request_identifier
(optional)
The identifier of the service request

The service request related with the job. The allowed service request identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the service request

number

(semi-optional)

String

The number of the service request

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

expected_completion_date
(semi-optional)

DateThe date that the job is expected to be completed. It is automatically calculated if estimate completion time is specified.

estimated_completion_time
(semi-optional)

Time Period ObjectThe time that is estimated to complete the job, measured in minutes, hours, days, weeks, years. It is automatically calculated if expected completion date is specified.
billing_terms
(mandatory on conditions)
Job Billing terms object

The billing terms of the job to be created. This information is applicable and mandatory only if the job is billable

assigned_to
(mandatory)
Assigned to objectThe assignment information for the job

requested_subscription_services_set

(mandatory)

Set of Requested Subscription Service Objects

A list of services that were requested by the customer and should be provided as part of the subscription that will be updated. The subscription services are filtered based on the specified subscription type and billing term scheme. All the subscription related rules and restrictions are applicable on the requested subscription services as well

requested_physical_goods_set

(optional)

Set of Requested Physical Good Objects

A list of physical goods (products only) that are requested by the customer, and should be delivered as part of fulfilling the ordered job. The requested physical goods are filtered based on the selected job type. Mandatory physical goods are added automatically.

requested_subscription_physical_goods_set

(optional)

Set of Requested Subscription Physical Good Objects

A list of physical goods (products only) that were requested by the customer and should be provided as part of the subscription that will be updated. The subscription physical goods are filtered based on the specified subscription type. All the subscription related rules and restrictions are applicable on the requested subscription physical goods as well

requested_expenses_set

(optional)

Set of Requested Expense Objects

A list of requested expenses that are requested by the customer and should be delivered as part of fulfilling the ordered job. The requested expenses are filtered based on the selected job type. Mandatory expenses are added automatically

requested_activity_services_set

(optional)

Set of Requested Activity Service Objects

A list of one time services that are requested by the customer and should be delivered by a scheduling and performing a specific activity. The requested activity services are defined by specifying the type of the activity and the activity services that should be performed. The activity types are filtered based on the selected job type. The activity services are filtered based on the selected activity type. Mandatory activity types and services are added automatically.

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 Data

 time period parameter object data

Name

Type

Description

time_period_value

(mandatory)

Number

The time period value

time_period_uot

(mandatory)

String

The time period unit of time

The supported values are the following: MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS

 job_billing_terms object parameter data

Name

Type

Description

billing_term_scheme_identifier

(mandatory)

Billing term scheme identifier

The billing term scheme that will be used on the billing terms. The allowed billing term scheme identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the billing term scheme

code

(semi-optional)

String

The code of the billing term scheme

price_plan_identifier

(mandatory on conditions)

Price plan identifier

The price plan that will be used on the billing terms. The allowed price plan identifier 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

The price_plan_identifier is considered as mandatory up until CRM.COM R11.2.0.  From CRM.COM R11.2.0 the identifier becomes mandatory on conditions, which means that it is mandatory only as long as no default price plan is specified in the Billing Term Scheme

agreement_date

(mandatory)

DateThe agreement date of the billing terms that will be created. Billing terms agreement date is used to log the date that the billing terms were agreed and signed by the customer.

concurrent_usage_based_pricing

(mandatory on conditions)

Concurrent usage based pricing object

Concurrent usage based pricing is used to apply price plan rates based on the number of concurrent usage of the services or the installed items that will be billed, and a rate percentage which is agreed between the customer and the company providing those service. Concurrent usage based pricing is applicable and mandatory only if it is supported by the billing term schemes

This object is deprecated in CRM.COM R10.0.0 onwards

Referred Objects Response Data

 

 concurrent_usage_based_pricing object parameter data

Name

Type

Description

concurrent_usage

(mandatory)

Number

Defines the concurrent usage of services which will be billed based on the specified billing terms

Deprecated from CRM.COM R15.0.0

rate_percentage

(mandatory)

Number

Defines the rate percentage that should be applied on all services which will be billed based on the specified billing terms

Deprecated from CRM.COM R15.0.0

number_of_installed_items

(mandatory on conditions)

Number

The agreed number of installed items that will be concurrently consuming the related subscription's services. Applicable and mandatory if concurrent usage billing method is set to "based on number of installed items".

Available from CRM.COM R15.0.0

concurrent_usage_billing_method

(mandatory)

String

Defines how the subscription will be billed for the agreed concurrent usage. Available options are:

  • BASED_ON_NUMBER_OF_INSTALLED_ITEMS
  • BASED_ON_MAXIMUM_CAPACITY
  • BASED_ON_ACTUAL_CAPACITY

If not specified, then the billing method is considered as "based on number of installed items".

Available from CRM.COM R15.0.0

 assigned_to object parameter data
Name
Type
Description
user_identifier

(semi-optional)

User Identifier  

The identifier of the user that the assignable entity should be assigned to. The allowed user identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the user

username

(semi-optional)

String

The username of the user

business_unit_identifier

(semi-optional)

Business Unit Identifier 

The identifier of the business unit that the assignable entity should be assigned to. The allowed business unit identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the business unit

name

(semi-optional)

String

The code of the business unit

code

(semi-optional)

String

The code of the business unit

Available from CRM.COM R18.0.0

unit_identifier

(semi-optional)

Unit Identifier 

The identifier of the unit that the assignable entity should be assigned to. The allowed unit identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the Unit

name

(semi-optional)

String

The name of the Unit

alternative_code

(semi-optional)

String

The alternative code of  the Unit

Deprecated from CRM.COM R18.0.0

 job_requested_subscription_service object parameter data
Name
Type
Description
service_identifier

(mandatory)

Service identifier  

The identifier of the subscription service. Only products classified as services are retrieved. 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

swap_service_identifier

(mandatory)

Service identifier

 

The service of the subscription service which will swap the existing subscription service. This is applicable and mandatory only if the job type's fulfillment scope is set to Swap Subscription Services. Only products classified as services are retrieved.

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

Available from CRM.COM R9.0.0

period_billed_in_advance

(mandatory on conditions)

Integer

The period that the specified service will be billed in advance. Applicable and mandatory only for prepaid and pre-rated services.

Available from CRM.COM R14.0.0

period_billed_in_advance_uot

(mandatory on conditions)

String

The unit of time for the period that the specified service will be billed in advance. Applicable and mandatory only for prepaid and pre-rated services. The supported values are DAYS, WEEKS or MONTHS

Available from CRM.COM R14.0.0

provisioning_distribution_set

(optional)

Set of Subscription Service Distribution objects The distribution of the requested subscription services

components_set

(mandatory on conditions)

Set of Subscription Service Components objects

The service components that should be composing the specified service. This information is available and mandatory if the specified service is a flexible product bundle

Referred Parameter Objects Data

 subscription_service_distribution object parameter data
Name
Type
Description

provisioning_distributor_identifier

(mandatory)

Provisioning distributor identifier  

The identifier of the provisioning distributor. The allowed provisioning distributor identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the provisioning distributor

name

(semi-optional)

String

The name of the provisioning distributor

alternative_code

(semi-optional)

String

The alternative code of  the provisioning distributor

 subscription_service_component object parameter data
Name
Type
Description
service_identifier

(mandatory)

Service identifier  

The identifier of the service. Only products classified as services, which are also included in the product components of the related flexible product bundle are retrieved. The allowed service 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

 job_requested_physical_good object parameter data

Name

Type

Description

product_identifier
(mandatory)

Product Identifier

The identifier of the physical good related with the requested physical good. The allowed physical good 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

quantity
(optional)

NumberThe quantity of the requested physical good. If not specified then it is set to 1

notes

(optional)

String

The notes of the retrieved job requested physical goods

Available form CRM.COM R12.3.0

components_set

(applicable on conditions)

Set of Product Components objects

The physical good components that should be composing the specified physical good. This information is applicable only if the specified physical good is classified as a flexible product bundle

Available form CRM.COM R12.3.0

Referred Parameter Objects Data

 product component object parameter data
Name
Type
Description
product_identifier

(mandatory)

Product identifier  

The identifier of the product component. Only products that are allowed to be added on the related flexible product bundle are retrieved. 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

 job_requested_subscription_physical_good object parameter data

Name

Type

Description

product_identifier
(mandatory based on conditions)

Product Identifier

The identifier of the physical good related with the requested subscription physical good. This is applicable and mandatory if the job type's fulfillment scope is not set to Swap Subscription Installed Items. The allowed physical good 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

Job Type fulfillment scope Swap Subscription Installed Items is available from CRM.COM R9.0.0

installed_item_identifier

(mandatory based on conditions)

Installed Item IdentifierThe identifier of the installed item which is requested to be swapped with another installed item. This is applicable and mandatory only if the job type fulfillment scope is set to Swap Subscription Installed Items. 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

Available from CRM.COM R9.0.0

quantity
(optional)

NumberThe quantity of the requested subscription physical good. If not specified then it is set to 1

warranty_coverage_reason_identifier

(mandatory based on conditions)

Warranty Coverage Reason Identifier

The Warranty Coverage Reason which indicates if the requested to be swapped subscription installed item's warranty will eventually cover the replacement or not. This is applicable and mandatory in Swap Subscription Installed Items jobs and only if the requested to be swapped installed item is still under warranty.

Name

Type

Description

id

(semi-optional)

String

The ID of the warranty coverage reason

name

(semi-optional)

String

The name of the warranty coverage reason

alternative_code

(semi-optional)

String

The alternative code of the warranty coverage reason

Available from CRM.COM R9.0.0

notes

(optional)

String

The notes of the job requested subscription physical goods

Available form CRM.COM R12.3.0

provisioning_distribution_set

(optional)

Set of Subscription Physical Good Provisioning Distribution objectsThe distribution of the requested subscription physical good

Referred Parameter Objects Data

 subscription_physical_good_distribution object parameter data
Name
Type
Description

provisioning_distributor_identifier

(mandatory)

Provisioning distributor identifier  

The identifier of the provisioning distributor. The allowed provisioning distributor identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the provisioning distributor

name

(semi-optional)

String

The name of the provisioning distributor

alternative_code

(semi-optional)

String

The alternative code of  the provisioning distributor

 job_requested_expense object parameter data
Name
Type
Description
product_identifier

(mandatory)

Identifier  

The identifier of the product related with the job requested expense. 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


 job_requested_activity_service object parameter data

Name

Type

Description

activity_type_identifier

(mandatory)

Activity Type Identifier

The identifier of the activity type that will be created in order to deliver the requested activity service. The activity service is filtered based on the services allowed by the specified activity type. The allowed activity type identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the activity type

name

(semi-optional)

String

The code of the activity type

alternative_code

(semi-optional)

String

The alternative code of  the activity type

product_identifier
(mandatory)

Product Identifier

The identifier of the product related with the requested activity service. 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

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

id

String

The ID of the retrieved job

number

String

The number of the retrieved job 

descriptionStringThe description of the retrieved job 
notesStringThe notes of the retrieved job
contact_emailString

The email of the customer related with the retrieved job, which will be used in order to communicate the job

contact_phoneString

The phone of the customer related with the retrieved job, which will be used in order to communicate the job

life_cycle_state

String

The life cycle state of the retrieved job which can be DRAFT, PENDING, IN PROGRESS, COMPLETED, CANCELLED

start_dateDateThe date that the job is created
expected_completion_dateDateThe date that the job is expected to be completed
actual_completed_dateDateThe date that the job is actually completed
expiration_dateDate

The date on which the job expires.

Available form CRM.COM R13.0.0

rating_stateString 

The rating state of the job that can be PENDING or COMPLETED

udf_string_1

String

User Defined Field of type String

udf_string_2

String

User Defined Field of type String

udf_string_3

String

User Defined Field of type String

udf_string_4

String

User Defined Field of type String

udf_string_5

String

User Defined Field of type String

udf_string_6

String

User Defined Field of type String

udf_string_7

String

User Defined Field of type String

udf_string_8

String

User Defined Field of type String

udf_float_1

Float

User Defined Field of type Float

udf_float_2

Float

User Defined Field of type Float

udf_float_3

Float

User Defined Field of type Float

udf_float_4

Float

User Defined Field of type Float

udf_date_1

Date

User Defined Field of type Date

udf_date_2

Date

User Defined Field of type Date

udf_date_3

Date

User Defined Field of type Date

udf_date_4

Date

User Defined Field of type Date

assigned_toAssign ObjectThe assignment information of the retrieved job
typeJob type objectThe type information of the retrieved job
billing_termsJobs Billing Terms ObjectThe billing terms of the retrieved job
statusJob Status objectThe status information of the retrieved job
categoryJob Category objectThe category of the retrieved job
subscriptionSubscription Object

The subscription that the subscription services were added on through the retrieved job.

service_requestService Request Object

The service request that was related with the retrieved job.

estimated_completion_timeTime Period ObjectThe time that is estimated to complete the job, measured in minutes, hours, days, weeks, years
time_to_completionTime Period ObjectThe time that is left up to the expected completion date
time_overdueTime Period ObjectThe time past the expected completion date

accounts_receivable

Accounts Receivable object

The accounts receivable related with the specified job

pricing_agreement_price_planPrice Plan Object

The pricing agreement that was assigned against an Accounts Receivable

Applicable for an Accounts Receivable that is owned by a Company (Corporate Account) and a Price Plan was agreed as part of a special pricing agreement

Applicable for Accounts Receivables that are members in the related Corporate Account Group as well

Available from CRM.COM R14.0.0

locationAddress ObjectThe physical location that the job should be performed and delivered to
cancellation_reasonJobs Cancellation Object

The reason that the job was cancelled. This is applicable only if the job is on a cancelled life cycle state

owned_by_groupGroup objectThe group that is owning the job
privacy_levelPrivacy level objectThe job privacy level

log_information

Log Information Object

The log information related with the retrieved job

requested_subscription_services_setSet of Requested Subscription Services Objects

The subscription services that were requested by the retrieved job to be added on the subscription.

requested_physical_goods_setSet of Requested Physical Goods Objects

The physical goods that were requested by the retrieved job

requested_subscription_physical_goods_setSet of Requested Subscription Physical Goods Objects

The subscription physical goods that were requested by the retrieved job to be added on the subscription.

requested_expenses_setSet of Requested Expenses Objects

The expenses that were requested by the retrieved job

requested_activity_services_setSet of Requested Activity Services Objects

The activity services that were requested by the retrieved job

subscription_physical_goods_setSet of Subscription Physical Goods Objects

The subscription physical goods that were adde don the subscription through the job.

subscription_services_setSet of Subscription Services Objects

The subscription services that will be provided as part of the job.

physical_goods_setSet of Physical Goods Objects

The physical goods that will be provided as part of the job

expenses_setSet of Expense ObjectsA list of one time services which are applied on the job as expenses
activities_setSet of Activity ObjectsA set of activities which are planned for the specific job

bills_set

Set of Bill Objects A set of bills that were generated by the billing engine in relation to the specific job

 

Referred Objects Response Data

 assigned_to object response data

Name

Type

Description

userUser objectThe user which is assigned with the retrieved activity 
business_unitBusiness Unit object

The business unit which is assigned with the retrieved activity

Available from CRM.COM R18.0.0

unitUnit object

The unit which is assigned with the retrieved activity 

Deprecated from CRM.COM R18.0.0

Referred Objects Response Data

 user object response data

Name

Type

Description

id

String

The ID of the retrieved user

username

String

The user name of the retrieved user

person_name

String

The full name of the retrieved user

email

String

The email of the retrieved user

 business unit object response data

Name

Type

Description

id

String

The ID of the retrieved business unit

name

String

The name of the retrieved business unit

codeStringThe code of the retrieved business unit
unified_codeString

The unified code of the retrieved business unit

description

String

The description of the retrieved business unit

parent_business_unit_nameStringThe name of the parent business unit that the retrieved business unit belongs to

 unit object response data

Name

Type

Description

id

String

The ID of the retrieved unit

name

String

The name of the retrieved unit

group_name

String

The name of the group that the retrieved unit belongs to

community_name

String

The name of the community that the retrieved unit belongs to

alternative_code

String

The alternative code of the retrieved unit

description

String

The description of the retrieved unit

 job_type response data object
NameType Description
IdStringThe ID of the retrieved job type
nameStringThe Name of the retrieved job type
alternative_codeStringThe Alternative Code of the retrieved job type
descriptionStringThe Description of the retrieved job type
billing_directiveString

The billing directive of the retrieved job type

The supported billing directive options are

  • BILLABLE
  • NOT_BILLABLE

Available from CRM.COM R10.0.0

billing_methodString

The billing method of the retrieved job type. Applicable only for billable job types with fulfillment scope GENERIC_PURPOSE

The supported billing methods are

  • BILL_ON_STARTING_PROGRESS
  • BILL_ON_COMPLETION

Available from CRM.COM R10.0.0

From CRM.COM R15.0.0 and onward, this attribute will be deprecated

fulfillment_scopeString

The fulfillment scope of the retrieved job type

The supported fulfillment scopes are

  • GENERIC_PURPOSE
  • NEW_SUBSCRIPTION
  • ACTIVATE_SUBSCRIPTION
  • DEACTIVATE_SUBSCRIPTION
  • CANCEL_SUBSCRIPTION
  • ADD_SUBSCRIPTION_SERVICES
  • CANCEL_SUBSCRIPTION_SERVICES
  • CHANGE_SUBSCRIPTION_LOCATION
  • SWAP_SUBSCRIPTION_SERVICES
  • SWAP_SUBSCRIPTION_INSTALLED_ITEMS
  • REPLACE_PHYSICAL_GOODS

The following fulfillment scopes will be available from CRM.COM R8.0.0

ACTIVATE_SUBSCRIPTION, DEACTIVATE_SUBSCRIPTION, CANCEL_SUBSCRIPTION, ADD_SUBSCRIPTION_SERVICES, CANCEL_SUBSCRIPTION_SERVICES, CHANGE_SUBSCRIPTION_LOCATION

The following fulfillment scopes will be available from CRM.COM R9.0.0

SWAP_SUBSCRIPTION_SERVICES, SWAP_SUBSCRIPTION_INSTALLED_ITEMS

The following fulfillment scope will be available from CRM.COM R11.0.0

REPLACE_PHYSICAL_GOODS

From CRM.COM R15.0.0 and onward, all fulfillment scopes will be deprecated

fulfillment_methodString

The fulfillment method of the retrieved job type

The supported fulfillment methods are

  • BASED_ON_ORDERED_ITEMS
  • BASED_ON_DELIVERED_ITEMS

From CRM.COM R15.0.0 and onward, this attribute will be deprecated

 job_billing_terms object response data

Name

Type

Description

id

String

The ID of the retrieved billing terms

life_cycle_stateStringThe life cycle state of the retrieved billing terms which can be EFFECTIVE or TERMINATED
agreement_dateDateThe agreement date of the retrieved billing terms. Billing terms agreement date is used to log the date that the billing terms were agreed and signed by the customer
effective_dateDate The effective date of the retrieved billing terms
expiration_dateDateThe expiration date of the retrieved billing terms
concurrent_usage_based_pricingConcurrent usage based pricing object

Concurrent usage based pricing is used to apply price plan rates based on the number of concurrent usage of the services or the installed items that will be billed, and a rate percentage which is agreed between the customer and the company providing those services

Not available from CRM.COM R10.0.0 and onward

billing_term_schemeBilling term scheme objectThe billing term scheme of the retrieved billing terms
price_planPrice plan objectThe price plan of the retrieved billing terms

Referred Objects Response Data

 concurrent_usage_based_pricing object response data

Name

Type

Description

concurrent_usage

Number

Defines the concurrent usage of services which will be billed based on the specified billing terms

Deprecated from CRM.COM R15.0.0

rate_percentage

Number

Defines the rate percentage that should be applied on all services which will be billed based on the specified billing terms

Deprecated from CRM.COM R15.0.0

number_of_installed_itemsNumber

The agreed number of installed items that will be concurrently consuming the subscription's services

Available from CRM.COM R15.0.0

 concurrent_usage_billing_methodString

Defines how the subscriber will be billed because of the concurrent usage of the subscription's services. Available options are:

  • BASED_ON_NUMBER_OF_INSTALLED_ITEMS,
  • BASED_ON_MAXIMUM_CAPACITY
  • BASED_ON_ACTUAL_CAPACITY

Available from CRM.COM R15.0.0


 billing_term_scheme object response data

Name

Type

Description

id

String

The ID of the retrieved billing term scheme

codeStringThe code of the retrieved billing term scheme
nameStringThe name of the retrieved billing term scheme
life_cycle_stateString

The life cycle state of the retrieved billing term scheme. The supported life cycle states are the following

DRAFT, EFFECTIVE, TERMINATED

classificationString

The classification of the retrieved billing term scheme which can be either NORMAL or PREPAID

Classification options NORMAL and PREPAID are available from CRM.COM R15.0.0

Prior CRM.COM R15.0.0 the options are SUBSCRIPTIONS or JOBS

billing_typeString

The billing type of the billing term scheme which can be PRE_BILL or POST_BILL for NORMAL billing term schemes and PRE_RATED or POST_RATED for PREPAID billing term schemes

Billing type options PRE/POST_BILL and PRE/POST_RATED are available from CRM.COM R15.0.0

Prior CRM.COM R15.0.0 the options are NORMAL and PREPAID

billing_methodStringThe billing method of the billing term scheme which can be ANNIVERSARY or PERIOD

 price_plan object data response
NameType Description
IdStringThe ID of the retrieved price plan
nameStringThe Name of the retrieved price plan
codeStringThe Code of the retrieved price plan
descriptionStringThe Description of the retrieved price plan
typeStringThe Type of the retrieved price plan which can be BASE or CONDITIONAL
effective_date DateThe Effective Date of the retrieved price plan
expiration_date Date

The Expiration Date of the retrieved price plan

currencyCurrency Object

The Currency of the retrieved price plan

Available from CRM.COM R14.2.0

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_symbolStringThe prefix symbol for the specified currency

suffix_symbol

StringThe suffix symbol for the specified currency
life_cycle_stateString

The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE

Available from CRM.COM R14.0.0

integer_part_nameStringThe integer part name for the specified currency
decimal_part_nameStringThe decimal part name for the specified currency

 

 

 job_status object response data

Name

Type

Description

id

String

The ID of the retrieved job status

name

String

The name of the retrieved job status

alternative_code

String

The alternative code of the retrieved job status

descriptionStringA description of the retrieved job status
life_cycle_stateString

The life cycle state related with the retrieved job status

The supported life cycle states are the following: DRAFT, PENDING, IN_PROGRESS,COMPLETED,CANCELLED

 job_category response data object
NameType Description
IdStringThe ID of the retrieved job category
nameStringThe Name of the retrieved job category
codeStringThe code of the retrieved job category
descriptionStringThe Description of the retrieved job category

 subscription object response data

Name

Type

Description

id

String

The ID of the retrieved subscription

number

String

The number of the retrieved subscription

life_cycle_state

String

The life cycle state of the subscription. One of the following values is returned

DRAFT, EFFECTIVE, NOT_EFFECTIVE, SHORT_TERM_EFFECTIVE, SHORT_TERM_NOT_EFFECTIVE, IN_RESTING, CANCELLED, REGRETTED, REPLACED, PENDING_VERIFICATION

REPLACED life cycle state available from CRM.COM R14.0.0, deprecated in CRM.COM R17.0.0

PENDING_VERIFICATION life cycle state available from CRM.COM R15.0.0

first_activated_dateDate

The date that the subscription became effective for the first time (i.e. the date that the first effective period of that subscription started)

Available from CRM.COM R9.0.0

rating_stateString

The rating state of the retrieved subscription that can be PENDING or COMPLETED

Available from CRM.COM R9.0.0

accounts_receivableAccounts receivable objectThe accounts receivable owning the subscriptions
typeSubscription type objectThe type of the retrieved subscription

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

nameStringThe 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_ownerContact information objectThe 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_nameSting

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_dateDate

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_dateDate

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_codeString

The alternative code of the retrieved country

dialing_codeString

The dialing code of the retrieved country

Available from CRM.COM R15.1.0

two_character_codeString

The two character code of the retrieved country

three_character_codeString

The three character code of the retrieved country

country_flagImage 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

fileFile ObjectThe information of the attached file

Referred Objects Response Data

 file object response data

 

Name

Type

Description

file_nameStringThe name of the file
file_content_urlStringThe url that can be used to access the actual content of the file
file_mime_typeStringThe 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_employeesNumber

The number of employees of the retrieved contact information

registration_number

String

The registration number of the retrieved contact information

vat_registration_numberString

The vat registration number of the retrieved contact information

vat_registered_byString

The vat registration by of the retrieved contact information

vat_registration_date

Date

The vat registration date of the retrieved contact information

tax_reference_numberString

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_codeString

The alternative code of the retrieved country

dialing_codeString

The dialing code of the retrieved country

Available from CRM.COM R15.1.0

two_character_codeString

The two character code of the retrieved country

three_character_codeString

The three character code of the retrieved country

country_flagImage 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

fileFile ObjectThe information of the attached file

Referred Objects Response Data

 file object response data

 

Name

Type

Description

file_nameStringThe name of the file
file_content_urlStringThe url that can be used to access the actual content of the file
file_mime_typeStringThe 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

 subscription type object response data

Name

Type

Description

id

String

The ID of the retrieved subscription type

name

String

The name of the retrieved subscription type

alternative_code

String

The alternative code of the retrieved subscription type

descriptionStringA description of the retrieved subscription type
classificationString

The classification of the retrieved subscription type, Flexible or Package

Available from CRM.COM R14.0.0

Deprecated from CRM.COM R17.0.0

 service_request object response data

Name

Type

Description

id

String

The ID of the retrieved service request

number

String

The number of the retrieved service request

descriptionStringThe description of the retrieved service request

life_cycle_state

String

The life cycle state of the retrieved service request which can be PENDING, RESPONDED, TEMPORARY_RESOLVED, FINAL_RESOLVED, COMPLETED

accounts_receivable

Accounts Receivable object

The accounts receivable related with the specified service request


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

nameStringThe 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_ownerContact information objectThe 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_nameSting

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_dateDate

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_dateDate

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_codeString

The alternative code of the retrieved country

dialing_codeString

The dialing code of the retrieved country

Available from CRM.COM R15.1.0

two_character_codeString

The two character code of the retrieved country

three_character_codeString

The three character code of the retrieved country

country_flagImage 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

fileFile ObjectThe information of the attached file

Referred Objects Response Data

 file object response data

 

Name

Type

Description

file_nameStringThe name of the file
file_content_urlStringThe url that can be used to access the actual content of the file
file_mime_typeStringThe 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_employeesNumber

The number of employees of the retrieved contact information

registration_number

String

The registration number of the retrieved contact information

vat_registration_numberString

The vat registration number of the retrieved contact information

vat_registered_byString

The vat registration by of the retrieved contact information

vat_registration_date

Date

The vat registration date of the retrieved contact information

tax_reference_numberString

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_codeString

The alternative code of the retrieved country

dialing_codeString

The dialing code of the retrieved country

Available from CRM.COM R15.1.0

two_character_codeString

The two character code of the retrieved country

three_character_codeString

The three character code of the retrieved country

country_flagImage 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

fileFile ObjectThe information of the attached file

Referred Objects Response Data

 file object response data

 

Name

Type

Description

file_nameStringThe name of the file
file_content_urlStringThe url that can be used to access the actual content of the file
file_mime_typeStringThe 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

 period object response data

Name

Type

Description

time_period_valueNumber

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

 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

nameStringThe 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_ownerContact information objectThe 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_nameSting

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_dateDate

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_dateDate

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_codeString

The alternative code of the retrieved country

dialing_codeString

The dialing code of the retrieved country

Available from CRM.COM R15.1.0

two_character_codeString

The two character code of the retrieved country

three_character_codeString

The three character code of the retrieved country

country_flagImage 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

fileFile ObjectThe information of the attached file

Referred Objects Response Data

 file object response data

 

Name

Type

Description

file_nameStringThe name of the file
file_content_urlStringThe url that can be used to access the actual content of the file
file_mime_typeStringThe 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_employeesNumber

The number of employees of the retrieved contact information

registration_number

String

The registration number of the retrieved contact information

vat_registration_numberString

The vat registration number of the retrieved contact information

vat_registered_byString

The vat registration by of the retrieved contact information

vat_registration_date

Date

The vat registration date of the retrieved contact information

tax_reference_numberString

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_codeString

The alternative code of the retrieved country

dialing_codeString

The dialing code of the retrieved country

Available from CRM.COM R15.1.0

two_character_codeString

The two character code of the retrieved country

three_character_codeString

The three character code of the retrieved country

country_flagImage 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

fileFile ObjectThe information of the attached file

Referred Objects Response Data

 file object response data

 

Name

Type

Description

file_nameStringThe name of the file
file_content_urlStringThe url that can be used to access the actual content of the file
file_mime_typeStringThe 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

 price_plan object data response
NameType Description
IdStringThe ID of the retrieved price plan
nameStringThe Name of the retrieved price plan
codeStringThe Code of the retrieved price plan
descriptionStringThe Description of the retrieved price plan
typeStringThe Type of the retrieved price plan which can be BASE or CONDITIONAL
effective_date DateThe Effective Date of the retrieved price plan
expiration_date Date

The Expiration Date of the retrieved price plan

currencyCurrency Object

The Currency of the retrieved price plan

Available from CRM.COM R14.2.0

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_symbolStringThe prefix symbol for the specified currency

suffix_symbol

StringThe suffix symbol for the specified currency
life_cycle_stateString

The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE

Available from CRM.COM R14.0.0

integer_part_nameStringThe integer part name for the specified currency
decimal_part_nameStringThe decimal part name for the specified currency

 address object response data

From R14.2.0, the following object is applicable for CRM.COM Address Format

Name

Type

Description

id

String

The ID of the retrieved address

type

String

The type of the retrieved address which can be

HOME, BUSINESS, POBOX, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5

postal_code

String

The postal code of the retrieved address

street_name

String

The street name of the retrieved address

street_number

String

The street number of the retrieved address

floor

Integer

The floor of the retrieved address

apartment_number

String

The apartment number of the retrieved address

area

String

The area of the retrieved address

town_city

String

The town / city of the retrieved address

district

String

The district of the retrieved address

municipality         

String

The municipality of the retrieved address

po_box

String

The PO box of the retrieved address

po_box_postal_code

String

The PO box postal code of the retrieved address

care_of

String

The care of person of the retrieved address

udf_string_1

String

User Defined Field of type String

udf_string_2

String

User Defined Field of type String

udf_string_3

String

User Defined Field of type String

udf_string_4

String

User Defined Field of type String

udf_string_5

String

User Defined Field of type String

udf_string_6

String

User Defined Field of type String

udf_string_7

String

User Defined Field of type String

udf_string_8

String

User Defined Field of type String

udf_string_9

String

User Defined Field of type String

udf_string_10

String

User Defined Field of type String

udf_string_11

String

User Defined Field of type String

udf_string_12

String

User Defined Field of type String

udf_string_13

String

User Defined Field of type String

udf_string_14

String

User Defined Field of type String

udf_string_15

String

User Defined Field of type String

udf_string_16

String

User Defined Field of type String

udf_float_1

Float

User Defined Field of type Float

udf_float_2

Float

User Defined Field of type Float

udf_float_3

Float

User Defined Field of type Float

udf_float_4

Float

User Defined Field of type Float

udf_date_1

Date

User Defined Field of type Date

udf_date_2

Date

User Defined Field of type Date

udf_date_3

Date

User Defined Field of type Date

udf_date_4

Date

User Defined Field of type Date

country

Country Object

The country of the retrieved address

is_primaryBoolean

Defines if the address is the contact's primary address or not.

Available from CRM.COM R15

 

From R14.2.0, the following object is applicable for International Address Format

Name

Type

Description

id

String

The ID of the retrieved address

type

String

The type of the retrieved address which can be

HOME, BUSINESS, POBOX, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5

postal_code

String

The postal code of the retrieved address

town_city

String

The town / city of the retrieved address

address_line_1

String

The address line 1

address_line_2

String

 The address line 2

state_province_county

String

The state or province or county of the address.

udf_string_1

String

User Defined Field of type String

udf_string_2

String

User Defined Field of type String

udf_string_3

String

User Defined Field of type String

udf_string_4

String

User Defined Field of type String

udf_string_5

String

User Defined Field of type String

udf_string_6

String

User Defined Field of type String

udf_string_7

String

User Defined Field of type String

udf_string_8

String

User Defined Field of type String

udf_string_9

String

User Defined Field of type String

udf_string_10

String

User Defined Field of type String

udf_string_11

String

User Defined Field of type String

udf_string_12

String

User Defined Field of type String

udf_string_13

String

User Defined Field of type String

udf_string_14

String

User Defined Field of type String

udf_string_15

String

User Defined Field of type String

udf_string_16

String

User Defined Field of type String

udf_float_1

Float

User Defined Field of type Float

udf_float_2

Float

User Defined Field of type Float

udf_float_3

Float

User Defined Field of type Float

udf_float_4

Float

User Defined Field of type Float

udf_date_1

Date

User Defined Field of type Date

udf_date_2

Date

User Defined Field of type Date

udf_date_3

Date

User Defined Field of type Date

udf_date_4

Date

User Defined Field of type Date

country

Country Object

The country of the retrieved address

is_primaryBoolean

Defines if the address is the contact's primary address or not.

Available from CRM.COM R15

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_codeString

The alternative code of the retrieved country

dialing_codeString

The dialing code of the retrieved country

Available from CRM.COM R15.1.0

two_character_codeString

The two character code of the retrieved country

three_character_codeString

The three character code of the retrieved country

country_flagImage 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

fileFile ObjectThe information of the attached file

Referred Objects Response Data

 file object response data

 

Name

Type

Description

file_nameStringThe name of the file
file_content_urlStringThe url that can be used to access the actual content of the file
file_mime_typeStringThe mime type of the attached file

 job_cancellation_reasons object response data

Name

Type

Description

id

String

The ID of the retrieved job cancellation reason

name

String

The name of the retrieved job cancellation reason

alternative_code

String

The alternative code of the retrieved job cancellation reason

descriptionStringA description of the retrieved job cancellation reason

 group object response data

Name

Type

Description

id

String

The ID of the retrieved group

name

String

The name of the retrieved group

community_name

String

The name of the community that the retrieved group belongs to

alternative_code

String

The alternative code of the retrieved group

unified_codeString

The unified code of the retrieved group

Available from CRM.COM R16.2.2

description

String

The description of the retrieved group

 privacy_level object response data

Name

Type

Description

id

String

The id of the retrieved privacy level

numberStringThe number of the retrieved privacy level

name

String

The name of the retrieved privacy level

hierarchy_level

String

The hierarchy level of the retrieved privacy level

 job_requested_subscription_service object response data

Name

Type

Description

id

String

The ID of the retrieved job requested subscription service

productProducts ObjectThe product related with the retrieved job requested subscription service
swap_productProducts Object

The product related with the retrieved job requested swap subscription service. This product swaps the existing subscription service. Applies only if the fulfillment scope of the job type is set to Swap Subscription Services

Available from CRM.COM R9.0.0

product_bundleProducts ObjectThe service bundle that contains the specified product as a product bundle. This information is available only if the specified product was added as part of a flexible product bundle.
provisioning_distributorProvisioning Distributor ObjectThe provisioning distributor on which the retrieved job requested subscription service will be distributed on

Referred Objects Response Data

 product object response data
Name
Type
Description
IdStringThe ID of the product
codeStringThe code of product

alternative_code

String

The alternative code of product

description

String

The description of product

priority_levelInteger

The priority level of the product

Available from CRM.COM R12.3.0

global_rateGlobal Rate Object

The global rate of the retrieved product

Available from CRM.COM R15.0.0

product_typeProduct type objectThe type of the product

Referred Objects Response Data

 product_type object data response
NameType Description
IdStringThe ID of the retrieved product type
nameStringThe Name of the retrieved product type
alternative_codeStringThe Alternative Code of the retrieved product type
descriptionStringThe Description of the retrieved product type
classificationStringThe Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS
service_typeStringThe Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE
physical_good_typeStringThe physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE
composition_methodStringThe Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE
used_for_provisioningBooleanThe flag shows if the retrieved product type is used for provisioning
udr_typeUsage Detail Record TypeThe 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_typeMeter 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
NameType Description
IdStringThe ID of the retrieved usage detail record type
nameStringThe Name of the retrieved usage detail record type
alternative_codeStringThe Alternative Code of the retrieved usage detail record type
descriptionStringThe Description of the retrieved usage detail record type
unit_of_measurementStringThe Unit of measurement of the retrieved usage detail record type

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe 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_codeStringThe alternative code of the Unit of measurement

 

 meter_reading_type object data response
NameType Description
IdStringThe ID of the retrieved meter reading type
nameStringThe Name of the retrieved meter reading type
alternative_codeStringThe Alternative Code of the retrieved meter reading type
classificationStringThe Classification of the retrieved meter reading type
descriptionStringThe Description of the retrieved meter reading type
unit_of_measurementStringThe Unit of measurement of the retrieved meter reading type

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe 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_codeStringThe 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_amountNumber

The base price of the product in the Global Price Plan

base_rate_applied_perString

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
uotString

The 'UOT' applicable for the rate

  • Seconds
  • Minute
  • Hour
  • Day
  • Week
  • Month
  • Year

Available for one-time services

time_periodTime Period Object

 The period and unit of time for which the base amount is applicable for. This is available only on termed services rates.

uomString

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_valueNumber

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

 provisioning_distributor object response data

Name

Type

Description

id

String

The id of the retrieved provisioning distributor

name

String

The name of the retrieved provisioning distributor

alternative_code

String

The alternative code of the retrieved provisioning distributor

 

 job_requested_physical_good object response data

Name

Type

Description

id

String

The ID of the retrieved job requested physical good

quantityNumberThe quantity of the retrieved job requested physical good
notesString

The notes of the retrieved job requested physical goods

Available form CRM.COM R12.3.0

productProducts ObjectThe product related with the retrieved job requested physical good
components_setSet of Products Object

The product components that are included in the specified product bundle. This information is available only if the specified product is a flexible product bundle

Available form CRM.COM R12.3.0

Referred Objects Response Data

 product object response data
Name
Type
Description
IdStringThe ID of the product
codeStringThe code of product

alternative_code

String

The alternative code of product

description

String

The description of product

priority_levelInteger

The priority level of the product

Available from CRM.COM R12.3.0

global_rateGlobal Rate Object

The global rate of the retrieved product

Available from CRM.COM R15.0.0

product_typeProduct type objectThe type of the product

Referred Objects Response Data

 product_type object data response
NameType Description
IdStringThe ID of the retrieved product type
nameStringThe Name of the retrieved product type
alternative_codeStringThe Alternative Code of the retrieved product type
descriptionStringThe Description of the retrieved product type
classificationStringThe Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS
service_typeStringThe Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE
physical_good_typeStringThe physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE
composition_methodStringThe Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE
used_for_provisioningBooleanThe flag shows if the retrieved product type is used for provisioning
udr_typeUsage Detail Record TypeThe 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_typeMeter 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
NameType Description
IdStringThe ID of the retrieved usage detail record type
nameStringThe Name of the retrieved usage detail record type
alternative_codeStringThe Alternative Code of the retrieved usage detail record type
descriptionStringThe Description of the retrieved usage detail record type
unit_of_measurementStringThe Unit of measurement of the retrieved usage detail record type

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe 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_codeStringThe alternative code of the Unit of measurement

 

 meter_reading_type object data response
NameType Description
IdStringThe ID of the retrieved meter reading type
nameStringThe Name of the retrieved meter reading type
alternative_codeStringThe Alternative Code of the retrieved meter reading type
classificationStringThe Classification of the retrieved meter reading type
descriptionStringThe Description of the retrieved meter reading type
unit_of_measurementStringThe Unit of measurement of the retrieved meter reading type

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe 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_codeStringThe 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_amountNumber

The base price of the product in the Global Price Plan

base_rate_applied_perString

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
uotString

The 'UOT' applicable for the rate

  • Seconds
  • Minute
  • Hour
  • Day
  • Week
  • Month
  • Year

Available for one-time services

time_periodTime Period Object

 The period and unit of time for which the base amount is applicable for. This is available only on termed services rates.

uomString

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_valueNumber

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

 job_requested_subsrciption_physical_good object response data

Name

Type

Description

id

String

The ID of the retrieved job requested subscription physical good

quantityNumberThe quantity of the retrieved job requested subscription physical good
coverageInteger

Indicates whether the warranty policy that covers a job's requested physical good eventually covers the physical good's swap. This information is applicable for Swap Subscription Installed Items jobs and only if the swapped installed item is still under warranty. 

Available from CRM.COM R9.0.0

notes

String

The notes of the retrieved job requested subscription physical good

Available form CRM.COM R12.3.0

productProducts ObjectThe product related with the retrieved job requested subscription physical good
installed_itemInstalled Items Object

The installed item related with the retrieved job requested subscription physical good. This information is applicable only when the job type fulfillment scope is set to Swap Subscription Installed Items. The installed item represents the installed item which will be swapped with another installed item through the Job.

Available from CRM.COM R9.0.0

swap_installed_item

 

Installed Items Object

The installed item related which replaces the job's requested subscription physical good. This information is applicable only when the job type fulfillment scope is set to Swap Subscription Installed Items

Available from CRM.COM R9.0.0

warranty_policyWarranty Policy Object

The warranty policy which covers the job's requested subscription physical good. This information is available only for Jobs whose type has fulfillment scope is set to Swap Subscription Installed Items and represents the warranty that covers the installed item that will be swapped.

Available from CRM.COM R9.0.0

warranty_coverage_reasonWarranty Coverage Reason Object

The Warranty coverage reason which provides reasoning for the job requested physical good's replacement. This information is available only in Swap Subscription Installed Item jobs and only when the installed item requested to be swapped is still under warranty.

Available from CRM.COM R9.0.0

provisioning_distributorProvisioning Distributor ObjectThe provisioning distributor on which the retrieved job requested subscription physical good will be distributed on

Referred Objects Response Data

 product object response data
Name
Type
Description
IdStringThe ID of the product
codeStringThe code of product

alternative_code

String

The alternative code of product

description

String

The description of product

priority_levelInteger

The priority level of the product

Available from CRM.COM R12.3.0

global_rateGlobal Rate Object

The global rate of the retrieved product

Available from CRM.COM R15.0.0

product_typeProduct type objectThe type of the product

Referred Objects Response Data

 product_type object data response
NameType Description
IdStringThe ID of the retrieved product type
nameStringThe Name of the retrieved product type
alternative_codeStringThe Alternative Code of the retrieved product type
descriptionStringThe Description of the retrieved product type
classificationStringThe Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS
service_typeStringThe Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE
physical_good_typeStringThe physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE
composition_methodStringThe Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE
used_for_provisioningBooleanThe flag shows if the retrieved product type is used for provisioning
udr_typeUsage Detail Record TypeThe 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_typeMeter 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
NameType Description
IdStringThe ID of the retrieved usage detail record type
nameStringThe Name of the retrieved usage detail record type
alternative_codeStringThe Alternative Code of the retrieved usage detail record type
descriptionStringThe Description of the retrieved usage detail record type
unit_of_measurementStringThe Unit of measurement of the retrieved usage detail record type

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe 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_codeStringThe alternative code of the Unit of measurement

 

 meter_reading_type object data response
NameType Description
IdStringThe ID of the retrieved meter reading type
nameStringThe Name of the retrieved meter reading type
alternative_codeStringThe Alternative Code of the retrieved meter reading type
classificationStringThe Classification of the retrieved meter reading type
descriptionStringThe Description of the retrieved meter reading type
unit_of_measurementStringThe Unit of measurement of the retrieved meter reading type

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe 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_codeStringThe 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_amountNumber

The base price of the product in the Global Price Plan

base_rate_applied_perString

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
uotString

The 'UOT' applicable for the rate

  • Seconds
  • Minute
  • Hour
  • Day
  • Week
  • Month
  • Year

Available for one-time services

time_periodTime Period Object

 The period and unit of time for which the base amount is applicable for. This is available only on termed services rates.

uomString

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_valueNumber

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

stateStringThe state of the retrieved installed item, which can be EFFECTIVE or NOT_EFFECTIVE
state_classificationState 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
IdStringThe ID of the product
codeStringThe code of product

alternative_code

String

The alternative code of product

description

String

The description of product

priority_levelInteger

The priority level of the product

Available from CRM.COM R12.3.0

global_rateGlobal Rate Object

The global rate of the retrieved product

Available from CRM.COM R15.0.0

product_typeProduct type objectThe type of the product

Referred Objects Response Data

 product_type object data response
NameType Description
IdStringThe ID of the retrieved product type
nameStringThe Name of the retrieved product type
alternative_codeStringThe Alternative Code of the retrieved product type
descriptionStringThe Description of the retrieved product type
classificationStringThe Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS
service_typeStringThe Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE
physical_good_typeStringThe physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE
composition_methodStringThe Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE
used_for_provisioningBooleanThe flag shows if the retrieved product type is used for provisioning
udr_typeUsage Detail Record TypeThe 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_typeMeter 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
NameType Description
IdStringThe ID of the retrieved usage detail record type
nameStringThe Name of the retrieved usage detail record type
alternative_codeStringThe Alternative Code of the retrieved usage detail record type
descriptionStringThe Description of the retrieved usage detail record type
unit_of_measurementStringThe Unit of measurement of the retrieved usage detail record type

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe 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_codeStringThe alternative code of the Unit of measurement

 

 meter_reading_type object data response
NameType Description
IdStringThe ID of the retrieved meter reading type
nameStringThe Name of the retrieved meter reading type
alternative_codeStringThe Alternative Code of the retrieved meter reading type
classificationStringThe Classification of the retrieved meter reading type
descriptionStringThe Description of the retrieved meter reading type
unit_of_measurementStringThe Unit of measurement of the retrieved meter reading type

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe 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_codeStringThe 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_amountNumber

The base price of the product in the Global Price Plan

base_rate_applied_perString

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
uotString

The 'UOT' applicable for the rate

  • Seconds
  • Minute
  • Hour
  • Day
  • Week
  • Month
  • Year

Available for one-time services

time_periodTime Period Object

 The period and unit of time for which the base amount is applicable for. This is available only on termed services rates.

uomString

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_valueNumber

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
nameStringThe 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

 warranty object response data

Name

Type

Description

id

String

The ID of the retrieved warranty policy

numberStringThe number of the retrieved warranty policy
nameStringThe name of the retrieved warranty policy
alternative_codeStringThe alternative code of the retrieved warranty policy
life_cycle_stateString

The life cycle state of the retrieved warranty policy. The supported life cycle states are EFFECTIVE or NOT EFFECTIVE

 warranty_coverage_reason object data response
NameType Description
idStringThe ID of the retrieved warranty coverage reason
nameStringThe Name of the retrieved warranty coverage reason
alternative_codeStringThe Alternative Code of the retrieved warranty coverage reason
descriptionStringThe Description of the retrieved warranty coverage reason

 provisioning_distributor object response data

Name

Type

Description

id

String

The id of the retrieved provisioning distributor

name

String

The name of the retrieved provisioning distributor

alternative_code

String

The alternative code of the retrieved provisioning distributor

 job_requested_expense object response data

Name

Type

Description

id

String

The ID of the retrieved job requested expense

productProduct objectThe product classified as an expense service which is related with the retrieved job requested expense

Referred Objects Response Data

 product object response data
Name
Type
Description
IdStringThe ID of the product
codeStringThe code of product

alternative_code

String

The alternative code of product

description

String

The description of product

priority_levelInteger

The priority level of the product

Available from CRM.COM R12.3.0

global_rateGlobal Rate Object

The global rate of the retrieved product

Available from CRM.COM R15.0.0

product_typeProduct type objectThe type of the product

Referred Objects Response Data

 product_type object data response
NameType Description
IdStringThe ID of the retrieved product type
nameStringThe Name of the retrieved product type
alternative_codeStringThe Alternative Code of the retrieved product type
descriptionStringThe Description of the retrieved product type
classificationStringThe Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS
service_typeStringThe Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE
physical_good_typeStringThe physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE
composition_methodStringThe Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE
used_for_provisioningBooleanThe flag shows if the retrieved product type is used for provisioning
udr_typeUsage Detail Record TypeThe 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_typeMeter 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
NameType Description
IdStringThe ID of the retrieved usage detail record type
nameStringThe Name of the retrieved usage detail record type
alternative_codeStringThe Alternative Code of the retrieved usage detail record type
descriptionStringThe Description of the retrieved usage detail record type
unit_of_measurementStringThe Unit of measurement of the retrieved usage detail record type

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe 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_codeStringThe alternative code of the Unit of measurement

 

 meter_reading_type object data response
NameType Description
IdStringThe ID of the retrieved meter reading type
nameStringThe Name of the retrieved meter reading type
alternative_codeStringThe Alternative Code of the retrieved meter reading type
classificationStringThe Classification of the retrieved meter reading type
descriptionStringThe Description of the retrieved meter reading type
unit_of_measurementStringThe Unit of measurement of the retrieved meter reading type

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe 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_codeStringThe 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_amountNumber

The base price of the product in the Global Price Plan

base_rate_applied_perString

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
uotString

The 'UOT' applicable for the rate

  • Seconds
  • Minute
  • Hour
  • Day
  • Week
  • Month
  • Year

Available for one-time services

time_periodTime Period Object

 The period and unit of time for which the base amount is applicable for. This is available only on termed services rates.

uomString

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_valueNumber

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

 job_requested_activity_service object response data

Name

Type

Description

id

String

The ID of the retrieved job requested activity service

activity_typeActivity Type ObjectThe type of the activity that will be performed in order to deliver the related job requested activity service
productProduct ObjectThe product classified as one time service which is related with the retrieved job requested activity service

Referred Objects Response Data

 activity_type object response data

Name

Type

Description

id

String

The ID of the retrieved activity type

name

String

The name of the retrieved activity type

alternative_code

String

The alternative code of the retrieved activity type

descriptionStringA description of the retrieved activity type

 product object response data
Name
Type
Description
IdStringThe ID of the product
codeStringThe code of product

alternative_code

String

The alternative code of product

description

String

The description of product

priority_levelInteger

The priority level of the product

Available from CRM.COM R12.3.0

global_rateGlobal Rate Object

The global rate of the retrieved product

Available from CRM.COM R15.0.0

product_typeProduct type objectThe type of the product

Referred Objects Response Data

 product_type object data response
NameType Description
IdStringThe ID of the retrieved product type
nameStringThe Name of the retrieved product type
alternative_codeStringThe Alternative Code of the retrieved product type
descriptionStringThe Description of the retrieved product type
classificationStringThe Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS
service_typeStringThe Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE
physical_good_typeStringThe physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE
composition_methodStringThe Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE
used_for_provisioningBooleanThe flag shows if the retrieved product type is used for provisioning
udr_typeUsage Detail Record TypeThe 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_typeMeter 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
NameType Description
IdStringThe ID of the retrieved usage detail record type
nameStringThe Name of the retrieved usage detail record type
alternative_codeStringThe Alternative Code of the retrieved usage detail record type
descriptionStringThe Description of the retrieved usage detail record type
unit_of_measurementStringThe Unit of measurement of the retrieved usage detail record type

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe 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_codeStringThe alternative code of the Unit of measurement

 

 meter_reading_type object data response
NameType Description
IdStringThe ID of the retrieved meter reading type
nameStringThe Name of the retrieved meter reading type
alternative_codeStringThe Alternative Code of the retrieved meter reading type
classificationStringThe Classification of the retrieved meter reading type
descriptionStringThe Description of the retrieved meter reading type
unit_of_measurementStringThe Unit of measurement of the retrieved meter reading type

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe 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_codeStringThe 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_amountNumber

The base price of the product in the Global Price Plan

base_rate_applied_perString

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
uotString

The 'UOT' applicable for the rate

  • Seconds
  • Minute
  • Hour
  • Day
  • Week
  • Month
  • Year

Available for one-time services

time_periodTime Period Object

 The period and unit of time for which the base amount is applicable for. This is available only on termed services rates.

uomString

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_valueNumber

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

 job_subscription_service object response data

Name

Type

Description

service_productProduct Object

The service product that will be delivered as a subscription service through the job

Available from CRM.COM R13.0.0

subscription_serviceSubscription Service ObjectThe subscription service related with the retrieved job subscription service

Referred Objects Response Data

 product object response data
Name
Type
Description
IdStringThe ID of the product
codeStringThe code of product

alternative_code

String

The alternative code of product

description

String

The description of product

priority_levelInteger

The priority level of the product

Available from CRM.COM R12.3.0

global_rateGlobal Rate Object

The global rate of the retrieved product

Available from CRM.COM R15.0.0

product_typeProduct type objectThe type of the product

Referred Objects Response Data

 product_type object data response
NameType Description
IdStringThe ID of the retrieved product type
nameStringThe Name of the retrieved product type
alternative_codeStringThe Alternative Code of the retrieved product type
descriptionStringThe Description of the retrieved product type
classificationStringThe Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS
service_typeStringThe Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE
physical_good_typeStringThe physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE
composition_methodStringThe Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE
used_for_provisioningBooleanThe flag shows if the retrieved product type is used for provisioning
udr_typeUsage Detail Record TypeThe 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_typeMeter 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
NameType Description
IdStringThe ID of the retrieved usage detail record type
nameStringThe Name of the retrieved usage detail record type
alternative_codeStringThe Alternative Code of the retrieved usage detail record type
descriptionStringThe Description of the retrieved usage detail record type
unit_of_measurementStringThe Unit of measurement of the retrieved usage detail record type

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe 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_codeStringThe alternative code of the Unit of measurement

 

 meter_reading_type object data response
NameType Description
IdStringThe ID of the retrieved meter reading type
nameStringThe Name of the retrieved meter reading type
alternative_codeStringThe Alternative Code of the retrieved meter reading type
classificationStringThe Classification of the retrieved meter reading type
descriptionStringThe Description of the retrieved meter reading type
unit_of_measurementStringThe Unit of measurement of the retrieved meter reading type

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe 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_codeStringThe 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_amountNumber

The base price of the product in the Global Price Plan

base_rate_applied_perString

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
uotString

The 'UOT' applicable for the rate

  • Seconds
  • Minute
  • Hour
  • Day
  • Week
  • Month
  • Year

Available for one-time services

time_periodTime Period Object

 The period and unit of time for which the base amount is applicable for. This is available only on termed services rates.

uomString

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_valueNumber

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

 subscription_service object response data

Name

Type

Description

id

String

The ID of the retrieved subscription service

life_cycle_state

String

The life cycle state of the subscription service. One of the following values is returned:

DRAFT, EFFECTIVE, NOT_EFFECTIVE, IN_RESTING, CANCELLED, REGRETTED, SWAPPED, REMOVED

productProduct objectThe product classified as termed service which is related with the retrieved termed subscription service
service_bundleSubscription Service Bundle Object

The subscription service bundle that contains the specified product as a product bundle. This information is available only if the specified product was added as part of a flexible product bundle.

service_distribution_setSet of Subscription Service Distribution ObjectsThe distribution of the retrieved subscription service

Referred Objects Response Data

 product object response data
Name
Type
Description
IdStringThe ID of the product
codeStringThe code of product

alternative_code

String

The alternative code of product

description

String

The description of product

priority_levelInteger

The priority level of the product

Available from CRM.COM R12.3.0

global_rateGlobal Rate Object

The global rate of the retrieved product

Available from CRM.COM R15.0.0

product_typeProduct type objectThe type of the product

Referred Objects Response Data

 product_type object data response
NameType Description
IdStringThe ID of the retrieved product type
nameStringThe Name of the retrieved product type
alternative_codeStringThe Alternative Code of the retrieved product type
descriptionStringThe Description of the retrieved product type
classificationStringThe Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS
service_typeStringThe Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE
physical_good_typeStringThe physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE
composition_methodStringThe Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE
used_for_provisioningBooleanThe flag shows if the retrieved product type is used for provisioning
udr_typeUsage Detail Record TypeThe 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_typeMeter 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
NameType Description
IdStringThe ID of the retrieved usage detail record type
nameStringThe Name of the retrieved usage detail record type
alternative_codeStringThe Alternative Code of the retrieved usage detail record type
descriptionStringThe Description of the retrieved usage detail record type
unit_of_measurementStringThe Unit of measurement of the retrieved usage detail record type

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe 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_codeStringThe alternative code of the Unit of measurement

 

 meter_reading_type object data response
NameType Description
IdStringThe ID of the retrieved meter reading type
nameStringThe Name of the retrieved meter reading type
alternative_codeStringThe Alternative Code of the retrieved meter reading type
classificationStringThe Classification of the retrieved meter reading type
descriptionStringThe Description of the retrieved meter reading type
unit_of_measurementStringThe Unit of measurement of the retrieved meter reading type

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe 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_codeStringThe 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_amountNumber

The base price of the product in the Global Price Plan

base_rate_applied_perString

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
uotString

The 'UOT' applicable for the rate

  • Seconds
  • Minute
  • Hour
  • Day
  • Week
  • Month
  • Year

Available for one-time services

time_periodTime Period Object

 The period and unit of time for which the base amount is applicable for. This is available only on termed services rates.

uomString

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_valueNumber

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

 termed_subscription_service_bundle object response data

Name

Type

Description

id

String

The ID of the retrieved termed subscription service

life_cycle_state

String

The life cycle state of the termed subscription service. One of the following values is returned:

DRAFT, EFFECTIVE, NOT_EFFECTIVE, SHIRT_TERM_EFFECTIVE, SHORT_TERM_NOT_EFFECTIVE, IN_RESTING, CANCELLED, REGRETTED, SWAPPED, REMOVED, REPLACED

REPLACED available from CRM.COM R14.0.0, deprecated in CRM.COM R18.0.0

first_activated_dateDate

The date that the subscription service became effective for the first time (i.e. the date that the first effective period of that subscription service started)

Available from CRM.COM R9.0.0

rating_stateString

The rating state of the retrieved subscription service that can be PENDING or COMPLETED

Available from CRM.COM R9.0.0

rated_up_toDate

The date up until which the termed service was rated.

Available from CRM.COM R9.0.0

productProduct objectThe product classified as termed service which is related with the retrieved termed subscription service

Referred Objects Response Data

 product object response data
Name
Type
Description
IdStringThe ID of the product
codeStringThe code of product

alternative_code

String

The alternative code of product

description

String

The description of product

priority_levelInteger

The priority level of the product

Available from CRM.COM R12.3.0

global_rateGlobal Rate Object

The global rate of the retrieved product

Available from CRM.COM R15.0.0

product_typeProduct type objectThe type of the product

Referred Objects Response Data

 product_type object data response
NameType Description
IdStringThe ID of the retrieved product type
nameStringThe Name of the retrieved product type
alternative_codeStringThe Alternative Code of the retrieved product type
descriptionStringThe Description of the retrieved product type
classificationStringThe Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS
service_typeStringThe Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE
physical_good_typeStringThe physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE
composition_methodStringThe Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE
used_for_provisioningBooleanThe flag shows if the retrieved product type is used for provisioning
udr_typeUsage Detail Record TypeThe 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_typeMeter 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
NameType Description
IdStringThe ID of the retrieved usage detail record type
nameStringThe Name of the retrieved usage detail record type
alternative_codeStringThe Alternative Code of the retrieved usage detail record type
descriptionStringThe Description of the retrieved usage detail record type
unit_of_measurementStringThe Unit of measurement of the retrieved usage detail record type

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe 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_codeStringThe alternative code of the Unit of measurement

 

 meter_reading_type object data response
NameType Description
IdStringThe ID of the retrieved meter reading type
nameStringThe Name of the retrieved meter reading type
alternative_codeStringThe Alternative Code of the retrieved meter reading type
classificationStringThe Classification of the retrieved meter reading type
descriptionStringThe Description of the retrieved meter reading type
unit_of_measurementStringThe Unit of measurement of the retrieved meter reading type

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe 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_codeStringThe 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_amountNumber

The base price of the product in the Global Price Plan

base_rate_applied_perString

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
uotString

The 'UOT' applicable for the rate

  • Seconds
  • Minute
  • Hour
  • Day
  • Week
  • Month
  • Year

Available for one-time services

time_periodTime Period Object

 The period and unit of time for which the base amount is applicable for. This is available only on termed services rates.

uomString

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_valueNumber

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

 subscription_service_distribution object response data

Name

Type

Description

id

String

The ID of the retrieved subscription service distribution

provisioning_distributorProvisioning distributor objectThe provisioning distributor

Referred Objects Response Data

 provisioning_distributor object response data

Name

Type

Description

id

String

The id of the retrieved provisioning distributor

name

String

The name of the retrieved provisioning distributor

alternative_code

String

The alternative code of the retrieved provisioning distributor

 job_subscription_physical_good object response data

Name

Type

Description

id

String

The ID of the retrieved job subscription physical good

installed_itemInstalled Item Object

The installed item object which will be delivered as a subscription installed item through the job

Available from CRM.COM R13.0.0

subscription_installed_itemSubscription Installed Item ObjectThe subscription installed item related with the retrieved job subscription physical good
swap_subscription_installed_itemSubscription Installed Item Object

The subscription installed item related with the retrieved job swap subscription physical good

Available from CRM.COM R9.0.0

Referred Objects Response Data

 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

stateStringThe state of the retrieved installed item, which can be EFFECTIVE or NOT_EFFECTIVE
state_classificationState 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
IdStringThe ID of the product
codeStringThe code of product

alternative_code

String

The alternative code of product

description

String

The description of product

priority_levelInteger

The priority level of the product

Available from CRM.COM R12.3.0

global_rateGlobal Rate Object

The global rate of the retrieved product

Available from CRM.COM R15.0.0

product_typeProduct type objectThe type of the product

Referred Objects Response Data

 product_type object data response
NameType Description
IdStringThe ID of the retrieved product type
nameStringThe Name of the retrieved product type
alternative_codeStringThe Alternative Code of the retrieved product type
descriptionStringThe Description of the retrieved product type
classificationStringThe Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS
service_typeStringThe Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE
physical_good_typeStringThe physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE
composition_methodStringThe Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE
used_for_provisioningBooleanThe flag shows if the retrieved product type is used for provisioning
udr_typeUsage Detail Record TypeThe 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_typeMeter 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
NameType Description
IdStringThe ID of the retrieved usage detail record type
nameStringThe Name of the retrieved usage detail record type
alternative_codeStringThe Alternative Code of the retrieved usage detail record type
descriptionStringThe Description of the retrieved usage detail record type
unit_of_measurementStringThe Unit of measurement of the retrieved usage detail record type

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe 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_codeStringThe alternative code of the Unit of measurement

 

 meter_reading_type object data response
NameType Description
IdStringThe ID of the retrieved meter reading type
nameStringThe Name of the retrieved meter reading type
alternative_codeStringThe Alternative Code of the retrieved meter reading type
classificationStringThe Classification of the retrieved meter reading type
descriptionStringThe Description of the retrieved meter reading type
unit_of_measurementStringThe Unit of measurement of the retrieved meter reading type

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe 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_codeStringThe 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_amountNumber

The base price of the product in the Global Price Plan

base_rate_applied_perString

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
uotString

The 'UOT' applicable for the rate

  • Seconds
  • Minute
  • Hour
  • Day
  • Week
  • Month
  • Year

Available for one-time services

time_periodTime Period Object

 The period and unit of time for which the base amount is applicable for. This is available only on termed services rates.

uomString

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_valueNumber

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
nameStringThe 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

 subscription_installed_item object response data

Name

Type

Description

id

String

The ID of the retrieved subscription installed item

ownership_statusString

The ownership status of the retrieved subscription installed item. The ownership status defines if the installed item is owned by the company or the customer, based on the business transactions that were applied on the installed item. This Information is calculated dynamically. The supported values are the following:

SOLD_TO_CUSTOMER_NOT_INVOICED, SOLD_TO_CUSTOMER_INVOICED, RENTED_TO_CUSTOMER, IN_INTERNAL_WAREHOUSE, IN_EXTERNAL_WAREHOUSE, NOT_IN_WAREHOUSE, BROUGHT_BY_CUSTOMER

Available from CRM.COM R10.0.0. Prior to that release the supported values were the following: SOLD_TO_CUSTOMER, RENTED_TO_CUSTOMER

From CRM.COM R14.0.0, BROUGHT_BY_CUSTOMER is supported

From CRM.COM R15.0.0 the available ownership statuses are:

  • RENTED_TO_CUSTOMER
  • SOLD_TO_CUSTOMER_THROUGH_COMPANY
  • SOLD_TO_CUSTOMER_THROUGH_PARTNER
  • OWNED_BY_CUSTOMER
enabledBoolean

Indicates whether the subscription installed item is enabled in a provisioning provider

Available from CRM.COM R15.0.0

udf_string_1 

String

User Defined Field of type String

Available from CRM.COM R14.3.0

udf_string_2 

String

User Defined Field of type String

Available from CRM.COM R14.3.0

udf_string_3 

String

User Defined Field of type String

Available from CRM.COM R14.3.0

udf_string_4 

String

User Defined Field of type String

Available from CRM.COM R14.3.0

udf_string_5

String

User Defined Field of type String

Available from CRM.COM R14.3.0

udf_string_6 

String

User Defined Field of type String

Available from CRM.COM R14.3.0

udf_string_7

String

User Defined Field of type String

Available from CRM.COM R14.3.0

udf_string_8

String

User Defined Field of type String

Available from CRM.COM R14.3.0

udf_float_1

Float

User Defined Field of type Float

Available from CRM.COM R14.3.0

udf_float_2

Float

User Defined Field of type Float

Available from CRM.COM R14.3.0

udf_float_3

Float

User Defined Field of type Float

Available from CRM.COM R14.3.0

udf_float_4

Float

User Defined Field of type Float

Available from CRM.COM R14.3.0

udf_date_1 

Date

User Defined Field of type Date

Available from CRM.COM R14.3.0

udf_date_2 

Date

User Defined Field of type Date

Available from CRM.COM R14.3.0

udf_date_3

Date

User Defined Field of type Date

Available from CRM.COM R14.3.0

udf_date_4

Date

User Defined Field of type Date

Available from CRM.COM R14.3.0

installed_itemInstalled item objectThe installed item related with the retrieved subscription installed item
installed_item_bundleSubscription Installed item bundle object

The subscription installed item bundle that contains the specified installed item as a product bundle. This information is available only if the specified installed item was added as part of a fixed product bundle.

 

Referred Objects Response Data

 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

stateStringThe state of the retrieved installed item, which can be EFFECTIVE or NOT_EFFECTIVE
state_classificationState 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
IdStringThe ID of the product
codeStringThe code of product

alternative_code

String

The alternative code of product

description

String

The description of product

priority_levelInteger

The priority level of the product

Available from CRM.COM R12.3.0

global_rateGlobal Rate Object

The global rate of the retrieved product

Available from CRM.COM R15.0.0

product_typeProduct type objectThe type of the product

Referred Objects Response Data

 product_type object data response
NameType Description
IdStringThe ID of the retrieved product type
nameStringThe Name of the retrieved product type
alternative_codeStringThe Alternative Code of the retrieved product type
descriptionStringThe Description of the retrieved product type
classificationStringThe Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS
service_typeStringThe Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE
physical_good_typeStringThe physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE
composition_methodStringThe Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE
used_for_provisioningBooleanThe flag shows if the retrieved product type is used for provisioning
udr_typeUsage Detail Record TypeThe 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_typeMeter 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
NameType Description
IdStringThe ID of the retrieved usage detail record type
nameStringThe Name of the retrieved usage detail record type
alternative_codeStringThe Alternative Code of the retrieved usage detail record type
descriptionStringThe Description of the retrieved usage detail record type
unit_of_measurementStringThe Unit of measurement of the retrieved usage detail record type

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe 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_codeStringThe alternative code of the Unit of measurement

 

 meter_reading_type object data response
NameType Description
IdStringThe ID of the retrieved meter reading type
nameStringThe Name of the retrieved meter reading type
alternative_codeStringThe Alternative Code of the retrieved meter reading type
classificationStringThe Classification of the retrieved meter reading type
descriptionStringThe Description of the retrieved meter reading type
unit_of_measurementStringThe Unit of measurement of the retrieved meter reading type

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe 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_codeStringThe 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_amountNumber

The base price of the product in the Global Price Plan

base_rate_applied_perString

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
uotString

The 'UOT' applicable for the rate

  • Seconds
  • Minute
  • Hour
  • Day
  • Week
  • Month
  • Year

Available for one-time services

time_periodTime Period Object

 The period and unit of time for which the base amount is applicable for. This is available only on termed services rates.

uomString

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_valueNumber

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
nameStringThe 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

 subscription_installed_item_bundle object response data

Name

Type

Description

id

String

The ID of the retrieved subscription installed item

ownership_statusString

The ownership status of the retrieved subscription installed item. The ownership status defines if the installed item is owned by the company or the customer, based on the business transactions that were applied on the installed item. This Information is calculated dynamically. The supported values are the following:

SOLD_TO_CUSTOMER_NOT_INVOICED, SOLD_TO_CUSTOMER_INVOICED, RENTED_TO_CUSTOMER, IN_INTERNAL_WAREHOUSE, IN_EXTERNAL_WAREHOUSE, NOT_IN_WAREHOUSE

Available from CRM.COM R10.0.0. Prior to that release the supported values were the following:

SOLD_TO_CUSTOMER, RENTED_TO_CUSTOMER

installed_itemInstalled item objectThe installed item related with the retrieved subscription installed item

Referred Objects Response Data

 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

stateStringThe state of the retrieved installed item, which can be EFFECTIVE or NOT_EFFECTIVE
state_classificationState 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
IdStringThe ID of the product
codeStringThe code of product

alternative_code

String

The alternative code of product

description

String

The description of product

priority_levelInteger

The priority level of the product

Available from CRM.COM R12.3.0

global_rateGlobal Rate Object

The global rate of the retrieved product

Available from CRM.COM R15.0.0

product_typeProduct type objectThe type of the product

Referred Objects Response Data

 product_type object data response
NameType Description
IdStringThe ID of the retrieved product type
nameStringThe Name of the retrieved product type
alternative_codeStringThe Alternative Code of the retrieved product type
descriptionStringThe Description of the retrieved product type
classificationStringThe Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS
service_typeStringThe Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE
physical_good_typeStringThe physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE
composition_methodStringThe Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE
used_for_provisioningBooleanThe flag shows if the retrieved product type is used for provisioning
udr_typeUsage Detail Record TypeThe 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_typeMeter 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
NameType Description
IdStringThe ID of the retrieved usage detail record type
nameStringThe Name of the retrieved usage detail record type
alternative_codeStringThe Alternative Code of the retrieved usage detail record type
descriptionStringThe Description of the retrieved usage detail record type
unit_of_measurementStringThe Unit of measurement of the retrieved usage detail record type

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe 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_codeStringThe alternative code of the Unit of measurement

 

 meter_reading_type object data response
NameType Description
IdStringThe ID of the retrieved meter reading type
nameStringThe Name of the retrieved meter reading type
alternative_codeStringThe Alternative Code of the retrieved meter reading type
classificationStringThe Classification of the retrieved meter reading type
descriptionStringThe Description of the retrieved meter reading type
unit_of_measurementStringThe Unit of measurement of the retrieved meter reading type

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe 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_codeStringThe 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_amountNumber

The base price of the product in the Global Price Plan

base_rate_applied_perString

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
uotString

The 'UOT' applicable for the rate

  • Seconds
  • Minute
  • Hour
  • Day
  • Week
  • Month
  • Year

Available for one-time services

time_periodTime Period Object

 The period and unit of time for which the base amount is applicable for. This is available only on termed services rates.

uomString

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_valueNumber

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
nameStringThe 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

 job_physical_good object response data

Name

Type

Description

id

String

The ID of the retrieved physical good

quantityNumberThe quantity of the product if the job physical good is not traceable
installed_itemInstalled item objectThe installed item related with the retrieved job physical good, if the physical good is traceable
productProducts ObjectThe product related with the retrieved job physical good, if the physical good is non traceable
components_setSet of Products Object

The product components that are included in the specified product bundle. This information is available only if the specified product is a flexible product bundle

Available form CRM.COM R12.3.0

Referred Objects Response Data

 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

stateStringThe state of the retrieved installed item, which can be EFFECTIVE or NOT_EFFECTIVE
state_classificationState 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
IdStringThe ID of the product
codeStringThe code of product

alternative_code

String

The alternative code of product

description

String

The description of product

priority_levelInteger

The priority level of the product

Available from CRM.COM R12.3.0

global_rateGlobal Rate Object

The global rate of the retrieved product

Available from CRM.COM R15.0.0

product_typeProduct type objectThe type of the product

Referred Objects Response Data

 product_type object data response
NameType Description
IdStringThe ID of the retrieved product type
nameStringThe Name of the retrieved product type
alternative_codeStringThe Alternative Code of the retrieved product type
descriptionStringThe Description of the retrieved product type
classificationStringThe Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS
service_typeStringThe Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE
physical_good_typeStringThe physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE
composition_methodStringThe Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE
used_for_provisioningBooleanThe flag shows if the retrieved product type is used for provisioning
udr_typeUsage Detail Record TypeThe 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_typeMeter 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
NameType Description
IdStringThe ID of the retrieved usage detail record type
nameStringThe Name of the retrieved usage detail record type
alternative_codeStringThe Alternative Code of the retrieved usage detail record type
descriptionStringThe Description of the retrieved usage detail record type
unit_of_measurementStringThe Unit of measurement of the retrieved usage detail record type

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe 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_codeStringThe alternative code of the Unit of measurement

 

 meter_reading_type object data response
NameType Description
IdStringThe ID of the retrieved meter reading type
nameStringThe Name of the retrieved meter reading type
alternative_codeStringThe Alternative Code of the retrieved meter reading type
classificationStringThe Classification of the retrieved meter reading type
descriptionStringThe Description of the retrieved meter reading type
unit_of_measurementStringThe Unit of measurement of the retrieved meter reading type

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe 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_codeStringThe 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_amountNumber

The base price of the product in the Global Price Plan

base_rate_applied_perString

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
uotString

The 'UOT' applicable for the rate

  • Seconds
  • Minute
  • Hour
  • Day
  • Week
  • Month
  • Year

Available for one-time services

time_periodTime Period Object

 The period and unit of time for which the base amount is applicable for. This is available only on termed services rates.

uomString

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_valueNumber

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
nameStringThe 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

 product object response data
Name
Type
Description
IdStringThe ID of the product
codeStringThe code of product

alternative_code

String

The alternative code of product

description

String

The description of product

priority_levelInteger

The priority level of the product

Available from CRM.COM R12.3.0

global_rateGlobal Rate Object

The global rate of the retrieved product

Available from CRM.COM R15.0.0

product_typeProduct type objectThe type of the product

Referred Objects Response Data

 product_type object data response
NameType Description
IdStringThe ID of the retrieved product type
nameStringThe Name of the retrieved product type
alternative_codeStringThe Alternative Code of the retrieved product type
descriptionStringThe Description of the retrieved product type
classificationStringThe Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS
service_typeStringThe Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE
physical_good_typeStringThe physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE
composition_methodStringThe Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE
used_for_provisioningBooleanThe flag shows if the retrieved product type is used for provisioning
udr_typeUsage Detail Record TypeThe 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_typeMeter 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
NameType Description
IdStringThe ID of the retrieved usage detail record type
nameStringThe Name of the retrieved usage detail record type
alternative_codeStringThe Alternative Code of the retrieved usage detail record type
descriptionStringThe Description of the retrieved usage detail record type
unit_of_measurementStringThe Unit of measurement of the retrieved usage detail record type

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe 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_codeStringThe alternative code of the Unit of measurement

 

 meter_reading_type object data response
NameType Description
IdStringThe ID of the retrieved meter reading type
nameStringThe Name of the retrieved meter reading type
alternative_codeStringThe Alternative Code of the retrieved meter reading type
classificationStringThe Classification of the retrieved meter reading type
descriptionStringThe Description of the retrieved meter reading type
unit_of_measurementStringThe Unit of measurement of the retrieved meter reading type

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe 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_codeStringThe 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_amountNumber

The base price of the product in the Global Price Plan

base_rate_applied_perString

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
uotString

The 'UOT' applicable for the rate

  • Seconds
  • Minute
  • Hour
  • Day
  • Week
  • Month
  • Year

Available for one-time services

time_periodTime Period Object

 The period and unit of time for which the base amount is applicable for. This is available only on termed services rates.

uomString

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_valueNumber

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

 job_expense object response data

Name

Type

Description

id

String

The ID of the retrieved job expense

productProduct objectThe product classified as one time service which is related with the retrieved job expense

Referred Objects Response Data

 product object response data
Name
Type
Description
IdStringThe ID of the product
codeStringThe code of product

alternative_code

String

The alternative code of product

description

String

The description of product

priority_levelInteger

The priority level of the product

Available from CRM.COM R12.3.0

global_rateGlobal Rate Object

The global rate of the retrieved product

Available from CRM.COM R15.0.0

product_typeProduct type objectThe type of the product

Referred Objects Response Data

 product_type object data response
NameType Description
IdStringThe ID of the retrieved product type
nameStringThe Name of the retrieved product type
alternative_codeStringThe Alternative Code of the retrieved product type
descriptionStringThe Description of the retrieved product type
classificationStringThe Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS
service_typeStringThe Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE
physical_good_typeStringThe physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE
composition_methodStringThe Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE
used_for_provisioningBooleanThe flag shows if the retrieved product type is used for provisioning
udr_typeUsage Detail Record TypeThe 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_typeMeter 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
NameType Description
IdStringThe ID of the retrieved usage detail record type
nameStringThe Name of the retrieved usage detail record type
alternative_codeStringThe Alternative Code of the retrieved usage detail record type
descriptionStringThe Description of the retrieved usage detail record type
unit_of_measurementStringThe Unit of measurement of the retrieved usage detail record type

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe 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_codeStringThe alternative code of the Unit of measurement

 

 meter_reading_type object data response
NameType Description
IdStringThe ID of the retrieved meter reading type
nameStringThe Name of the retrieved meter reading type
alternative_codeStringThe Alternative Code of the retrieved meter reading type
classificationStringThe Classification of the retrieved meter reading type
descriptionStringThe Description of the retrieved meter reading type
unit_of_measurementStringThe Unit of measurement of the retrieved meter reading type

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe 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_codeStringThe 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_amountNumber

The base price of the product in the Global Price Plan

base_rate_applied_perString

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
uotString

The 'UOT' applicable for the rate

  • Seconds
  • Minute
  • Hour
  • Day
  • Week
  • Month
  • Year

Available for one-time services

time_periodTime Period Object

 The period and unit of time for which the base amount is applicable for. This is available only on termed services rates.

uomString

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_valueNumber

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

 activity object response data

Name

Type

Description

id

String

The ID of the retrieved activity

number

String

The number of the retrieved activity

life_cycle_state

String

The life cycle state of the activity. One of the following values is returned:

PENDING, IN PROGRESS, COMPLETED, CANCELLED

contact_informationContact information objectThe contact information owning the activity
typeActivity Type ObjectThe type information of the retrieved activity

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_nameSting

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_dateDate

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_dateDate

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_codeString

The alternative code of the retrieved country

dialing_codeString

The dialing code of the retrieved country

Available from CRM.COM R15.1.0

two_character_codeString

The two character code of the retrieved country

three_character_codeString

The three character code of the retrieved country

country_flagImage 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

fileFile ObjectThe information of the attached file

Referred Objects Response Data

 file object response data

 

Name

Type

Description

file_nameStringThe name of the file
file_content_urlStringThe url that can be used to access the actual content of the file
file_mime_typeStringThe 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_employeesNumber

The number of employees of the retrieved contact information

registration_number

String

The registration number of the retrieved contact information

vat_registration_numberString

The vat registration number of the retrieved contact information

vat_registered_byString

The vat registration by of the retrieved contact information

vat_registration_date

Date

The vat registration date of the retrieved contact information

tax_reference_numberString

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_codeString

The alternative code of the retrieved country

dialing_codeString

The dialing code of the retrieved country

Available from CRM.COM R15.1.0

two_character_codeString

The two character code of the retrieved country

three_character_codeString

The three character code of the retrieved country

country_flagImage 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

fileFile ObjectThe information of the attached file

Referred Objects Response Data

 file object response data

 

Name

Type

Description

file_nameStringThe name of the file
file_content_urlStringThe url that can be used to access the actual content of the file
file_mime_typeStringThe 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

 activity_type object response data

Name

Type

Description

id

String

The ID of the retrieved activity type

name

String

The name of the retrieved activity type

alternative_code

String

The alternative code of the retrieved activity type

descriptionStringA description of the retrieved activity type

 bill object response data

Name

Type

Description

id

String

The ID of the retrieved bill

number

String

The number of the retrieved bill

life_cycle_state

String

The life cycle state of the bill. One of the following values is returned:

POSTED, PRESENTED, PRESENTED_CONFIRMED, PRESENTED_REJECTED

from_dateDateThe date from which the accounts receivable is billed for
to_dateDateThe date until which the accounts receivable is billed for
due_dateDate

The due date of bill. The field is calculated dynamically. The maximum due date of related invoices.

Available from CRM.COM R12.4.0

total_billed_amountNumberThe total billed amount
total_amount_to_be_paidNumberThe total amount to be paid
bill_statusString

The status of the bill in terms of it is settled or not.The supported values are the following:

SETTLED, UNSETTLED, PARTIALLY_SETTLED

currencyCurrency object

The bill's currency

Available from CRM.COM R10.0.0

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_symbolStringThe prefix symbol for the specified currency

suffix_symbol

StringThe suffix symbol for the specified currency
life_cycle_stateString

The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE

Available from CRM.COM R14.0.0

integer_part_nameStringThe integer part name for the specified currency
decimal_part_nameStringThe decimal part name for the specified currency

 log_information object response data

Name

Type

Description

created_date

Date

The date that the retrieved record was created

updated_date

Date

The last date that the retrieved record was updated

created_by_unit

Unit Object

The unit that created the retrieved record

From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled

Deprecated from CRM.COM R18.0.0

created_by_business_unit

Unit Object

The unit that created the retrieved record

From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled

Available from CRM.COM R18.0.0

created_by_user

User Object

The user that created the retrieved record

From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled

updated_by_unit

Unit Object

The last unit that updated the retrieved record

From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled

Deprecated from CRM.COM R18.0.0

updated_by_business_unit

Unit Object

The last unit that updated the retrieved record

Available from CRM.COM R18.0.0

updated_by_user

User Object

The last user that updated the retrieved record

From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled

Referred Objects Response Data

 unit object response data

Name

Type

Description

id

String

The ID of the retrieved unit

name

String

The name of the retrieved unit

group_name

String

The name of the group that the retrieved unit belongs to

community_name

String

The name of the community that the retrieved unit belongs to

alternative_code

String

The alternative code of the retrieved unit

description

String

The description of the retrieved unit

 business unit object response data

Name

Type

Description

id

String

The ID of the retrieved business unit

name

String

The name of the retrieved business unit

codeStringThe code of the retrieved business unit
unified_codeString

The unified code of the retrieved business unit

description

String

The description of the retrieved business unit

parent_business_unit_nameStringThe name of the parent business unit that the retrieved business unit belongs to

 user object response data

Name

Type

Description

id

String

The ID of the retrieved user

username

String

The user name of the retrieved user

person_name

String

The full name of the retrieved user

email

String

The email of the retrieved user

Examples

 Example 1

HTTP Method: POST 

Request:

Body:

 {
"token":"44720BFD213D4498BCD6DCD52B342D12",
"type_identifier":{"name":"Add subscription services"},
"status_identifier": {"name":"Draft"},
"accounts_receivable_identifier":{"number":"ACR001182"},
"subscription_identifier":{"number":"S61007"},
"contact_email":"m_antoniadou@crm.com",
"description":"Add Service Cartoons 2",
"start_date":"2016-07-28T11:00:00",
"owned_by_group_identifier":{"name":"Main Group"},
"estimated_completion_time":
{
    "time_period_value":1,
    "time_period_uot":"DAYS"
},
"billing_terms":
{
    "billing_term_scheme_identifier":{"code":"PJBTS"},
    "price_plan_identifier":{"code":"BPP0614"},
    "agreement_date":"2016-07-27T17:00:00"
},
"assigned_to":
{
    "unit_identifier":{"name":"Admin Unit"}
},
"requested_subscription_services_set":
[
    {
      "service_identifier":{"code":"Cartoons 2"},
      "provisioning_distribution_set":
      [
          {
              "provisioning_distributor_identifier":{"name":"CONAX SMS Main"}
          }
      ]
    }
],
"requested_physical_goods_set":
[
    {
        "product_identifier":{"code":"Antenna 1"},
        "quantity":1
    },
    {
        "product_identifier":{"code":"Remote Control"},
        "quantity":1
    }
],
"requested_subscription_physical_goods_set":
[
    {
        "product_identifier":{"code":"Smartcard 1"},
        "quantity":1,
        "provisioning_distribution_set":
        [
            {
              "provisioning_distributor_identifier":{"name":"CONAX SMS Main"}
          }
        ]
    }
],
"requested_expenses_set":
[
    {
        "product_identifier":{"code":"Installation Fee"}
    }
],
"requested_activity_services_set":
[
    {
        "activity_type_identifier":{"name":"InstallationsX"},
        "product_identifier":{"code":"Installation Fee"}
    }
]
}

 

Response:

 {
  "status": {
    "message": "",
    "description": "",
    "code": "OK"
  },
  "data": {
    "requested_physical_goods_set": [
      {
        "id": "EBF6F9A8EB764FAC8DBA948A0FCFCEEB",
        "quantity": 1,
        "product": {
          "product_type": {
            "service_type": null,
            "physical_good_type": "NONTRACEABLE",
            "used_for_provisioning": false,
            "classification": "PHYSICALGOODS",
            "composition_method": "FLAT",
            "id": "0F94B51F175F06A475EB2948B4030074",
            "name": "Accessories",
            "description": "A type which is used for accessories physical goods",
            "alternative_code": "005"
          },
          "id": "3F01BB0B40264DF7311660F63CB2180D",
          "description": "Remote Control",
          "code": "Remote Control",
          "alternative_code": "REM"
        }
      },
      {
        "id": "EAE74E5D2AC34211B938BE3487F96510",
        "quantity": 1,
        "product": {
          "product_type": {
            "service_type": null,
            "physical_good_type": "NONTRACEABLE",
            "used_for_provisioning": false,
            "classification": "PHYSICALGOODS",
            "composition_method": "FLAT",
            "id": "0F94B51F175F06A475EB2948B4030074",
            "name": "Accessories",
            "description": "A type which is used for accessories physical goods",
            "alternative_code": "005"
          },
          "id": "70FFDF2B2A74466DD7D0D5246ED1DD2D",
          "description": "Antenna v1",
          "code": "Antenna 1",
          "alternative_code": "ANT1"
        }
      }
    ],
    "service_request": null,
    "udf_float_1": null,
    "udf_float_2": null,
    "udf_float_3": null,
    "udf_float_4": null,
    "udf_string_1": null,
    "udf_string_2": null,
    "assigned_to": {
      "unit": {
        "community_name": "Internal Community",
        "id": "48305F8849E3C18B227C5BE3A27BA6DF",
        "name": "Admin Unit",
        "group_name": "Main Group",
        "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
        "alternative_code": "MG"
      },
      "user": null
    },
    "udf_string_3": null,
    "privacy_level": null,
    "udf_string_4": null,
    "udf_string_5": null,
    "contact_phone": null,
    "udf_string_6": null,
    "activities_set": [],
    "udf_string_7": null,
    "physical_goods_set": [],
    "udf_string_8": null,
    "accounts_receivable": {
      "account_owner": {
        "last_name": "Anton",
        "middle_name": "333",
        "life_cycle_state": "FINANCIAL",
        "company_profile": null,
        "title": "Mrs",
        "first_name": "Mara",
        "type": "PERSON",
        "id": "3358197AD0334CE2834DB60933B2CE88",
        "name": "Anton Mara",
        "company_name": null,
        "demographics": {
          "gender": "FEMALE",
          "passport_issued_by_country": null,
          "social_security_number": null,
          "passport_number": null,
          "industry_sector": null,
          "country_of_residence": {
            "three_character_code": "CYP",
            "two_character_code": "CY",
            "id": "181",
            "name": "CYPRUS",
            "alternative_code": null
          },
          "name_day": {
            "month": null,
            "day": null
          },
          "date_of_birth": {
            "month": null,
            "day": null,
            "year": null
          },
          "id_number": "568941",
          "industry": null,
          "id_issued_by_country": null
        }
      },
      "life_cycle_state": "ACTIVE",
      "number": "ACR001182",
      "id": "570169F05EF949E89FF987AD086A09BE",
      "name": "ACR001182"
    },
    "id": "08632E19E3ED497E9CE4B7AA484245F8",
    "subscription": {
      "life_cycle_state": "EFFECTIVE",
      "accounts_receivable": {
        "account_owner": {
          "last_name": "Anton",
          "middle_name": "333",
          "life_cycle_state": "FINANCIAL",
          "company_profile": null,
          "title": "Mrs",
          "first_name": "Mara",
          "type": "PERSON",
          "id": "3358197AD0334CE2834DB60933B2CE88",
          "name": "Anton Mara",
          "company_name": null,
          "demographics": {
            "gender": "FEMALE",
            "passport_issued_by_country": null,
            "social_security_number": null,
            "passport_number": null,
            "industry_sector": null,
            "country_of_residence": {
              "three_character_code": "CYP",
              "two_character_code": "CY",
              "id": "181",
              "name": "CYPRUS",
              "alternative_code": null
            },
            "name_day": {
              "month": null,
              "day": null
            },
            "date_of_birth": {
              "month": null,
              "day": null,
              "year": null
            },
            "id_number": "568941",
            "industry": null,
            "id_issued_by_country": null
          }
        },
        "life_cycle_state": "ACTIVE",
        "number": "ACR001182",
        "id": "570169F05EF949E89FF987AD086A09BE",
        "name": "ACR001182"
      },
      "number": "S61007",
      "type": {
        "id": "D433A85FB6CD4880A1BCEEB1E164EFA4",
        "name": "London",
        "description": "Subscription for London customers",
        "alternative_code": "LND"
      },
      "id": "26505A7D9E904C069F03DE12AEDE015D",
      "first_activated_date": "2016-07-20T12:51:24",
      "rating_state": "PENDING"
    },
    "requested_activity_services_set": [
      {
        "activity_type": {
          "id": "938B9B6411AAB03DC25B3F569A443C6D",
          "name": "InstallationsX",
          "description": "Test",
          "alternative_code": "INX"
        },
        "id": "7C1AA5233E174062A9DE3E401B4A4C2A",
        "product": {
          "product_type": {
            "service_type": "EXPENSE",
            "physical_good_type": null,
            "used_for_provisioning": false,
            "classification": "SERVICES",
            "composition_method": "FLAT",
            "id": "67FA013211E348C58F7CD27F8399AADE",
            "name": "Expense Type",
            "description": null,
            "alternative_code": "ET"
          },
          "id": "8F7A45F44BBEB320718F309F58CCE097",
          "description": "Installation",
          "code": "Installation Fee",
          "alternative_code": "Ins"
        }
      }
    ],
    "requested_subscription_physical_goods_set": [
      {
        "swap_installed_item": null,
        "provisioning_distributor": {
          "id": "9653D381D3874E9A9CABCE9C2585C253",
          "name": "CONAX SMS Main",
          "alternative_code": "CONAX_SMS_Main"
        },
        "installed_item": null,
        "id": "57E80E80FC64408EB3780AEDD0B04CA9",
        "quantity": 1,
        "product": {
          "product_type": {
            "service_type": null,
            "physical_good_type": "TRACEABLE",
            "used_for_provisioning": false,
            "classification": "PHYSICALGOODS",
            "composition_method": "FLAT",
            "id": "6173FC99331504AD1ACB5D697D54DA8C",
            "name": "Smartcards",
            "description": "Smartcards",
            "alternative_code": "SC"
          },
          "id": "EAC7A30429364176616CFEF5DF709941",
          "description": "Smartcard 1",
          "code": "Smartcard 1",
          "alternative_code": "SC1"
        }
      }
    ],
    "expected_completion_date": "2016-07-29T11:00:00",
    "time_to_completion": {
      "time_period_value": 2,
      "time_period_uot": "DAYS"
    },
    "time_overdue": {
      "time_period_value": null,
      "time_period_uot": null
    },
    "log_information": {
      "updated_date": "2016-07-27T18:22:09",
      "created_date": "2016-07-27T18:22:05",
      "created_by_unit": {
        "community_name": "Internal Community",
        "id": "48305F8849E3C18B227C5BE3A27BA6DF",
        "name": "Admin Unit",
        "group_name": "Main Group",
        "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
        "alternative_code": "MG"
      },
      "updated_by_unit": {
        "community_name": "Internal Community",
        "id": "48305F8849E3C18B227C5BE3A27BA6DF",
        "name": "Admin Unit",
        "group_name": "Main Group",
        "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
        "alternative_code": "MG"
      },
      "created_by_user": {
        "person_name": "Marios Lannister",
        "username": "MPAdministrator",
        "id": "1"
      },
      "updated_by_user": {
        "person_name": "Marios Lannister",
        "username": "MPAdministrator",
        "id": "1"
      }
    },
    "life_cycle_state": "DRAFT",
    "location": {
      "udf_string_10": null,
      "street_number": "10",
      "care_of": null,
      "udf_string_11": null,
      "udf_float_1": null,
      "street_name": "Athalassis",
      "udf_string_12": null,
      "udf_float_2": null,
      "udf_string_13": null,
      "udf_float_3": null,
      "udf_string_14": null,
      "udf_float_4": null,
      "udf_string_15": null,
      "udf_string_16": null,
      "po_box": "1136525",
      "udf_string_1": null,
      "floor": 2,
      "udf_string_2": null,
      "area": null,
      "udf_string_3": null,
      "district": null,
      "udf_string_4": null,
      "udf_string_5": null,
      "udf_string_6": null,
      "udf_string_7": null,
      "state": "Active",
      "udf_string_8": null,
      "udf_string_9": null,
      "country": {
        "three_character_code": "CYP",
        "two_character_code": "CY",
        "id": "181",
        "name": "CYPRUS",
        "alternative_code": null
      },
      "id": "3B808C39809A431EAE83C7FD2584D7D8",
      "postal_code": null,
      "udf_date_1": null,
      "udf_date_2": null,
      "udf_date_3": null,
      "udf_date_4": null,
      "po_box_postal_code": "3654",
      "apartment_number": "203",
      "town_city": "Nicosia",
      "type": "POBOX",
      "municipality": null
    },
    "type": {
      "fulfillment_method": "BASED_ON_ORDERED_ITEMS",
      "fulfillment_scope": "ADD_SUBSCRIPTION_SERVICES",
      "id": "FE4AC73E0F8F4B3F999314CF556B6F1E",
      "name": "Add subscription services",
      "description": null,
      "alternative_code": "ADD_SERVICES"
    },
    "contact_email": "m_antoniadou@crm.com",
    "expenses_set": [],
    "notes": null,
    "billing_terms": {
      "binding_information": null,
      "agreement_date": "2016-07-27T00:00:00",
      "concurrent_usage_based_pricing": {
        "concurrent_usage": null,
        "rate_percentage": null
      },
      "billing_term_scheme": {
        "life_cycle_state": "EFFECTIVE",
        "billing_method": "PERIOD",
        "classification": "JOBS",
        "id": "9C0B2B52003EFEEE0864212F34D41229",
        "name": "P Job Billing Term Scheme",
        "code": "PJBTS",
        "billing_type": "NORMAL"
      },
      "effective_date": "2016-07-27T00:00:00",
      "billing_frequency": null,
      "id": "4E4D4EB5496A4901AAFB497FAEFDEB1D",
      "allowed_cancel_date": null,
      "expiration_date": null,
      "billing_cycle_day": null,
      "price_plan": {
        "effective_date": "2016-04-08T00:00:00",
        "type": "BASE",
        "id": "62F4D4E787AD4ACC895FD1D066037353",
        "name": "BPP0614",
        "description": "Base Price PLan June 14 for Subscription Test Case 6",
        "code": "BPP0614",
        "expiration_date": null
      }
    },
    "number": "JOB000808",
    "estimated_completion_time": {
      "time_period_value": 1,
      "time_period_uot": "DAYS"
    },
    "requested_subscription_services_set": [
      {
        "product_bundle": null,
        "swap_product": null,
        "provisioning_distributor": {
          "id": "9653D381D3874E9A9CABCE9C2585C253",
          "name": "CONAX SMS Main",
          "alternative_code": "CONAX_SMS_Main"
        },
        "id": "03CAF4D8224C4EB38F10D08CEF98BACF",
        "product": {
          "product_type": {
            "service_type": "TERMED",
            "physical_good_type": null,
            "used_for_provisioning": true,
            "classification": "SERVICES",
            "composition_method": "FLAT",
            "id": "600438B64B0F05AB3D020C902674949F",
            "name": "Subscription services",
            "description": "Subscription services",
            "alternative_code": "SS"
          },
          "id": "E3600383FF2650A594594F10BEB358D5",
          "description": "Cartoons 2",
          "code": "Cartoons 2",
          "alternative_code": "C2"
        }
      }
    ],
    "udf_date_1": null,
    "udf_date_2": null,
    "udf_date_3": null,
    "start_date": "2016-07-28T11:00:00",
    "udf_date_4": null,
    "requested_expenses_set": [
      {
        "id": "1BABF33983BB42769ADA1DDCBC33C159",
        "product": {
          "product_type": {
            "service_type": "EXPENSE",
            "physical_good_type": null,
            "used_for_provisioning": false,
            "classification": "SERVICES",
            "composition_method": "FLAT",
            "id": "67FA013211E348C58F7CD27F8399AADE",
            "name": "Expense Type",
            "description": null,
            "alternative_code": "ET"
          },
          "id": "8F7A45F44BBEB320718F309F58CCE097",
          "description": "Installation",
          "code": "Installation Fee",
          "alternative_code": "Ins"
        }
      }
    ],
    "rating_state": "PENDING",
    "owned_by_group": {
      "community_name": "Internal Community",
      "id": "84F33366CB592BAAE7E2044D93611C6A",
      "name": "Main Group",
      "description": "Main Group",
      "alternative_code": "MG1"
    },
    "status": {
      "life_cycle_state": "DRAFT",
      "id": "0F1EE97BD63642699FFAEB461F471147",
      "name": "Draft",
      "description": null,
      "alternative_code": "D"
    },
    "actual_completed_date": null,
    "description": "Add Service Cartoons 2",
    "category": null
  }
}
 Example 2

HTTP Method: POST 

Request:

Body:

 {
"token":"4D034E4054DE4B9C87C83CB7C8DEDDA0",
"type_identifier":{"name":"Add subscription services"},
"accounts_receivable_identifier":{"number":"ACR001182"},
"subscription_identifier":{"number":"S61007"},
"contact_email":"m_antoniadou@crm.com",
"contact_phone":"99585858",
"description":"Add Service To Subscription S61007",
"estimated_completion_time":
{
    "time_period_value":1,
    "time_period_uot":"DAYS"
},
"billing_terms":
{
    "billing_term_scheme_identifier":{"code":"PJBTS"},
    "price_plan_identifier":{"code":"BPP0614"},
    "agreement_date":"2016-07-26T13:00:00"
},
"assigned_to":
{
    "user_identifier":{"username":"MPAdministrator"}
},
"requested_subscription_services_set":
[
    {
      "service_identifier":{"code":"Cartoons 2"},
      "provisioning_distribution_set":
      [
          {
              "provisioning_distributor_identifier":{"name":"CONAX SMS Main"}
          }
      ]
    }
],
"requested_physical_goods_set":
[
    {
        "product_identifier":{"alternative_code":"REM"},
        "quantity":1
    }
],
"requested_subscription_physical_goods_set":
[
    {
        "product_identifier":{"code":"Smartcard 1"},
        "quantity":1,
        "provisioning_distribution_set":
        [
            {
              "provisioning_distributor_identifier":{"name":"CONAX SMS Main"}
          }
        ]
    }
],
"fields_set":"id,number,life_cycle_state,start_date,expected_completion_date,type,billing_terms,requested_subscription_services_set,requested_physical_goods_set,requested_subscription_physical_goods_set,requested_expenses_set,requested_activity_services_set"
}

 

Response:

 {
  "status": {
    "message": "",
    "description": "",
    "code": "OK"
  },
  "data": {
    "requested_activity_services_set": [],
    "requested_subscription_physical_goods_set": [
      {
        "swap_installed_item": null,
        "provisioning_distributor": {
          "id": "9653D381D3874E9A9CABCE9C2585C253",
          "name": "CONAX SMS Main",
          "alternative_code": "CONAX_SMS_Main"
        },
        "installed_item": null,
        "id": "A586C994376F4750ADDC38E44DF1F171",
        "quantity": 1,
        "product": {
          "product_type": {
            "service_type": null,
            "physical_good_type": "TRACEABLE",
            "used_for_provisioning": false,
            "classification": "PHYSICALGOODS",
            "composition_method": "FLAT",
            "id": "6173FC99331504AD1ACB5D697D54DA8C",
            "name": "Smartcards",
            "description": "Smartcards",
            "alternative_code": "SC"
          },
          "id": "EAC7A30429364176616CFEF5DF709941",
          "description": "Smartcard 1",
          "code": "Smartcard 1",
          "alternative_code": "SC1"
        }
      }
    ],
    "requested_physical_goods_set": [
      {
        "id": "5D0EF6298930420A8603DD8365999C94",
        "quantity": 1,
        "product": {
          "product_type": {
            "service_type": null,
            "physical_good_type": "NONTRACEABLE",
            "used_for_provisioning": false,
            "classification": "PHYSICALGOODS",
            "composition_method": "FLAT",
            "id": "0F94B51F175F06A475EB2948B4030074",
            "name": "Accessories",
            "description": "A type which is used for accessories physical goods",
            "alternative_code": "005"
          },
          "id": "3F01BB0B40264DF7311660F63CB2180D",
          "description": "Remote Control",
          "code": "Remote Control",
          "alternative_code": "REM"
        }
      }
    ],
    "requested_subscription_services_set": [
      {
        "product_bundle": null,
        "swap_product": null,
        "provisioning_distributor": {
          "id": "9653D381D3874E9A9CABCE9C2585C253",
          "name": "CONAX SMS Main",
          "alternative_code": "CONAX_SMS_Main"
        },
        "id": "46D0760AC047463293FE7368D47C843B",
        "product": {
          "product_type": {
            "service_type": "TERMED",
            "physical_good_type": null,
            "used_for_provisioning": true,
            "classification": "SERVICES",
            "composition_method": "FLAT",
            "id": "600438B64B0F05AB3D020C902674949F",
            "name": "Subscription services",
            "description": "Subscription services",
            "alternative_code": "SS"
          },
          "id": "E3600383FF2650A594594F10BEB358D5",
          "description": "Cartoons 2",
          "code": "Cartoons 2",
          "alternative_code": "C2"
        }
      }
    ],
    "billing_terms": {
      "binding_information": null,
      "agreement_date": "2016-07-26T00:00:00",
      "concurrent_usage_based_pricing": {
        "concurrent_usage": null,
        "rate_percentage": null
      },
      "billing_term_scheme": {
        "life_cycle_state": "EFFECTIVE",
        "billing_method": "PERIOD",
        "classification": "JOBS",
        "id": "9C0B2B52003EFEEE0864212F34D41229",
        "name": "P Job Billing Term Scheme",
        "code": "PJBTS",
        "billing_type": "NORMAL"
      },
      "effective_date": "2016-07-26T00:00:00",
      "billing_frequency": null,
      "id": "B7808BF39C22420AB58A5F386218F16E",
      "allowed_cancel_date": null,
      "expiration_date": null,
      "billing_cycle_day": null,
      "price_plan": {
        "effective_date": "2016-04-08T00:00:00",
        "type": "BASE",
        "id": "62F4D4E787AD4ACC895FD1D066037353",
        "name": "BPP0614",
        "description": "Base Price PLan June 14 for Subscription Test Case 6",
        "code": "BPP0614",
        "expiration_date": null
      }
    },
    "life_cycle_state": "DRAFT",
    "number": "JOB000784",
    "type": {
      "fulfillment_method": "BASED_ON_ORDERED_ITEMS",
      "fulfillment_scope": "ADD_SUBSCRIPTION_SERVICES",
      "id": "FE4AC73E0F8F4B3F999314CF556B6F1E",
      "name": "Add subscription services",
      "description": null,
      "alternative_code": "ADD_SERVICES"
    },
    "expected_completion_date": "2016-07-27T14:44:56",
    "start_date": "2016-07-26T14:44:56",
    "id": "7094FCEB13E542DC92A7C7D9191E25D5",
    "requested_expenses_set": []
  }
}
  • No labels