accounts_receivable_presentment_preference_parameter

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

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

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