POST subscriptions/change_subscriber

This method is changing the subscriber owning a specific subscription, to a new or existing accounts receivable owned by a different customer. The method can be applied on a single subscription only

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

subscription_identifier

(semi-optional)

Subscription identifier

The subscription to be modified. The allowed subscription identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of subscription

number

(semi-optional)

String

The number of subscription

For releases prior to CRM.COM R13.0.0 the subscription_identifier is mandatory

accounts_receivable_identifier

(semi-optional)

Accounts Receivable Identifier

The accounts receivable identifier that can be used to perform the subscription modification. 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

access_token_identifier

(semi-optional)

Access Token Identifier

The identifier of the access token which is related with the accounts receivable. Only effective access tokens can be used to identify an accounts receivable. 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)	String	The 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)	String	The pass code of the access token, which is applicable and mandatory if the identifier is specified
one_time_password (semi-optional)	Integer	The one-time password (OTP) of the access token Available from CRM.COM R13.0.0

Available from CRM.COM R8.0.0

Deprecated from CRM.COM R18.0.0

The ability to use the accounts_receivable_identifier instead of the subscription_identifier is applicable only when the specified Accounts Receivable owns only one Subscription

Available from CRM.COM R13.0.0

action_type_identifier

(optional)

Subscription action type identifier

The action type that should be used. The allowed subscription action type identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the subscription action type

name

(semi-optional)

String

The name of the subscription action type

alternative_code

(semi-optional)

String

The alternative code of the subscription action type

Deprecated from CRM.COM R15.0.0

sub_action_type_identifier

(optional)

Subscription sub action type identifier

The sub action type that should be used. The allowed subscription sub action type identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the subscription sub action type

name

(semi-optional)

String

The name of the subscription sub action type

alternative_code

(semi-optional)

String

The alternative code of the subscription sub action type

Deprecated from CRM.COM R15.0.0

transaction_reference_number

(optional)

String

The transaction reference number of the performed subscription action. The transaction reference number is unique against already submitted subscription actions.

Available from CRM.COM R13.0.0

performed_by_user_identifier

(optional)

User identifier

The user that actually performed the action. 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

performed_by_unit_identifier

(optional)

Unit Identifier

The unit that performed the action. 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

Available from CRM.COM R14.0.0

performed_on

(optional)

Date

The date that the action was actually performed

billing_effective_date

(optional)

Date

Determines when the subscription services that are affected by the subscription action should be billed by the billing engine.

billable_period_start_date

(optional)

Date

Determines the start date of the billable period of each subscription service (it answers to the question “from which date should I start billing this service) that is affected by the subscription action.

scheduled_date

(optional)

Date

The date that the action is scheduled to be executed. If not specified then the action will be executed immediately

Deprecated from CRM.COM R12.1.0. Such actions should never be scheduled even from CRM.COM R5.0.0

udf_string_1

(optional)

String

User Defined Field of type String

udf_string_2

(optional)

String

User Defined Field of type String

udf_string_3

(optional)

String

User Defined Field of type String

udf_string_4

(optional)

String

User Defined Field of type String

udf_string_5

(optional)

String

User Defined Field of type String

udf_string_6

(optional)

String

User Defined Field of type String

udf_string_7

(optional)

String

User Defined Field of type String

udf_string_8

(optional)

String

User Defined Field of type String

udf_float_1

(optional)

Float

User Defined Field of type Float

udf_float_2

(optional)

Float

User Defined Field of type Float

udf_float_3

(optional)

Float

User Defined Field of type Float

udf_float_4

(optional)

Float

User Defined Field of type Float

udf_date_1

(optional)

Date

User Defined Field of type Date

udf_date_2

(optional)

Date

User Defined Field of type Date

udf_date_3

(optional)

Date

User Defined Field of type Date

udf_date_4

(optional)

Date

User Defined Field of type Date

accounts_receivable

(mandatory)

Accounts Receivable Object

The accounts receivable that should own the subscription.

subscription_address

(mandatory)

Address object

The address of the subscription to be created

From CRM.COM R14.3.0, Subscription Address is mandatory based on the Accounts Receivable Definitions' Billing Address Rules

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

Available from CRM.COM R10.0.0

Referred Parameter Objects Data

change_subscriber_parameters 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)

String

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

notes

(optional)

String

The 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 starting 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)

Number

Credit 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

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

contact_information

(mandatory on conditions)

