GET jobs/swap_subscription_installed_items/get_latest

Available from CRM.COM R14.0.0

This method returns information related to the latest jobs of fulfillment scope Swap Subscription Installed Items. Multiple jobs are returned by each call. Results are sorted based on the date that they were updated in a descending order

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

(semi-optional)

Accounts Receivable Identifier

The identifier of the account related to the job that should be returned as a result. The allowed account identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the accounts receivable

number

(semi-optional)

String

The number of the accounts receivable

name

(semi-optional)

String

The name of the accounts receivable

type_identifier
(semi-optional)

Job Type Identifier

The identifier of the job type related with the jobs that should be returned as a result. Only job types classified as Swap Subscription Installed Items can be specified. 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

number_of_results

(optional)

Number

The number of results that can be retrieved through each call

offset

(optional)

Number

Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise, the results will begin at the provided offset number

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

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
description	String	The description of the retrieved job
notes	String	The notes of the retrieved job
contact_email	String	The email of the customer related with the retrieved job, which will be used in order to communicate the job
contact_phone	String	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_date	Date	The date that the job is created
expected_completion_date	Date	The date that the job is expected to be completed
actual_completed_date	Date	The date that the job is actually completed
expiration_date	Date	The date on which the job expires. Available form CRM.COM R13.0.0
rating_state	String	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_to	Assign Object	The assignment information of the retrieved job
type	Job type object	The type information of the retrieved job
billing_terms	Jobs Billing Terms Object	The billing terms of the retrieved job
status	Job Status object	The status information of the retrieved job
category	Job Category object	The category of the retrieved job
subscription	Subscription Object	The subscription for which the requested subscription installed items were swapped by the job.
service_request	Service Request Object	The service request that was related with the retrieved job.
estimated_completion_time	Time Period Object	The time that is estimated to complete the job, measured in minutes, hours, days, weeks, years
time_to_completion	Time Period Object	The time that is left up to the expected completion date
time_overdue	Time Period Object	The time past the expected completion date
accounts_receivable	Accounts Receivable object	The accounts receivable related with the specified job
pricing_agreement_price_plan	Price 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
location	Address Object	The physical location that the job should be performed and delivered to
cancellation_reason	Jobs 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_group	Group object	The group that is owning the job
privacy_level	Privacy level object	The job privacy level
log_information	Log Information Object	The log information related with the retrieved job
requested_physical_goods_set	Set of Requested Physical Goods Objects	The physical goods that were requested by the retrieved job
requested_subscription_physical_goods_set	Set of Requested Subscription Physical Goods Objects	The subscription physical goods that were requested by the retrieved job to be swapped on the subscription.
requested_expenses_set	Set of Requested Expenses Objects	The expenses that were requested by the retrieved job
requested_activity_services_set	Set of Requested Activity Services Objects	The activity services that were requested by the retrieved job
subscription_physical_goods_set	Set of Subscription Physical Goods Objects	The subscription physical goods that will be added on the subscription by the job after the swap.
physical_goods_set	Set of Physical Goods Objects	The physical goods that will be provided as part of the job
expenses_set	Set of Expense Objects	A list of one time services which are applied on the job as expenses
activities_set	Set of Activity Objects	A 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
user	User object	The user which is assigned with the retrieved activity
business_unit	Business Unit object	The business unit which is assigned with the retrieved activity Available from CRM.COM R18.0.0
unit	Unit 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
code	String	The code of the retrieved business unit
unified_code	String	The unified code of the retrieved business unit
description	String	The description of the retrieved business unit
parent_business_unit_name	String	The 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

Name	Type	Description
Id	String	The ID of the retrieved job type
name	String	The Name of the retrieved job type
alternative_code	String	The Alternative Code of the retrieved job type
description	String	The Description of the retrieved job type
billing_directive	String	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_method	String	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_scope	String	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_method	String	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_state	String	The life cycle state of the retrieved billing terms which can be EFFECTIVE or TERMINATED
agreement_date	Date	The 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_date	Date	The effective date of the retrieved billing terms
expiration_date	Date	The expiration date of the retrieved billing terms
concurrent_usage_based_pricing	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 services Not available from CRM.COM R10.0.0 and onward
billing_term_scheme	Billing term scheme object	The billing term scheme of the retrieved billing terms
price_plan	Price plan object	The 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_items	Number	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_method	String	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
code	String	The code of the retrieved billing term scheme
name	String	The name of the retrieved billing term scheme
life_cycle_state	String	The life cycle state of the retrieved billing term scheme. The supported life cycle states are the following DRAFT, EFFECTIVE, TERMINATED
classification	String	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_type	String	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_method	String	The billing method of the billing term scheme which can be ANNIVERSARY or PERIOD

price_plan object data response

Name	Type	Description
Id	String	The ID of the retrieved price plan
name	String	The Name of the retrieved price plan
code	String	The Code of the retrieved price plan
description	String	The Description of the retrieved price plan
type	String	The Type of the retrieved price plan which can be BASE or CONDITIONAL
effective_date	Date	The Effective Date of the retrieved price plan
expiration_date	Date	The Expiration Date of the retrieved price plan
currency	Currency 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_symbol	String	The prefix symbol for the specified currency
suffix_symbol	String	The suffix symbol for the specified currency
life_cycle_state	String	The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE Available from CRM.COM R14.0.0
integer_part_name	String	The integer part name for the specified currency
decimal_part_name	String	The decimal part name for the specified currency

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
description	String	A description of the retrieved job status
life_cycle_state	String	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

Name	Type	Description
Id	String	The ID of the retrieved job category
name	String	The Name of the retrieved job category
code	String	The code of the retrieved job category
description	String	The 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_date	Date	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_state	String	The rating state of the retrieved subscription that can be PENDING or COMPLETED Available from CRM.COM R9.0.0
accounts_receivable	Accounts receivable object	The accounts receivable owning the subscriptions
type	Subscription type object	The 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
name	String	The name of the retrieved accounts receivable
life_cycle_state	String	The life cycle state of the accounts receivable. One of the following values is returned: ACTIVE, SUSPENDED, TERMINATED
account_owner	Contact information object	The contact information owning the accounts receivable

Referred Objects Response Data

contact_information object response data

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

Referred Objects Response Data

demographics object response data

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

Referred Objects Response Data

date_of_birth object response data

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

name_day object response data

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

country object response data

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

Referred Objects Response Data

country_flag object response data

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

Referred Objects Response Data

file object response data

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

industry object response data

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

industry sector object response data

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

company profile object response data

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

Referred Objects Response Data

country object response data

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

Referred Objects Response Data

country_flag object response data

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

Referred Objects Response Data

file object response data

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

industry object response data

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

industry sector object response data

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

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
description	String	A description of the retrieved subscription type
classification	String	The classification of the retrieved subscription type, Flexible or Package Available from CRM.COM R14.0.0 Deprecated from CRM.COM R17.0.0

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_date	Date	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_state	String	The rating state of the retrieved subscription that can be PENDING or COMPLETED Available from CRM.COM R9.0.0
accounts_receivable	Accounts receivable object	The accounts receivable owning the subscriptions
type	Subscription type object	The 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
name	String	The name of the retrieved accounts receivable
life_cycle_state	String	The life cycle state of the accounts receivable. One of the following values is returned: ACTIVE, SUSPENDED, TERMINATED
account_owner	Contact information object	The contact information owning the accounts receivable

Referred Objects Response Data

contact_information object response data

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

Referred Objects Response Data

demographics object response data

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

Referred Objects Response Data

date_of_birth object response data

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

name_day object response data

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

country object response data

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

Referred Objects Response Data

country_flag object response data

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

Referred Objects Response Data

file object response data

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

industry object response data

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

industry sector object response data

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

company profile object response data

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

Referred Objects Response Data

country object response data

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

Referred Objects Response Data

country_flag object response data

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

Referred Objects Response Data

file object response data

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

industry object response data

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

industry sector object response data

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

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
description	String	A description of the retrieved subscription type
classification	String	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
description	String	The 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
name	String	The name of the retrieved accounts receivable
life_cycle_state	String	The life cycle state of the accounts receivable. One of the following values is returned: ACTIVE, SUSPENDED, TERMINATED
account_owner	Contact information object	The contact information owning the accounts receivable

Referred Objects Response Data

contact_information object response data

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

Referred Objects Response Data

demographics object response data

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

Referred Objects Response Data

date_of_birth object response data

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

name_day object response data

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

country object response data

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

Referred Objects Response Data

country_flag object response data

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

Referred Objects Response Data

file object response data

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

industry object response data

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

industry sector object response data

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

company profile object response data

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

Referred Objects Response Data

country object response data

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

Referred Objects Response Data

country_flag object response data

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

Referred Objects Response Data

file object response data

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

industry object response data

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

industry sector object response data

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

period object response data

Name

Type

Description

time_period_value

Number

The time period value

time_period_uot

String

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

MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS

accounts_receivable object response data

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

Referred Objects Response Data

contact_information object response data

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

Referred Objects Response Data

demographics object response data

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

Referred Objects Response Data

date_of_birth object response data

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

name_day object response data

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

country object response data

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

Referred Objects Response Data

country_flag object response data

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

Referred Objects Response Data

file object response data

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

industry object response data

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

industry sector object response data

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

company profile object response data

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

Referred Objects Response Data

country object response data

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

Referred Objects Response Data

country_flag object response data

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

Referred Objects Response Data

file object response data

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

industry object response data

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

industry sector object response data

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

price_plan object data response

Name	Type	Description
Id	String	The ID of the retrieved price plan
name	String	The Name of the retrieved price plan
code	String	The Code of the retrieved price plan
description	String	The Description of the retrieved price plan
type	String	The Type of the retrieved price plan which can be BASE or CONDITIONAL
effective_date	Date	The Effective Date of the retrieved price plan
expiration_date	Date	The Expiration Date of the retrieved price plan
currency	Currency 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_symbol	String	The prefix symbol for the specified currency
suffix_symbol	String	The suffix symbol for the specified currency
life_cycle_state	String	The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE Available from CRM.COM R14.0.0
integer_part_name	String	The integer part name for the specified currency
decimal_part_name	String	The decimal part name for the specified currency

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_primary	Boolean	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_primary	Boolean	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_code	String	The alternative code of the retrieved country
dialing_code	String	The dialing code of the retrieved country Available from CRM.COM R15.1.0
two_character_code	String	The two character code of the retrieved country
three_character_code	String	The three character code of the retrieved country
country_flag	Image Object	The flag of the retrieved country Available from CRM.COM R15.1.0

Referred Objects Response Data

country_flag object response data

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

Referred Objects Response Data

file object response data

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

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
description	String	A 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_code	String	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
number	String	The 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_physical_good object response data

Name	Type	Description
id	String	The ID of the retrieved job requested physical good
quantity	Number	The quantity of the retrieved job requested physical good
notes	String	The notes of the retrieved job requested physical goods Available form CRM.COM R12.3.0
product	Products Object	The product related with the retrieved job requested physical good
components_set	Set 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
Id	String	The ID of the product
code	String	The code of product
alternative_code	String	The alternative code of product
description	String	The description of product
priority_level	Integer	The priority level of the product Available from CRM.COM R12.3.0
global_rate	Global Rate Object	The global rate of the retrieved product Available from CRM.COM R15.0.0
product_type	Product type object	The type of the product

