Skip to end of banner
Go to start of banner

POST jobs/generic_purpose/create

Skip to end of metadata
Go to start of metadata

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

Compare with Current View Page History

« Previous Version 8 Next »

Available from CRM.COM R10.0.0

This method creates a job of fulfillment scope Generic Purpose. A single job can be created by each call. Only customer jobs can be created through this method.

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

type_identifier
(mandatory)

Job type identifier

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

Name

Type

Description

id

(semi-optional)

String

The ID of the job type

name

(semi-optional)

String

The name of the job type

alternative_code

(semi-optional)

String

The alternative code of  the job type

status_identifier
(optional)

Job status identifier

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

Name

Type

Description

id

(semi-optional)

String

The ID of the job status

name

(semi-optional)

String

The name of the job status

alternative_code

(semi-optional)

String

The alternative code of  the job status

category_identifier
(optional)

Job category identifier

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

Name

Type

Description

id

(semi-optional)

String

The ID of the job category

name

(semi-optional)

String

The name of the job category

code

(semi-optional)

String

The code of  the job category

accounts_receivable_identifier

(mandatory)

Accounts receivable identifier

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

Name

Type

Description

id

(semi-optional)

String

The ID of the accounts receivable

number

(semi-optional)

String

The number of the accounts receivable

name

(semi-optional)

String

The name of the accounts receivable

From CRM.COM R14.0.0, this attribute will be deprecated

accounts_receivable
(mandatory)
Accounts Receivable Object

The new job's accounts receivable

Available from CRM.COM R14.0.0

contact_email

(optional)

String

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

contact_phone

(optional)

 String

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

description
(optional)

StringThe description of the new job

notes
(optional)

StringThe notes of the new job

start_date
(optional)

DateThe date that the job is created

location_identifier
(mandatory)

Job location identifier

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

Name

Type

Description

id

(semi-optional)

String

The ID of the address belonging to the specified contact information

 

type

(semi-optional)

String

The type of the address belonging to the specified contact information. The supported values are the following:

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

owned_by_group_identifier
(optional)

The identifier of the owned by group information

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

Name

Type

Description

id

(semi-optional)

String

The ID of the group

name

(semi-optional)

String

The code of the group

alternative_code

(semi-optional)

String

The alternative code of  the group

privacy_level_identifier
(optional)

The identifier of the privacy level

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

Name

Type

Description

id

(semi-optional)

String

The ID of the privacy level

 

number

(semi-optional)

String

The number of the privacy level

service_request_identifier
(optional)
The identifier of the service request

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

Name

Type

Description

id

(semi-optional)

String

The ID of the service request

number

(semi-optional)

String

The number of the service request

udf_string_1 

(optional)

String

User Defined Field of type String

udf_string_2 

(optional)

String

User Defined Field of type String

udf_string_3 

(optional)

String

User Defined Field of type String

udf_string_4 

(optional)

String

User Defined Field of type String

udf_string_5

(optional)

String

User Defined Field of type String

udf_string_6 

(optional)

String

User Defined Field of type String

udf_string_7

(optional)

String

User Defined Field of type String

udf_string_8

(optional)

String

User Defined Field of type String

udf_float_1

(optional)

Float

User Defined Field of type Float

udf_float_2

(optional)

Float

User Defined Field of type Float

udf_float_3

(optional)

Float

User Defined Field of type Float

udf_float_4

(optional)

Float

User Defined Field of type Float

udf_date_1 

(optional)

Date

User Defined Field of type Date

udf_date_2 

(optional)

Date

User Defined Field of type Date

udf_date_3

(optional)

Date

User Defined Field of type Date

udf_date_4

(optional)

Date

User Defined Field of type Date

expected_completion_date
(semi-optional)

Date

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

From CRM.COM R14.1.0, this parameter will be applicable only when the Recalculate Key Dates on Starting Progress option is not enabled through the related Job Type configuration

estimated_completion_time
(semi-optional)

Time Period Object

The time that is estimated to complete the job, measured in minutes, hours, days, weeks, years. It is automatically calculated if expected completion date is specified

From CRM.COM R14.1.0, this parameter will be applicable only when the Recalculate Key Dates on Starting Progress option is not enabled through the related Job Type configuration

billing_terms
(mandatory on conditions)
Job Billing terms object

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

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

requested_physical_goods_set

(optional)

Set of Requested Physical Good Objects

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

requested_expenses_set

(optional)

Set of Requested Expense Objects

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

 

requested_activity_services_set

(optional)

Set of Requested Activity Service Objects

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

fields_set

(optional)

List of Strings, comma separated 

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

Referred Parameter Objects Data

 accounts_receivable_parameter object data

Name

Type

Description

action

(mandatory)

String

Defines if a new or existing accounts receivable should be used. The supported values are the following:

NEW, EXISTING

accounts_receivable_identifier

(mandatory on conditions)

Accounts receivable identifier

An existing accounts receivable that should be used. This is applicable and mandatory if the action is set to EXISTING. The allowed accounts receivable identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the accounts receivable

number

(semi-optional)

String

The number of the accounts receivable

name

(semi-optional)

String

The name of the accounts receivable

name

(mandatory on conditions)

String

The name of the accounts receivable. This is applicable and mandatory if the action is set to NEW

description

(optional)

StringThe description of the retrieved accounts receivable. This is applicable if the action is set to NEW

notes

(optional)

StringThe notes of the retrieved accounts receivable. This is applicable if the action is set to NEW

vat_number

(optional)

String

The VAT number of the retrieved accounts receivable. This is applicable if the action is set to NEW

credit_limit

(optional)

Number

Is the maximum amount of credit that can be provided to the specific accounts receivable, or in other words the maximum balance that the accounts receivable can ever reach. This is applicable if the action is set to NEW

Deprecated from CRM.COM R11.0.0

credit_period_operator 

(optional)

String

The credit period operator. The supported values are the following:

PLUS,MINUS

This is applicable if the action is set to NEW

credit_period

(optional)

NumberCredit period is the length of time for which a customer is allowed to settle any given debit. This is applicable if the action is set to NEW

classification_identifier

(mandatory on conditions)

Accounts receivable classification identifier

The accounts receivable classification identifier.  This is applicable and mandatory if the action is set to NEW. The allowed classification identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the classification

name

(semi-optional)

String

The name of the classification

alternative_code

(semi-optional)

String

The alternative code of  the classification

This is applicable if the action is set to NEW

credit_rating_code

(mandatory on conditions)

String

The code of  the credit rating. This is applicable and mandatory if the action is set to NEW. The supported codes are the following:

AAA, AA, A, BAA, BA, B, CAA, CA, C

 This is applicable if the action is set to NEW

owned_by_group_identifier

(optional)

Group identifier

The group owning the accounts receivable. This is applicable if the action is set to NEW. The allowed group identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the group

name

(semi-optional)

String

The code of the group

alternative_code

(semi-optional)

String

The alternative code of  the group

Deprecated from CRM.COM R18.0.0

owned_by_business_unit_identifier

(optional)

Business Unit identifier

The business unit owning the accounts receivable. This is applicable if the action is set to NEW. The allowed business unit identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the business unit

name

(semi-optional)

String

The code of the business unit

code

(semi-optional)

String

The code of the business unit

Available from CRM.COM R18.0.0

privacy_level_identifier

(optional)

Privacy level identifier

The privacy level of the accounts receivable. This is applicable if the action is set to NEW. The allowed privacy level identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the privacy level

 

number

(semi-optional)

String

The number of the privacy level

Deprecated from CRM.COM R18.0.0

currency_identifier

(optional)

Currency identifier
The identifier of the currency to be used. This is optional information but it is only applicable when creating a new accunts receivable. The allowed currency identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the currency

code

(semi-optional)

String

The code of the currency

Available from CRM.COM R10.0.0

account_manager

(optional)

User Identifier

The identifier of the user that should be set as the Account Manager. The allowed user identifier fields are the following

Name

Type

Description

id

(semi-optional)

String

The ID of the user

username

(semi-optional)

String

The username of the user

Assigning an Account Manager is only applicable for Accounts Receivables that are owned by a COMPANY

Available from CRM.COM R14.0.0

udf_string_1 

(optional)

String

User Defined Field of type String. This is applicable if the action is set to NEW

udf_string_2 

(optional)

String

User Defined Field of type String. This is applicable if the action is set to NEW

udf_string_3 

(optional)

String

User Defined Field of type String. This is applicable if the action is set to NEW

udf_string_4 

(optional)

String

User Defined Field of type String. This is applicable if the action is set to NEW

udf_string_5

(optional)

String

User Defined Field of type String. This is applicable if the action is set to NEW

udf_string_6 

(optional)

String

User Defined Field of type String. This is applicable if the action is set to NEW

udf_string_7

(optional)

String

User Defined Field of type String. This is applicable if the action is set to NEW

udf_string_8

(optional)

String

User Defined Field of type String. This is applicable if the action is set to NEW

udf_float_1

(optional)

Float

User Defined Field of type Float. This is applicable if the action is set to NEW

udf_float_2

(optional)

Float

User Defined Field of type Float. This is applicable if the action is set to NEW

udf_float_3

(optional)

Float

User Defined Field of type Float. This is applicable if the action is set to NEW

udf_float_4

(optional)

Float

User Defined Field of type Float. This is applicable if the action is set to NEW

udf_date_1 

(optional)

Date

User Defined Field of type Date. This is applicable if the action is set to NEW

udf_date_2 

(optional)

Date

User Defined Field of type Date. This is applicable if the action is set to NEW

udf_date_3

(optional)

Date

User Defined Field of type Date. This is applicable if the action is set to NEW

udf_date_4

(optional)

Date

User Defined Field of type Date. This is applicable if the action is set to NEW

custom_field_set

(optional)

Set of Custom Fields

The custom fields that are associated with the accounts receivable

If no records are specified in the set then nothing will be updated. To add or update a value on a custom field use the custom field name as configured in CRM.COM along with the respective value. To remove a value from a custom field use the custom field name as configured in CRM.COM along with an empty value

"custom_field_set": [
	{"field_name" : "value"},
	{"field_name" : "value"}
]

Available from CRM.COM R16.2.0

contact_information

(mandatory on conditions)

Contact information objectThe contact information of the accounts receivable owner. This is applicable and mandatory if the action is set to NEW

billing_address

(mandatory on conditions)

Billing address object

The accounts receivable billing address. This is applicable and mandatory if the action is set to NEW

From CRM.COM R14.3.0, billing_address is mandatory based on the accounts receivable definitions' billing address rules

wallet_top_up_rules

(optional)

Wallet Top Up Rules Object

The accounts receivable wallet top up rules. Applicable only if the account owner owns a wallet and has opt in to recurring payments through payment preferences

Available from CRM.COM R14.2.0

presentment_preferences_set 

(optional)

Set of Presentment Preferences Object            

The presentment preferences of the retrieved accounts receivable. This is applicable if the action is set to NEW

payment_preferences_set

(optional)

Set of Payment Preferences Object      

The payment preferences of the retrieved accounts receivable. This is applicable if the action is set to NEW

access_tokens_set

(mandatory on conditions)

Set of Access Token Objects

The access tokens that will be associated with the accounts receivable. This information is mandatory if the active access token definition is set up to require at least one access token for each accounts receivable

Available from CRM.COM R8.0.0

Referred Parameter Objects Data

 contact_information_parameters object data

Name

Type

Description

action

(mandatory)

String

Defines if a new or existing contact information should be used. The supported values are the following:

NEW, EXISTING

contact_information_identifier

(mandatory on conditions)

Contact information identifier

An existing contact information that should be used. This is applicable and mandatory if the action is set to EXISTING. The allowed contact information identifier fields are the following:

Name

Type

Description

id 

(semi-optional)

String

The ID of the contact information

id_number

(semi-optional)

String

The ID number of the contact information

Applicable only for contact information that represent PERSON

passport_number 

(semi-optional)

String

The passport number of the contact information

Applicable only for contact information that represent PERSON

social_security_number 

(semi-optional)

String

The social security number of the contact information

Applicable only for contact information that represent PERSON

vat_registration_number

(semi-optional)

String

The VAT registration number of the contact information

Applicable only for contact information that represent COMPANY

registration_number

(semi-optional)

String

The registration number of the contact information

Applicable only for contact information that represent COMPANY

Available from CRM.COM R14.0.0

type

(mandatory on conditions)

String

The type of the contact information which can be PERSON or COMPANY. Applicable and mandatory if the action is set to NEW

title

(optional)

String

The title of the contact information. Applicable only if the type is PERSON and the action is set to NEW

first_name

(mandatory on conditions)

String

The first name of the contact information. Applicable and mandatory only if the type is PERSON and the action is set to NEW

middle_name

(optional)

String

The middle name of the contact information. Applicable only if the type is PERSON and the action is set to NEW

last_name

(mandatory on conditions)

String

The last name of the contact information. Applicable and mandatory only if the type is PERSON and the action is set to NEW

company_name

(mandatory on conditions)

Sting

The company name of the contact information. Applicable and mandatory only if the type is COMPANY and the action is set to NEW

category_identifier

(optional)

Identifier  

The identifier of the contact category that will be associate with the contact information. The allowed contact category identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the contact category

name

(semi-optional)

String

The name of the category

code

(semi-optional)

String

The code of  the category

Applicable only if the action is set to NEW

owned_by_group_identifier

(optional)

Group identifier

The group owning the contact information. The allowed group identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the group

name

(semi-optional)

String

The code of the group

alternative_code

(semi-optional)

String

The alternative code of  the group

Applicable only if the action is set to NEW

Deprecated from CRM.COM R18.0.0

owned_by_business_unit_identifier

(optional)

Business Unit identifier

The business unit owning the contact information. The allowed business unit identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the business unit

name

(semi-optional)

String

The code of the business unit

code

(semi-optional)

String

The code of the business unit

Applicable only if the action is set to NEW

Available from CRM.COM R18.0.0

privacy_level_identifier

(optional)

Privacy level identifier

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

Name

Type

Description

id

(semi-optional)

String

The ID of the privacy level

 

number

(semi-optional)

String

The number of the privacy level

Applicable only if the action is set to NEW

Deprecated from CRM.COM R18.0.0

send_direct_marketing_material

(optional)

Boolean


The Contact Information's authorization setting for Direct Marketing

Available from CRM.COM R9.0.0

send_affiliate_marketing_material

(optional)

Boolean

The Contact Information's authorization setting for Affiliate Marketing

Available from CRM.COM R9.0.0

udf_string_1

(optional)

String

User Defined Field of type String. Applicable only if the action is set to NEW

udf_string_2

(optional)

String

User Defined Field of type String. Applicable only if the action is set to NEW

udf_string_3

(optional)

String

User Defined Field of type String. Applicable only if the action is set to NEW

udf_string_4

(optional)

String

User Defined Field of type String. Applicable only if the action is set to NEW

udf_string_5

(optional)

String

User Defined Field of type String. Applicable only if the action is set to NEW

udf_string_6

(optional)

String

User Defined Field of type String. Applicable only if the action is set to NEW

udf_string_7

(optional)

String

User Defined Field of type String. Applicable only if the action is set to NEW

udf_string_8

(optional)

String

User Defined Field of type String. Applicable only if the action is set to NEW

udf_string_9

(optional)

String

User Defined Field of type String. Applicable only if the action is set to NEW

udf_string_10

(optional)

String

User Defined Field of type String. Applicable only if the action is set to NEW

udf_string_11

(optional)

String

User Defined Field of type String. Applicable only if the action is set to NEW

udf_string_12

(optional)

String

User Defined Field of type String. Applicable only if the action is set to NEW

udf_string_13

(optional)

String

User Defined Field of type String. Applicable only if the action is set to NEW

udf_string_14

(optional)

String

User Defined Field of type String. Applicable only if the action is set to NEW

udf_string_15

(optional)

String

User Defined Field of type String. Applicable only if the action is set to NEW

udf_string_16

(optional)

String

User Defined Field of type String. Applicable only if the action is set to NEW

udf_float_1

(optional)

Float

User Defined Field of type Float. Applicable only if the action is set to NEW

udf_float_2

(optional)

Float

User Defined Field of type Float. Applicable only if the action is set to NEW

udf_float_3

(optional)

Float

User Defined Field of type Float. Applicable only if the action is set to NEW

udf_float_4

(optional)

Float

User Defined Field of type Float. Applicable only if the action is set to NEW

udf_float_5

(optional)

Float

User Defined Field of type Float. Applicable only if the action is set to NEW

udf_float_6

(optional)

Float

User Defined Field of type Float. Applicable only if the action is set to NEW

udf_float_7

(optional)

Float

User Defined Field of type Float. Applicable only if the action is set to NEW

udf_float_8

(optional)

Float

User Defined Field of type Float. Applicable only if the action is set to NEW

udf_date_1

(optional)

Date

User Defined Field of type Date. Applicable only if the action is set to NEW