Contact information object

The 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

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

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

Name

Type

Description

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

Name

Type

Description

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)

String

The 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)	String	The 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 object

The 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

Name

Type

Description

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

Name

Type

Description

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

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)

String

Indicates 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 object

The 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)	String	The 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 object

The 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)

String

The 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)	Number	The card's expiration month, which can be from 1 to 12
expiration_year (mandatory)	Number	The 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)	String	The 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)	String	Information related with the card's billing address
address_line_2 (optional)	String	Information related with the card's billing address
address_city (optional)	String	Information related with the card's billing address
address_zip (optional)	String	Information related with the card's billing address
address_state (optional)	String	Information related with the card's billing address
address_country (optional)	String	Information 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)	Boolean	It 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.

subscription_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 subscription address. This is applicable and mandatory only if the action is set to EXISTING or EXISTINGUPDATED. The supported options are the following:

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

address

(mandatory on conditions)

Address object

The 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

Name

Type

Description

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

Name

Type

Description

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

Restrictions

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

Response Data

subscription action object response data

Name	Type	Description
id	String	The ID of the retrieved subscription action
number	String	The number of the retrieved subscription action
transaction_reference_number	String	The unique transaction reference number of the retrieved subscription action Available from CRM.COM R13.1.0
life_cycle_state	String	The life cycle state of the subscription action. One of the following values is returned: EXECUTED, EXECUTEDWITHERRORS, REJECTEDSYSTEMFAILURE, REJECTEDSYSTEMVALIDATION, SCHEDULED, CANCELLED From CRM.COM R15.0.0 the available life cycle states are: PENDING_VERIFICATION EXECUTED SCHEDULED CANCELLED REJECTED
classification	String	The classification that was provided when the subscription action was submitted. Available from CRM.COM R17.0.0
behavior_code	String	The behavior code of the subscription action
business_classification_code	String	The business classification code of the subscription action
scheduled_date	Date	The date that the subscription was scheduled to be executed
executed_on	Date	The date that the subscription action is executed
submitted_on	Date	The date that the business action was submitted into the system
performed_on	Date	The date that the business action was actually performed, which might be different than the date that was submitted into the system
udf_string_1	String	User Defined Field of type String Available from CRM.COM R14.2.0
udf_string_2	String	User Defined Field of type String Available from CRM.COM R14.2.0
udf_string_3	String	User Defined Field of type String Available from CRM.COM R14.2.0
udf_string_4	String	User Defined Field of type String Available from CRM.COM R14.2.0
udf_string_5	String	User Defined Field of type String Available from CRM.COM R14.2.0
udf_string_6	String	User Defined Field of type String Available from CRM.COM R14.2.0
udf_string_7	String	User Defined Field of type String Available from CRM.COM R14.2.0
udf_string_8	String	User Defined Field of type String Available from CRM.COM R14.2.0
udf_string_9	String	User Defined Field of type String Available from CRM.COM R14.2.0
udf_string_10	String	User Defined Field of type String Available from CRM.COM R14.2.0
udf_string_11	String	User Defined Field of type String Available from CRM.COM R14.2.0
udf_string_12	String	User Defined Field of type String Available from CRM.COM R14.2.0
udf_string_13	String	User Defined Field of type String Available from CRM.COM R14.2.0
udf_string_14	String	User Defined Field of type String Available from CRM.COM R14.2.0
udf_string_15	String	User Defined Field of type String Available from CRM.COM R14.2.0
udf_string_16	String	User Defined Field of type String Available from CRM.COM R14.2.0
udf_float_1	Float	User Defined Field of type Float Available from CRM.COM R14.2.0
udf_float_2	Float	User Defined Field of type Float Available from CRM.COM R14.2.0
udf_float_3	Float	User Defined Field of type Float Available from CRM.COM R14.2.0
udf_float_4	Float	User Defined Field of type Float Available from CRM.COM R14.2.0
udf_float_5	Float	User Defined Field of type Float Available from CRM.COM R14.2.0
udf_float_6	Float	User Defined Field of type Float Available from CRM.COM R14.2.0
udf_float_7	Float	User Defined Field of type Float Available from CRM.COM R14.2.0
udf_float_8	Float	User Defined Field of type Float Available from CRM.COM R14.2.0
udf_date_1	Date	User Defined Field of type Date Available from CRM.COM R14.2.0
udf_date_2	Date	User Defined Field of type Date Available from CRM.COM R14.2.0
udf_date_3	Date	User Defined Field of type Date Available from CRM.COM R14.2.0
udf_date_4	Date	User Defined Field of type Date Available from CRM.COM R14.2.0
submitted_by	User Object	The user that submitted the action into the system
performed_by	User Object	The user that actually performed the subscription action, which might be different than the user that submitted the action into the system
performed_by_unit	Unit Object	The unit that performed the subscription action Available from CRM.COM R14.0.0 Deprecated from CRM.COM R18.0.0
performed_by_business_unit	Business Unit Object	The business unit that performed the subscription action Available from CRM.COM R18.0.0
action_type	Subscription Action Type Object	The action type of the subscription action Deprecated from CRM.COM R15.0.0
sub_action_type	Subscription Sub Action Type Object	The sub action type of the subscription action Deprecated from CRM.COM R15.0.0
subscription	Subscription Object	The subscription that was or will be modified by the execution of the subscription action
job	Job Object	The Job for which the subscription action was performed Available from CRM.COM R9.0.0
resubmitted_by	Subscription Action Object	The subscription action that was generated when the retrieved subscription was re-submitted. Applicable only if the retrieved subscription action is in Rejected life cycle state Available from CRM.COM R17.0.0
subscription_action_affected_services_set	Set of subscription action affected services	A list of subscription services which are affected by the specified subscription action. Each subscription service might be affected if it is being added or removed by the subscription action, or if its life cycle changes because of the action. Available from CRM.COM R15.0.0
subscription_action_affected_installed_items_set	Set of subscription action affected installed items	A list of subscription installed items which are affected by the specified subscription action. Each subscription installed item might be affected if it is being added or removed by the subscription action Available from CRM.COM R15.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