Referred Objects Response Data

product_type object data response

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

Referred Objects Response Data

usage_detail_record_type object data response

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

Referred Objects Response Data

unit_of_measurement object response data

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

meter_reading_type object data response

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

Referred Objects Response Data

unit_of_measurement object response data

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

global rate object response data

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

Referred Objects Response Data

period object response data

Name

Type

Description

time_period_value

Number

The time period value

time_period_uot

String

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

MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS

job_requested_subsrciption_physical_good object response data

Name	Type	Description
id	String	The ID of the retrieved job requested subscription physical good
quantity	Number	The quantity of the retrieved job requested subscription physical good
coverage	Integer	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
product	Products Object	The product related with the retrieved job requested subscription physical good
installed_item	Installed 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_policy	Warranty 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_reason	Warranty 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_distributor	Provisioning Distributor Object	The 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
Id	String	The ID of the product
code	String	The code of product
alternative_code	String	The alternative code of product
description	String	The description of product
priority_level	Integer	The priority level of the product Available from CRM.COM R12.3.0
global_rate	Global Rate Object	The global rate of the retrieved product Available from CRM.COM R15.0.0
product_type	Product type object	The type of the product

Referred Objects Response Data

product_type object data response

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

Referred Objects Response Data

usage_detail_record_type object data response

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

Referred Objects Response Data

unit_of_measurement object response data

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

meter_reading_type object data response

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

Referred Objects Response Data

unit_of_measurement object response data

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

global rate object response data

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

Referred Objects Response Data

period object response data

Name

Type

Description

time_period_value

Number

The time period value

time_period_uot

String

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

MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS

installed item object response data

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

Referred Objects Response Data

product object response data

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

Referred Objects Response Data

product_type object data response

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

Referred Objects Response Data

usage_detail_record_type object data response

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

Referred Objects Response Data

unit_of_measurement object response data

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

meter_reading_type object data response

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

Referred Objects Response Data

unit_of_measurement object response data

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

global rate object response data

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

Referred Objects Response Data

period object response data

Name

Type

Description

time_period_value

Number

The time period value

time_period_uot

String

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

MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS

state classification object response data

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

warranty object response data

Name	Type	Description
id	String	The ID of the retrieved warranty policy
number	String	The number of the retrieved warranty policy
name	String	The name of the retrieved warranty policy
alternative_code	String	The alternative code of the retrieved warranty policy
life_cycle_state	String	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

Name	Type	Description
id	String	The ID of the retrieved warranty coverage reason
name	String	The Name of the retrieved warranty coverage reason
alternative_code	String	The Alternative Code of the retrieved warranty coverage reason
description	String	The 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
product	Product object	The 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
Id	String	The ID of the product
code	String	The code of product
alternative_code	String	The alternative code of product
description	String	The description of product
priority_level	Integer	The priority level of the product Available from CRM.COM R12.3.0
global_rate	Global Rate Object	The global rate of the retrieved product Available from CRM.COM R15.0.0
product_type	Product type object	The type of the product

Referred Objects Response Data

product_type object data response

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

Referred Objects Response Data

usage_detail_record_type object data response

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

Referred Objects Response Data

unit_of_measurement object response data

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

meter_reading_type object data response

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

Referred Objects Response Data

unit_of_measurement object response data

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

global rate object response data

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

Referred Objects Response Data

period object response data

Name

Type

Description

time_period_value

Number

The time period value

time_period_uot

String

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

MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS

job_requested_activity_service object response data

Name	Type	Description
id	String	The ID of the retrieved job requested activity service
activity_type	Activity Type Object	The type of the activity that will be performed in order to deliver the related job requested activity service
product	Product Object	The 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
description	String	A description of the retrieved activity type

product object response data

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

Referred Objects Response Data

product_type object data response

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

Referred Objects Response Data

usage_detail_record_type object data response

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

Referred Objects Response Data

unit_of_measurement object response data

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

meter_reading_type object data response

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

Referred Objects Response Data

unit_of_measurement object response data

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

global rate object response data

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

Referred Objects Response Data

period object response data

Name

Type

Description

time_period_value

Number

The time period value

time_period_uot

String

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

MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS

job_subscription_physical_good object response data

Name	Type	Description
id	String	The ID of the retrieved job subscription physical good
installed_item	Installed 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_item	Subscription Installed Item Object	The subscription installed item related with the retrieved job subscription physical good
swap_subscription_installed_item	Subscription 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
state	String	The state of the retrieved installed item, which can be EFFECTIVE or NOT_EFFECTIVE
state_classification	State Classification object	The state classification of the retrieved installed item, which defines the reason why the installed item was set as Not Effective Applicable only if the Installed Item was set as Not Effective through automation process Available from CRM.COM R14.0.0
product	Product object	The product of the retrieved installed item

Referred Objects Response Data

product object response data

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

Referred Objects Response Data

product_type object data response

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

Referred Objects Response Data

usage_detail_record_type object data response

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

Referred Objects Response Data

unit_of_measurement object response data

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

meter_reading_type object data response

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

Referred Objects Response Data

unit_of_measurement object response data

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

global rate object response data

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

Referred Objects Response Data

period object response data

Name

Type

Description

time_period_value

Number

The time period value

time_period_uot

String

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

MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS

state classification object response data

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

subscription_installed_item object response data

Name	Type	Description
id	String	The ID of the retrieved subscription installed item
ownership_status	String	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
enabled	Boolean	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_item	Installed item object	The installed item related with the retrieved subscription installed item
installed_item_bundle	Subscription 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
state	String	The state of the retrieved installed item, which can be EFFECTIVE or NOT_EFFECTIVE
state_classification	State Classification object	The state classification of the retrieved installed item, which defines the reason why the installed item was set as Not Effective Applicable only if the Installed Item was set as Not Effective through automation process Available from CRM.COM R14.0.0
product	Product object	The product of the retrieved installed item

Referred Objects Response Data

product object response data

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

Referred Objects Response Data

product_type object data response

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

Referred Objects Response Data

usage_detail_record_type object data response

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

Referred Objects Response Data

unit_of_measurement object response data

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

meter_reading_type object data response

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

Referred Objects Response Data

unit_of_measurement object response data

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

global rate object response data

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

Referred Objects Response Data

period object response data

Name

Type

Description

time_period_value

Number

The time period value

time_period_uot

String

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

MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS

state classification object response data

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

subscription_installed_item_bundle object response data

Name

Type

Description

id

String

The ID of the retrieved subscription installed item

ownership_status

String

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_item

Installed item object

The 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
state	String	The state of the retrieved installed item, which can be EFFECTIVE or NOT_EFFECTIVE
state_classification	State Classification object	The state classification of the retrieved installed item, which defines the reason why the installed item was set as Not Effective Applicable only if the Installed Item was set as Not Effective through automation process Available from CRM.COM R14.0.0
product	Product object	The product of the retrieved installed item

Referred Objects Response Data

product object response data

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

Referred Objects Response Data

product_type object data response

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

Referred Objects Response Data

usage_detail_record_type object data response

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

Referred Objects Response Data

unit_of_measurement object response data

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

meter_reading_type object data response

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

Referred Objects Response Data

unit_of_measurement object response data

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

global rate object response data

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

Referred Objects Response Data

period object response data

Name

Type

Description

time_period_value

Number

The time period value

time_period_uot

String

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

MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS

state classification object response data

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

job_physical_good object response data

Name	Type	Description
id	String	The ID of the retrieved physical good
quantity	Number	The quantity of the product if the job physical good is not traceable
installed_item	Installed item object	The installed item related with the retrieved job physical good, if the physical good is traceable
product	Products Object	The product related with the retrieved job physical good, if the physical good is non traceable
components_set	Set 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
state	String	The state of the retrieved installed item, which can be EFFECTIVE or NOT_EFFECTIVE
state_classification	State Classification object	The state classification of the retrieved installed item, which defines the reason why the installed item was set as Not Effective Applicable only if the Installed Item was set as Not Effective through automation process Available from CRM.COM R14.0.0
product	Product object	The product of the retrieved installed item

Referred Objects Response Data

product object response data

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

Referred Objects Response Data

product_type object data response

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

Referred Objects Response Data

usage_detail_record_type object data response

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

Referred Objects Response Data

unit_of_measurement object response data

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

meter_reading_type object data response

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

Referred Objects Response Data

unit_of_measurement object response data

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

global rate object response data

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

Referred Objects Response Data

period object response data

Name

Type

Description

time_period_value

Number

The time period value

time_period_uot

String

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

MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS

state classification object response data

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

product object response data

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

Referred Objects Response Data

product_type object data response

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

Referred Objects Response Data

usage_detail_record_type object data response

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

Referred Objects Response Data

unit_of_measurement object response data

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

meter_reading_type object data response

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

Referred Objects Response Data

unit_of_measurement object response data

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

global rate object response data

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

Referred Objects Response Data

period object response data

Name

Type

Description

time_period_value

Number

The time period value

time_period_uot

String

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

MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS

job_expense object response data

Name	Type	Description
id	String	The ID of the retrieved job expense
product	Product object	The 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
Id	String	The ID of the product
code	String	The code of product
alternative_code	String	The alternative code of product
description	String	The description of product
priority_level	Integer	The priority level of the product Available from CRM.COM R12.3.0
global_rate	Global Rate Object	The global rate of the retrieved product Available from CRM.COM R15.0.0
product_type	Product type object	The type of the product

Referred Objects Response Data

product_type object data response

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

Referred Objects Response Data

usage_detail_record_type object data response

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

Referred Objects Response Data

unit_of_measurement object response data

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

meter_reading_type object data response

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

Referred Objects Response Data

unit_of_measurement object response data

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

global rate object response data

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

Referred Objects Response Data

period object response data

Name

Type

Description

time_period_value

Number

The time period value

time_period_uot

String

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

MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS

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_information	Contact information object	The contact information owning the activity
type	Activity Type Object	The 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_name	Sting	The company name of the retrieved contact information
demographics	Demographics Object	The demographics information of the retrieved contact information
company_profile	Company profile object	The company profile of the retrieve contact information

Referred Objects Response Data

demographics object response data

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

Referred Objects Response Data

date_of_birth object response data

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

name_day object response data

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

country object response data

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

Referred Objects Response Data

country_flag object response data

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

Referred Objects Response Data

file object response data

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

industry object response data

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

industry sector object response data

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

company profile object response data

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

Referred Objects Response Data

country object response data

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

Referred Objects Response Data

country_flag object response data

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

Referred Objects Response Data

file object response data

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

industry object response data

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