udf_date_2

(optional)

Date

User Defined Field of type Date. Applicable only if the action is set to NEW

udf_date_3

(optional)

Date

User Defined Field of type Date. Applicable only if the action is set to NEW

udf_date_4

(optional)

Date

User Defined Field of type Date. Applicable only if the action is set to NEW

udf_date_5

(optional)

Date

User Defined Field of type Date. Applicable only if the action is set to NEW

udf_date_6

(optional)

Date

User Defined Field of type Date. Applicable only if the action is set to NEW

udf_date_7

(optional)

Date

User Defined Field of type Date. Applicable only if the action is set to NEW

udf_date_8

(optional)

Date

User Defined Field of type Date. Applicable only if the action is set to NEW

custom_field_set

(optional)

Set of Custom Fields

The custom fields that are associated with the contact information

If no records are specified in the set then nothing will be updated. To add or update a value on a custom field use the custom field name as configured in CRM.COM along with the respective value. To remove a value from a custom field use the custom field name as configured in CRM.COM along with an empty value

"custom_field_set": [
	{"field_name" : "value"},
	{"field_name" : "value"}
]

Available from CRM.COM R16.2.0

demographics

(optional)

Demographics object

The demographics of the contact information. Applicable only if the type is PERSON and the action is set to NEW


company_profile

(optional)

Company profile object

The company profile of the contact information. Applicable only if the type is COMPANY and the action is set to NEW


address_set

(optional)

Address object

The addresses of the contact information. Applicable only if the action is set to NEW


phone_set

(optional)

Phone object

The phone of the contact information. Applicable only if the action is set to NEW


email_set

(optional)

Email object

The email of the contact information. Applicable only if the action is set to NEW


Referred Parameter Objects Data

 demographics parameter object data

Name

Type

Description

gender

(optional)

String

The gender of the contact information which can be MALE or FEMALE

id_number

(optional)

String

The ID number of the contact information

id_number_expiration_date

(optional)

Date

The expiration date of the ID number

Available from CRM.COM R14.0.0

passport_number

(optional)

String

The passport number of the contact information

passport_number_expiration_date

(optional)

 

Date

The expiration date of the passport

Available from CRM.COM R14.0.0

social_security_number

(optional)

String

The social security number of the contact information

country_of_residence_identifier

(optional)

Country identifier

The country of residence of the contact information. The allowed country identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the country

name

(semi-optional)

String

The name of the country

alternative_code

(semi-optional)

String

The alternative code of the retrieved country

two_character_code

(semi-optional)

String

 The two character code of the retrieved country


three_character_code

(semi-optional)

String

 The three character code of the retrieved country

id_issued_by_country_identifier

(optional)

Country identifier

The ID issued country of the contact information. The allowed country identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the country

name

(semi-optional)

String

The name of the country

alternative_code

(semi-optional)

String

The alternative code of the retrieved country

two_character_code

(semi-optional)

String

 The two character code of the retrieved country


three_character_code

(semi-optional)

String

 The three character code of the retrieved country

passport_issued_by_country_identifier

(optional)

Country identifier

The passport  issued country of the contact information. The allowed country identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the country

name

(semi-optional)

String

The name of the country

alternative_code

(semi-optional)

String

The alternative code of the retrieved country

two_character_code

(semi-optional)

String

 The two character code of the retrieved country


three_character_code

(semi-optional)

String

 The three character code of the retrieved country

industry_identifier

(optional)

Industry identifier

The industry of the contact information. The allowed industry identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the industry

name

(semi-optional)

String

The name of the industry

code

(semi-optional)

String

The alternative code of  the industry

industry_sector_identifier

(optional)

Industry Sector identifier

The sector of the contact information. The allowed industry sector identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the industry sector

name

(semi-optional)

String

The name of the industry sector

alternative_code

(semi-optional)

String

The alternative code of  the industry sector

date_of_birth

(optional)

Date of Birth Object

The date of birth of the contact information

name_day

(optional)

Name Day Object

The name day of the contact information

Referred Parameter Objects Data

 date_of_birth object parameter data

Name

Type

Description

day 

(optional)

Integer

The day of the retrieved date of birth

month 

(optional)

Integer

The month of the retrieved date of birth

year

(optional)

Integer

The year of the retrieved date of birth

 name_day object parameter data

Name

Type

Description

day

(optional)

Integer

The day of the retrieved name day

month

(optional)

Integer

The month of the retrieved name day

 company_profile parameter object data

Name

Type

Description

profile_year

(optional)

Number

The profile year of the contact information

annual_turnover

(optional)

Number

The annual turnover of the contact information

established_date

(optional)

Date

The established date of the contact information

number_of_employees

(optional)

Number

The number of employees of the contact information

registration_number

(optional)

String

The registration number of the contact information

vat_registration_number

(optional)

String

The vat registration number of the contact information

vat_registered_by

(optional)

String

The vat registration by of the contact information

vat_registration_date

(optional)

Date

The vat registration date of the contact information

tax_reference_number

(optional)

String

The tax reference number of the contact information

registered_in_country_identifier

Country Identifier

The country of registration of the contact information. The allowed country identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the country

name

(semi-optional)

String

The name of the country

alternative_code

(semi-optional)

String

The alternative code of the retrieved country

two_character_code

(semi-optional)

String

 The two character code of the retrieved country


three_character_code

(semi-optional)

String

 The three character code of the retrieved country

industry_identifier

(optional)

Industry identifier

The industry of the contact information. The allowed industry identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the industry

name

(semi-optional)

String

The name of the industry

code

(semi-optional)

String

The alternative code of  the industry

industry_sector_identifier

(optional)

Industry Sector identifier

The sector of the contact information. The allowed industry sector identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the industry sector

name

(semi-optional)

String

The name of the industry sector

alternative_code

(semi-optional)

String

The alternative code of  the industry sector


 address parameter object data

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

NameTypeDescription

type

(mandatory)

String

The type of the address which can be added

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

is_primary

(mandatory on conditions)

Boolean

Weather the address is the primary one


Applicable from CRM.COM R16.1.0 onwards

postal_code

(optional)

String

The postal code of the address

street_name

(mandatory on conditions)

String

The street name of the address

street_number

(optional)

String

The street number of the address


floor

(optional)

Integer

The floor of the address


apartment_number

(optional)

String

The apartment number of the address


area

(optional)

String

The area of the address


town_city

(optional)

String

The town/city of the address


district

(optional)

String

The district of the address


municipality

(optional)

         

String

The municipality of the address


country_identifier

(optional)

Country identifier

The country of the address. The allowed country identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the country

name

(semi-optional)

String

The name of the country

alternative_code

(semi-optional)

String

The alternative code of the retrieved country

two_character_code

(semi-optional)

String

 The two character code of the retrieved country


three_character_code

(semi-optional)

String

 The three character code of the retrieved country

po_box

(optional)

String

The PO box of the address

po_box_postal_code

(optional)

String

The PO box postal code of the address

care_of

(optional)

String

The care of person of the address

udf_string_1

(optional)

String

User Defined Field of type String

udf_string_2

(optional)

String

User Defined Field of type String

udf_string_3

(optional)

String

User Defined Field of type String

udf_string_4

(optional)

String

User Defined Field of type String

udf_string_5

(optional)

String

User Defined Field of type String

udf_string_6

(optional)

String

User Defined Field of type String

udf_string_7

(optional)

String

User Defined Field of type String

udf_string_8

(optional)

String

User Defined Field of type String

udf_string_9

(optional)

String

User Defined Field of type String

udf_string_10

(optional)

String

User Defined Field of type String

udf_string_11

(optional)

String

User Defined Field of type String

udf_string_12

(optional)

String

User Defined Field of type String

udf_string_13

(optional)

String

User Defined Field of type String

udf_string_14

(optional)

String

User Defined Field of type String

udf_string_15

(optional)

String

User Defined Field of type String

udf_string_16

(optional)

String

User Defined Field of type String

udf_float_1

(optional)

Float

User Defined Field of type Float

udf_float_2

(optional)

Float

User Defined Field of type Float

udf_float_3

(optional)

Float

User Defined Field of type Float

udf_float_4

(optional)

Float

User Defined Field of type Float

udf_date_1

(optional)

Date

User Defined Field of type Date

udf_date_2

(optional)

Date

User Defined Field of type Date

udf_date_3

(optional)

Date

User Defined Field of type Date

udf_date_4

(optional)

Date

User Defined Field of type Date


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

type

(mandatory)

String

The type of the address which can be added

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

postal_code

(optional)

String

The postal code of the address


town_city

(optional)

String

The town/city of the address

country_identifier

(optional)

Country identifier

The country of the address. The allowed country identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the country

name

(semi-optional)

String

The name of the country

alternative_code

(semi-optional)

String

The alternative code of the retrieved country

two_character_code

(semi-optional)

String

 The two character code of the retrieved country


three_character_code

(semi-optional)

String

 The three character code of the retrieved country

address_line_1

(mandatory)

String

The address line 1

address_line_2

(optional)

String

 The address line 2

state_province_county

(optional)

String

The state or province or county of the address.


udf_string_1

(optional)

String

User Defined Field of type String

udf_string_2

(optional)

String

User Defined Field of type String

udf_string_3

(optional)

String

User Defined Field of type String

udf_string_4

(optional)

String

User Defined Field of type String

udf_string_5

(optional)

String

User Defined Field of type String

udf_string_6

(optional)

String

User Defined Field of type String

udf_string_7

(optional)

String

User Defined Field of type String

udf_string_8

(optional)

String

User Defined Field of type String

udf_string_9

(optional)

String

User Defined Field of type String

udf_string_10

(optional)

String

User Defined Field of type String

udf_string_11

(optional)

String

User Defined Field of type String

udf_string_12

(optional)

String

User Defined Field of type String

udf_string_13

(optional)

String

User Defined Field of type String

udf_string_14

(optional)

String

User Defined Field of type String

udf_string_15

(optional)

String

User Defined Field of type String

udf_string_16

(optional)

String

User Defined Field of type String

udf_float_1

(optional)

Float

User Defined Field of type Float

udf_float_2

(optional)

Float

User Defined Field of type Float

udf_float_3

(optional)

Float

User Defined Field of type Float

udf_float_4

(optional)

Float

User Defined Field of type Float

udf_date_1

(optional)

Date

User Defined Field of type Date

udf_date_2

(optional)

Date

User Defined Field of type Date

udf_date_3

(optional)

Date

User Defined Field of type Date

udf_date_4

(optional)

Date

User Defined Field of type Date

 phone parameter object data

Name

Type

Description

type

(mandatory)

String

The type of the phone which can be

LANDLINE, MOBILE, FAX, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5

is_primary

(mandatory on conditions)

Boolean

Weather the phone is the primary one


Applicable from CRM.COM R16.1.0 onwards

number

(mandatory)

String

The number of the phone

area_code

(optional)

String

The area code of the phone

country_identifier

(optional)

Country identifier

The country of the phone. The allowed country identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the country

name

(semi-optional)

String

The name of the country

alternative_code

(semi-optional)

String

The alternative code of the retrieved country

two_character_code

(semi-optional)

String

 The two character code of the retrieved country


three_character_code

(semi-optional)

String

 The three character code of the retrieved country

notes

(optional)

StringThe notes of the phone

udf_string_1

(optional)

String

User Defined Field of type String

udf_string_2

(optional)

String

User Defined Field of type String

udf_string_3

(optional)

String

User Defined Field of type String

udf_string_4

(optional)

String

User Defined Field of type String

udf_string_5

(optional)

String

User Defined Field of type String

udf_string_6

(optional)

String

User Defined Field of type String

udf_string_7

(optional)

String

User Defined Field of type String

udf_string_8

(optional)

String

User Defined Field of type String

udf_float_1

(optional)

Float

User Defined Field of type Float

udf_float_2

(optional)

Float

User Defined Field of type Float

udf_float_3

(optional)

Float

User Defined Field of type Float

udf_float_4

(optional)

Float

User Defined Field of type Float

udf_date_1

(optional)

Date

User Defined Field of type Date

udf_date_2

(optional)

Date

User Defined Field of type Date

udf_date_3

(optional)

Date

User Defined Field of type Date

udf_date_4

(optional)

Date

User Defined Field of type Date

 email parameter object data

Name

Type

Description

type

(mandatory)

String

The type of the retrieved email which can be

PERSONAL, BUSINESS, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5

is_primary

(mandatory on conditions)

Boolean

Weather the email is the primary one


Applicable from CRM.COM R16.1.0 onwards

email_address

(mandatory)

String

The address of the retrieved email

notes

(optional)

StringThe notes of the retrieved email

udf_string_1

(optional)

String

User Defined Field of type String

udf_string_2

(optional)

String

User Defined Field of type String

udf_string_3

(optional)

String

User Defined Field of type String

udf_string_4

(optional)

String

User Defined Field of type String

udf_string_5

(optional)

String

User Defined Field of type String

udf_string_6

(optional)

String

User Defined Field of type String

udf_string_7

(optional)

String

User Defined Field of type String

udf_string_8

(optional)

String

User Defined Field of type String

udf_float_1

(optional)

Float

User Defined Field of type Float

udf_float_2

(optional)

Float

User Defined Field of type Float

udf_float_3

(optional)

Float

User Defined Field of type Float

udf_float_4

(optional)

Float

User Defined Field of type Float

udf_date_1

(optional)

Date

User Defined Field of type Date

udf_date_2

(optional)

Date

User Defined Field of type Date

udf_date_3

(optional)

Date

User Defined Field of type Date

udf_date_4

(optional)

Date

User Defined Field of type Date

 billing_address object parameter data
Name
Type
Description
action

(mandatory)

String

Defines if a new or existing address will be used. In the case of an existing address then it also defines if the existing address should be updated or not. The supported values are the following:

NEW, EXISTING, EXISTINGUPDATED

type

(mandatory on conditions)

String

The contact information address that should be set as the billing address address. This is applicable and mandatory only if the action is set to EXISTING or EXISTINGUPDATED. The supported options are the following:

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

address

(mandatory on conditions)

Address objectThe address to be created (if action is set to NEW) or updated (if action is set to EXISTINGUPDATED). This is applicable and mandatory only if the action is set to NEW or EXISTINGUPDATED.

Referred Objects Response Data

 address parameter object data

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

NameTypeDescription

type

(mandatory)

String

The type of the address which can be added

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

is_primary

(mandatory on conditions)

Boolean

Weather the address is the primary one


Applicable from CRM.COM R16.1.0 onwards

postal_code

(optional)

String

The postal code of the address

street_name

(mandatory on conditions)

String

The street name of the address

street_number

(optional)

String

The street number of the address


floor

(optional)

Integer

The floor of the address


apartment_number

(optional)

String

The apartment number of the address


area

(optional)

String

The area of the address


town_city

(optional)

String

The town/city of the address


district

(optional)

String

The district of the address


municipality

(optional)

         

String

The municipality of the address


country_identifier

(optional)

Country identifier

The country of the address. The allowed country identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the country

name

(semi-optional)

String

The name of the country

alternative_code

(semi-optional)

String

The alternative code of the retrieved country

two_character_code

(semi-optional)

String

 The two character code of the retrieved country


three_character_code

(semi-optional)

String

 The three character code of the retrieved country

po_box

(optional)

String

The PO box of the address

po_box_postal_code

(optional)

String

The PO box postal code of the address

care_of

(optional)

String

The care of person of the address

udf_string_1

(optional)

String

User Defined Field of type String

udf_string_2

(optional)

String

User Defined Field of type String

udf_string_3

(optional)

String

User Defined Field of type String

udf_string_4

(optional)

String

User Defined Field of type String

udf_string_5

(optional)

String

User Defined Field of type String

udf_string_6

(optional)

String

User Defined Field of type String

udf_string_7

(optional)

String

User Defined Field of type String

udf_string_8

(optional)

String

User Defined Field of type String

udf_string_9

(optional)

String

User Defined Field of type String

udf_string_10

(optional)

String

User Defined Field of type String

udf_string_11

(optional)

String

User Defined Field of type String

udf_string_12

(optional)

String

User Defined Field of type String

udf_string_13

(optional)

String

User Defined Field of type String

udf_string_14

(optional)

String

User Defined Field of type String

udf_string_15

(optional)

String

User Defined Field of type String

udf_string_16

(optional)

String

User Defined Field of type String

udf_float_1

(optional)

Float

User Defined Field of type Float

udf_float_2

(optional)

Float

User Defined Field of type Float

udf_float_3

(optional)

Float

User Defined Field of type Float

udf_float_4

(optional)

Float

User Defined Field of type Float

udf_date_1

(optional)

Date

User Defined Field of type Date

udf_date_2

(optional)

Date

User Defined Field of type Date

udf_date_3

(optional)

Date

User Defined Field of type Date

udf_date_4

(optional)

Date

User Defined Field of type Date


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