unit object response data

Name	Type	Description
id	String	The ID of the retrieved unit
name	String	The name of the retrieved unit
group_name	String	The name of the group that the retrieved unit belongs to
community_name	String	The name of the community that the retrieved unit belongs to
alternative_code	String	The alternative code of the retrieved unit
description	String	The description of the retrieved unit

business unit object response data

Name	Type	Description
id	String	The ID of the retrieved business unit
name	String	The name of the retrieved business unit
code	String	The code of the retrieved business unit
unified_code	String	The unified code of the retrieved business unit
description	String	The description of the retrieved business unit
parent_business_unit_name	String	The name of the parent business unit that the retrieved business unit belongs to

subscription action type object response data

Name	Type	Description
id	String	The id of the retrieved subscription action type
name	String	The name of the retrieved subscription action type
alternative_code	String	The alternative code of the retrieved subscription action type

subscription sub action type object response data

Name	Type	Description
id	String	The id of the retrieved subscription sub action type
name	String	The name of the retrieved subscription sub action type
alternative_code	String	The alternative code of the retrieved subscription sub action type

subscription object response data

Name	Type	Description
id	String	The ID of the retrieved subscription
number	String	The number of the retrieved subscription
life_cycle_state	String	The life cycle state of the subscription. One of the following values is returned DRAFT, EFFECTIVE, NOT_EFFECTIVE, SHORT_TERM_EFFECTIVE, SHORT_TERM_NOT_EFFECTIVE, IN_RESTING, CANCELLED, REGRETTED, REPLACED, PENDING_VERIFICATION REPLACED life cycle state available from CRM.COM R14.0.0, deprecated in CRM.COM R17.0.0 PENDING_VERIFICATION life cycle state available from CRM.COM R15.0.0
first_activated_date	Date	The date that the subscription became effective for the first time (i.e. the date that the first effective period of that subscription started) Available from CRM.COM R9.0.0
rating_state	String	The rating state of the retrieved subscription that can be PENDING or COMPLETED Available from CRM.COM R9.0.0
accounts_receivable	Accounts receivable object	The accounts receivable owning the subscriptions
type	Subscription type object	The type of the retrieved subscription

Referred Objects Response Data

accounts_receivable object response data

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

Referred Objects Response Data

contact_information object response data

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

Referred Objects Response Data

demographics object response data

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

Referred Objects Response Data

date_of_birth object response data

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

name_day object response data

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

country object response data

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

Referred Objects Response Data

country_flag object response data

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

Referred Objects Response Data

file object response data

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

industry object response data

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

industry sector object response data

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

company profile object response data

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

Referred Objects Response Data

