change_subscriber_parameters

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

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

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

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.