type

(mandatory)

String

The type of the address which can be added

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

postal_code

(optional)

String

The postal code of the address


town_city

(optional)

String

The town/city of the address

country_identifier

(optional)

Country identifier

The country of the address. The allowed country identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the country

name

(semi-optional)

String

The name of the country

alternative_code

(semi-optional)

String

The alternative code of the retrieved country

two_character_code

(semi-optional)

String

 The two character code of the retrieved country


three_character_code

(semi-optional)

String

 The three character code of the retrieved country

address_line_1

(mandatory)

String

The address line 1

address_line_2

(optional)

String

 The address line 2

state_province_county

(optional)

String

The state or province or county of the address.


udf_string_1

(optional)

String

User Defined Field of type String

udf_string_2

(optional)

String

User Defined Field of type String

udf_string_3

(optional)

String

User Defined Field of type String

udf_string_4

(optional)

String

User Defined Field of type String

udf_string_5

(optional)

String

User Defined Field of type String

udf_string_6

(optional)

String

User Defined Field of type String

udf_string_7

(optional)

String

User Defined Field of type String

udf_string_8

(optional)

String

User Defined Field of type String

udf_string_9

(optional)

String

User Defined Field of type String

udf_string_10

(optional)

String

User Defined Field of type String

udf_string_11

(optional)

String

User Defined Field of type String

udf_string_12

(optional)

String

User Defined Field of type String

udf_string_13

(optional)

String

User Defined Field of type String

udf_string_14

(optional)

String

User Defined Field of type String

udf_string_15

(optional)

String

User Defined Field of type String

udf_string_16

(optional)

String

User Defined Field of type String

udf_float_1

(optional)

Float

User Defined Field of type Float

udf_float_2

(optional)

Float

User Defined Field of type Float

udf_float_3

(optional)

Float

User Defined Field of type Float

udf_float_4

(optional)

Float

User Defined Field of type Float

udf_date_1

(optional)

Date

User Defined Field of type Date

udf_date_2

(optional)

Date

User Defined Field of type Date

udf_date_3

(optional)

Date

User Defined Field of type Date

udf_date_4

(optional)

Date

User Defined Field of type Date

 wallet_top_up_rules object parameter data

Name

Type

Description

wallet_balance_threshold

(mandatory)

Number

The wallet balance threshold that will trigger the automatic wallet top-up

top_up_amount

(mandatory)

Number

The amount that will top up the wallet balance

frequency

(mandatory)

Number

The minimum period (in days) between wallet top ups

product_conditions_set

(optional)

Set of Allotment Product Conditions

A set of products that will be allowed to consume the specified top up amount

If no records are specified in the set then nothing will be updated. To remove a record use action "remove". To add a record use action "add". Different actions can be used within the same set. For example:

"set": [
	   		{
            	"action": "remove",
            	...........
        	},
			{
            	"action": "add",
            	...........
			}
		]


Referred Objects Response Data

 allotment_product parameter data
Name
Type
Description

product_identifier
(semi-optional)

Product identifier

The product related with the wallet transaction allotment. The allowed product identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the product

code

(semi-optional)

String

The code of the product

alternative_code

(semi-optional)

String

The alternative code of  the product

 accounts_receivable_presentment_preference object parameter data
Name
Type
Description
presentment_preference_identifier

(mandatory)

Identifier  

The identifier of the presentment preference to be added on account presentment preference object. The allowed presentment preference identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of presentment preference

name 

(semi-optional)

String

The name of presentment preference

alternative_code

(semi-optional)

String

The alternative code of presentment preference

state

(optional)

StringIndicates if the retrieved presentment preference is active or not. The supported values are ACTIVE or INACTIVE. If not specified then it is considered as active

email

(mandatory on conditions)

Presentment Preference Email Object

The email that should be related with the presentment preference. The email is mandatory and applicable only if the specified presentment preference is of type Email

Deprecated from CRM.COM R17.0.0



phone

(mandatory on conditions)

Presentment Preference Phone Object

The phone that should be related with the presentment preference. The phone is mandatory and applicable only if the specified presentment preference is of type SMS

Deprecated from CRM.COM R17.0.0

Referred Objects Response Data

 presentment preference email object parameter data
Name
Type
Description
action

(mandatory)

String

Defines if a new or existing email will be used. In the case of an existing email then it also defines if the existing email should be updated or not. The supported values are the following:

NEW, EXISTING, EXISTINGUPDATED

type

(mandatory on conditions)

String

The contact information email that should be used. This is applicable and mandatory only if the action is set to EXISTING or EXISTINGUPDATED. The supported options are the following:

PERSONAL, BUSINESS, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5

email

(mandatory on conditions)

Email objectThe email to be created (if action is set to NEW) or updated (if action is set to EXISTINGUPDATED). This is applicable and mandatory only if the action is set to NEW or EXISTINGUPDATED.

Referred Objects Response Data

 email parameter object data

Name

Type

Description

type

(mandatory)

String

The type of the retrieved email which can be

PERSONAL, BUSINESS, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5

is_primary

(mandatory on conditions)

Boolean

Weather the email is the primary one


Applicable from CRM.COM R16.1.0 onwards

email_address

(mandatory)

String

The address of the retrieved email

notes

(optional)

StringThe notes of the retrieved email

udf_string_1

(optional)

String

User Defined Field of type String

udf_string_2

(optional)

String

User Defined Field of type String

udf_string_3

(optional)

String

User Defined Field of type String

udf_string_4

(optional)

String

User Defined Field of type String

udf_string_5

(optional)

String

User Defined Field of type String

udf_string_6

(optional)

String

User Defined Field of type String

udf_string_7

(optional)

String

User Defined Field of type String

udf_string_8

(optional)

String

User Defined Field of type String

udf_float_1

(optional)

Float

User Defined Field of type Float

udf_float_2

(optional)

Float

User Defined Field of type Float

udf_float_3

(optional)

Float

User Defined Field of type Float

udf_float_4

(optional)

Float

User Defined Field of type Float

udf_date_1

(optional)

Date

User Defined Field of type Date

udf_date_2

(optional)

Date

User Defined Field of type Date

udf_date_3

(optional)

Date

User Defined Field of type Date

udf_date_4

(optional)

Date

User Defined Field of type Date

 presentment preference phone object parameter data
Name
Type
Description
action

(mandatory)

String

Defines if a new or existing phone will be used. In the case of an existing phone then it also defines if the existing phone should be updated or not. The supported values are the following:

NEW, EXISTING, EXISTINGUPDATED

type

(mandatory on conditions)

String

The contact information phone that should be used. This is applicable and mandatory only if the action is set to EXISTING or EXISTINGUPDATED. The supported options are the following:

LANDLINE, MOBILE, FAX, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5

phone

(mandatory on conditions)

Email objectThe email to be created (if action is set to NEW) or updated (if action is set to EXISTINGUPDATED). This is applicable and mandatory only if the action is set to NEW or EXISTINGUPDATED.

Referred Objects Response Data

 phone parameter object data

Name

Type

Description

type

(mandatory)

String

The type of the phone which can be

LANDLINE, MOBILE, FAX, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5

is_primary

(mandatory on conditions)

Boolean

Weather the phone is the primary one


Applicable from CRM.COM R16.1.0 onwards

number

(mandatory)

String

The number of the phone

area_code

(optional)

String

The area code of the phone

country_identifier

(optional)

Country identifier

The country of the phone. The allowed country identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the country

name

(semi-optional)

String

The name of the country

alternative_code

(semi-optional)

String

The alternative code of the retrieved country

two_character_code

(semi-optional)

String

 The two character code of the retrieved country


three_character_code

(semi-optional)

String

 The three character code of the retrieved country

notes

(optional)

StringThe notes of the phone

udf_string_1

(optional)

String

User Defined Field of type String

udf_string_2

(optional)

String

User Defined Field of type String

udf_string_3

(optional)

String

User Defined Field of type String

udf_string_4

(optional)

String

User Defined Field of type String

udf_string_5

(optional)

String

User Defined Field of type String

udf_string_6

(optional)

String

User Defined Field of type String

udf_string_7

(optional)

String

User Defined Field of type String

udf_string_8

(optional)

String

User Defined Field of type String

udf_float_1

(optional)

Float

User Defined Field of type Float

udf_float_2

(optional)

Float

User Defined Field of type Float

udf_float_3

(optional)

Float

User Defined Field of type Float

udf_float_4

(optional)

Float

User Defined Field of type Float

udf_date_1

(optional)

Date

User Defined Field of type Date

udf_date_2

(optional)

Date

User Defined Field of type Date

udf_date_3

(optional)

Date

User Defined Field of type Date

udf_date_4

(optional)

Date

User Defined Field of type Date

 accounts_receivable_payment_preference object parameter data

Name

Type

Description

account_holder

(optional)

String

The account holder of the retrieved payment preference

bank_account_number

(optional)

String

The bank account number of the retrieved payment preference

payment_preference_identifier

(mandatory)

Identifier  

The identifier of the payment preference to be added on account payment preference object. The allowed payment preference identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of payment preference

name 

(semi-optional)

String

The name of payment preference

alternative_code 

(semi-optional)

String

The alternative code of payment preference

bank_account_type_identifier

(optional)

Identifier 

The identifier of the bank account type to be added on account payment preference object. The allowed bank account type identifier fields are the following:

Name

Type

Description

id 

(semi-optional)

String

The ID of bank account type

name

(semi-optional)

String

The name of bank account type

alternative_code 

(semi-optional)

String

The alternative code of bank account type

bank_identifier

(optional)

Identifier 

The identifier of the bank to be added on account payment preference object. The allowed bank identifier fields are the following:

Name

Type

Description

id 

(semi-optional)

String

The ID of bank

name 

(semi-optional)

String

The name of bank

alternative_code 

(semi-optional)

String

The alternative code of bank

bank_branch_identifier

(optional)

Identifier 

The identifier of the bank branch to be added on account payment preference object. The allowed bank branch identifier fields are the following:

Name

Type

Description

id 

(semi-optional)

String

The ID of bank branch

name

(semi-optional)

String

The name of bank branch

alternative_code 

(semi-optional)

String

The alternative code of bank branch

notes

(optional)

String

The notes to be added on account payment preference object.

Available from CRM.COM R10.1.0


payment_medium_identifier

(optional)

String

The payment medium identifier to be added on account payment preference object.

Available from CRM.COM R11.0.0

state

(optional)

Boolean

Indicates if the retrieved payment preference is active or not. The supported values are ACTIVE or INACTIVE. If not specified then it is considered as active

Available from CRM.COM R15.0.0

payment_medium_type_identifier

(optional)

Payment Medium Type Identifier

The payment medium type to be added on account payment preference object. The allowed payment medium type identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the payment medium type

name

(semi-optional)

String

The name of the payment medium type

alternative_code

(semi-optional)

String

The alternative code of  the payment medium type

Available from CRM.COM R11.0.0

payment_medium_brand_identifier

(optional)

Payment Medium Brand Identifier

The payment medium brand to be added on account payment preference object. The allowed payment medium brand identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the payment medium brand

name

(semi-optional)

String

The name of the payment medium brand

alternative_code

(semi-optional)

String

The alternative code of  the payment medium brand

Available from CRM.COM R11.0.0

use_for_recurring_payments

(optional)

Boolean

Indicates if the specific Accounts Receivable Payment Preference will be used to automatically pay any unsettled bills allocated to the related accounts receivable. Applicable only if the Payment Preference is related to a Payment Gateway

Depracated from CRM.COM R16.0.0 (and replaced by opt_in_for_subscriptions). The parameter will still function but it will not be maintained

 opt_in_for_subscriptions

(optional)

 Boolean

Indicates if the specific Accounts Receivable Payment Preference will be used to automatically pay any unsettled bills allocated to the related accounts receivable, related to its subscriptions. Applicable only if the Payment Preference is related to a Payment Gateway or a Wallet

Available from CRM.COM R16.0.0

Wallet as a payment preference is available from CRM.COM R17.0.0


 opt_in_for_purchases

(optional)

 Boolean

Indicates if the specific Accounts Receivable Payment Preference will be used to automatically pay any unsettled bills allocated to the related accounts receivable, related to purchases. Applicable only if the Payment Preference is related to a Payment Gateway or a Wallet

Available from CRM.COM R16.0.0

Wallet as a payment preference is available from CRM.COM R17.0.0


iban

(optional)

String

The international bank account number

Applicable only for payment preferences of type DIRECT_DEBIT, GENERIC_PAYMENT_GATEWAY, OTHER, CUSTOM_1, CUSTOM_2, CUSTOM_3, CUSTOM_4, CUSTOM_5, as specified through the configuration

Available from CRM.COM R13.1.0

business_identifier_code

(optional)

String

The business identifier code that identifies the bank (supports 8 or 11 alphanumeric characters)

Applicable only for payment preferences of type DIRECT_DEBIT, GENERIC_PAYMENT_GATEWAY, OTHER, CUSTOM_1, CUSTOM_2, CUSTOM_3, CUSTOM_4, CUSTOM_5, as specified through the configuration

Available from CRM.COM R13.1.0

unique_mandate_reference

(optional)

Number

The unique reference, which identifies a mandate that was signed by a Debtor for any given Creditor (supports up to 35 alphanumeric characters)

Applicable only for payment preferences of type DIRECT_DEBIT, GENERIC_PAYMENT_GATEWAY, OTHER, CUSTOM_1, CUSTOM_2, CUSTOM_3, CUSTOM_4, CUSTOM_5, as specified through the configuration

Available from CRM.COM R13.1.0

mandate_signing_date

(optional)

Date

The date that the mandate was signed

Applicable only for payment preferences of type DIRECT_DEBIT, GENERIC_PAYMENT_GATEWAY, OTHER, CUSTOM_1, CUSTOM_2, CUSTOM_3, CUSTOM_4, CUSTOM_5, as specified through the configuration

Available from CRM.COM R13.1.0

mandate_termination_date

(optional)

Date

The date that the mandate will be terminated. No payments should be send after that date (inclusive)

Applicable only for payment preferences of type DIRECT_DEBIT, GENERIC_PAYMENT_GATEWAY, OTHER, CUSTOM_1, CUSTOM_2, CUSTOM_3, CUSTOM_4, CUSTOM_5, as specified through the configuration

Available from CRM.COM R13.1.0

gateway_payment_method_token

(optional)

String

The token of the payment gateway payment method that will be registered (defines payment methods other than cards)

Available from CRM.COM R14.2.0


cards_set

(mandatory on conditions)

Set of Payment Gateway Cards Objects

The cards that are related with the Accounts Receivable Payment Preference, in case the payment preference is related with a payment gateway such as Stripe. This information is applicable only if the payment preference is related with a payment gateway. In that case it is mandatory to specify at least one card, which also needs to be set as the default card

If no records are specified in the set then nothing will be updated. To update a record use "action" : "update". To remove a record use "action" : "remove". To add a record use "action" : "add". Different actions can be used within the same set. For example:

"set": [
	   		{
            	"action": "update",
            	...........
        	},
			{
            	"action": "remove",
            	...........
			},
			{
            	"action": "add",
            	...........
			}
		]

Referred Objects Response Data

 payment_gateway_card_parameters object data

Name

Type

Description

number

(semi-optional)

String

The card's number, which should be a 16 digits number

For releases prior CRM.COM R14.2.0, this parameter is mandatory

last_digits

(semi-optional)

Number

The card last 4 digits

Available from CRM.COM R14.2.0

expiration_month

(mandatory)

NumberThe card's expiration month, which can be from 1 to 12

expiration_year

(mandatory)

NumberThe card's expiration year which should be a 4 digits number

card_security_code

(optional)

Number

The security code of the card, which should be a 3 digits number

From CRM.COM R14.2.0, this parameter is optional

card_holder_name

(mandatory)

StringThe card holders name, as provided during the registration of the card

brand

(mandatory on conditions)

String

The card's brand, as provided by the payment gateway provider. The supported brands by the payment gateway are the following:

  • Stripe: VISA, AMERICAN_EXPRESS, MASTER_CARD, DISCOVER, JCB, DINERS_CLUB, UNKNOWN
  • Braintree: VISA, AMERICAN_EXPRESS, MAESTRO, MASTER_CARD, DISCOVER, JCB, DINERS_CLUB
  • Payeezy: VISA, AMERICAN_EXPRESS, MASTER_CARD, DISCOVER
  • Swedbank: VISA, MAESTRO, MASTER_CARD

This attribute is mandatory for Payeezy Payment Gateway

Available from CRM.COM R14.3.0


same_as_billing_address

(optional)

Boolean

Sets the card's billing address same as the account's receivable billing address

Available from CRM.COM R14.3.0

address_line_1

(optional)

StringInformation related with the card's billing address

address_line_2

(optional)

StringInformation related with the card's billing address

address_city

(optional)

StringInformation related with the card's billing address

address_zip

(optional)