country object response data

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

Referred Objects Response Data

country_flag object response data

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

Referred Objects Response Data

file object response data

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

industry object response data

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

industry sector object response data

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

subscription type object response data

Name	Type	Description
id	String	The ID of the retrieved subscription type
name	String	The name of the retrieved subscription type
alternative_code	String	The alternative code of the retrieved subscription type
description	String	A description of the retrieved subscription type
classification	String	The classification of the retrieved subscription type, Flexible or Package Available from CRM.COM R14.0.0 Deprecated from CRM.COM R17.0.0

job object response data

Name	Type	Description
id	String	The ID of the retrieved job
number	String	The number of the retrieved job
description	String	The description of the retrieved job
life_cycle_state	String	The life cycle state of the retrieved job The supported options are DRAFT PENDING IN PROGRESS COMPLETED CANCELLED
rating_state	String	The rating state of the retrieved subscription that can be PENDING or COMPLETED Available from CRM.COM R9.0.0
accounts_receivable	Accounts Receivable object	The accounts receivable related with the specified job
type	Job 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
name	String	The name of the retrieved accounts receivable
life_cycle_state	String	The life cycle state of the accounts receivable. One of the following values is returned: ACTIVE, SUSPENDED, TERMINATED
account_owner	Contact information object	The contact information owning the accounts receivable

Referred Objects Response Data

contact_information object response data

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

Referred Objects Response Data

demographics object response data

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

Referred Objects Response Data

date_of_birth object response data

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

name_day object response data

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

country object response data

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

Referred Objects Response Data

country_flag object response data

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

Referred Objects Response Data

file object response data

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

industry object response data

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

industry sector object response data

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

company profile object response data

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

Referred Objects Response Data

country object response data

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

Referred Objects Response Data

country_flag object response data

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

Referred Objects Response Data

file object response data

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

industry object response data

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

industry sector object response data

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

job_type response data object

Name	Type	Description
Id	String	The ID of the retrieved job type
name	String	The Name of the retrieved job type
alternative_code	String	The Alternative Code of the retrieved job type
description	String	The Description of the retrieved job type
billing_directive	String	The billing directive of the retrieved job type The supported billing directive options are BILLABLE NOT_BILLABLE Available from CRM.COM R10.0.0
billing_method	String	The billing method of the retrieved job type. Applicable only for billable job types with fulfillment scope GENERIC_PURPOSE The supported billing methods are BILL_ON_STARTING_PROGRESS BILL_ON_COMPLETION Available from CRM.COM R10.0.0 From CRM.COM R15.0.0 and onward, this attribute will be deprecated
fulfillment_scope	String	The fulfillment scope of the retrieved job type The supported fulfillment scopes are GENERIC_PURPOSE NEW_SUBSCRIPTION ACTIVATE_SUBSCRIPTION DEACTIVATE_SUBSCRIPTION CANCEL_SUBSCRIPTION ADD_SUBSCRIPTION_SERVICES CANCEL_SUBSCRIPTION_SERVICES CHANGE_SUBSCRIPTION_LOCATION SWAP_SUBSCRIPTION_SERVICES SWAP_SUBSCRIPTION_INSTALLED_ITEMS REPLACE_PHYSICAL_GOODS The following fulfillment scopes will be available from CRM.COM R8.0.0 ACTIVATE_SUBSCRIPTION, DEACTIVATE_SUBSCRIPTION, CANCEL_SUBSCRIPTION, ADD_SUBSCRIPTION_SERVICES, CANCEL_SUBSCRIPTION_SERVICES, CHANGE_SUBSCRIPTION_LOCATION The following fulfillment scopes will be available from CRM.COM R9.0.0 SWAP_SUBSCRIPTION_SERVICES, SWAP_SUBSCRIPTION_INSTALLED_ITEMS The following fulfillment scope will be available from CRM.COM R11.0.0 REPLACE_PHYSICAL_GOODS From CRM.COM R15.0.0 and onward, all fulfillment scopes* will be deprecated*
fulfillment_method	String	The fulfillment method of the retrieved job type The supported fulfillment methods are BASED_ON_ORDERED_ITEMS BASED_ON_DELIVERED_ITEMS From CRM.COM R15.0.0 and onward, this attribute will be deprecated

Unable to render {include} The included page could not be found.

subscription action affected service object response data