industry sector object response data

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

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
description	String	A 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_date	Date	The date from which the accounts receivable is billed for
to_date	Date	The date until which the accounts receivable is billed for
due_date	Date	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_amount	Number	The total billed amount
total_amount_to_be_paid	Number	The total amount to be paid
bill_status	String	The status of the bill in terms of it is settled or not.The supported values are the following: SETTLED, UNSETTLED, PARTIALLY_SETTLED
currency	Currency 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_symbol	String	The prefix symbol for the specified currency
suffix_symbol	String	The suffix symbol for the specified currency
life_cycle_state	String	The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE Available from CRM.COM R14.0.0
integer_part_name	String	The integer part name for the specified currency
decimal_part_name	String	The decimal part name for the specified currency

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
code	String	The code of the retrieved business unit
unified_code	String	The unified code of the retrieved business unit
description	String	The description of the retrieved business unit
parent_business_unit_name	String	The 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: GET

Request:

Response:

{
    "data": [
        {
            "notes": null,
            "contact_phone": null,
            "log_information": {
                "created_by_unit": {
                    "alternative_code": "adminunit",
                    "group_name": "Main Group",
                    "community_name": "Community",
                    "name": "Admin Unit",
                    "description": "admin unit",
                    "id": "1"
                },
                "updated_by_unit": {
                    "alternative_code": "adminunit",
                    "group_name": "Main Group",
                    "community_name": "Community",
                    "name": "Admin Unit",
                    "description": "admin unit",
                    "id": "1"
                },
                "created_date": "2016-06-23T07:08:20",
                "updated_date": "2016-08-01T06:05:05",
                "updated_by_user": {
                    "person_name": "CRM COM",
                    "id": "1",
                    "email": "dev@crm.com",
                    "username": "MPAdministrator"
                },
                "created_by_user": {
                    "person_name": "CRM COM",
                    "id": "1",
                    "email": "dev@crm.com",
                    "username": "MPAdministrator"
                }
            },
            "requested_physical_goods_set": [
                {
                    "product": {
                        "code": "Smartcard",
                        "product_type": {
                            "service_type": null,
                            "used_for_provisioning": true,
                            "alternative_code": "S",
                            "udr_type": null,
                            "composition_method": "FLAT",
                            "name": "SMARTCARD",
                            "description": "SMARTCARD",
                            "id": "D6BE0209EC0149989A89972CE889DF8B",
                            "classification": "PHYSICALGOODS",
                            "physical_good_type": "TRACEABLE"
                        },
                        "alternative_code": "S",
                        "description": "Smartcard",
                        "id": "4F656ED5DAC44168B0805227881202CD",
                        "priority_level": null
                    },
                    "quantity": 1,
                    "notes": null,
                    "id": "2FDC571C150A41DE8C0E107DB11FF7C1"
                }
            ],
            "expiration_date": null,
            "type": {
                "billing_method": null,
                "alternative_code": "SWII",
                "name": "Swap Installed Items",
                "fulfillment_scope": "SWAP_SUB_INSTALLED_ITEMS",
                "description": null,
                "fulfillment_method": "BASED_ON_ORDERED_ITEMS",
                "id": "7E22FEE5CEC74A47B0D88CF99F3360BC",
                "billing_directive": "BILLABLE"
            },
            "number": "J00000309",
            "bills_set": null,
            "id": "B42AD293A94A4BFFA646BE917DF9C320",
            "actual_completed_date": null,
            "requested_expenses_set": [],
            "udf_string_2": null,
            "udf_string_3": null,
            "udf_string_4": null,
            "udf_string_5": null,
            "privacy_level": null,
            "requested_subscription_physical_goods_set": [
                {
                    "product": {
                        "code": "Set-top-box",
                        "product_type": {
                            "service_type": null,
                            "used_for_provisioning": true,
                            "alternative_code": "STB",
                            "udr_type": null,
                            "composition_method": "FLAT",
                            "name": "SET TOP BOX",
                            "description": "SET TOP BOX",
                            "id": "E8BA9A6F34A24019A89892D5B3ACD9DF",
                            "classification": "PHYSICALGOODS",
                            "physical_good_type": "TRACEABLE"
                        },
                        "alternative_code": "STB",
                        "description": "Set-top-box",
                        "id": "D613415339C14975B28BB4FC11598E93",
                        "priority_level": null
                    },
                    "installed_item": {
                        "product": {
                            "code": "Set-top-box",
                            "product_type": {
                                "service_type": null,
                                "used_for_provisioning": true,
                                "alternative_code": "STB",
                                "udr_type": null,
                                "composition_method": "FLAT",
                                "name": "SET TOP BOX",
                                "description": "SET TOP BOX",
                                "id": "E8BA9A6F34A24019A89892D5B3ACD9DF",
                                "classification": "PHYSICALGOODS",
                                "physical_good_type": "TRACEABLE"
                            },
                            "alternative_code": "STB",
                            "description": "Set-top-box",
                            "id": "D613415339C14975B28BB4FC11598E93",
                            "priority_level": null
                        },
                        "alternative_code": "stbx1000007",
                        "serial_number": "stbx1000007",
                        "id": "6A97CBE152BE49F09DE69CF6DB29A901",
                        "state": "EFFECTIVE"
                    },
                    "quantity": 1,
                    "notes": null,
                    "provisioning_distributor": null,
                    "id": "CBCE254E2834415084BD0CF519F58DFA",
                    "swap_installed_item": null
                }
            ],
            "udf_string_1": "1",
            "life_cycle_state": "IN_PROGRESS",
            "activities_set": [
                {
                    "number": "456",
                    "contact_information": {
                        "company_profile": null,
                        "company_name": null,
                        "name": "Marios Michael",
                        "last_name": "Michael",
                        "id": "32289B42B1BF42DDA49099FF2AFEC416",
                        "life_cycle_state": "FINANCIAL",
                        "middle_name": null,
                        "title": "456",
                        "type": "PERSON",
                        "first_name": "Marios",
                        "demographics": {
                            "name_day": {
                                "month": 11,
                                "day": 21
                            },
                            "id_number": null,
                            "gender": null,
                            "country_of_residence": {
                                "alternative_code": "CYP",
                                "three_character_code": "CYP",
                                "name": "CYPRUS",
                                "id": "181",
                                "two_character_code": "CY"
                            },
                            "date_of_birth": {
                                "month": null,
                                "year": null,
                                "day": null
                            },
                            "industry_sector": null,
                            "passport_number": null,
                            "industry": null,
                            "social_security_number": null,
                            "id_issued_by_country": null,
                            "passport_issued_by_country": null
                        }
                    },
                    "id": "0434BA7715C24F4AA55387755BCB0F2A",
                    "life_cycle_state": "PENDING",
                    "type": {
                        "alternative_code": "GENR",
                        "name": "General Repairs",
                        "description": null,
                        "id": "9C6A44C9BBB640D4937BBAEE01FAC484"
                    }
                }
            ],
            "physical_goods_set": [
                {
                    "installed_item": null,
                    "product": {
                        "code": "Smartcard",
                        "product_type": {
                            "service_type": null,
                            "used_for_provisioning": true,
                            "alternative_code": "S",
                            "udr_type": null,
                            "composition_method": "FLAT",
                            "name": "SMARTCARD",
                            "description": "SMARTCARD",
                            "id": "D6BE0209EC0149989A89972CE889DF8B",
                            "classification": "PHYSICALGOODS",
                            "physical_good_type": "TRACEABLE"
                        },
                        "alternative_code": "S",
                        "description": "Smartcard",
                        "id": "4F656ED5DAC44168B0805227881202CD",
                        "priority_level": null
                    },
                    "quantity": 1,
                    "id": "3054742BF92F9921614C4058F1561BB5"
                }
            ],
            "time_overdue": {
                "time_period_uot": "YEARS",
                "time_period_value": 1.2404371584699454
            },
            "udf_string_6": null,
            "udf_string_7": null,
            "udf_string_8": null,
            "status": {
                "alternative_code": "2",
                "name": "Approved",
                "description": null,
                "id": "7A98FA9566534F1C82227985EA48F617",
                "life_cycle_state": "IN_PROGRESS"
            },
            "owned_by_group": {
                "alternative_code": "MG",
                "community_name": "Community",
                "name": "Main Group",
                "description": "Main Group",
                "id": "1"
            },
            "description": null,
            "rating_state": "PENDING",
            "expenses_set": [],
            "subscription": {
                "number": "S0000000113",
                "first_activated_date": "2016-03-23T10:34:59",
                "rating_state": "PENDING",
                "accounts_receivable": {
                    "number": "ACR0000000120",
                    "name": "ACR0000000120 Marios Michael",
                    "id": "D9862FB706734931B97EE50877217674",
                    "life_cycle_state": "ACTIVE",
                    "account_owner": {
                        "company_profile": null,
                        "company_name": null,
                        "name": "Marios Michael",
                        "last_name": "Michael",
                        "id": "32289B42B1BF42DDA49099FF2AFEC416",
                        "life_cycle_state": "FINANCIAL",
                        "middle_name": null,
                        "title": "456",
                        "type": "PERSON",
                        "first_name": "Marios",
                        "demographics": {
                            "name_day": {
                                "month": 11,
                                "day": 21
                            },
                            "id_number": null,
                            "gender": null,
                            "country_of_residence": {
                                "alternative_code": "CYP",
                                "three_character_code": "CYP",
                                "name": "CYPRUS",
                                "id": "181",
                                "two_character_code": "CY"
                            },
                            "date_of_birth": {
                                "month": null,
                                "year": null,
                                "day": null
                            },
                            "industry_sector": null,
                            "passport_number": null,
                            "industry": null,
                            "social_security_number": null,
                            "id_issued_by_country": null,
                            "passport_issued_by_country": null
                        }
                    }
                },
                "id": "2C3D12492DAD4E0D85957913B76250AD",
                "life_cycle_state": "NOT_EFFECTIVE",
                "type": {
                    "alternative_code": "normalsub",
                    "name": "Normal",
                    "description": null,
                    "id": "D1BAE6454A2248189EBCD7ADD3B4B65F"
                }
            },
            "udf_date_2": null,
            "udf_date_1": null,
            "udf_date_4": null,
            "contact_email": null,
            "udf_date_3": null,
            "udf_float_3": null,
            "udf_float_4": null,
            "estimated_completion_time": {
                "time_period_uot": "HOURS",
                "time_period_value": 2
            },
            "service_request": null,
            "udf_float_1": null,
            "billing_terms": {
                "billing_frequency": null,
                "billing_term_scheme": {
                    "code": "Jobs Scheme Concurrent",
                    "name": "Jobs Scheme Concurrent",
                    "billing_type": "NORMAL",
                    "id": "96816A52A4FA4F00881BCD4D236272A3",
                    "life_cycle_state": "EFFECTIVE",
                    "classification": "JOBS"
                },
                "allowed_cancel_date": null,
                "billing_cycle_day": null,
                "agreement_date": "2016-06-23T00:00:00",
                "effective_date": "2016-06-23T00:00:00",
                "price_plan": {
                    "code": "PPA",
                    "name": "PPA",
                    "effective_date": "2016-01-01T02:00:00",
                    "description": null,
                    "id": "C617235767C840318780DFFA47711AF2",
                    "type": "BASE",
                    "expiration_date": null
                },
                "id": "007FF3BCFFC84FA591B8C4BD3B2DBC24",
                "expiration_date": null,
                "binding_information": null
            },
            "udf_float_2": null,
            "start_date": "2016-06-23T07:08:20",
            "assigned_to": {
                "unit": {
                    "alternative_code": "adminunit",
                    "group_name": "Main Group",
                    "community_name": "Community",
                    "name": "Admin Unit",
                    "description": "admin unit",
                    "id": "1"
                },
                "user": {
                    "person_name": "CRM COM",
                    "id": "1",
                    "email": "dev@crm.com",
                    "username": "MPAdministrator"
                }
            },
            "subscription_physical_goods_set": [
                {
                    "installed_item": {
                        "product": {
                            "code": "Smartcard",
                            "product_type": {
                                "service_type": null,
                                "used_for_provisioning": true,
                                "alternative_code": "S",
                                "udr_type": null,
                                "composition_method": "FLAT",
                                "name": "SMARTCARD",
                                "description": "SMARTCARD",
                                "id": "D6BE0209EC0149989A89972CE889DF8B",
                                "classification": "PHYSICALGOODS",
                                "physical_good_type": "TRACEABLE"
                            },
                            "alternative_code": "S",
                            "description": "Smartcard",
                            "id": "4F656ED5DAC44168B0805227881202CD",
                            "priority_level": null
                        },
                        "alternative_code": "S000004",
                        "serial_number": "S000004",
                        "id": "6022764CF4FD47FAB2C8032498202C36",
                        "state": "EFFECTIVE"
                    },
                    "installed_item_bundle": null,
                    "id": "ACF84945A4614261BA8EFA73EA5AE081",
                    "ownership_status": "RENTED_TO_CUSTOMER"
                }
            ],
            "accounts_receivable": {
                "number": "ACR0000000120",
                "name": "ACR0000000120 Marios Michael",
                "id": "D9862FB706734931B97EE50877217674",
                "life_cycle_state": "ACTIVE",
                "account_owner": {
                    "company_profile": null,
                    "company_name": null,
                    "name": "Marios Michael",
                    "last_name": "Michael",
                    "id": "32289B42B1BF42DDA49099FF2AFEC416",
                    "life_cycle_state": "FINANCIAL",
                    "middle_name": null,
                    "title": "456",
                    "type": "PERSON",
                    "first_name": "Marios",
                    "demographics": {
                        "name_day": {
                            "month": 11,
                            "day": 21
                        },
                        "id_number": null,
                        "gender": null,
                        "country_of_residence": {
                            "alternative_code": "CYP",
                            "three_character_code": "CYP",
                            "name": "CYPRUS",
                            "id": "181",
                            "two_character_code": "CY"
                        },
                        "date_of_birth": {
                            "month": null,
                            "year": null,
                            "day": null
                        },
                        "industry_sector": null,
                        "passport_number": null,
                        "industry": null,
                        "social_security_number": null,
                        "id_issued_by_country": null,
                        "passport_issued_by_country": null
                    }
                }
            },
            "time_to_completion": {
                "time_period_uot": null,
                "time_period_value": null
            },
            "requested_activity_services_set": [
                {
                    "product": {
                        "code": "Repair 1",
                        "product_type": {
                            "service_type": "ONETIME",
                            "used_for_provisioning": false,
                            "alternative_code": "I",
                            "udr_type": null,
                            "composition_method": "FLAT",
                            "name": "Services",
                            "description": null,
                            "id": "7A2F73F07F944CBAB8C5ACDA1A7879B4",
                            "classification": "SERVICES",
                            "physical_good_type": null
                        },
                        "alternative_code": "Repair 1",
                        "description": "Repair 1",
                        "id": "444743B358184FE598E8B3AE19E052A4",
                        "priority_level": 3
                    },
                    "activity_type": {
                        "alternative_code": "GENR",
                        "name": "General Repairs",
                        "description": null,
                        "id": "9C6A44C9BBB640D4937BBAEE01FAC484"
                    },
                    "id": "7D6F8F4B5B8E4F5D96AA129C84EC645F"
                }
            ],
            "location": {
                "apartment_number": null,
                "care_of": null,
                "country": {
                    "alternative_code": "CYP",
                    "three_character_code": "CYP",
                    "name": "CYPRUS",
                    "id": "181",
                    "two_character_code": "CY"
                },
                "municipality": null,
                "type": "BUSINESS",
                "udf_date_2": null,
                "udf_date_1": null,
                "street_name": "Test",
                "udf_date_4": null,
                "udf_date_3": null,
                "udf_float_3": null,
                "udf_float_4": null,
                "po_box_postal_code": null,
                "udf_string_15": null,
                "udf_string_16": null,
                "udf_string_13": null,
                "udf_string_14": null,
                "udf_string_11": null,
                "udf_string_12": null,
                "id": "D69E0F1D3E3F4A078B53C389315EEB5D",
                "state": "Active",
                "udf_string_10": null,
                "floor": null,
                "udf_float_1": null,
                "udf_float_2": null,
                "area": null,
                "udf_string_2": null,
                "udf_string_3": null,
                "udf_string_4": null,
                "udf_string_5": null,
                "udf_string_1": null,
                "po_box": null,
                "town_city": null,
                "district": null,
                "street_number": "15",
                "postal_code": "3",
                "udf_string_6": null,
                "udf_string_7": null,
                "udf_string_8": null,
                "udf_string_9": null
            },
            "category": null,
            "expected_completion_date": "2016-06-23T09:08:20"
        },
        {
            "notes": null,
            "contact_phone": null,
            "log_information": {
                "created_by_unit": {
                    "alternative_code": "adminunit",
                    "group_name": "Main Group",
                    "community_name": "Community",
                    "name": "Admin Unit",
                    "description": "admin unit",
                    "id": "1"
                },
                "updated_by_unit": {
                    "alternative_code": "adminunit",
                    "group_name": "Main Group",
                    "community_name": "Community",
                    "name": "Admin Unit",
                    "description": "admin unit",
                    "id": "1"
                },
                "created_date": "2016-07-04T12:05:23",
                "updated_date": "2016-07-04T12:19:08",
                "updated_by_user": {
                    "person_name": "CRM COM",
                    "id": "1",
                    "email": "dev@crm.com",
                    "username": "MPAdministrator"
                },
                "created_by_user": {
                    "person_name": "CRM COM",
                    "id": "1",
                    "email": "dev@crm.com",
                    "username": "MPAdministrator"
                }
            },
            "requested_physical_goods_set": [
                {
                    "product": {
                        "code": "Antenna",
                        "product_type": {
                            "service_type": null,
                            "used_for_provisioning": false,
                            "alternative_code": "001",
                            "udr_type": null,
                            "composition_method": "FLAT",
                            "name": "Equipment",
                            "description": null,
                            "id": "EQ",
                            "classification": "PHYSICALGOODS",
                            "physical_good_type": "NONTRACEABLE"
                        },
                        "alternative_code": "A",
                        "description": "Antenna",
                        "id": "872C558604704AA29D8512A70B608573",
                        "priority_level": null
                    },
                    "quantity": 1,
                    "notes": null,
                    "id": "26FB8F955F1B4B3A9BF927C0EBEBC50E"
                }
            ],
            "expiration_date": null,
            "type": {
                "billing_method": null,
                "alternative_code": "SSII",
                "name": "Swap Subscription Inst Item",
                "fulfillment_scope": "SWAP_SUB_INSTALLED_ITEMS",
                "description": null,
                "fulfillment_method": "BASED_ON_DELIVERED_ITEMS",
                "id": "C24FBDF4B89543829701EB5BA5046936",
                "billing_directive": "BILLABLE"
            },
            "number": "J00000314",
            "bills_set": null,
            "id": "856C78718596468088912413BE3A7163",
            "actual_completed_date": null,
            "requested_expenses_set": [
                {
                    "product": {
                        "code": "Expense 2",
                        "product_type": {
                            "service_type": "EXPENSE",
                            "used_for_provisioning": false,
                            "alternative_code": "006",
                            "udr_type": null,
                            "composition_method": "FLAT",
                            "name": "Fees",
                            "description": "Fees One Time Services",
                            "id": "6",
                            "classification": "SERVICES",
                            "physical_good_type": null
                        },
                        "alternative_code": "E2",
                        "description": "Expense 2",
                        "id": "1CEB8D2B86134B138469F8F3E12EB792",
                        "priority_level": null
                    },
                    "id": "1DE31BB68A764492A671156D1FFC35F9"
                }
            ],
            "udf_string_2": null,
            "udf_string_3": null,
            "udf_string_4": null,
            "udf_string_5": null,
            "privacy_level": null,
            "requested_subscription_physical_goods_set": [
                {
                    "product": {
                        "code": "Set-top-box",
                        "product_type": {
                            "service_type": null,
                            "used_for_provisioning": true,
                            "alternative_code": "STB",
                            "udr_type": null,
                            "composition_method": "FLAT",
                            "name": "SET TOP BOX",
                            "description": "SET TOP BOX",
                            "id": "E8BA9A6F34A24019A89892D5B3ACD9DF",
                            "classification": "PHYSICALGOODS",
                            "physical_good_type": "TRACEABLE"
                        },
                        "alternative_code": "STB",
                        "description": "Set-top-box",
                        "id": "D613415339C14975B28BB4FC11598E93",
                        "priority_level": null
                    },
                    "installed_item": {
                        "product": {
                            "code": "Set-top-box",
                            "product_type": {
                                "service_type": null,
                                "used_for_provisioning": true,
                                "alternative_code": "STB",
                                "udr_type": null,
                                "composition_method": "FLAT",
                                "name": "SET TOP BOX",
                                "description": "SET TOP BOX",
                                "id": "E8BA9A6F34A24019A89892D5B3ACD9DF",
                                "classification": "PHYSICALGOODS",
                                "physical_good_type": "TRACEABLE"
                            },
                            "alternative_code": "STB",
                            "description": "Set-top-box",
                            "id": "D613415339C14975B28BB4FC11598E93",
                            "priority_level": null
                        },
                        "alternative_code": "stbx1000007",
                        "serial_number": "stbx1000007",
                        "id": "6A97CBE152BE49F09DE69CF6DB29A901",
                        "state": "EFFECTIVE"
                    },
                    "quantity": 1,
                    "notes": null,
                    "provisioning_distributor": null,
                    "id": "E6BDFD82D5214B999528CC354D099B1E",
                    "swap_installed_item": null
                },
                {
                    "product": {
                        "code": "Set-top-box",
                        "product_type": {
                            "service_type": null,
                            "used_for_provisioning": true,
                            "alternative_code": "STB",
                            "udr_type": null,
                            "composition_method": "FLAT",
                            "name": "SET TOP BOX",
                            "description": "SET TOP BOX",
                            "id": "E8BA9A6F34A24019A89892D5B3ACD9DF",
                            "classification": "PHYSICALGOODS",
                            "physical_good_type": "TRACEABLE"
                        },
                        "alternative_code": "STB",
                        "description": "Set-top-box",
                        "id": "D613415339C14975B28BB4FC11598E93",
                        "priority_level": null
                    },
                    "installed_item": {
                        "product": {
                            "code": "Set-top-box",
                            "product_type": {
                                "service_type": null,
                                "used_for_provisioning": true,
                                "alternative_code": "STB",
                                "udr_type": null,
                                "composition_method": "FLAT",
                                "name": "SET TOP BOX",
                                "description": "SET TOP BOX",
                                "id": "E8BA9A6F34A24019A89892D5B3ACD9DF",
                                "classification": "PHYSICALGOODS",
                                "physical_good_type": "TRACEABLE"
                            },
                            "alternative_code": "STB",
                            "description": "Set-top-box",
                            "id": "D613415339C14975B28BB4FC11598E93",
                            "priority_level": null
                        },
                        "alternative_code": "stbx1000008",
                        "serial_number": "stbx1000008",
                        "id": "F5915A5B64ED4EE09AB7A2289FEF629F",
                        "state": "EFFECTIVE"
                    },
                    "quantity": 1,
                    "notes": null,
                    "provisioning_distributor": null,
                    "id": "1A52DD2FAE0745E2BEE8AE07778F8834",
                    "swap_installed_item": null
                }
            ],
            "udf_string_1": "1",
            "life_cycle_state": "IN_PROGRESS",
            "activities_set": [],
            "physical_goods_set": [
                {
                    "installed_item": null,
                    "product": {
                        "code": "Antenna",
                        "product_type": {
                            "service_type": null,
                            "used_for_provisioning": false,
                            "alternative_code": "001",
                            "udr_type": null,
                            "composition_method": "FLAT",
                            "name": "Equipment",
                            "description": null,
                            "id": "EQ",
                            "classification": "PHYSICALGOODS",
                            "physical_good_type": "NONTRACEABLE"
                        },
                        "alternative_code": "A",
                        "description": "Antenna",
                        "id": "872C558604704AA29D8512A70B608573",
                        "priority_level": null
                    },
                    "quantity": 1,
                    "id": "415CB2B1CD95D8FB488694FB6866ABA3"
                }
            ],
            "time_overdue": {
                "time_period_uot": "YEARS",
                "time_period_value": 1.210382513661202
            },
            "udf_string_6": null,
            "udf_string_7": null,
            "udf_string_8": null,
            "status": {
                "alternative_code": "2",
                "name": "Approved",
                "description": null,
                "id": "7A98FA9566534F1C82227985EA48F617",
                "life_cycle_state": "IN_PROGRESS"
            },
            "owned_by_group": {
                "alternative_code": "MG",
                "community_name": "Community",
                "name": "Main Group",
                "description": "Main Group",
                "id": "1"
            },
            "description": null,
            "rating_state": "PENDING",
            "expenses_set": [
                {
                    "product": {
                        "code": "Expense 2",
                        "product_type": {
                            "service_type": "EXPENSE",
                            "used_for_provisioning": false,
                            "alternative_code": "006",
                            "udr_type": null,
                            "composition_method": "FLAT",
                            "name": "Fees",
                            "description": "Fees One Time Services",
                            "id": "6",
                            "classification": "SERVICES",
                            "physical_good_type": null
                        },
                        "alternative_code": "E2",
                        "description": "Expense 2",
                        "id": "1CEB8D2B86134B138469F8F3E12EB792",
                        "priority_level": null
                    },
                    "id": "2DABF95A8A7048E18514DE0CEEE7D90D"
                }
            ],
            "subscription": {
                "number": "S0000000113",
                "first_activated_date": "2016-03-23T10:34:59",
                "rating_state": "PENDING",
                "accounts_receivable": {
                    "number": "ACR0000000120",
                    "name": "ACR0000000120 Marios Michael",
                    "id": "D9862FB706734931B97EE50877217674",
                    "life_cycle_state": "ACTIVE",
                    "account_owner": {
                        "company_profile": null,
                        "company_name": null,
                        "name": "Marios Michael",
                        "last_name": "Michael",
                        "id": "32289B42B1BF42DDA49099FF2AFEC416",
                        "life_cycle_state": "FINANCIAL",
                        "middle_name": null,
                        "title": "456",
                        "type": "PERSON",
                        "first_name": "Marios",
                        "demographics": {
                            "name_day": {
                                "month": 11,
                                "day": 21
                            },
                            "id_number": null,
                            "gender": null,
                            "country_of_residence": {
                                "alternative_code": "CYP",
                                "three_character_code": "CYP",
                                "name": "CYPRUS",
                                "id": "181",
                                "two_character_code": "CY"
                            },
                            "date_of_birth": {
                                "month": null,
                                "year": null,
                                "day": null
                            },
                            "industry_sector": null,
                            "passport_number": null,
                            "industry": null,
                            "social_security_number": null,
                            "id_issued_by_country": null,
                            "passport_issued_by_country": null
                        }
                    }
                },
                "id": "2C3D12492DAD4E0D85957913B76250AD",
                "life_cycle_state": "NOT_EFFECTIVE",
                "type": {
                    "alternative_code": "normalsub",
                    "name": "Normal",
                    "description": null,
                    "id": "D1BAE6454A2248189EBCD7ADD3B4B65F"
                }
            },
            "udf_date_2": null,
            "udf_date_1": null,
            "udf_date_4": null,
            "contact_email": null,
            "udf_date_3": null,
            "udf_float_3": null,
            "udf_float_4": null,
            "estimated_completion_time": {
                "time_period_uot": "HOURS",
                "time_period_value": 1
            },
            "service_request": null,
            "udf_float_1": null,
            "billing_terms": {
                "billing_frequency": null,
                "billing_term_scheme": {
                    "code": "PJBTS",
                    "name": "P Job Billing Term Scheme",
                    "billing_type": "NORMAL",
                    "id": "4DA32AA285FD43CE85256B970277E638",
                    "life_cycle_state": "EFFECTIVE",
                    "classification": "JOBS"
                },
                "allowed_cancel_date": null,
                "billing_cycle_day": null,
                "agreement_date": "2016-07-04T00:00:00",
                "effective_date": "2016-07-04T00:00:00",
                "price_plan": {
                    "code": "MPP",
                    "name": "Main Price Plan",
                    "effective_date": "2016-06-14T00:00:00",
                    "description": "Main Price Plan",
                    "id": "85ACEEF700A048A58F9C5581142719A8",
                    "type": "BASE",
                    "expiration_date": "2016-07-21T00:00:00"
                },
                "id": "96592BDEAD614E269285C1FF4F3AD5CA",
                "expiration_date": null,
                "binding_information": null
            },
            "udf_float_2": null,
            "start_date": "2016-07-04T12:05:23",
            "assigned_to": {
                "unit": {
                    "alternative_code": "adminunit",
                    "group_name": "Main Group",
                    "community_name": "Community",
                    "name": "Admin Unit",
                    "description": "admin unit",
                    "id": "1"
                },
                "user": {
                    "person_name": "CRM COM",
                    "id": "1",
                    "email": "dev@crm.com",
                    "username": "MPAdministrator"
                }
            },
            "subscription_physical_goods_set": [
                {
                    "installed_item": {
                        "product": {
                            "code": "Smartcard",
                            "product_type": {
                                "service_type": null,
                                "used_for_provisioning": true,
                                "alternative_code": "S",
                                "udr_type": null,
                                "composition_method": "FLAT",
                                "name": "SMARTCARD",
                                "description": "SMARTCARD",
                                "id": "D6BE0209EC0149989A89972CE889DF8B",
                                "classification": "PHYSICALGOODS",
                                "physical_good_type": "TRACEABLE"
                            },
                            "alternative_code": "S",
                            "description": "Smartcard",
                            "id": "4F656ED5DAC44168B0805227881202CD",
                            "priority_level": null
                        },
                        "alternative_code": "S000004",
                        "serial_number": "S000004",
                        "id": "6022764CF4FD47FAB2C8032498202C36",
                        "state": "EFFECTIVE"
                    },
                    "installed_item_bundle": null,
                    "id": "ACF84945A4614261BA8EFA73EA5AE081",
                    "ownership_status": "RENTED_TO_CUSTOMER"
                }
            ],
            "accounts_receivable": {
                "number": "ACR0000000120",
                "name": "ACR0000000120 Marios Michael",
                "id": "D9862FB706734931B97EE50877217674",
                "life_cycle_state": "ACTIVE",
                "account_owner": {
                    "company_profile": null,
                    "company_name": null,
                    "name": "Marios Michael",
                    "last_name": "Michael",
                    "id": "32289B42B1BF42DDA49099FF2AFEC416",
                    "life_cycle_state": "FINANCIAL",
                    "middle_name": null,
                    "title": "456",
                    "type": "PERSON",
                    "first_name": "Marios",
                    "demographics": {
                        "name_day": {
                            "month": 11,
                            "day": 21
                        },
                        "id_number": null,
                        "gender": null,
                        "country_of_residence": {
                            "alternative_code": "CYP",
                            "three_character_code": "CYP",
                            "name": "CYPRUS",
                            "id": "181",
                            "two_character_code": "CY"
                        },
                        "date_of_birth": {
                            "month": null,
                            "year": null,
                            "day": null
                        },
                        "industry_sector": null,
                        "passport_number": null,
                        "industry": null,
                        "social_security_number": null,
                        "id_issued_by_country": null,
                        "passport_issued_by_country": null
                    }
                }
            },
            "time_to_completion": {
                "time_period_uot": null,
                "time_period_value": null
            },
            "requested_activity_services_set": [],
            "location": {
                "apartment_number": null,
                "care_of": null,
                "country": {
                    "alternative_code": "CYP",
                    "three_character_code": "CYP",
                    "name": "CYPRUS",
                    "id": "181",
                    "two_character_code": "CY"
                },
                "municipality": null,
                "type": "BUSINESS",
                "udf_date_2": null,
                "udf_date_1": null,
                "street_name": "Test",
                "udf_date_4": null,
                "udf_date_3": null,
                "udf_float_3": null,
                "udf_float_4": null,
                "po_box_postal_code": null,
                "udf_string_15": null,
                "udf_string_16": null,
                "udf_string_13": null,
                "udf_string_14": null,
                "udf_string_11": null,
                "udf_string_12": null,
                "id": "D69E0F1D3E3F4A078B53C389315EEB5D",
                "state": "Active",
                "udf_string_10": null,
                "floor": null,
                "udf_float_1": null,
                "udf_float_2": null,
                "area": null,
                "udf_string_2": null,
                "udf_string_3": null,
                "udf_string_4": null,
                "udf_string_5": null,
                "udf_string_1": null,
                "po_box": null,
                "town_city": null,
                "district": null,
                "street_number": "15",
                "postal_code": "3",
                "udf_string_6": null,
                "udf_string_7": null,
                "udf_string_8": null,
                "udf_string_9": null
            },
            "category": null,
            "expected_completion_date": "2016-07-04T13:05:23"
        },
        {
            "notes": null,
            "contact_phone": null,
            "log_information": {
                "created_by_unit": {
                    "alternative_code": "adminunit",
                    "group_name": "Main Group",
                    "community_name": "Community",
                    "name": "Admin Unit",
                    "description": "admin unit",
                    "id": "1"
                },
                "updated_by_unit": {
                    "alternative_code": "adminunit",
                    "group_name": "Main Group",
                    "community_name": "Community",
                    "name": "Admin Unit",
                    "description": "admin unit",
                    "id": "1"
                },
                "created_date": "2016-07-04T10:51:23",
                "updated_date": "2016-07-04T12:05:07",
                "updated_by_user": {
                    "person_name": "CRM COM",
                    "id": "1",
                    "email": "dev@crm.com",
                    "username": "MPAdministrator"
                },
                "created_by_user": {
                    "person_name": "CRM COM",
                    "id": "1",
                    "email": "dev@crm.com",
                    "username": "MPAdministrator"
                }
            },
            "requested_physical_goods_set": [
                {
                    "product": {
                        "code": "Antenna",
                        "product_type": {
                            "service_type": null,
                            "used_for_provisioning": false,
                            "alternative_code": "001",
                            "udr_type": null,
                            "composition_method": "FLAT",
                            "name": "Equipment",
                            "description": null,
                            "id": "EQ",
                            "classification": "PHYSICALGOODS",
                            "physical_good_type": "NONTRACEABLE"
                        },
                        "alternative_code": "A",
                        "description": "Antenna",
                        "id": "872C558604704AA29D8512A70B608573",
                        "priority_level": null
                    },
                    "quantity": 1,
                    "notes": null,
                    "id": "8081D1AD6D314CEA8BA29E76A706AE12"
                }
            ],
            "expiration_date": null,
            "type": {
                "billing_method": null,
                "alternative_code": "SSII",
                "name": "Swap Subscription Inst Item",
                "fulfillment_scope": "SWAP_SUB_INSTALLED_ITEMS",
                "description": null,
                "fulfillment_method": "BASED_ON_DELIVERED_ITEMS",
                "id": "C24FBDF4B89543829701EB5BA5046936",
                "billing_directive": "BILLABLE"
            },
            "number": "J00000313",
            "bills_set": null,
            "id": "D999E815B92D4A5F88998E66A7D24E7C",
            "actual_completed_date": null,
            "requested_expenses_set": [
                {
                    "product": {
                        "code": "Expense 1",
                        "product_type": {
                            "service_type": "EXPENSE",
                            "used_for_provisioning": false,
                            "alternative_code": "006",
                            "udr_type": null,
                            "composition_method": "FLAT",
                            "name": "Fees",
                            "description": "Fees One Time Services",
                            "id": "6",
                            "classification": "SERVICES",
                            "physical_good_type": null
                        },
                        "alternative_code": "E1",
                        "description": "Expense 1",
                        "id": "A9917A7895044BEF9499DD6958539D33",
                        "priority_level": null
                    },
                    "id": "526A296D623D47C9818E5187ECDE1C70"
                }
            ],
            "udf_string_2": null,
            "udf_string_3": null,
            "udf_string_4": null,
            "udf_string_5": null,
            "privacy_level": null,
            "requested_subscription_physical_goods_set": [
                {
                    "product": {
                        "code": "Set-top-box",
                        "product_type": {
                            "service_type": null,
                            "used_for_provisioning": true,
                            "alternative_code": "STB",
                            "udr_type": null,
                            "composition_method": "FLAT",
                            "name": "SET TOP BOX",
                            "description": "SET TOP BOX",
                            "id": "E8BA9A6F34A24019A89892D5B3ACD9DF",
                            "classification": "PHYSICALGOODS",
                            "physical_good_type": "TRACEABLE"
                        },
                        "alternative_code": "STB",
                        "description": "Set-top-box",
                        "id": "D613415339C14975B28BB4FC11598E93",
                        "priority_level": null
                    },
                    "installed_item": {
                        "product": {
                            "code": "Set-top-box",
                            "product_type": {
                                "service_type": null,
                                "used_for_provisioning": true,
                                "alternative_code": "STB",
                                "udr_type": null,
                                "composition_method": "FLAT",
                                "name": "SET TOP BOX",
                                "description": "SET TOP BOX",
                                "id": "E8BA9A6F34A24019A89892D5B3ACD9DF",
                                "classification": "PHYSICALGOODS",
                                "physical_good_type": "TRACEABLE"
                            },
                            "alternative_code": "STB",
                            "description": "Set-top-box",
                            "id": "D613415339C14975B28BB4FC11598E93",
                            "priority_level": null
                        },
                        "alternative_code": "stbx1000008",
                        "serial_number": "stbx1000008",
                        "id": "F5915A5B64ED4EE09AB7A2289FEF629F",
                        "state": "EFFECTIVE"
                    },
                    "quantity": 1,
                    "notes": null,
                    "provisioning_distributor": null,
                    "id": "75DE5FC632F5432FBB90AE2B75ECC093",
                    "swap_installed_item": null
                },
                {
                    "product": {
                        "code": "Set-top-box",
                        "product_type": {
                            "service_type": null,
                            "used_for_provisioning": true,
                            "alternative_code": "STB",
                            "udr_type": null,
                            "composition_method": "FLAT",
                            "name": "SET TOP BOX",
                            "description": "SET TOP BOX",
                            "id": "E8BA9A6F34A24019A89892D5B3ACD9DF",
                            "classification": "PHYSICALGOODS",
                            "physical_good_type": "TRACEABLE"
                        },
                        "alternative_code": "STB",
                        "description": "Set-top-box",
                        "id": "D613415339C14975B28BB4FC11598E93",
                        "priority_level": null
                    },
                    "installed_item": {
                        "product": {
                            "code": "Set-top-box",
                            "product_type": {
                                "service_type": null,
                                "used_for_provisioning": true,
                                "alternative_code": "STB",
                                "udr_type": null,
                                "composition_method": "FLAT",
                                "name": "SET TOP BOX",
                                "description": "SET TOP BOX",
                                "id": "E8BA9A6F34A24019A89892D5B3ACD9DF",
                                "classification": "PHYSICALGOODS",
                                "physical_good_type": "TRACEABLE"
                            },
                            "alternative_code": "STB",
                            "description": "Set-top-box",
                            "id": "D613415339C14975B28BB4FC11598E93",
                            "priority_level": null
                        },
                        "alternative_code": "stbx1000007",
                        "serial_number": "stbx1000007",
                        "id": "6A97CBE152BE49F09DE69CF6DB29A901",
                        "state": "EFFECTIVE"
                    },
                    "quantity": 1,
                    "notes": null,
                    "provisioning_distributor": null,
                    "id": "05C26B576C3C4AB1B9CD224426D5A73F",
                    "swap_installed_item": null
                }
            ],
            "udf_string_1": "1",
            "life_cycle_state": "CANCELLED",
            "cancellation_reason": {
                "alternative_code": "WII",
                "name": "Wrong Input/Missing Information",
                "description": null,
                "id": "716632CA6EF8482B818B78F4018800E2"
            },
            "activities_set": [],
            "physical_goods_set": [],
            "time_overdue": {
                "time_period_uot": "YEARS",
                "time_period_value": 1.210382513661202
            },
            "udf_string_6": null,
            "udf_string_7": null,
            "udf_string_8": null,
            "status": {
                "alternative_code": "C",
                "name": "Cancelled",
                "description": null,
                "id": "8B7D8C54FDC64DE592C5F170041DC91C",
                "life_cycle_state": "CANCELLED"
            },
            "owned_by_group": {
                "alternative_code": "MG",
                "community_name": "Community",
                "name": "Main Group",
                "description": "Main Group",
                "id": "1"
            },
            "description": null,
            "rating_state": "PENDING",
            "expenses_set": [],
            "subscription": {
                "number": "S0000000113",
                "first_activated_date": "2016-03-23T10:34:59",
                "rating_state": "PENDING",
                "accounts_receivable": {
                    "number": "ACR0000000120",
                    "name": "ACR0000000120 Marios Michael",
                    "id": "D9862FB706734931B97EE50877217674",
                    "life_cycle_state": "ACTIVE",
                    "account_owner": {
                        "company_profile": null,
                        "company_name": null,
                        "name": "Marios Michael",
                        "last_name": "Michael",
                        "id": "32289B42B1BF42DDA49099FF2AFEC416",
                        "life_cycle_state": "FINANCIAL",
                        "middle_name": null,
                        "title": "456",
                        "type": "PERSON",
                        "first_name": "Marios",
                        "demographics": {
                            "name_day": {
                                "month": 11,
                                "day": 21
                            },
                            "id_number": null,
                            "gender": null,
                            "country_of_residence": {
                                "alternative_code": "CYP",
                                "three_character_code": "CYP",
                                "name": "CYPRUS",
                                "id": "181",
                                "two_character_code": "CY"
                            },
                            "date_of_birth": {
                                "month": null,
                                "year": null,
                                "day": null
                            },
                            "industry_sector": null,
                            "passport_number": null,
                            "industry": null,
                            "social_security_number": null,
                            "id_issued_by_country": null,
                            "passport_issued_by_country": null
                        }
                    }
                },
                "id": "2C3D12492DAD4E0D85957913B76250AD",
                "life_cycle_state": "NOT_EFFECTIVE",
                "type": {
                    "alternative_code": "normalsub",
                    "name": "Normal",
                    "description": null,
                    "id": "D1BAE6454A2248189EBCD7ADD3B4B65F"
                }
            },
            "udf_date_2": null,
            "udf_date_1": null,
            "udf_date_4": null,
            "contact_email": null,
            "udf_date_3": null,
            "udf_float_3": null,
            "udf_float_4": null,
            "estimated_completion_time": {
                "time_period_uot": "HOURS",
                "time_period_value": 1
            },
            "service_request": null,
            "udf_float_1": null,
            "billing_terms": {
                "billing_frequency": null,
                "billing_term_scheme": {
                    "code": "PJBTS",
                    "name": "P Job Billing Term Scheme",
                    "billing_type": "NORMAL",
                    "id": "4DA32AA285FD43CE85256B970277E638",
                    "life_cycle_state": "EFFECTIVE",
                    "classification": "JOBS"
                },
                "allowed_cancel_date": null,
                "billing_cycle_day": null,
                "agreement_date": "2016-07-04T00:00:00",
                "effective_date": "2016-07-04T00:00:00",
                "price_plan": {
                    "code": "MPP",
                    "name": "Main Price Plan",
                    "effective_date": "2016-06-14T00:00:00",
                    "description": "Main Price Plan",
                    "id": "85ACEEF700A048A58F9C5581142719A8",
                    "type": "BASE",
                    "expiration_date": "2016-07-21T00:00:00"
                },
                "id": "14CA899E65654881BC8E0DB40781BD91",
                "expiration_date": null,
                "binding_information": null
            },
            "udf_float_2": null,
            "start_date": "2016-07-04T10:51:23",
            "assigned_to": {
                "unit": {
                    "alternative_code": "adminunit",
                    "group_name": "Main Group",
                    "community_name": "Community",
                    "name": "Admin Unit",
                    "description": "admin unit",
                    "id": "1"
                },
                "user": {
                    "person_name": "CRM COM",
                    "id": "1",
                    "email": "dev@crm.com",
                    "username": "MPAdministrator"
                }
            },
            "subscription_physical_goods_set": [
                {
                    "installed_item": {
                        "product": {
                            "code": "Smartcard",
                            "product_type": {
                                "service_type": null,
                                "used_for_provisioning": true,
                                "alternative_code": "S",
                                "udr_type": null,
                                "composition_method": "FLAT",
                                "name": "SMARTCARD",
                                "description": "SMARTCARD",
                                "id": "D6BE0209EC0149989A89972CE889DF8B",
                                "classification": "PHYSICALGOODS",
                                "physical_good_type": "TRACEABLE"
                            },
                            "alternative_code": "S",
                            "description": "Smartcard",
                            "id": "4F656ED5DAC44168B0805227881202CD",
                            "priority_level": null
                        },
                        "alternative_code": "S000004",
                        "serial_number": "S000004",
                        "id": "6022764CF4FD47FAB2C8032498202C36",
                        "state": "EFFECTIVE"
                    },
                    "installed_item_bundle": null,
                    "id": "ACF84945A4614261BA8EFA73EA5AE081",
                    "ownership_status": "RENTED_TO_CUSTOMER"
                }
            ],
            "accounts_receivable": {
                "number": "ACR0000000120",
                "name": "ACR0000000120 Marios Michael",
                "id": "D9862FB706734931B97EE50877217674",
                "life_cycle_state": "ACTIVE",
                "account_owner": {
                    "company_profile": null,
                    "company_name": null,
                    "name": "Marios Michael",
                    "last_name": "Michael",
                    "id": "32289B42B1BF42DDA49099FF2AFEC416",
                    "life_cycle_state": "FINANCIAL",
                    "middle_name": null,
                    "title": "456",
                    "type": "PERSON",
                    "first_name": "Marios",
                    "demographics": {
                        "name_day": {
                            "month": 11,
                            "day": 21
                        },
                        "id_number": null,
                        "gender": null,
                        "country_of_residence": {
                            "alternative_code": "CYP",
                            "three_character_code": "CYP",
                            "name": "CYPRUS",
                            "id": "181",
                            "two_character_code": "CY"
                        },
                        "date_of_birth": {
                            "month": null,
                            "year": null,
                            "day": null
                        },
                        "industry_sector": null,
                        "passport_number": null,
                        "industry": null,
                        "social_security_number": null,
                        "id_issued_by_country": null,
                        "passport_issued_by_country": null
                    }
                }
            },
            "time_to_completion": {
                "time_period_uot": null,
                "time_period_value": null
            },
            "requested_activity_services_set": [
                {
                    "product": {
                        "code": "Installation Service",
                        "product_type": {
                            "service_type": "ONETIME",
                            "used_for_provisioning": false,
                            "alternative_code": "I",
                            "udr_type": null,
                            "composition_method": "FLAT",
                            "name": "Services",
                            "description": null,
                            "id": "7A2F73F07F944CBAB8C5ACDA1A7879B4",
                            "classification": "SERVICES",
                            "physical_good_type": null
                        },
                        "alternative_code": "IS",
                        "description": "Installation Service",
                        "id": "DB4875A4EB7C46BF94AD72169B36FD90",
                        "priority_level": null
                    },
                    "activity_type": {
                        "alternative_code": "I",
                        "name": "Installation",
                        "description": "test",
                        "id": "47675EE2507BC9237F144B46221F7B17"
                    },
                    "id": "111475C444AB4B9C88C5BAAB59A70422"
                }
            ],
            "location": {
                "apartment_number": null,
                "care_of": null,
                "country": {
                    "alternative_code": "CYP",
                    "three_character_code": "CYP",
                    "name": "CYPRUS",
                    "id": "181",
                    "two_character_code": "CY"
                },
                "municipality": null,
                "type": "BUSINESS",
                "udf_date_2": null,
                "udf_date_1": null,
                "street_name": "Test",
                "udf_date_4": null,
                "udf_date_3": null,
                "udf_float_3": null,
                "udf_float_4": null,
                "po_box_postal_code": null,
                "udf_string_15": null,
                "udf_string_16": null,
                "udf_string_13": null,
                "udf_string_14": null,
                "udf_string_11": null,
                "udf_string_12": null,
                "id": "D69E0F1D3E3F4A078B53C389315EEB5D",
                "state": "Active",
                "udf_string_10": null,
                "floor": null,
                "udf_float_1": null,
                "udf_float_2": null,
                "area": null,
                "udf_string_2": null,
                "udf_string_3": null,
                "udf_string_4": null,
                "udf_string_5": null,
                "udf_string_1": null,
                "po_box": null,
                "town_city": null,
                "district": null,
                "street_number": "15",
                "postal_code": "3",
                "udf_string_6": null,
                "udf_string_7": null,
                "udf_string_8": null,
                "udf_string_9": null
            },
            "category": null,
            "expected_completion_date": "2016-07-04T11:51:23"
        },
        {
            "notes": null,
            "contact_phone": null,
            "log_information": {
                "created_by_unit": {
                    "alternative_code": "adminunit",
                    "group_name": "Main Group",
                    "community_name": "Community",
                    "name": "Admin Unit",
                    "description": "admin unit",
                    "id": "1"
                },
                "updated_by_unit": {
                    "alternative_code": "adminunit",
                    "group_name": "Main Group",
                    "community_name": "Community",
                    "name": "Admin Unit",
                    "description": "admin unit",
                    "id": "1"
                },
                "created_date": "2016-03-17T16:27:15",
                "updated_date": "2016-03-30T06:23:51",
                "updated_by_user": {
                    "person_name": "CRM COM",
                    "id": "1",
                    "email": "dev@crm.com",
                    "username": "MPAdministrator"
                },
                "created_by_user": {
                    "person_name": "CRM COM",
                    "id": "1",
                    "email": "dev@crm.com",
                    "username": "MPAdministrator"
                }
            },
            "requested_physical_goods_set": [
                {
                    "product": {
                        "code": "Antenna",
                        "product_type": {
                            "service_type": null,
                            "used_for_provisioning": false,
                            "alternative_code": "001",
                            "udr_type": null,
                            "composition_method": "FLAT",
                            "name": "Equipment",
                            "description": null,
                            "id": "EQ",
                            "classification": "PHYSICALGOODS",
                            "physical_good_type": "NONTRACEABLE"
                        },
                        "alternative_code": "A",
                        "description": "Antenna",
                        "id": "872C558604704AA29D8512A70B608573",
                        "priority_level": null
                    },
                    "quantity": 1,
                    "notes": null,
                    "id": "9B9F7C7F6C38412E80FD58273BFCB6DC"
                }
            ],
            "expiration_date": null,
            "type": {
                "billing_method": null,
                "alternative_code": "SSII",
                "name": "Swap Subscription Inst Item",
                "fulfillment_scope": "SWAP_SUB_INSTALLED_ITEMS",
                "description": null,
                "fulfillment_method": "BASED_ON_DELIVERED_ITEMS",
                "id": "C24FBDF4B89543829701EB5BA5046936",
                "billing_directive": "BILLABLE"
            },
            "number": "J00000055",
            "bills_set": null,
            "id": "53DA7C5CA7304C8CBE20C0A720A3EE53",
            "actual_completed_date": null,
            "requested_expenses_set": [
                {
                    "product": {
                        "code": "Expense 1",
                        "product_type": {
                            "service_type": "EXPENSE",
                            "used_for_provisioning": false,
                            "alternative_code": "006",
                            "udr_type": null,
                            "composition_method": "FLAT",
                            "name": "Fees",
                            "description": "Fees One Time Services",
                            "id": "6",
                            "classification": "SERVICES",
                            "physical_good_type": null
                        },
                        "alternative_code": "E1",
                        "description": "Expense 1",
                        "id": "A9917A7895044BEF9499DD6958539D33",
                        "priority_level": null
                    },
                    "id": "24F3A170F40D483F8CACBD4754C2702F"
                }
            ],
            "udf_string_2": null,
            "udf_string_3": null,
            "udf_string_4": null,
            "udf_string_5": null,
            "privacy_level": null,
            "requested_subscription_physical_goods_set": [
                {
                    "product": {
                        "code": "Set-top-box",
                        "product_type": {
                            "service_type": null,
                            "used_for_provisioning": true,
                            "alternative_code": "STB",
                            "udr_type": null,
                            "composition_method": "FLAT",
                            "name": "SET TOP BOX",
                            "description": "SET TOP BOX",
                            "id": "E8BA9A6F34A24019A89892D5B3ACD9DF",
                            "classification": "PHYSICALGOODS",
                            "physical_good_type": "TRACEABLE"
                        },
                        "alternative_code": "STB",
                        "description": "Set-top-box",
                        "id": "D613415339C14975B28BB4FC11598E93",
                        "priority_level": null
                    },
                    "installed_item": {
                        "product": {
                            "code": "Set-top-box",
                            "product_type": {
                                "service_type": null,
                                "used_for_provisioning": true,
                                "alternative_code": "STB",
                                "udr_type": null,
                                "composition_method": "FLAT",
                                "name": "SET TOP BOX",
                                "description": "SET TOP BOX",
                                "id": "E8BA9A6F34A24019A89892D5B3ACD9DF",
                                "classification": "PHYSICALGOODS",
                                "physical_good_type": "TRACEABLE"
                            },
                            "alternative_code": "STB",
                            "description": "Set-top-box",
                            "id": "D613415339C14975B28BB4FC11598E93",
                            "priority_level": null
                        },
                        "alternative_code": "stbx1000007",
                        "serial_number": "stbx1000007",
                        "id": "6A97CBE152BE49F09DE69CF6DB29A901",
                        "state": "EFFECTIVE"
                    },
                    "quantity": 1,
                    "notes": null,
                    "provisioning_distributor": null,
                    "id": "9D9A4645D8B149FAA9D30C34CAB4A5F6",
                    "swap_installed_item": null
                },
                {
                    "product": {
                        "code": "Smartcard",
                        "product_type": {
                            "service_type": null,
                            "used_for_provisioning": true,
                            "alternative_code": "S",
                            "udr_type": null,
                            "composition_method": "FLAT",
                            "name": "SMARTCARD",
                            "description": "SMARTCARD",
                            "id": "D6BE0209EC0149989A89972CE889DF8B",
                            "classification": "PHYSICALGOODS",
                            "physical_good_type": "TRACEABLE"
                        },
                        "alternative_code": "S",
                        "description": "Smartcard",
                        "id": "4F656ED5DAC44168B0805227881202CD",
                        "priority_level": null
                    },
                    "installed_item": {
                        "product": {
                            "code": "Smartcard",
                            "product_type": {
                                "service_type": null,
                                "used_for_provisioning": true,
                                "alternative_code": "S",
                                "udr_type": null,
                                "composition_method": "FLAT",
                                "name": "SMARTCARD",
                                "description": "SMARTCARD",
                                "id": "D6BE0209EC0149989A89972CE889DF8B",
                                "classification": "PHYSICALGOODS",
                                "physical_good_type": "TRACEABLE"
                            },
                            "alternative_code": "S",
                            "description": "Smartcard",
                            "id": "4F656ED5DAC44168B0805227881202CD",
                            "priority_level": null
                        },
                        "alternative_code": "S000003",
                        "serial_number": "S000003",
                        "id": "2898E901FD6A4720AE89BDD4E3155EB5",
                        "state": "EFFECTIVE"
                    },
                    "quantity": 1,
                    "notes": null,
                    "provisioning_distributor": null,
                    "id": "0E86305B981F4B6AA58BEEEE133D71CE",
                    "swap_installed_item": null
                }
            ],
            "udf_string_1": "1",
            "life_cycle_state": "CANCELLED",
            "cancellation_reason": {
                "alternative_code": "WII",
                "name": "Wrong Input/Missing Information",
                "description": null,
                "id": "716632CA6EF8482B818B78F4018800E2"
            },
            "activities_set": [],
            "physical_goods_set": [],
            "time_overdue": {
                "time_period_uot": "YEARS",
                "time_period_value": 1.505464480874317
            },
            "udf_string_6": null,
            "udf_string_7": null,
            "udf_string_8": null,
            "status": {
                "alternative_code": "C",
                "name": "Cancelled",
                "description": null,
                "id": "8B7D8C54FDC64DE592C5F170041DC91C",
                "life_cycle_state": "CANCELLED"
            },
            "owned_by_group": {
                "alternative_code": "MG",
                "community_name": "Community",
                "name": "Main Group",
                "description": "Main Group",
                "id": "1"
            },
            "description": null,
            "rating_state": "PENDING",
            "expenses_set": [],
            "subscription": {
                "number": "S0000000113",
                "first_activated_date": "2016-03-23T10:34:59",
                "rating_state": "PENDING",
                "accounts_receivable": {
                    "number": "ACR0000000120",
                    "name": "ACR0000000120 Marios Michael",
                    "id": "D9862FB706734931B97EE50877217674",
                    "life_cycle_state": "ACTIVE",
                    "account_owner": {
                        "company_profile": null,
                        "company_name": null,
                        "name": "Marios Michael",
                        "last_name": "Michael",
                        "id": "32289B42B1BF42DDA49099FF2AFEC416",
                        "life_cycle_state": "FINANCIAL",
                        "middle_name": null,
                        "title": "456",
                        "type": "PERSON",
                        "first_name": "Marios",
                        "demographics": {
                            "name_day": {
                                "month": 11,
                                "day": 21
                            },
                            "id_number": null,
                            "gender": null,
                            "country_of_residence": {
                                "alternative_code": "CYP",
                                "three_character_code": "CYP",
                                "name": "CYPRUS",
                                "id": "181",
                                "two_character_code": "CY"
                            },
                            "date_of_birth": {
                                "month": null,
                                "year": null,
                                "day": null
                            },
                            "industry_sector": null,
                            "passport_number": null,
                            "industry": null,
                            "social_security_number": null,
                            "id_issued_by_country": null,
                            "passport_issued_by_country": null
                        }
                    }
                },
                "id": "2C3D12492DAD4E0D85957913B76250AD",
                "life_cycle_state": "NOT_EFFECTIVE",
                "type": {
                    "alternative_code": "normalsub",
                    "name": "Normal",
                    "description": null,
                    "id": "D1BAE6454A2248189EBCD7ADD3B4B65F"
                }
            },
            "udf_date_2": null,
            "udf_date_1": null,
            "udf_date_4": null,
            "contact_email": null,
            "udf_date_3": null,
            "udf_float_3": null,
            "udf_float_4": null,
            "estimated_completion_time": {
                "time_period_uot": "DAYS",
                "time_period_value": 1
            },
            "service_request": null,
            "udf_float_1": null,
            "billing_terms": {
                "billing_frequency": null,
                "billing_term_scheme": {
                    "code": "PJBTS",
                    "name": "P Job Billing Term Scheme",
                    "billing_type": "NORMAL",
                    "id": "4DA32AA285FD43CE85256B970277E638",
                    "life_cycle_state": "EFFECTIVE",
                    "classification": "JOBS"
                },
                "allowed_cancel_date": null,
                "billing_cycle_day": null,
                "agreement_date": "2016-03-17T00:00:00",
                "effective_date": "2016-03-17T00:00:00",
                "price_plan": {
                    "code": "MPP",
                    "name": "Main Price Plan",
                    "effective_date": "2016-02-09T00:00:00",
                    "description": "Main Price Plan",
                    "id": "FF75A943141B43528BC96B11D687380D",
                    "type": "BASE",
                    "expiration_date": "2016-06-14T00:00:00"
                },
                "id": "00CE332D20AA458D8821F7766EA40EF5",
                "expiration_date": null,
                "binding_information": null
            },
            "udf_float_2": null,
            "start_date": "2016-02-17T16:27:15",
            "assigned_to": {
                "unit": {
                    "alternative_code": "adminunit",
                    "group_name": "Main Group",
                    "community_name": "Community",
                    "name": "Admin Unit",
                    "description": "admin unit",
                    "id": "1"
                },
                "user": {
                    "person_name": "CRM COM",
                    "id": "1",
                    "email": "dev@crm.com",
                    "username": "MPAdministrator"
                }
            },
            "subscription_physical_goods_set": [
                {
                    "installed_item": {
                        "product": {
                            "code": "Smartcard",
                            "product_type": {
                                "service_type": null,
                                "used_for_provisioning": true,
                                "alternative_code": "S",
                                "udr_type": null,
                                "composition_method": "FLAT",
                                "name": "SMARTCARD",
                                "description": "SMARTCARD",
                                "id": "D6BE0209EC0149989A89972CE889DF8B",
                                "classification": "PHYSICALGOODS",
                                "physical_good_type": "TRACEABLE"
                            },
                            "alternative_code": "S",
                            "description": "Smartcard",
                            "id": "4F656ED5DAC44168B0805227881202CD",
                            "priority_level": null
                        },
                        "alternative_code": "S000004",
                        "serial_number": "S000004",
                        "id": "6022764CF4FD47FAB2C8032498202C36",
                        "state": "EFFECTIVE"
                    },
                    "installed_item_bundle": null,
                    "id": "ACF84945A4614261BA8EFA73EA5AE081",
                    "ownership_status": "RENTED_TO_CUSTOMER"
                }
            ],
            "accounts_receivable": {
                "number": "ACR0000000120",
                "name": "ACR0000000120 Marios Michael",
                "id": "D9862FB706734931B97EE50877217674",
                "life_cycle_state": "ACTIVE",
                "account_owner": {
                    "company_profile": null,
                    "company_name": null,
                    "name": "Marios Michael",
                    "last_name": "Michael",
                    "id": "32289B42B1BF42DDA49099FF2AFEC416",
                    "life_cycle_state": "FINANCIAL",
                    "middle_name": null,
                    "title": "456",
                    "type": "PERSON",
                    "first_name": "Marios",
                    "demographics": {
                        "name_day": {
                            "month": 11,
                            "day": 21
                        },
                        "id_number": null,
                        "gender": null,
                        "country_of_residence": {
                            "alternative_code": "CYP",
                            "three_character_code": "CYP",
                            "name": "CYPRUS",
                            "id": "181",
                            "two_character_code": "CY"
                        },
                        "date_of_birth": {
                            "month": null,
                            "year": null,
                            "day": null
                        },
                        "industry_sector": null,
                        "passport_number": null,
                        "industry": null,
                        "social_security_number": null,
                        "id_issued_by_country": null,
                        "passport_issued_by_country": null
                    }
                }
            },
            "time_to_completion": {
                "time_period_uot": null,
                "time_period_value": null
            },
            "requested_activity_services_set": [],
            "location": {
                "apartment_number": "2",
                "care_of": null,
                "country": {
                    "alternative_code": "CYP",
                    "three_character_code": "CYP",
                    "name": "CYPRUS",
                    "id": "181",
                    "two_character_code": "CY"
                },
                "municipality": null,
                "type": "HOME",
                "udf_date_2": null,
                "udf_date_1": null,
                "street_name": "Solonos",
                "udf_date_4": null,
                "udf_date_3": null,
                "udf_float_3": null,
                "udf_float_4": null,
                "po_box_postal_code": null,
                "udf_string_15": null,
                "udf_string_16": null,
                "udf_string_13": null,
                "udf_string_14": null,
                "udf_string_11": null,
                "udf_string_12": null,
                "id": "A26C2CA794464922B74F522B3EF74AE3",
                "state": "Active",
                "udf_string_10": null,
                "floor": 2,
                "udf_float_1": null,
                "udf_float_2": null,
                "area": null,
                "udf_string_2": null,
                "udf_string_3": null,
                "udf_string_4": null,
                "udf_string_5": null,
                "udf_string_1": null,
                "po_box": null,
                "town_city": null,
                "district": null,
                "street_number": "25",
                "postal_code": "2",
                "udf_string_6": null,
                "udf_string_7": null,
                "udf_string_8": null,
                "udf_string_9": null
            },
            "category": null,
            "expected_completion_date": "2016-03-18T16:27:15"
        }
    ],
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}