StringInformation related with the card's billing address

address_state

(optional)

StringInformation related with the card's billing address

address_country

(optional)

StringInformation related with the card's billing address

card_token

(optional)

String

The token of the card that will be registered

Available from CRM.COM R14.2.0

consumer_token

(optional)

String

The consumer token of the card that will be registered

Available from CRM.COM R14.26.0

default

(mandatory)

BooleanIt defines the default payment gateway card that should be used while automatically creating payments against that specific accounts receivable. The default card is also set on payments done using the specific payment preference, although the user can modify this information, by selecting an additional card. 

 access_token_parameters object data

Name

Type

Description

action

(mandatory)

String

Defines if a new or existing access token should be used. The supported values are the following:

ADD_NEW, ADD_EXISTING

The NEW option can be used only if access tokens are allowed to be created on creating reward participants, as specified in access token definitions

access_token_identifier

(mandatory on conditions)

Access Token identifier

An existing access token that should be used. This is applicable and mandatory if the action is set to EXISTING. Only effective access tokens can be used. The allowed access token identifier fields are the following:

Name

Type

Description

authentication_code

(semi-optional)

String

The authentication code of the access token

identifier

(semi-optional)

StringThe identifier of the access token. If the identifier is specified then it will be validated against the specified pass code

pass_code

(mandatory on conditions)

StringThe pass code of the access token, which is applicable and mandatory if the identifier is specified

authentication_code

(mandatory on conditions)

String

The authentication code of the access token that will be created. This information is not mandatory if set to be generated automatically, in the definition or the classification. Applicable only if the action is set to ADD_NEW

identifier

(mandatory on conditions)

String

The identifier of the access token that will be created. This information is not mandatory if the system is set up to allow creating access tokens with no identifier and pass code. Applicable only if the action is set to ADD_NEW

pass_code

(mandatory on conditions)

StringThe pass code of the access token that will be created. This information is not mandatory if the system is set up to allow creating access tokens with no identifier and pass code, although it is always mandatory if an identifier was specified. Applicable only if the action is set to ADD_NEW

classification_identifier

(optional)

Access Token Classification Identifier

 The identifier of the access token classification that will be related with the access token. The allowed access token classification identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the classification

name

(semi-optional)

String

The name of the classification

alternative_code

(semi-optional)

String

The alternative code of  the classification

Available from CRM.COM R10.0.0

card_masked_number

(optional)

String

The masked number of the credit card that will be related to the access token

  • Applicable only when the authentication code is related with a credit card

Available from CRM.COM R16.2.0

udf_string_1

(optional)

String

User Defined Field of type String. Applicable only if the action is set to ADD_NEW

Available from CRM.COM R10.1.0

udf_string_2

(optional)

String

User Defined Field of type String. Applicable only if the action is set to ADD_NEW

Available from CRM.COM R10.1.0

udf_string_3

(optional)

String

User Defined Field of type String. Applicable only if the action is set to ADD_NEW

Available from CRM.COM R10.1.0

udf_string_4

(optional)

String

User Defined Field of type String. Applicable only if the action is set to ADD_NEW

Available from CRM.COM R10.1.0

udf_string_5

(optional)

String

User Defined Field of type String. Applicable only if the action is set to ADD_NEW

Available from CRM.COM R10.1.0

udf_string_6

(optional)

String

User Defined Field of type String. Applicable only if the action is set to ADD_NEW

Available from CRM.COM R10.1.0

udf_string_7

(optional)

String

User Defined Field of type String. Applicable only if the action is set to ADD_NEW

Available from CRM.COM R10.1.0

udf_string_8

(optional)

String

User Defined Field of type String. Applicable only if the action is set to ADD_NEW

Available from CRM.COM R10.1.0

udf_float_1

(optional)

Float

User Defined Field of type Float. Applicable only if the action is set to ADD_NEW

Available from CRM.COM R10.1.0

udf_float_2

(optional)

Float

User Defined Field of type Float. Applicable only if the action is set to ADD_NEW

Available from CRM.COM R10.1.0

udf_float_3

(optional)

Float

User Defined Field of type Float. Applicable only if the action is set to ADD_NEW

Available from CRM.COM R10.1.0

udf_float_4

(optional)

Float

User Defined Field of type Float. Applicable only if the action is set to ADD_NEW

Available from CRM.COM R10.1.0

udf_date_1

(optional)

Date

User Defined Field of type Date. Applicable only if the action is set to ADD_NEW

Available from CRM.COM R10.1.0

udf_date_2

(optional)

Date

User Defined Field of type Date. Applicable only if the action is set to ADD_NEW

Available from CRM.COM R10.1.0

udf_date_3

(optional)

Date

User Defined Field of type Date. Applicable only if the action is set to ADD_NEW

Available from CRM.COM R10.1.0

udf_date_4

(optional)

Date

User Defined Field of type Date. Applicable only if the action is set to ADD_NEW

Available from CRM.COM R10.1.0

 time period parameter object data

Name

Type

Description

time_period_value

(mandatory)

Number

The time period value

time_period_uot

(mandatory)

String

The time period unit of time

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

 job_billing_terms object parameter data

Name

Type

Description

billing_term_scheme_identifier

(mandatory)

Billing term scheme identifier

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

Name

Type

Description

id

(semi-optional)

String

The ID of the billing term scheme

code

(semi-optional)

String

The code of the billing term scheme

price_plan_identifier

(mandatory on conditions)

Price plan identifier

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

Name

Type

Description

id

(semi-optional)

String

The ID of the price plan

code

(semi-optional)

String

The code of the price plan

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

agreement_date

(mandatory)

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

concurrent_usage_based_pricing

(mandatory on conditions)

Concurrent usage based pricing object

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

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

Referred Objects Response Data

 

 concurrent_usage_based_pricing object parameter data

Name

Type

Description

concurrent_usage

(mandatory)

Number

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

Deprecated from CRM.COM R15.0.0

rate_percentage

(mandatory)

Number

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

Deprecated from CRM.COM R15.0.0

number_of_installed_items

(mandatory on conditions)

Number

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

Available from CRM.COM R15.0.0

concurrent_usage_billing_method

(mandatory)

String

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

  • BASED_ON_NUMBER_OF_INSTALLED_ITEMS
  • BASED_ON_MAXIMUM_CAPACITY
  • BASED_ON_ACTUAL_CAPACITY

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

Available from CRM.COM R15.0.0

 assigned_to object parameter data
Name
Type
Description
user_identifier

(semi-optional)

User Identifier  

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

Name

Type

Description

id

(semi-optional)

String

The ID of the user

username

(semi-optional)

String

The username of the user

business_unit_identifier

(semi-optional)

Business Unit Identifier 

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

Name

Type

Description

id

(semi-optional)

String

The ID of the business unit

name

(semi-optional)

String

The code of the business unit

code

(semi-optional)

String

The code of the business unit

Available from CRM.COM R18.0.0

unit_identifier

(semi-optional)

Unit Identifier 

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

Name

Type

Description

id

(semi-optional)

String

The ID of the Unit

name

(semi-optional)

String

The name of the Unit

alternative_code

(semi-optional)

String

The alternative code of  the Unit

Deprecated from CRM.COM R18.0.0

 job_requested_physical_good object parameter data

Name

Type

Description

product_identifier
(mandatory)

Product Identifier

The identifier of the physical good related with the requested physical good. The allowed physical good product identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the product

code

(semi-optional)

String

The code of the product

alternative_code

(semi-optional)

String

The alternative code of  the product

quantity
(optional)

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

notes

(optional)

String

The notes of the retrieved job requested physical goods

Available form CRM.COM R12.3.0

components_set

(applicable on conditions)

Set of Product Components objects

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

Available form CRM.COM R12.3.0

Referred Parameter Objects Data

 product component object parameter data
Name
Type
Description
product_identifier

(mandatory)

Product identifier  

The identifier of the product component. Only products that are allowed to be added on the related flexible product bundle are retrieved. The allowed product identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the product

code

(semi-optional)

String

The code of the product

alternative_code

(semi-optional)

String

The alternative code of  the product

 job_requested_expense object parameter data
Name
Type
Description
product_identifier

(mandatory)

Identifier  

The identifier of the product related with the job requested expense. The allowed product identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the product

code

(semi-optional)

String

The code of the product

alternative_code

(semi-optional)

String

The alternative code of  the product


 job_requested_activity_service object parameter data

Name

Type

Description

activity_type_identifier

(mandatory)

Activity Type Identifier

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

Name

Type

Description

id

(semi-optional)

String

The ID of the activity type

name

(semi-optional)

String

The code of the activity type

alternative_code

(semi-optional)

String

The alternative code of  the activity type

product_identifier
(mandatory)

Product Identifier

The identifier of the product related with the requested activity service. The allowed product identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the product

code

(semi-optional)

String

The code of the product

alternative_code

(semi-optional)

String

The alternative code of  the product

Restrictions

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

Response Data

Name

Type

Description

id

String

The ID of the retrieved job

number

String

The number of the retrieved job 

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

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

contact_phoneString

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

life_cycle_state

String

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

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

The date on which the job expires.

Available from CRM.COM R13.0.0

rating_stateString 

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

amount_to_be_paid_through_wallet Float

  The amount that the customer was intending to use from his wallet in order to pay for the specific job

Available from CRM.COM R14.4.0

amount_already_paidFloat

The amount that was already paid for that job, calculated dynamically based on the payments that were submitted against that job

Available from CRM.COM R14.4.0

items_receipt_method String Determines if the customer prefers the job physical goods to be send to him at the specified delivery address, to pick them up from a specific unit or in any other way. The supported options are the following:
  • DELIVERY
  • PICK_UP
  • OTHER

Available from CRM.COM R14.4.0

udf_string_1

String

User Defined Field of type String

udf_string_2

String

User Defined Field of type String

udf_string_3

String

User Defined Field of type String

udf_string_4

String

User Defined Field of type String

udf_string_5

String

User Defined Field of type String

udf_string_6

String

User Defined Field of type String

udf_string_7

String

User Defined Field of type String

udf_string_8

String

User Defined Field of type String

udf_float_1

Float

User Defined Field of type Float

udf_float_2

Float

User Defined Field of type Float

udf_float_3

Float

User Defined Field of type Float

udf_float_4

Float

User Defined Field of type Float

udf_date_1

Date

User Defined Field of type Date

udf_date_2

Date

User Defined Field of type Date

udf_date_3

Date

User Defined Field of type Date

udf_date_4

Date

User Defined Field of type Date

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

The service request that was related to the retrieved job.

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

accounts_receivable

Accounts Receivable object

The accounts receivable related with the specified job

pricing_agreement_price_planPrice Plan Object

The pricing agreement that was assigned against an Accounts Receivable

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

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

Available from CRM.COM R14.0.0

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

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

owned_by_groupGroup ObjectThe group that is owning the job
privacy_levelPrivacy Level ObjectThe job privacy level
cloned_jobJob Object

The job that was cloned in order to create the new job

This is applicable only if the job is a clone of another job

Available on CRM.COM 12.4.0 and from CRM.COM 13.1.0

log_information

Log Information Object

The log information related to the retrieved job

pick_up_unit

 Unit object

 The identifier of the unit that the customer requested to pick up the job physical goods from

Available from CRM.COM R14.4.0

requested_physical_goods_setSet of Requested Physical Goods Objects

The physical goods that were requested by the retrieved job

requested_expenses_setSet of Requested Expenses Objects

The expenses that were requested by the retrieved job

requested_activity_services_setSet of Requested Activity Services Objects

The activity services that were requested by the retrieved job

physical_goods_setSet of Physical Goods Objects

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

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

Set of Bill Objects

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

Referred Objects Response Data

 assigned_to object response data

Name

Type

Description

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

The business unit which is assigned with the retrieved activity

Available from CRM.COM R18.0.0

unitUnit object

The unit which is assigned with the retrieved activity 

Deprecated from CRM.COM R18.0.0

Referred Objects Response Data

 user object response data

Name

Type

Description

id

String

The ID of the retrieved user

username

String

The user name of the retrieved user

person_name

String

The full name of the retrieved user

email

String

The email of the retrieved user

 business unit object response data

Name

Type

Description

id

String

The ID of the retrieved business unit

name

String

The name of the retrieved business unit

codeStringThe code of the retrieved business unit
unified_codeString

The unified code of the retrieved business unit

description

String

The description of the retrieved business unit

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

 unit object response data

Name

Type

Description

id

String

The ID of the retrieved unit

name

String

The name of the retrieved unit

group_name

String

The name of the group that the retrieved unit belongs to

community_name

String

The name of the community that the retrieved unit belongs to

alternative_code

String

The alternative code of the retrieved unit

description

String

The description of the retrieved unit

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

The billing directive of the retrieved job type

The supported billing directive options are

  • BILLABLE
  • NOT_BILLABLE

Available from CRM.COM R10.0.0

billing_methodString

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

The supported billing methods are

  • BILL_ON_STARTING_PROGRESS
  • BILL_ON_COMPLETION

Available from CRM.COM R10.0.0

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

fulfillment_scopeString

The fulfillment scope of the retrieved job type

The supported fulfillment scopes are

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

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

ACTIVATE_SUBSCRIPTION, DEACTIVATE_SUBSCRIPTION, CANCEL_SUBSCRIPTION, ADD_SUBSCRIPTION_SERVICES, CANCEL_SUBSCRIPTION_SERVICES, CHANGE_SUBSCRIPTION_LOCATION

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

SWAP_SUBSCRIPTION_SERVICES, SWAP_SUBSCRIPTION_INSTALLED_ITEMS

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

REPLACE_PHYSICAL_GOODS

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

fulfillment_methodString

The fulfillment method of the retrieved job type

The supported fulfillment methods are

  • BASED_ON_ORDERED_ITEMS
  • BASED_ON_DELIVERED_ITEMS

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

 job_billing_terms object response data

Name

Type

Description

id

String

The ID of the retrieved billing terms

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

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

Not available from CRM.COM R10.0.0 and onward

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

Referred Objects Response Data

 concurrent_usage_based_pricing object response data

Name

Type

Description

concurrent_usage

Number

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

Deprecated from CRM.COM R15.0.0

rate_percentage

Number

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

Deprecated from CRM.COM R15.0.0

number_of_installed_itemsNumber

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

Available from CRM.COM R15.0.0

 concurrent_usage_billing_methodString

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

  • BASED_ON_NUMBER_OF_INSTALLED_ITEMS,
  • BASED_ON_MAXIMUM_CAPACITY
  • BASED_ON_ACTUAL_CAPACITY

Available from CRM.COM R15.0.0


 billing_term_scheme object response data

Name

Type

Description

id

String

The ID of the retrieved billing term scheme

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

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

DRAFT, EFFECTIVE, TERMINATED

classificationString

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

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

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

billing_typeString

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

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

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

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

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

The Expiration Date of the retrieved price plan

currencyCurrency Object

The Currency of the retrieved price plan

Available from CRM.COM R14.2.0

Referred Objects Response Data

 currency object response data

Name

Type

Description

id

String

The ID of the retrieved currency

code

String

The code of the retrieved currency

prefix_symbolStringThe prefix symbol for the specified currency

suffix_symbol

StringThe suffix symbol for the specified currency
life_cycle_stateString

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

Available from CRM.COM R14.0.0

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

 

 

 job_status object response data

Name

Type

Description

id

String

The ID of the retrieved job status

name

String

The name of the retrieved job status

alternative_code

String

The alternative code of the retrieved job status

descriptionStringA description of the retrieved job status
life_cycle_stateString

The life cycle state related with the retrieved job status

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

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

 service_request object response data

Name

Type

Description

id

String

The ID of the retrieved service request

number

String

The number of the retrieved service request

descriptionStringThe description of the retrieved service request

life_cycle_state

String

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

accounts_receivable

Accounts Receivable object

The accounts receivable related with the specified service request


Referred Objects Response Data

 accounts_receivable object response data

Name

Type

Description

id

String

The ID of the retrieved accounts receivable

number

String

The number of the retrieved accounts receivable

nameStringThe name of the retrieved accounts receivable

life_cycle_state

String

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

ACTIVE, SUSPENDED, TERMINATED

account_ownerContact information objectThe contact information owning the accounts receivable

Referred Objects Response Data

 contact_information object response data

Name

Type

Description

id

String

The ID of the retrieved contact information

type

String

The type of the retrieved contact information which can be PERSON or COMPANY

life_cycle_state

String

The lifecycle state of the retrieved contact information which can be MARKETING or FINANCIAL

name

String

The full name of the retrieved contact information

first_name

String

The first name of the retrieved contact information

middle_name

String

The middle name of the retrieved contact information

last_name

String

The last name of the retrieved contact information

title

String

The title of the retrieved contact information

company_nameSting

The company name of the retrieved contact information

demographics

Demographics Object

The demographics information of the retrieved contact information

company_profile

Company profile object