Name	Type	Description
affected_mode	String	Defines how the subscription service was affected by the subscription action. Available values are ADDED, REMOVED, UPDATED
product	Product object	The product of the service that was affected because of the subscription action

Referred Objects Response Data

product object response data

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

Referred Objects Response Data

product_type object data response

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

Referred Objects Response Data

usage_detail_record_type object data response

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

Referred Objects Response Data

unit_of_measurement object response data

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

meter_reading_type object data response

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

Referred Objects Response Data

unit_of_measurement object response data

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

global rate object response data

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

Referred Objects Response Data

period object response data

Name

Type

Description

time_period_value

Number

The time period value

time_period_uot

String

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

MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS

subscription action affected installed item object response data

Name	Type	Description
affected_mode	String	Defines how the subscription installed item was affected by the subscription action. Available values are ADDED, REMOVED, UPDATED
installed_item	Installed Item object	The installed item that was affected because of the subscription action

Referred Objects Response Data

installed item object response data

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

Referred Objects Response Data

product object response data

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

Referred Objects Response Data

product_type object data response

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

Referred Objects Response Data

usage_detail_record_type object data response

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

Referred Objects Response Data

unit_of_measurement object response data

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

meter_reading_type object data response

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

Referred Objects Response Data

unit_of_measurement object response data

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

global rate object response data

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

Referred Objects Response Data

period object response data

Name

Type

Description

time_period_value

Number

The time period value

time_period_uot

String

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

MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS

state classification object response data

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

Examples

Example 1

HTTP Method: POST

Request:

Body:

{
    "token":"6F48ACCAB4FC6628C52F4DDE1EE0559E",
    
    "subscription_identifier":{"number":"S60243"},
    "accounts_receivable":{
            "action":"EXISTING",
            "accounts_receivable_identifier":{
                "number":"4"
            }
    },
	"subscription_address":{
                    "action":"EXISTING",
                    "type":"SAMEASBILLINGADDRESS"
    }
}

Response:

{
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    {
        "action_type": null,
        "submitted_on": "2014-12-31T10:08:38",
        "sub_action_type": null,
        "business_classification_code": "CHANGE_SUBSCRIBER",
        "number": "129",
        "executed_on": "2014-12-31T10:08:40",
        "life_cycle_state": "EXECUTED",
        "performed_by":
        {
            "person_name": "Marios Lannister",
            "username": "MPAdministrator",
            "id": "1",
            "email": null
        },
        "behavior_code": "CHANGE_SUBSCRIBER_ACCOUNT",
        "submitted_by":
        {
            "person_name": "Marios Lannister",
            "username": "MPAdministrator",
            "id": "1",
            "email": null
        },
        "id": "574A4A027F88DA0D07BE3A3359BB4B66",
        "subscription":
        {
            "accounts_receivable":
            {
                "account_owner":
                {
                    "last_name": "Lannister",
                    "life_cycle_state": "FINANCIAL",
                    "middle_name": null,
                    "company_profile": null,
                    "title": "Mr",
                    "type": "PERSON",
                    "first_name": "Marios",
                    "name": "Marios Lannister",
                    "id": "F60EF6A65658F86B3DFADA3809BD85C4",
                    "company_name": null,
                    "demographics":
                    {
                        "gender": "MALE",
                        "passport_issued_by_country": null,
                        "passport_number": null,
                        "social_security_number": null,
                        "country_of_residence":
                        {
                            "name": "CAMEROON",
                            "id": "164"
                        },
                        "industry_sector": null,
                        "date_of_birth":
                        {
                            "month": 5,
                            "day": 1,
                            "year": 1963
                        },
                        "name_day":
                        {
                            "month": 5,
                            "day": 1
                        },
                        "id_number": "593664",
                        "id_issued_by_country":
                        {
                            "name": "CYPRUS",
                            "id": "181"
                        },
                        "industry": null
                    }
                },
                "life_cycle_state": "ACTIVE",
                "number": "4",
                "name": "mar",
                "id": "5C7045E4DCE86FE0670CEE3A32437227"
            },
            "life_cycle_state": "DRAFT",
            "number": "S60243",
            "type":
            {
                "name": "Test Sub",
                "id": "C2FEA2C046FC3A28F98173D1CD98BA09",
                "description": null,
                "alternative_code": "TS"
            },
            "id": "F609D1E4FDD4E083478B45DCF9DC210A"
        },
        "performed_on": "2014-12-31T10:08:34"
    }
}