Example 2

HTTP Method: GET

Request:

Response:

{
    "data": [
        {
            "number": "J00000440",
            "description": null,
            "id": "0701C30A57324116BC7C7F9A55ABFDFB",
            "life_cycle_state": "IN_PROGRESS"
        },
        {
            "number": "J00000575",
            "description": null,
            "id": "0DECC791B13641CEA5452D7D9BB89337",
            "life_cycle_state": "PENDING"
        },
        {
            "number": "J00000574",
            "description": null,
            "id": "B450E4E68DD2499194C1245458D20C24",
            "life_cycle_state": "PENDING"
        },
        {
            "number": "J00000573",
            "description": null,
            "id": "1B65D671DE9D428A926329E097B5797C",
            "life_cycle_state": "PENDING"
        },
        {
            "number": "J00000163",
            "description": null,
            "id": "227B6BB149014F17B3D88DFE5985F5CD",
            "life_cycle_state": "COMPLETED"
        },
        {
            "number": "J00000316",
            "description": null,
            "id": "4979EAA7F1874F57845A9871F16E3970",
            "life_cycle_state": "COMPLETED"
        },
        {
            "number": "J00000314",
            "description": null,
            "id": "856C78718596468088912413BE3A7163",
            "life_cycle_state": "IN_PROGRESS"
        },
        {
            "number": "J00000313",
            "description": null,
            "id": "D999E815B92D4A5F88998E66A7D24E7C",
            "life_cycle_state": "CANCELLED"
        },
        {
            "number": "J00000294",
            "description": null,
            "id": "ED110D47B0AA435C909A3E4618496109",
            "life_cycle_state": "IN_PROGRESS"
        },
        {
            "number": "J00000293",
            "description": null,
            "id": "38B16F1A371C4807A2D164F0DDC7C1C5",
            "life_cycle_state": "COMPLETED"
        }
    ],
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}