The company profile of the retrieve contact information

Referred Objects Response Data

 demographics object response data

Name

Type

Description

gender

String

The gender of the retrieved contact information which can be MALE or FEMALE

id_number

String

The ID number of the retrieved contact information

id_number_expiration_dateDate

The ID number's expiration date of the retrieved contact information

Available from CRM.COM R14.0.0

passport_number

String

The passport number of the retrieved contact information

passport_number_expiration_dateDate

The passport's expiration date of the retrieved contact information

Available from CRM.COM R14.0.0

social_security_number

String

The social security number of the retrieved contact information

date_of_birth

Date of Birth Object

The date of birth of the retrieved contact information

name_day

Name Day Object

The name day of the retrieved contact information

country_of_residence

Country Object

The country of residence of the retrieved contact information

id_issued_by_country

Country Object

The ID issued country of retrieved contact information

passport_issued_by_country

Country Object

The passport  issued country of retrieved contact information

industry

Industry Object

The industry of retrieved contact information

industry_sector

Industry sector Object

The sector of retrieved contact information

Referred Objects Response Data

 date_of_birth object response data

Name

Type

Description

day

Integer

The day of the retrieved date of birth

month

Integer

The month of the retrieved date of birth

year

Integer

The year of the retrieved date of birth

 name_day object response data

Name

Type

Description

day

Integer

The day of the retrieved name day

month

Integer

The month of the retrieved name day

 country object response data

Name

Type

Description

id

String

The id of the retrieved country

name

String

The name of the retrieved country

alternative_codeString

The alternative code of the retrieved country

dialing_codeString

The dialing code of the retrieved country

Available from CRM.COM R15.1.0

two_character_codeString

The two character code of the retrieved country

three_character_codeString

The three character code of the retrieved country

country_flagImage Object

The flag of the retrieved country

Available from CRM.COM R15.1.0

Referred Objects Response Data

 country_flag object response data

Name

Type

Description

id

String

The ID of the retrieved country flag

fileFile ObjectThe information of the attached file

Referred Objects Response Data

 file object response data

 

Name

Type

Description

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

 industry object response data

Name

Type

Description

id

String

The id of the retrieved industry

name

String

The name of the retrieved industry

code

String

The code of the retrieved industry

 industry sector object response data

Name

Type

Description

id

String

The id of the retrieved industry sector

name

String

The name of the retrieved industry sector

alternative_code

String

The alternative code of the retrieved industry sector

 company profile object response data

Name

Type

Description

profile_year

Number

The profile year of the retrieved contact information

annual_turnover

Number

The annual turnover of the retrieved contact information

established_date

Date

The established date of the retrieved contact information

number_of_employeesNumber

The number of employees of the retrieved contact information

registration_number

String

The registration number of the retrieved contact information

vat_registration_numberString

The vat registration number of the retrieved contact information

vat_registered_byString

The vat registration by of the retrieved contact information

vat_registration_date

Date

The vat registration date of the retrieved contact information

tax_reference_numberString

The tax referenece number of the retrieved contact information

registered_in_country

Country Object

The country of residence of the retrieved contact information

industry

Industry Object

The industry of retrieved contact information

industry_sector

Industry sector Object

The sector of retrieved contact information

Referred Objects Response Data

 country object response data

Name

Type

Description

id

String

The id of the retrieved country

name

String

The name of the retrieved country

alternative_codeString

The alternative code of the retrieved country

dialing_codeString

The dialing code of the retrieved country

Available from CRM.COM R15.1.0

two_character_codeString

The two character code of the retrieved country

three_character_codeString

The three character code of the retrieved country

country_flagImage Object

The flag of the retrieved country

Available from CRM.COM R15.1.0

Referred Objects Response Data

 country_flag object response data

Name

Type

Description

id

String

The ID of the retrieved country flag

fileFile ObjectThe information of the attached file

Referred Objects Response Data

 file object response data

 

Name

Type

Description

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

 industry object response data

Name

Type

Description

id

String

The id of the retrieved industry

name

String

The name of the retrieved industry

code

String

The code of the retrieved industry

 industry sector object response data

Name

Type

Description

id

String

The id of the retrieved industry sector

name

String

The name of the retrieved industry sector

alternative_code

String

The alternative code of the retrieved industry sector

 period object response data

Name

Type

Description

time_period_valueNumber

The time period value

time_period_uot

String

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

MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS

 accounts_receivable object response data

Name

Type

Description

id

String

The ID of the retrieved accounts receivable

number

String

The number of the retrieved accounts receivable

nameStringThe name of the retrieved accounts receivable

life_cycle_state

String

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

ACTIVE, SUSPENDED, TERMINATED

account_ownerContact information objectThe contact information owning the accounts receivable

Referred Objects Response Data

 contact_information object response data

Name

Type

Description

id

String

The ID of the retrieved contact information

type

String

The type of the retrieved contact information which can be PERSON or COMPANY

life_cycle_state

String

The lifecycle state of the retrieved contact information which can be MARKETING or FINANCIAL

name

String

The full name of the retrieved contact information

first_name

String

The first name of the retrieved contact information

middle_name

String

The middle name of the retrieved contact information

last_name

String

The last name of the retrieved contact information

title

String

The title of the retrieved contact information

company_nameSting

The company name of the retrieved contact information

demographics

Demographics Object

The demographics information of the retrieved contact information

company_profile

Company profile object

The company profile of the retrieve contact information

Referred Objects Response Data

 demographics object response data

Name

Type

Description

gender

String

The gender of the retrieved contact information which can be MALE or FEMALE

id_number

String

The ID number of the retrieved contact information

id_number_expiration_dateDate

The ID number's expiration date of the retrieved contact information

Available from CRM.COM R14.0.0

passport_number

String

The passport number of the retrieved contact information

passport_number_expiration_dateDate

The passport's expiration date of the retrieved contact information

Available from CRM.COM R14.0.0

social_security_number

String

The social security number of the retrieved contact information

date_of_birth

Date of Birth Object

The date of birth of the retrieved contact information

name_day

Name Day Object

The name day of the retrieved contact information

country_of_residence

Country Object

The country of residence of the retrieved contact information

id_issued_by_country

Country Object

The ID issued country of retrieved contact information

passport_issued_by_country

Country Object

The passport  issued country of retrieved contact information

industry

Industry Object

The industry of retrieved contact information

industry_sector

Industry sector Object

The sector of retrieved contact information

Referred Objects Response Data

 date_of_birth object response data

Name

Type

Description

day

Integer

The day of the retrieved date of birth

month

Integer

The month of the retrieved date of birth

year

Integer

The year of the retrieved date of birth

 name_day object response data

Name

Type

Description

day

Integer

The day of the retrieved name day

month

Integer

The month of the retrieved name day

 country object response data

Name

Type

Description

id

String

The id of the retrieved country

name

String

The name of the retrieved country

alternative_codeString

The alternative code of the retrieved country

dialing_codeString

The dialing code of the retrieved country

Available from CRM.COM R15.1.0

two_character_codeString

The two character code of the retrieved country

three_character_codeString

The three character code of the retrieved country

country_flagImage Object

The flag of the retrieved country

Available from CRM.COM R15.1.0

Referred Objects Response Data

 country_flag object response data

Name

Type

Description

id

String

The ID of the retrieved country flag

fileFile ObjectThe information of the attached file

Referred Objects Response Data

 file object response data

 

Name

Type

Description

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

 industry object response data

Name

Type

Description

id

String

The id of the retrieved industry

name

String

The name of the retrieved industry

code

String

The code of the retrieved industry

 industry sector object response data

Name

Type

Description

id

String

The id of the retrieved industry sector

name

String

The name of the retrieved industry sector

alternative_code

String

The alternative code of the retrieved industry sector

 company profile object response data

Name

Type

Description

profile_year

Number

The profile year of the retrieved contact information

annual_turnover

Number

The annual turnover of the retrieved contact information

established_date

Date

The established date of the retrieved contact information

number_of_employeesNumber

The number of employees of the retrieved contact information

registration_number

String

The registration number of the retrieved contact information

vat_registration_numberString

The vat registration number of the retrieved contact information

vat_registered_byString

The vat registration by of the retrieved contact information

vat_registration_date

Date

The vat registration date of the retrieved contact information

tax_reference_numberString

The tax referenece number of the retrieved contact information

registered_in_country

Country Object

The country of residence of the retrieved contact information

industry

Industry Object

The industry of retrieved contact information

industry_sector

Industry sector Object

The sector of retrieved contact information

Referred Objects Response Data

 country object response data

Name

Type

Description

id

String

The id of the retrieved country

name

String

The name of the retrieved country

alternative_codeString

The alternative code of the retrieved country

dialing_codeString

The dialing code of the retrieved country

Available from CRM.COM R15.1.0

two_character_codeString

The two character code of the retrieved country

three_character_codeString

The three character code of the retrieved country

country_flagImage Object

The flag of the retrieved country

Available from CRM.COM R15.1.0

Referred Objects Response Data

 country_flag object response data

Name

Type

Description

id

String

The ID of the retrieved country flag

fileFile ObjectThe information of the attached file

Referred Objects Response Data

 file object response data

 

Name

Type

Description

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

 industry object response data

Name

Type

Description

id

String

The id of the retrieved industry

name

String

The name of the retrieved industry

code

String

The code of the retrieved industry

 industry sector object response data

Name

Type

Description

id

String

The id of the retrieved industry sector

name

String

The name of the retrieved industry sector

alternative_code

String

The alternative code of the retrieved industry sector

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

The Expiration Date of the retrieved price plan

currencyCurrency Object

The Currency of the retrieved price plan

Available from CRM.COM R14.2.0

Referred Objects Response Data

 currency object response data

Name

Type

Description

id

String

The ID of the retrieved currency

code

String

The code of the retrieved currency

prefix_symbolStringThe prefix symbol for the specified currency

suffix_symbol

StringThe suffix symbol for the specified currency
life_cycle_stateString

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

Available from CRM.COM R14.0.0

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

 address object response data

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

Name

Type

Description

id

String

The ID of the retrieved address

type

String

The type of the retrieved address which can be

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

postal_code

String

The postal code of the retrieved address

street_name

String

The street name of the retrieved address

street_number

String

The street number of the retrieved address

floor

Integer

The floor of the retrieved address

apartment_number

String

The apartment number of the retrieved address

area

String

The area of the retrieved address

town_city

String

The town / city of the retrieved address

district

String

The district of the retrieved address

municipality         

String

The municipality of the retrieved address

po_box

String

The PO box of the retrieved address

po_box_postal_code

String

The PO box postal code of the retrieved address

care_of

String

The care of person of the retrieved address

udf_string_1

String

User Defined Field of type String

udf_string_2

String

User Defined Field of type String

udf_string_3

String

User Defined Field of type String

udf_string_4

String

User Defined Field of type String

udf_string_5

String

User Defined Field of type String

udf_string_6

String

User Defined Field of type String

udf_string_7

String

User Defined Field of type String

udf_string_8

String

User Defined Field of type String

udf_string_9

String

User Defined Field of type String

udf_string_10

String

User Defined Field of type String

udf_string_11

String

User Defined Field of type String

udf_string_12

String

User Defined Field of type String

udf_string_13

String

User Defined Field of type String

udf_string_14

String

User Defined Field of type String

udf_string_15

String

User Defined Field of type String

udf_string_16

String

User Defined Field of type String

udf_float_1

Float

User Defined Field of type Float

udf_float_2

Float

User Defined Field of type Float

udf_float_3

Float

User Defined Field of type Float

udf_float_4

Float

User Defined Field of type Float

udf_date_1

Date

User Defined Field of type Date

udf_date_2

Date

User Defined Field of type Date

udf_date_3

Date

User Defined Field of type Date

udf_date_4

Date

User Defined Field of type Date

country

Country Object

The country of the retrieved address

is_primaryBoolean

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

Available from CRM.COM R15

 

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

Name

Type

Description

id

String

The ID of the retrieved address

type

String

The type of the retrieved address which can be

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

postal_code

String

The postal code of the retrieved address

town_city

String

The town / city of the retrieved address

address_line_1

String

The address line 1

address_line_2

String

 The address line 2

state_province_county

String

The state or province or county of the address.

udf_string_1

String

User Defined Field of type String

udf_string_2

String

User Defined Field of type String

udf_string_3

String

User Defined Field of type String

udf_string_4

String

User Defined Field of type String

udf_string_5

String

User Defined Field of type String

udf_string_6

String

User Defined Field of type String

udf_string_7

String

User Defined Field of type String

udf_string_8

String

User Defined Field of type String

udf_string_9

String

User Defined Field of type String

udf_string_10

String

User Defined Field of type String

udf_string_11

String

User Defined Field of type String

udf_string_12

String

User Defined Field of type String

udf_string_13

String

User Defined Field of type String

udf_string_14

String

User Defined Field of type String

udf_string_15

String

User Defined Field of type String

udf_string_16

String

User Defined Field of type String

udf_float_1

Float

User Defined Field of type Float

udf_float_2

Float

User Defined Field of type Float

udf_float_3

Float

User Defined Field of type Float

udf_float_4

Float

User Defined Field of type Float

udf_date_1

Date

User Defined Field of type Date

udf_date_2

Date

User Defined Field of type Date

udf_date_3

Date

User Defined Field of type Date

udf_date_4

Date

User Defined Field of type Date

country

Country Object

The country of the retrieved address

is_primaryBoolean

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

Available from CRM.COM R15

Referred Objects Response Data

 country object response data

Name

Type

Description

id

String

The id of the retrieved country

name

String

The name of the retrieved country

alternative_codeString

The alternative code of the retrieved country

dialing_codeString

The dialing code of the retrieved country

Available from CRM.COM R15.1.0

two_character_codeString

The two character code of the retrieved country

three_character_codeString

The three character code of the retrieved country

country_flagImage Object

The flag of the retrieved country

Available from CRM.COM R15.1.0

Referred Objects Response Data

 country_flag object response data

Name

Type

Description

id

String

The ID of the retrieved country flag

fileFile ObjectThe information of the attached file

Referred Objects Response Data

 file object response data

 

Name

Type

Description

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

 job_cancellation_reasons object response data

Name

Type

Description

id

String

The ID of the retrieved job cancellation reason

name

String

The name of the retrieved job cancellation reason

alternative_code

String

The alternative code of the retrieved job cancellation reason

descriptionStringA description of the retrieved job cancellation reason

 group object response data

Name

Type

Description

id

String

The ID of the retrieved group

name

String

The name of the retrieved group

community_name

String

The name of the community that the retrieved group belongs to

alternative_code

String

The alternative code of the retrieved group

unified_codeString

The unified code of the retrieved group

Available from CRM.COM R16.2.2

description

String

The description of the retrieved group

 privacy_level object response data

Name

Type

Description

id

String

The id of the retrieved privacy level

numberStringThe number of the retrieved privacy level

name

String

The name of the retrieved privacy level

hierarchy_level

String

The hierarchy level of the retrieved privacy level

 job object response data

Name

Type

Description

id

String

The ID of the retrieved job

number

String

The number of the retrieved job 

descriptionStringThe description of the retrieved job 

life_cycle_state

String

The life cycle state of the retrieved job

The supported options are

  • DRAFT
  • PENDING
  • IN PROGRESS
  • COMPLETED
  • CANCELLED
rating_stateString

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 related with the specified job

typeJob type object

The type information of the retrieved job

Available from CRM.COM R11.2.0


Referred Objects Response Data

 accounts_receivable object response data

Name

Type

Description

id

String

The ID of the retrieved accounts receivable

number

String

The number of the retrieved accounts receivable

nameStringThe name of the retrieved accounts receivable

life_cycle_state

String

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

ACTIVE, SUSPENDED, TERMINATED

account_ownerContact information objectThe contact information owning the accounts receivable

Referred Objects Response Data

 contact_information object response data

Name

Type

Description

id

String

The ID of the retrieved contact information

type

String

The type of the retrieved contact information which can be PERSON or COMPANY

life_cycle_state

String

The lifecycle state of the retrieved contact information which can be MARKETING or FINANCIAL

name

String

The full name of the retrieved contact information

first_name

String

The first name of the retrieved contact information

middle_name

String

The middle name of the retrieved contact information

last_name

String

The last name of the retrieved contact information

title

String

The title of the retrieved contact information

company_nameSting

The company name of the retrieved contact information

demographics

Demographics Object

The demographics information of the retrieved contact information

company_profile

Company profile object

The company profile of the retrieve contact information

Referred Objects Response Data

 demographics object response data

Name

Type

Description

gender

String

The gender of the retrieved contact information which can be MALE or FEMALE

id_number

String

The ID number of the retrieved contact information

id_number_expiration_dateDate

The ID number's expiration date of the retrieved contact information

Available from CRM.COM R14.0.0

passport_number

String

The passport number of the retrieved contact information

passport_number_expiration_dateDate

The passport's expiration date of the retrieved contact information

Available from CRM.COM R14.0.0

social_security_number

String

The social security number of the retrieved contact information

date_of_birth

Date of Birth Object

The date of birth of the retrieved contact information

name_day

Name Day Object

The name day of the retrieved contact information

country_of_residence

Country Object

The country of residence of the retrieved contact information

id_issued_by_country

Country Object

The ID issued country of retrieved contact information

passport_issued_by_country

Country Object

The passport  issued country of retrieved contact information

industry

Industry Object

The industry of retrieved contact information

industry_sector

Industry sector Object

The sector of retrieved contact information

Referred Objects Response Data

 date_of_birth object response data

Name

Type

Description

day

Integer

The day of the retrieved date of birth

month

Integer

The month of the retrieved date of birth

year

Integer

The year of the retrieved date of birth

 name_day object response data

Name

Type

Description

day

Integer

The day of the retrieved name day

month

Integer

The month of the retrieved name day

 country object response data

Name

Type

Description

id

String

The id of the retrieved country

name

String

The name of the retrieved country

alternative_codeString

The alternative code of the retrieved country

dialing_codeString

The dialing code of the retrieved country

Available from CRM.COM R15.1.0

two_character_codeString

The two character code of the retrieved country

three_character_codeString

The three character code of the retrieved country

country_flagImage Object

The flag of the retrieved country

Available from CRM.COM R15.1.0

Referred Objects Response Data

 country_flag object response data

Name

Type

Description

id

String

The ID of the retrieved country flag

fileFile ObjectThe information of the attached file

Referred Objects Response Data

 file object response data

 

Name

Type

Description

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

 industry object response data

Name

Type

Description

id

String

The id of the retrieved industry

name

String

The name of the retrieved industry

code

String

The code of the retrieved industry

 industry sector object response data

Name

Type

Description

id

String

The id of the retrieved industry sector

name

String

The name of the retrieved industry sector

alternative_code

String

The alternative code of the retrieved industry sector

 company profile object response data

Name

Type

Description

profile_year

Number

The profile year of the retrieved contact information

annual_turnover

Number

The annual turnover of the retrieved contact information

established_date

Date

The established date of the retrieved contact information

number_of_employeesNumber

The number of employees of the retrieved contact information

registration_number

String

The registration number of the retrieved contact information

vat_registration_numberString

The vat registration number of the retrieved contact information

vat_registered_byString

The vat registration by of the retrieved contact information

vat_registration_date

Date

The vat registration date of the retrieved contact information

tax_reference_numberString

The tax referenece number of the retrieved contact information

registered_in_country

Country Object

The country of residence of the retrieved contact information

industry

Industry Object

The industry of retrieved contact information

industry_sector

Industry sector Object

The sector of retrieved contact information

Referred Objects Response Data

 country object response data

Name

Type

Description

id

String

The id of the retrieved country

name

String

The name of the retrieved country

alternative_codeString

The alternative code of the retrieved country

dialing_codeString

The dialing code of the retrieved country

Available from CRM.COM R15.1.0

two_character_codeString

The two character code of the retrieved country

three_character_codeString

The three character code of the retrieved country

country_flagImage Object

The flag of the retrieved country

Available from CRM.COM R15.1.0

Referred Objects Response Data

 country_flag object response data

Name

Type

Description

id

String

The ID of the retrieved country flag

fileFile ObjectThe information of the attached file

Referred Objects Response Data

 file object response data

 

Name

Type

Description

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

 industry object response data

Name

Type

Description

id

String

The id of the retrieved industry

name

String

The name of the retrieved industry

code

String

The code of the retrieved industry

 industry sector object response data

Name

Type

Description

id

String

The id of the retrieved industry sector

name

String

The name of the retrieved industry sector

alternative_code

String

The alternative code of the retrieved industry sector

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

The billing directive of the retrieved job type

The supported billing directive options are

  • BILLABLE
  • NOT_BILLABLE

Available from CRM.COM R10.0.0

billing_methodString

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

The supported billing methods are

  • BILL_ON_STARTING_PROGRESS
  • BILL_ON_COMPLETION

Available from CRM.COM R10.0.0

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

fulfillment_scopeString

The fulfillment scope of the retrieved job type

The supported fulfillment scopes are

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

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

ACTIVATE_SUBSCRIPTION, DEACTIVATE_SUBSCRIPTION, CANCEL_SUBSCRIPTION, ADD_SUBSCRIPTION_SERVICES, CANCEL_SUBSCRIPTION_SERVICES, CHANGE_SUBSCRIPTION_LOCATION

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

SWAP_SUBSCRIPTION_SERVICES, SWAP_SUBSCRIPTION_INSTALLED_ITEMS

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

REPLACE_PHYSICAL_GOODS

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

fulfillment_methodString

The fulfillment method of the retrieved job type

The supported fulfillment methods are

  • BASED_ON_ORDERED_ITEMS
  • BASED_ON_DELIVERED_ITEMS

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

 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_requested_physical_good object response data

Name

Type

Description

id

String

The ID of the retrieved job requested physical good

quantityNumberThe quantity of the retrieved job requested physical good
notesString

The notes of the retrieved job requested physical goods

Available form CRM.COM R12.3.0

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

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

Available form CRM.COM R12.3.0

Referred Objects Response Data

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

alternative_code

String

The alternative code of product

description

String

The description of product

priority_levelInteger

The priority level of the product

Available from CRM.COM R12.3.0

global_rateGlobal Rate Object

The global rate of the retrieved product

Available from CRM.COM R15.0.0

product_typeProduct type objectThe type of the product

Referred Objects Response Data

 product_type object data response
NameType Description
IdStringThe ID of the retrieved product type
nameStringThe Name of the retrieved product type
alternative_codeStringThe Alternative Code of the retrieved product type
descriptionStringThe Description of the retrieved product type
classificationStringThe Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS
service_typeStringThe Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE
physical_good_typeStringThe physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE
composition_methodStringThe Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE
used_for_provisioningBooleanThe flag shows if the retrieved product type is used for provisioning
udr_typeUsage Detail Record TypeThe UDR type related with the product type. This is applicable only if the product type is classified as SERVICES and the service type is set to USAGE
meter_reading_typeMeter Reading Type

The Meter Reading type related with the product type. This is applicable only for traceable physical goods

Available from CRM.COM R14.0.0

Referred Objects Response Data

 usage_detail_record_type object data response
NameType Description
IdStringThe ID of the retrieved usage detail record type
nameStringThe Name of the retrieved usage detail record type
alternative_codeStringThe Alternative Code of the retrieved usage detail record type
descriptionStringThe Description of the retrieved usage detail record type
unit_of_measurementStringThe Unit of measurement of the retrieved usage detail record type

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe identifier of the Unit of measurement

name

String

The name of the Unit of measurement

description

String

The description of the Unit of measurement

alternative_codeStringThe alternative code of the Unit of measurement

 

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

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe identifier of the Unit of measurement

name

String

The name of the Unit of measurement

description

String

The description of the Unit of measurement

alternative_codeStringThe alternative code of the Unit of measurement

 global rate object response data

Name

Type

Description

id

String

The ID of the retrieved rate

rate_model

String

The price plan rate model which can be one of the following:

  • QUANTITYBASED
  • QUANTITYANDPERIODBASED
  • BILLABLEPERIODBASED
  • DURATIONBASED
  • FLATFEEBASED
  • USAGEBASED

From CRM.COM R17.0.0, QUANTITYANDMATURITYBASED is renamed to QUANTITYANDPERIODBASED

global_base_amountNumber

The base price of the product in the Global Price Plan

base_rate_applied_perString

The value for 'Base Rate Applied per'

Available when the rate model is 'Quantity & Quantity Based' and it is a selection between

  • Period
  • Period_Item
uotString

The 'UOT' applicable for the rate

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

Available for one-time services

time_periodTime Period Object

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

uomString

The 'UOM' applicable for the rate

Available when the product type is of Usage Service Classification 

Referred Objects Response Data

 period object response data

Name

Type

Description

time_period_valueNumber

The time period value

time_period_uot

String

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

MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS

 job_requested_expense object response data

Name

Type

Description

id

String

The ID of the retrieved job requested expense

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

Referred Objects Response Data

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

alternative_code

String

The alternative code of product

description

String

The description of product

priority_levelInteger

The priority level of the product

Available from CRM.COM R12.3.0

global_rateGlobal Rate Object

The global rate of the retrieved product

Available from CRM.COM R15.0.0

product_typeProduct type objectThe type of the product

Referred Objects Response Data

 product_type object data response
NameType Description
IdStringThe ID of the retrieved product type
nameStringThe Name of the retrieved product type
alternative_codeStringThe Alternative Code of the retrieved product type
descriptionStringThe Description of the retrieved product type
classificationStringThe Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS
service_typeStringThe Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE
physical_good_typeStringThe physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE
composition_methodStringThe Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE
used_for_provisioningBooleanThe flag shows if the retrieved product type is used for provisioning
udr_typeUsage Detail Record TypeThe UDR type related with the product type. This is applicable only if the product type is classified as SERVICES and the service type is set to USAGE
meter_reading_typeMeter Reading Type

The Meter Reading type related with the product type. This is applicable only for traceable physical goods

Available from CRM.COM R14.0.0

Referred Objects Response Data

 usage_detail_record_type object data response
NameType Description
IdStringThe ID of the retrieved usage detail record type
nameStringThe Name of the retrieved usage detail record type
alternative_codeStringThe Alternative Code of the retrieved usage detail record type
descriptionStringThe Description of the retrieved usage detail record type
unit_of_measurementStringThe Unit of measurement of the retrieved usage detail record type

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe identifier of the Unit of measurement

name

String

The name of the Unit of measurement

description

String

The description of the Unit of measurement

alternative_codeStringThe alternative code of the Unit of measurement

 

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

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe identifier of the Unit of measurement

name

String

The name of the Unit of measurement

description

String

The description of the Unit of measurement

alternative_codeStringThe alternative code of the Unit of measurement

 global rate object response data

Name

Type

Description

id

String

The ID of the retrieved rate

rate_model

String

The price plan rate model which can be one of the following:

  • QUANTITYBASED
  • QUANTITYANDPERIODBASED
  • BILLABLEPERIODBASED
  • DURATIONBASED
  • FLATFEEBASED
  • USAGEBASED

From CRM.COM R17.0.0, QUANTITYANDMATURITYBASED is renamed to QUANTITYANDPERIODBASED

global_base_amountNumber

The base price of the product in the Global Price Plan

base_rate_applied_perString

The value for 'Base Rate Applied per'

Available when the rate model is 'Quantity & Quantity Based' and it is a selection between

  • Period
  • Period_Item
uotString

The 'UOT' applicable for the rate

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

Available for one-time services

time_periodTime Period Object

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

uomString

The 'UOM' applicable for the rate

Available when the product type is of Usage Service Classification 

Referred Objects Response Data

 period object response data

Name

Type

Description

time_period_valueNumber

The time period value

time_period_uot

String

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

MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS

 job_requested_activity_service object response data

Name

Type

Description

id

String

The ID of the retrieved job requested activity service

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

Referred Objects Response Data

 activity_type object response data

Name

Type

Description

id

String

The ID of the retrieved activity type

name

String

The name of the retrieved activity type

alternative_code

String

The alternative code of the retrieved activity type

descriptionStringA description of the retrieved activity type

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

alternative_code

String

The alternative code of product

description

String

The description of product

priority_levelInteger

The priority level of the product

Available from CRM.COM R12.3.0

global_rateGlobal Rate Object

The global rate of the retrieved product

Available from CRM.COM R15.0.0

product_typeProduct type objectThe type of the product

Referred Objects Response Data

 product_type object data response
NameType Description
IdStringThe ID of the retrieved product type
nameStringThe Name of the retrieved product type
alternative_codeStringThe Alternative Code of the retrieved product type
descriptionStringThe Description of the retrieved product type
classificationStringThe Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS
service_typeStringThe Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE
physical_good_typeStringThe physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE
composition_methodStringThe Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE
used_for_provisioningBooleanThe flag shows if the retrieved product type is used for provisioning
udr_typeUsage Detail Record TypeThe UDR type related with the product type. This is applicable only if the product type is classified as SERVICES and the service type is set to USAGE
meter_reading_typeMeter Reading Type

The Meter Reading type related with the product type. This is applicable only for traceable physical goods

Available from CRM.COM R14.0.0

Referred Objects Response Data

 usage_detail_record_type object data response
NameType Description
IdStringThe ID of the retrieved usage detail record type
nameStringThe Name of the retrieved usage detail record type
alternative_codeStringThe Alternative Code of the retrieved usage detail record type
descriptionStringThe Description of the retrieved usage detail record type
unit_of_measurementStringThe Unit of measurement of the retrieved usage detail record type

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe identifier of the Unit of measurement

name

String

The name of the Unit of measurement

description

String

The description of the Unit of measurement

alternative_codeStringThe alternative code of the Unit of measurement

 

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

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe identifier of the Unit of measurement

name

String

The name of the Unit of measurement

description

String

The description of the Unit of measurement

alternative_codeStringThe alternative code of the Unit of measurement

 global rate object response data

Name

Type

Description

id

String

The ID of the retrieved rate

rate_model

String

The price plan rate model which can be one of the following:

  • QUANTITYBASED
  • QUANTITYANDPERIODBASED
  • BILLABLEPERIODBASED
  • DURATIONBASED
  • FLATFEEBASED
  • USAGEBASED

From CRM.COM R17.0.0, QUANTITYANDMATURITYBASED is renamed to QUANTITYANDPERIODBASED

global_base_amountNumber

The base price of the product in the Global Price Plan

base_rate_applied_perString

The value for 'Base Rate Applied per'

Available when the rate model is 'Quantity & Quantity Based' and it is a selection between

  • Period
  • Period_Item
uotString

The 'UOT' applicable for the rate

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

Available for one-time services

time_periodTime Period Object

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

uomString

The 'UOM' applicable for the rate

Available when the product type is of Usage Service Classification 

Referred Objects Response Data

 period object response data

Name

Type

Description

time_period_valueNumber

The time period value

time_period_uot

String

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

MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS

 job_physical_good object response data

Name

Type

Description

id

String

The ID of the retrieved physical good

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

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

Available form CRM.COM R12.3.0

Referred Objects Response Data

 installed item object response data

Name

Type

Description

id

String

The ID of the retrieved installed item

serial_number

String

The serial number of the retrieved installed item

alternative_code

String

The alternative code of the retrieved installed item

stateStringThe state of the retrieved installed item, which can be EFFECTIVE or NOT_EFFECTIVE
state_classificationState Classification object

The state classification of the retrieved installed item, which defines the reason why the installed item was set as Not Effective

Applicable only if the Installed Item was set as Not Effective through automation process

Available from CRM.COM R14.0.0

product

Product object

The product of the retrieved installed item

Referred Objects Response Data

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

alternative_code

String

The alternative code of product

description

String

The description of product

priority_levelInteger

The priority level of the product

Available from CRM.COM R12.3.0

global_rateGlobal Rate Object

The global rate of the retrieved product

Available from CRM.COM R15.0.0

product_typeProduct type objectThe type of the product

Referred Objects Response Data

 product_type object data response
NameType Description
IdStringThe ID of the retrieved product type
nameStringThe Name of the retrieved product type
alternative_codeStringThe Alternative Code of the retrieved product type
descriptionStringThe Description of the retrieved product type
classificationStringThe Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS
service_typeStringThe Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE
physical_good_typeStringThe physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE
composition_methodStringThe Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE
used_for_provisioningBooleanThe flag shows if the retrieved product type is used for provisioning
udr_typeUsage Detail Record TypeThe UDR type related with the product type. This is applicable only if the product type is classified as SERVICES and the service type is set to USAGE
meter_reading_typeMeter Reading Type

The Meter Reading type related with the product type. This is applicable only for traceable physical goods

Available from CRM.COM R14.0.0

Referred Objects Response Data

 usage_detail_record_type object data response
NameType Description
IdStringThe ID of the retrieved usage detail record type
nameStringThe Name of the retrieved usage detail record type
alternative_codeStringThe Alternative Code of the retrieved usage detail record type
descriptionStringThe Description of the retrieved usage detail record type
unit_of_measurementStringThe Unit of measurement of the retrieved usage detail record type

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe identifier of the Unit of measurement

name

String

The name of the Unit of measurement

description

String

The description of the Unit of measurement

alternative_codeStringThe alternative code of the Unit of measurement

 

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

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe identifier of the Unit of measurement

name

String

The name of the Unit of measurement

description

String

The description of the Unit of measurement

alternative_codeStringThe alternative code of the Unit of measurement

 global rate object response data

Name

Type

Description

id

String

The ID of the retrieved rate

rate_model

String

The price plan rate model which can be one of the following:

  • QUANTITYBASED
  • QUANTITYANDPERIODBASED
  • BILLABLEPERIODBASED
  • DURATIONBASED
  • FLATFEEBASED
  • USAGEBASED

From CRM.COM R17.0.0, QUANTITYANDMATURITYBASED is renamed to QUANTITYANDPERIODBASED

global_base_amountNumber

The base price of the product in the Global Price Plan

base_rate_applied_perString

The value for 'Base Rate Applied per'

Available when the rate model is 'Quantity & Quantity Based' and it is a selection between

  • Period
  • Period_Item
uotString

The 'UOT' applicable for the rate

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

Available for one-time services

time_periodTime Period Object

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

uomString

The 'UOM' applicable for the rate

Available when the product type is of Usage Service Classification 

Referred Objects Response Data

 period object response data

Name

Type

Description

time_period_valueNumber

The time period value

time_period_uot

String

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

MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS

 state classification object response data
Name
Type
Description
nameStringThe name of the installed item's state classification

alternative_code

String

The alternative code of the installed item's state classification

description

String

The description of the installed item's state classification

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

alternative_code

String

The alternative code of product

description

String

The description of product

priority_levelInteger

The priority level of the product

Available from CRM.COM R12.3.0

global_rateGlobal Rate Object

The global rate of the retrieved product

Available from CRM.COM R15.0.0

product_typeProduct type objectThe type of the product

Referred Objects Response Data

 product_type object data response
NameType Description
IdStringThe ID of the retrieved product type
nameStringThe Name of the retrieved product type
alternative_codeStringThe Alternative Code of the retrieved product type
descriptionStringThe Description of the retrieved product type
classificationStringThe Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS
service_typeStringThe Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE
physical_good_typeStringThe physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE
composition_methodStringThe Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE
used_for_provisioningBooleanThe flag shows if the retrieved product type is used for provisioning
udr_typeUsage Detail Record TypeThe UDR type related with the product type. This is applicable only if the product type is classified as SERVICES and the service type is set to USAGE
meter_reading_typeMeter Reading Type

The Meter Reading type related with the product type. This is applicable only for traceable physical goods

Available from CRM.COM R14.0.0

Referred Objects Response Data

 usage_detail_record_type object data response
NameType Description
IdStringThe ID of the retrieved usage detail record type
nameStringThe Name of the retrieved usage detail record type
alternative_codeStringThe Alternative Code of the retrieved usage detail record type
descriptionStringThe Description of the retrieved usage detail record type
unit_of_measurementStringThe Unit of measurement of the retrieved usage detail record type

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe identifier of the Unit of measurement

name

String

The name of the Unit of measurement

description

String

The description of the Unit of measurement

alternative_codeStringThe alternative code of the Unit of measurement

 

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

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe identifier of the Unit of measurement

name

String

The name of the Unit of measurement

description

String

The description of the Unit of measurement

alternative_codeStringThe alternative code of the Unit of measurement

 global rate object response data

Name

Type

Description

id

String

The ID of the retrieved rate

rate_model

String

The price plan rate model which can be one of the following:

  • QUANTITYBASED
  • QUANTITYANDPERIODBASED
  • BILLABLEPERIODBASED
  • DURATIONBASED
  • FLATFEEBASED
  • USAGEBASED

From CRM.COM R17.0.0, QUANTITYANDMATURITYBASED is renamed to QUANTITYANDPERIODBASED

global_base_amountNumber

The base price of the product in the Global Price Plan

base_rate_applied_perString

The value for 'Base Rate Applied per'

Available when the rate model is 'Quantity & Quantity Based' and it is a selection between

  • Period
  • Period_Item
uotString

The 'UOT' applicable for the rate

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

Available for one-time services

time_periodTime Period Object

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

uomString

The 'UOM' applicable for the rate

Available when the product type is of Usage Service Classification 

Referred Objects Response Data

 period object response data

Name

Type

Description

time_period_valueNumber

The time period value

time_period_uot

String

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

MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS

 job_expense object response data

Name

Type

Description

id

String

The ID of the retrieved job expense

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

Referred Objects Response Data

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

alternative_code

String

The alternative code of product

description

String

The description of product

priority_levelInteger

The priority level of the product

Available from CRM.COM R12.3.0

global_rateGlobal Rate Object

The global rate of the retrieved product

Available from CRM.COM R15.0.0

product_typeProduct type objectThe type of the product

Referred Objects Response Data

 product_type object data response
NameType Description
IdStringThe ID of the retrieved product type
nameStringThe Name of the retrieved product type
alternative_codeStringThe Alternative Code of the retrieved product type
descriptionStringThe Description of the retrieved product type
classificationStringThe Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS
service_typeStringThe Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE
physical_good_typeStringThe physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE
composition_methodStringThe Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE
used_for_provisioningBooleanThe flag shows if the retrieved product type is used for provisioning
udr_typeUsage Detail Record TypeThe UDR type related with the product type. This is applicable only if the product type is classified as SERVICES and the service type is set to USAGE
meter_reading_typeMeter Reading Type

The Meter Reading type related with the product type. This is applicable only for traceable physical goods

Available from CRM.COM R14.0.0

Referred Objects Response Data

 usage_detail_record_type object data response
NameType Description
IdStringThe ID of the retrieved usage detail record type
nameStringThe Name of the retrieved usage detail record type
alternative_codeStringThe Alternative Code of the retrieved usage detail record type
descriptionStringThe Description of the retrieved usage detail record type
unit_of_measurementStringThe Unit of measurement of the retrieved usage detail record type

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe identifier of the Unit of measurement

name

String

The name of the Unit of measurement

description

String

The description of the Unit of measurement

alternative_codeStringThe alternative code of the Unit of measurement

 

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

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe identifier of the Unit of measurement

name

String

The name of the Unit of measurement

description

String

The description of the Unit of measurement

alternative_codeStringThe alternative code of the Unit of measurement

 global rate object response data

Name

Type

Description

id

String

The ID of the retrieved rate

rate_model

String

The price plan rate model which can be one of the following:

  • QUANTITYBASED
  • QUANTITYANDPERIODBASED
  • BILLABLEPERIODBASED
  • DURATIONBASED
  • FLATFEEBASED
  • USAGEBASED

From CRM.COM R17.0.0, QUANTITYANDMATURITYBASED is renamed to QUANTITYANDPERIODBASED

global_base_amountNumber

The base price of the product in the Global Price Plan

base_rate_applied_perString

The value for 'Base Rate Applied per'

Available when the rate model is 'Quantity & Quantity Based' and it is a selection between

  • Period
  • Period_Item
uotString

The 'UOT' applicable for the rate

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

Available for one-time services

time_periodTime Period Object

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

uomString

The 'UOM' applicable for the rate

Available when the product type is of Usage Service Classification 

Referred Objects Response Data

 period object response data

Name

Type

Description

time_period_valueNumber

The time period value

time_period_uot

String

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

MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS

 activity object response data

Name

Type

Description

id

String

The ID of the retrieved activity

number

String

The number of the retrieved activity

life_cycle_state

String

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

PENDING, IN PROGRESS, COMPLETED, CANCELLED

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

Referred Objects Response Data

 contact_information object response data

Name

Type

Description

id

String

The ID of the retrieved contact information

type

String

The type of the retrieved contact information which can be PERSON or COMPANY

life_cycle_state

String

The lifecycle state of the retrieved contact information which can be MARKETING or FINANCIAL

name

String

The full name of the retrieved contact information

first_name

String

The first name of the retrieved contact information

middle_name

String

The middle name of the retrieved contact information

last_name

String

The last name of the retrieved contact information

title

String

The title of the retrieved contact information

company_nameSting

The company name of the retrieved contact information

demographics

Demographics Object

The demographics information of the retrieved contact information

company_profile

Company profile object

The company profile of the retrieve contact information

Referred Objects Response Data

 demographics object response data

Name

Type

Description

gender

String

The gender of the retrieved contact information which can be MALE or FEMALE

id_number

String

The ID number of the retrieved contact information

id_number_expiration_dateDate

The ID number's expiration date of the retrieved contact information

Available from CRM.COM R14.0.0

passport_number

String

The passport number of the retrieved contact information

passport_number_expiration_dateDate

The passport's expiration date of the retrieved contact information

Available from CRM.COM R14.0.0

social_security_number

String

The social security number of the retrieved contact information

date_of_birth

Date of Birth Object

The date of birth of the retrieved contact information

name_day

Name Day Object

The name day of the retrieved contact information

country_of_residence

Country Object

The country of residence of the retrieved contact information

id_issued_by_country

Country Object

The ID issued country of retrieved contact information

passport_issued_by_country

Country Object

The passport  issued country of retrieved contact information

industry

Industry Object

The industry of retrieved contact information

industry_sector

Industry sector Object

The sector of retrieved contact information

Referred Objects Response Data

 date_of_birth object response data

Name

Type

Description

day

Integer

The day of the retrieved date of birth

month

Integer

The month of the retrieved date of birth

year

Integer

The year of the retrieved date of birth

 name_day object response data

Name

Type

Description

day

Integer

The day of the retrieved name day

month

Integer

The month of the retrieved name day

 country object response data

Name

Type

Description

id

String

The id of the retrieved country

name

String

The name of the retrieved country

alternative_codeString

The alternative code of the retrieved country

dialing_codeString

The dialing code of the retrieved country

Available from CRM.COM R15.1.0

two_character_codeString

The two character code of the retrieved country

three_character_codeString

The three character code of the retrieved country

country_flagImage Object

The flag of the retrieved country

Available from CRM.COM R15.1.0

Referred Objects Response Data

 country_flag object response data

Name

Type

Description

id

String

The ID of the retrieved country flag

fileFile ObjectThe information of the attached file

Referred Objects Response Data

 file object response data

 

Name

Type

Description

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

 industry object response data

Name

Type

Description

id

String

The id of the retrieved industry

name

String

The name of the retrieved industry

code

String

The code of the retrieved industry

 industry sector object response data

Name

Type

Description

id

String

The id of the retrieved industry sector

name

String

The name of the retrieved industry sector

alternative_code

String

The alternative code of the retrieved industry sector

 company profile object response data

Name

Type

Description

profile_year

Number

The profile year of the retrieved contact information

annual_turnover

Number

The annual turnover of the retrieved contact information

established_date

Date

The established date of the retrieved contact information

number_of_employeesNumber

The number of employees of the retrieved contact information

registration_number

String

The registration number of the retrieved contact information

vat_registration_numberString

The vat registration number of the retrieved contact information

vat_registered_byString

The vat registration by of the retrieved contact information

vat_registration_date

Date

The vat registration date of the retrieved contact information

tax_reference_numberString

The tax referenece number of the retrieved contact information

registered_in_country

Country Object

The country of residence of the retrieved contact information

industry

Industry Object

The industry of retrieved contact information

industry_sector

Industry sector Object

The sector of retrieved contact information

Referred Objects Response Data

 country object response data

Name

Type

Description

id

String

The id of the retrieved country

name

String

The name of the retrieved country

alternative_codeString

The alternative code of the retrieved country

dialing_codeString

The dialing code of the retrieved country

Available from CRM.COM R15.1.0

two_character_codeString

The two character code of the retrieved country

three_character_codeString

The three character code of the retrieved country

country_flagImage Object

The flag of the retrieved country

Available from CRM.COM R15.1.0

Referred Objects Response Data

 country_flag object response data

Name

Type

Description

id

String

The ID of the retrieved country flag

fileFile ObjectThe information of the attached file

Referred Objects Response Data

 file object response data

 

Name

Type

Description

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

 industry object response data

Name

Type

Description

id

String

The id of the retrieved industry

name

String

The name of the retrieved industry

code

String

The code of the retrieved industry

 industry sector object response data

Name

Type

Description

id

String

The id of the retrieved industry sector

name

String

The name of the retrieved industry sector

alternative_code

String

The alternative code of the retrieved industry sector

 activity_type object response data

Name

Type

Description

id

String

The ID of the retrieved activity type

name

String

The name of the retrieved activity type

alternative_code

String

The alternative code of the retrieved activity type

descriptionStringA description of the retrieved activity type

 bill object response data

Name

Type

Description

id

String

The ID of the retrieved bill

number

String

The number of the retrieved bill

life_cycle_state

String

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

POSTED, PRESENTED, PRESENTED_CONFIRMED, PRESENTED_REJECTED

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

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

Available from CRM.COM R12.4.0

total_billed_amountNumberThe total billed amount
total_amount_to_be_paidNumberThe total amount to be paid
bill_statusString

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

SETTLED, UNSETTLED, PARTIALLY_SETTLED

currencyCurrency object

The bill's currency

Available from CRM.COM R10.0.0

Referred Objects Response Data

 currency object response data

Name

Type

Description

id

String

The ID of the retrieved currency

code

String

The code of the retrieved currency

prefix_symbolStringThe prefix symbol for the specified currency

suffix_symbol

StringThe suffix symbol for the specified currency
life_cycle_stateString

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

Available from CRM.COM R14.0.0

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

 log_information object response data

Name

Type

Description

created_date

Date

The date that the retrieved record was created

updated_date

Date

The last date that the retrieved record was updated

created_by_unit

Unit Object

The unit that created the retrieved record

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

Deprecated from CRM.COM R18.0.0

created_by_business_unit

Unit Object

The unit that created the retrieved record

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

Available from CRM.COM R18.0.0

created_by_user

User Object

The user that created the retrieved record

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

updated_by_unit

Unit Object

The last unit that updated the retrieved record

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

Deprecated from CRM.COM R18.0.0

updated_by_business_unit

Unit Object

The last unit that updated the retrieved record

Available from CRM.COM R18.0.0

updated_by_user

User Object

The last user that updated the retrieved record

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

Referred Objects Response Data

 unit object response data

Name

Type

Description

id

String

The ID of the retrieved unit

name

String

The name of the retrieved unit

group_name

String

The name of the group that the retrieved unit belongs to

community_name

String

The name of the community that the retrieved unit belongs to

alternative_code

String

The alternative code of the retrieved unit

description

String

The description of the retrieved unit

 business unit object response data

Name

Type

Description

id

String

The ID of the retrieved business unit

name

String

The name of the retrieved business unit

codeStringThe code of the retrieved business unit
unified_codeString

The unified code of the retrieved business unit

description

String

The description of the retrieved business unit

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

 user object response data

Name

Type

Description

id

String

The ID of the retrieved user

username

String

The user name of the retrieved user

person_name

String

The full name of the retrieved user

email

String

The email of the retrieved user

Examples

 Example 1

HTTP Method: POST 

Request:

Body:

{
"token":"556240FE3F49469F9A2C868A66DE5C05",
"type_identifier":{"name":"Installation Job 2"},
"status_identifier": {"name":"Draft"},
"accounts_receivable_identifier":{"number":"ACR001182"},
"contact_email":"m_antoniadou@crm.com",
"contact_phone":"99632587",
"notes":"Installation Job",
"start_date":"2016-07-27T15:30:00",
"location_identifier":{"type":"HOME"},
"owned_by_group_identifier":{"name":"Main Group"},
"estimated_completion_time":
{
    "time_period_value":2,
    "time_period_uot":"DAYS"
},
"billing_terms":
{
    "billing_term_scheme_identifier":{"code":"PJBTS"},
    "price_plan_identifier":{"code":"BPP0614"},
    "agreement_date":"2016-07-27T15:30:00"
},
"assigned_to":
{
    "user_identifier":{"username":"MPAdministrator"}
},
"requested_physical_goods_set":
[
    {
        "product_identifier":{"code":"Monitor"},
        "quantity":1
    },
    {
        "product_identifier":{"alternative_code":"T_1"}
    }
],
"requested_expenses_set":
[
    {
        "product_identifier":{"code":"Expence 1"}
    }
],
"requested_activity_services_set":
[
    {
        "activity_type_identifier":{"name":"Onside Deliveries"},
        "product_identifier":{"code":"Home Delivery"}
    }
]
}

Response:

 {
  "status": {
    "message": "",
    "description": "",
    "code": "OK"
  },
  "data": {
    "notes": "Marios Lannister\t27/7/2016 11:42:19\tInstallation Job",
    "requested_physical_goods_set": [
      {
        "id": "BF4383284F7845F4B1D680AB26D9141C",
        "quantity": 1,
        "product": {
          "product_type": {
            "service_type": null,
            "physical_good_type": "TRACEABLE",
            "used_for_provisioning": true,
            "classification": "PHYSICALGOODS",
            "composition_method": "FLAT",
            "id": "FA802647636A11B7B74B582A688B968D",
            "name": "Cameras",
            "description": "Cameras",
            "alternative_code": "CA"
          },
          "id": "1133F2CA7DEF919EB7328B2C32097152",
          "description": null,
          "code": "Monitor",
          "alternative_code": "MT"
        }
      },
      {
        "id": "F6986C8922D04E428F6353B12D4983DE",
        "quantity": 1,
        "product": {
          "product_type": {
            "service_type": null,
            "physical_good_type": "NONTRACEABLE",
            "used_for_provisioning": false,
            "classification": "PHYSICALGOODS",
            "composition_method": "FLAT",
            "id": "7E2B868514DC42FE8E253431F92C8FEE",
            "name": "STBControl",
            "description": null,
            "alternative_code": "S_1"
          },
          "id": "5BA4D41973AA4353852B1A284E8EDC91",
          "description": null,
          "code": "TV-Control",
          "alternative_code": "T_1"
        }
      }
    ],
    "billing_terms": {
      "binding_information": null,
      "agreement_date": "2016-07-27T00:00:00",
      "concurrent_usage_based_pricing": {
        "concurrent_usage": null,
        "rate_percentage": null
      },
      "billing_term_scheme": {
        "life_cycle_state": "EFFECTIVE",
        "billing_method": "PERIOD",
        "classification": "JOBS",
        "id": "9C0B2B52003EFEEE0864212F34D41229",
        "name": "P Job Billing Term Scheme",
        "code": "PJBTS",
        "billing_type": "NORMAL"
      },
      "effective_date": "2016-07-27T00:00:00",
      "billing_frequency": null,
      "id": "090E734D931044FE9F5B3D502ABEB638",
      "allowed_cancel_date": null,
      "expiration_date": null,
      "billing_cycle_day": null,
      "price_plan": {
        "effective_date": "2016-04-08T00:00:00",
        "type": "BASE",
        "id": "62F4D4E787AD4ACC895FD1D066037353",
        "name": "BPP0614",
        "description": "Base Price PLan June 14 for Subscription Test Case 6",
        "code": "BPP0614",
        "expiration_date": null
      }
    },
    "service_request": null,
    "udf_float_1": null,
    "udf_float_2": null,
    "udf_float_3": null,
    "number": "JOB000801",
    "udf_float_4": null,
    "udf_string_1": null,
    "assigned_to": {
      "unit": {
        "community_name": "Internal Community",
        "id": "48305F8849E3C18B227C5BE3A27BA6DF",
        "name": "Admin Unit",
        "group_name": "Main Group",
        "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
        "alternative_code": "MG"
      },
      "user": {
        "person_name": "Marios Lannister",
        "username": "MPAdministrator",
        "id": "1",
        "email": "sakkascy1986@hotmail.com"
      }
    },
    "udf_string_2": null,
    "privacy_level": null,
    "estimated_completion_time": {
      "time_period_value": 2,
      "time_period_uot": "DAYS"
    },
    "udf_string_3": null,
    "udf_string_4": null,
    "contact_phone": "99632587",
    "udf_string_5": null,
    "activities_set": [],
    "udf_string_6": null,
    "physical_goods_set": [],
    "udf_string_7": null,
    "udf_string_8": null,
    "accounts_receivable": {
      "account_owner": {
        "last_name": "Anton",
        "middle_name": "333",
        "life_cycle_state": "FINANCIAL",
        "company_profile": null,
        "title": "Mrs",
        "first_name": "Mara",
        "type": "PERSON",
        "id": "3358197AD0334CE2834DB60933B2CE88",
        "name": "Anton Mara",
        "company_name": null,
        "demographics": {
          "gender": "FEMALE",
          "passport_issued_by_country": null,
          "social_security_number": null,
          "passport_number": null,
          "industry_sector": null,
          "country_of_residence": {
            "three_character_code": "CYP",
            "two_character_code": "CY",
            "id": "181",
            "name": "CYPRUS",
            "alternative_code": null
          },
          "name_day": {
            "month": null,
            "day": null
          },
          "date_of_birth": {
            "month": null,
            "day": null,
            "year": null
          },
          "id_number": "568941",
          "industry": null,
          "id_issued_by_country": null
        }
      },
      "life_cycle_state": "ACTIVE",
      "number": "ACR001182",
      "id": "570169F05EF949E89FF987AD086A09BE",
      "name": "ACR001182"
    },
    "id": "91B21624D91B4CC183D7E86E82793779",
    "requested_activity_services_set": [
      {
        "activity_type": {
          "id": "CB7953F4D06C4135A794623C9F1620D8",
          "name": "Onside Deliveries",
          "description": null,
          "alternative_code": "OD"
        },
        "id": "FFA4F154E4AA4836AE090FF6D14B43F4",
        "product": {
          "product_type": {
            "service_type": "ONETIME",
            "physical_good_type": null,
            "used_for_provisioning": false,
            "classification": "SERVICES",
            "composition_method": "FIXEDBUNDLE",
            "id": "391D5E5E5F4F70FCA75C4D01ECAD0B6C",
            "name": "One Time Services - Fixed",
            "description": "One Time Services - Fixed",
            "alternative_code": "OTS-F_1"
          },
          "id": "2AEC889AEC884E83B67A1FF478E34FE0",
          "description": null,
          "code": "Home Delivery",
          "alternative_code": "H_D"
        }
      }
    ],
    "udf_date_1": null,
    "udf_date_2": null,
    "expected_completion_date": "2016-07-29T15:30:00",
    "udf_date_3": null,
    "udf_date_4": null,
    "start_date": "2016-07-27T15:30:00",
    "time_overdue": {
      "time_period_value": null,
      "time_period_uot": null
    },
    "time_to_completion": {
      "time_period_value": 2,
      "time_period_uot": "DAYS"
    },
    "rating_state": "PENDING",
    "requested_expenses_set": [
      {
        "id": "15E0E1408F424A27971A5A3599F1F4F3",
        "product": {
          "product_type": {
            "service_type": "EXPENSE",
            "physical_good_type": null,
            "used_for_provisioning": false,
            "classification": "SERVICES",
            "composition_method": "FLAT",
            "id": "67FA013211E348C58F7CD27F8399AADE",
            "name": "Expense Type",
            "description": null,
            "alternative_code": "ET"
          },
          "id": "2855ACFCB7D94ED69A5FC3B9557EB6D6",
          "description": "Expence 1",
          "code": "Expence 1",
          "alternative_code": "exp1"
        }
      }
    ],
    "log_information": {
      "updated_date": "2016-07-27T13:12:20",
      "created_date": "2016-07-27T13:12:19",
      "created_by_unit": {
        "community_name": "Internal Community",
        "id": "48305F8849E3C18B227C5BE3A27BA6DF",
        "name": "Admin Unit",
        "group_name": "Main Group",
        "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
        "alternative_code": "MG"
      },
      "updated_by_unit": {
        "community_name": "Internal Community",
        "id": "48305F8849E3C18B227C5BE3A27BA6DF",
        "name": "Admin Unit",
        "group_name": "Main Group",
        "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
        "alternative_code": "MG"
      },
      "created_by_user": {
        "person_name": "Marios Lannister",
        "username": "MPAdministrator",
        "id": "1"
      },
      "updated_by_user": {
        "person_name": "Marios Lannister",
        "username": "MPAdministrator",
        "id": "1"
      }
    },
    "owned_by_group": {
      "community_name": "Internal Community",
      "id": "84F33366CB592BAAE7E2044D93611C6A",
      "name": "Main Group",
      "description": "Main Group",
      "alternative_code": "MG1"
    },
    "status": {
      "life_cycle_state": "DRAFT",
      "id": "0F1EE97BD63642699FFAEB461F471147",
      "name": "Draft",
      "description": null,
      "alternative_code": "D"
    },
    "actual_completed_date": null,
    "location": {
      "udf_string_10": null,
      "street_number": "10",
      "care_of": null,
      "udf_string_11": null,
      "udf_float_1": null,
      "street_name": "Athaslassis",
      "udf_string_12": null,
      "udf_float_2": null,
      "udf_string_13": null,
      "udf_float_3": null,
      "udf_string_14": null,
      "udf_float_4": null,
      "udf_string_15": null,
      "udf_string_16": null,
      "po_box": null,
      "udf_string_1": null,
      "floor": 2,
      "udf_string_2": null,
      "area": null,
      "udf_string_3": null,
      "district": null,
      "udf_string_4": null,
      "udf_string_5": null,
      "udf_string_6": null,
      "udf_string_7": null,
      "state": "Active",
      "udf_string_8": null,
      "udf_string_9": null,
      "country": {
        "three_character_code": "CYP",
        "two_character_code": "CY",
        "id": "181",
        "name": "CYPRUS",
        "alternative_code": null
      },
      "id": "168CD026F5F74AFBA31CF02E291793AE",
      "postal_code": "2335",
      "udf_date_1": null,
      "udf_date_2": null,
      "udf_date_3": null,
      "udf_date_4": null,
      "po_box_postal_code": null,
      "apartment_number": "201",
      "town_city": null,
      "type": "HOME",
      "municipality": null
    },
    "life_cycle_state": "DRAFT",
    "type": {
      "fulfillment_method": "BASED_ON_ORDERED_ITEMS",
      "fulfillment_scope": "GENERIC_PURPOSE",
      "id": "98523D8F88354CFAA8BF66E51DEA0A40",
      "name": "Installation Job 2",
      "description": "Job for installing Smartcard and Set Top Box on Subscriber's house if requested",
      "alternative_code": "002"
    },
    "description": null,
    "contact_email": "m_antoniadou@crm.com",
    "expenses_set": [],
    "category": null
  }
}
 Example 2

HTTP Method: POST 

Request:

Body:

{
"token":"556240FE3F49469F9A2C868A66DE5C05",
"type_identifier":{"name":"L Jobs"},
"status_identifier": {"name":"Assigned"},
"accounts_receivable_identifier":{"number":"ACR001183"},
"contact_email":"m_antoniadou@crm.com",
"notes":"Generic Job",
"start_date":"2016-07-27T14:30:00",
"location_identifier":{"type":"BUSINESS"},
"owned_by_group_identifier":{"name":"Main Group"},
"estimated_completion_time":
{
    "time_period_value":1,
    "time_period_uot":"DAYS"
},
"billing_terms":
{
    "billing_term_scheme_identifier":{"code":"L Jobs All Price Plans"},
    "price_plan_identifier":{"code":"BPP0614"},
    "agreement_date":"2016-07-27T14:30:00"
},
"assigned_to":
{
    "unit_identifier":{"name":"Admin Unit"}
},
"requested_physical_goods_set":
[
    {
        "product_identifier":{"code":"Monitor"},
        "quantity":1
    },
    {
        "product_identifier":{"alternative_code":"TM"}
    }
],
"requested_expenses_set":
[
    {
        "product_identifier":{"code":"Expence 1"}
    }
],
"requested_activity_services_set":
[
    {
        "activity_type_identifier":{"name":"Customer Training"},
        "product_identifier":{"code":"Material Delivery"}
    },
    {
        "activity_type_identifier":{"name":"Customer Training"},
        "product_identifier":{"code":"Support"}
    }
],
"fields_set":"id,number,notes,expected_completion_date,type,status,location,owned_by_group,requested_physical_goods_set,requested_expenses_set,requested_activity_services_set"
}

Response:

 {
  "status": {
    "message": "",
    "description": "",
    "code": "OK"
  },
  "data": {
    "requested_activity_services_set": [
      {
        "activity_type": {
          "id": "09EE47872CF8414A98C2EC5655936BF5",
          "name": "Customer Training",
          "description": null,
          "alternative_code": "CT"
        },
        "id": "02C0A8EA0D404CB4BEF60DD168D8B825",
        "product": {
          "product_type": {
            "service_type": "ONETIME",
            "physical_good_type": null,
            "used_for_provisioning": false,
            "classification": "SERVICES",
            "composition_method": "FLAT",
            "id": "7EDF537A938DECAB1352E6EEAD54A5D0",
            "name": "One Time Services - Flat",
            "description": "A type which is used for one time services",
            "alternative_code": "OTS-F"
          },
          "id": "362AF22847BA4ED0CDED5CDFF8BABBC1",
          "description": "Delivery of Materials Service Charge",
          "code": "Material Delivery",
          "alternative_code": "MD"
        }
      },
      {
        "activity_type": {
          "id": "09EE47872CF8414A98C2EC5655936BF5",
          "name": "Customer Training",
          "description": null,
          "alternative_code": "CT"
        },
        "id": "416D876B6A90444EA31D796CA2ADAF4E",
        "product": {
          "product_type": {
            "service_type": "ONETIME",
            "physical_good_type": null,
            "used_for_provisioning": false,
            "classification": "SERVICES",
            "composition_method": "FLAT",
            "id": "7EDF537A938DECAB1352E6EEAD54A5D0",
            "name": "One Time Services - Flat",
            "description": "A type which is used for one time services",
            "alternative_code": "OTS-F"
          },
          "id": "2E1C3761B6701C1DC4652D5E1D826AD6",
          "description": null,
          "code": "Support",
          "alternative_code": "Support"
        }
      }
    ],
    "owned_by_group": {
      "community_name": "Internal Community",
      "id": "84F33366CB592BAAE7E2044D93611C6A",
      "name": "Main Group",
      "description": "Main Group",
      "alternative_code": "MG1"
    },
    "notes": "Marios Lannister\t27/7/2016 11:40:17\tGeneric Job",
    "requested_physical_goods_set": [
      {
        "id": "4D1FD0304B274C9EB46DA6B5BB0A25F9",
        "quantity": 1,
        "product": {
          "product_type": {
            "service_type": null,
            "physical_good_type": "TRACEABLE",
            "used_for_provisioning": true,
            "classification": "PHYSICALGOODS",
            "composition_method": "FLAT",
            "id": "249F5EA21B317E4B7BB6F696E7496F03",
            "name": "Modem",
            "description": "Modem",
            "alternative_code": "MODEM"
          },
          "id": "10E2DC528CC865A383FBB25A7DB97436",
          "description": null,
          "code": "Thomson Modem",
          "alternative_code": "TM"
        }
      },
      {
        "id": "DECEFDE283724836A0CE07A390DA988F",
        "quantity": 1,
        "product": {
          "product_type": {
            "service_type": null,
            "physical_good_type": "TRACEABLE",
            "used_for_provisioning": true,
            "classification": "PHYSICALGOODS",
            "composition_method": "FLAT",
            "id": "FA802647636A11B7B74B582A688B968D",
            "name": "Cameras",
            "description": "Cameras",
            "alternative_code": "CA"
          },
          "id": "1133F2CA7DEF919EB7328B2C32097152",
          "description": null,
          "code": "Monitor",
          "alternative_code": "MT"
        }
      }
    ],
    "status": {
      "life_cycle_state": "PENDING",
      "id": "JobStatus1",
      "name": "Assigned",
      "description": null,
      "alternative_code": "AS"
    },
    "location": {
      "udf_string_10": null,
      "street_number": "10",
      "care_of": null,
      "udf_string_11": null,
      "udf_float_1": null,
      "street_name": "Arsinoes",
      "udf_string_12": null,
      "udf_float_2": null,
      "udf_string_13": null,
      "udf_float_3": null,
      "udf_string_14": null,
      "udf_float_4": null,
      "udf_string_15": null,
      "udf_string_16": null,
      "po_box": null,
      "udf_string_1": null,
      "floor": 4,
      "udf_string_2": null,
      "area": null,
      "udf_string_3": null,
      "district": null,
      "udf_string_4": null,
      "udf_string_5": null,
      "udf_string_6": null,
      "udf_string_7": null,
      "state": "Active",
      "udf_string_8": null,
      "udf_string_9": null,
      "country": {
        "three_character_code": "CYP",
        "two_character_code": "CY",
        "id": "181",
        "name": "CYPRUS",
        "alternative_code": null
      },
      "id": "59A2696666C94730AFFCE58319B429E6",
      "postal_code": "1256",
      "udf_date_1": null,
      "udf_date_2": null,
      "udf_date_3": null,
      "udf_date_4": null,
      "po_box_postal_code": null,
      "apartment_number": "400",
      "town_city": null,
      "type": "BUSINESS",
      "municipality": null
    },
    "number": "JOB000800",
    "type": {
      "fulfillment_method": "BASED_ON_ORDERED_ITEMS",
      "fulfillment_scope": "GENERIC_PURPOSE",
      "id": "B0014F0386234D24806758951A4B389E",
      "name": "L Jobs",
      "description": null,
      "alternative_code": "L Jobs"
    },
    "expected_completion_date": "2016-07-28T14:30:00",
    "id": "81F2BC825CC340C7A972E1E8D9182447",
    "requested_expenses_set": [
      {
        "id": "2893537483D64253A618259F4B79FD0F",
        "product": {
          "product_type": {
            "service_type": "EXPENSE",
            "physical_good_type": null,
            "used_for_provisioning": false,
            "classification": "SERVICES",
            "composition_method": "FLAT",
            "id": "67FA013211E348C58F7CD27F8399AADE",
            "name": "Expense Type",
            "description": null,
            "alternative_code": "ET"
          },
          "id": "2855ACFCB7D94ED69A5FC3B9557EB6D6",
          "description": "Expence 1",
          "code": "Expence 1",
          "alternative_code": "exp1"
        }
      }
    ]
  }
}
  • No labels