This method updates accounts receivable. Single accounts receivable can be updated by each call. Fields which are not specified are not updated at all. Fields which are specified as null will be set as null.

Resource URL

http://host_name/crmapi/rest/$version/accounts_receivable/update

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

(mandatory)

Account Receivable Identifier

The identifier of the account receivable to be updated. The allowed account receivable identifier fields are the following:

Name

Type

Description

(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

name

(optional)

String

The name of the account receivable

description

(optional)

String

The description of the retrieved accounts receivable

notes

(optional)

String

The notes of the retrieved accounts receivable

vat_number

(optional)

String

The VAT number of the retrieved accounts receivable

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.

Deprecated from CRM.COM R11.0.0

credit_period

(optional)

Number

Credit period is the length of time for which a customer is allowed to settle any given debit

Deprecated from CRM.COM R14.0.0

classification_identifier

(optional)

Accounts Receivable Classification Identifier

The accounts receivable classification identifier. The allowed classification identifier fields are the following:

Name

Type

Description

(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

credit_rating_identifier

(optional)

Credit rating identifier

The accounts receivable credit rating identifier. The allowed credit rating identifier fields are the following:

Name

Type

Description

name

(semi-optional)

String

The name of the credit rating

code

(semi-optional)

String

The code of the credit rating. The supported codes are the following:

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

owned_by_group_identifier

(optional)

Group identifier

The group owning the accounts receivable. The allowed group identifier fields are the following:

Name

Type

Description

(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. The allowed privacy level identifier fields are the following:

Name

Type

Description

(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

account_manager

(optional)

User Identifier

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

Name

Type

Description

(semi-optional)

String

The ID of the user

username

(semi-optional)

String

The username of the user

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

Available from CRM.COM R14.0.0

is_tax_exempt

(optional)

Boolean

Defines whether the account owner is Tax Exempt or not

Available from CRM.COM R17.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

custom_field_set

(optional)

Set of Custom Fields

The custom fields that are associated with the accounts receivable

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

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

Available from CRM.COM R16.2.0

billing_address

(mandatory)

Billing Address object

The accounts receivable billing address.

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

rewards

(optional)

Rewards Object

The rewards information of the accounts receivable

Available from CRM.COM R17.0.0

wallet_top_up_rules

(optional)

Wallet Top Up Rules Object

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

Available from CRM.COM R14.2.0

presentment_preferences_set

(optional)

Set of accounts receivable presentment preferences objects

The presentment preferences of the retrieved accounts receivable.

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",
            	...........
			}
		]

payment_preferences_set

(optional)

Set of accounts receivable payment preferences objects

The payment preferences of the retrieved accounts receivable

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

access_tokens_set

(mandatory on conditions)

Set of Access Token Objects

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

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

"set": [
	   		{
            	"action": "add_existing",
            	...........
        	},
			{
            	"action": "remove",
            	...........
			},
			{
            	"action": "add_new",
            	...........
			}
		]

Available from CRM.COM R8.0.0

Deprecated from CRM.COM R18.0.0

Referred Parameter Objects Data

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.

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_rewards_update_parameters object data

Name

Type

Description

sign_up_on

(optional)

Date

The date that the accounts receivable signed up

If not specified, defaults to the current date; given that the accounts receivable does not participated in any scheme previously - otherwise it won't be taken into consideration

sign_up_by_business_unit_identifier

(optional)

Business Unit identifier

The business unit that signed up the accounts receivable

If not specified, defaults to the logged in user's unit; given that the accounts receivable does not participated in any scheme previously - otherwise it won't be taken into consideration

The allowed business unit identifier fields are the following:

Name

Type

Description

(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

sign_up_by_unit_identifier

(optional)

Unit identifier

The unit that signed up the accounts receivable

If not specified, defaults to the logged in user's unit; given that the accounts receivable does not participated in any scheme previously - otherwise it won't be taken into consideration

The allowed unit identifier fields are the following:

Name

Type

Description

(semi-optional)

String

The ID of the Unit

name

(semi-optional)

String

The name of the Unit

alternative_code

(semi-optional)

String

The alternative code of the Unit

Deprecated from CRM.COM R18.0.0

enable_automatic_spend

(optional)

Boolean

Defines whether the accounts receivable requires automatic spend on purchase events or not

minimum_wallet_balance

(optional)

Float

The minimum wallet balance that should be available in order for an automatic awards spending to be applied.

minimum_spend_amount

(optional)

Float

The minimum amount that can be spend by that specific accounts receivable during auto spend

maximum_spend_amount

(optional)

Float

The maximum amount that can be spend by that specific accounts receivable during auto spend

participating_schemes_set

(optional)

Set of Participating Rewards Scheme Objects

A list of reward schemes that the accounts receivable participant has joined

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

authorised_rewards_participating_merchants_set

(optional)

Set of Rewards Participating Merchants

It defines the list of merchants which are authorised to perform automatic awards spending on that specific accounts receivable, considering that those merchants are also allowing automatic awards spending. If not specified then all rewards participating merchants are considered as authorised. This is applicable only if the automatic spending is enabled.

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

Referred Parameter Objects Data

rewards participant schemes object parameter data

Name

Type

Description

action

(mandatory)

String

Defines if a new or existing information will be updated.The supported values are the following:

ADD, UPDATE, REMOVE

sign_up_on

(mandatory and applicable only on add and update)

Date

The date that the rewards participant signed up for that specific reward scheme

email_address

(semi-optional and only on add and update)

String

The email address that is associated with the unique reference code and was used while signing up to a reward scheme based on supported domains

This available and mandatory only it is required by the specific reward scheme (that is domain specific) and the reference code generation method is set to "AUTO_GENERATED"

Available from CRM.COM R15.2.0

reference_code

(mandatory on conditions and only on add and update)

String

The unique reference code that was used while signing up to that specific reward scheme

This is available and mandatory only if it is required by the specific reward scheme (that is domain specific) or if an email is defined instead of a reward scheme

Available from CRM.COM R12.7.0

sign_up_by_unit_identifier

(mandatory and applicable only on add and update)

Unit identifier

The unit that signed up the rewards participant to that specific reward scheme. The allowed unit identifier fields are the following:

Name

Type

Description

(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

sign_off_on

Date

The date that the rewards participant signed off from that specific reward scheme

Available from CRM.COM R9.0.0

rewards_participant_scheme_identifier

(mandatory and applicable only on update or remove)

Rewards Participant Scheme Identifier

The identifier of the activity service to be updated. The allowed activity service identifier fields are the following:

Name

Type

Description

(mandatory)

String

The ID of the reward participant participating scheme

reward_scheme_identifier

(semi-optional and applicable only on add)

Reward Scheme Identifier

The reward scheme that the rewards participant has joint. The allowed reward scheme identifier fields are the following:

Name

Type

Description

(semi-optional)

String

The ID of the reward scheme

name

(semi-optional)

String

The name of the reward scheme

alternative_code

(semi-optional)

String

The alternative code of the reward scheme

For releases prior CRM.COM R15.2.0 this parameter is mandatory

From CRM.COM R15.2.0 and onwards this parameter will be semi-optional and It should be specified if the email address is not specified

authorised rewards participating merchants parameters object data

Name

Type

Description

action

(mandatory)

String

Defines if a new or existing information will be updated.The supported values are the following:

ADD, REMOVE

rewards_participating_merchant_identifier

(mandatory)

Rewards Participating Merchant Identifier

The rewards participating merchant that should be authorised or de-authorised to perform automatic awards spending. The allowed rewards participating merchant identifier fields are the following:

Name

Type

Description

(semi-optional)

String

The ID of the rewards participating merchant

business_unit_identifier

(semi-optional)

Business Unit Identifier

The identifier of the business unit that represents the rewards participating merchant. The allowed business unit identifier fields are the following:

Name

Type

Description

(semi-optional)

String

The ID of the business unit

name

(semi-optional)

String

The code of the business unit

code

(semi-optional)

String

The code of the business unit

Available from CRM.COM R18.0.0

unit_identifier

(semi-optional)

Unit Identifier

The identifier of the unit that represents the rewards participating merchant. The allowed unit identifier fields are the following:

Name

Type

Description

(semi-optional)

String

The ID of the Unit

name

(semi-optional)

String

The name of the Unit

alternative_code

(semi-optional)

String

The alternative code of the Unit

Deprecated from CRM.COM R18.0.0

wallet_top_up_rules object parameter data

Name	Type	Description
wallet_balance_threshold (mandatory)	Number	The wallet balance threshold that will trigger the automatic wallet top-up
top_up_amount (mandatory)	Number	The amount that will top up the wallet balance
frequency (mandatory)	Number	The minimum period (in days) between wallet top ups
product_conditions_set (optional)	Set of Allotment Product Conditions	A set of products that will be allowed to consume the specified top up amount If no records are specified in the set then nothing will be updated. To remove a record use action "remove". To add a record use action "add". Different actions can be used within the same set. For example: "set": [ { "action": "remove", ........... }, { "action": "add", ........... } ]

Referred Objects Response Data

allotment_product parameter data

Name

Type

Description

product_identifier
(semi-optional)

Product identifier

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

Name

Type

Description

(semi-optional)

String

The ID of the product

code

(semi-optional)

String

The code of the product

alternative_code

(semi-optional)

String

The alternative code of the product

accounts_receivable_presentment_preference object parameter data

Name

Type

Description

action

(mandatory)

String

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

ADD, UPDATE, REMOVE

accounts_receivable_presentment_preference_identifier

(mandatory and applicable only on update or remove)

Accounts Receivable Presentment Preference Identifier

The identifier of the accounts receivable presentment preference that will be updated. The allowed accounts receivable presentment preference identifier fields are the following:

Name

Type

Description

(semi-optional)

String

The ID of accounts receivable presentment preference

presentment_preference_identifier

(semi-optional)

Identifier

The identifier of the presentment preference. The allowed presentment preference identifier fields are the following:

Name

Type

Description

(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

presentment_preference_identifier

(mandatory and applicable only on add)

Presentment Preference Identifier

The identifier of the presentment preference related with the accounts receivable presentment preference that will be updated. The allowed presentment preference identifier fields are the following:

Name

Type

Description

(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 and applicable only on add or update)

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

(mandatory and applicable only on add or update)

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 and applicable only on add or update)

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.

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

(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.

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

action

(mandatory)

String

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

ADD, UPDATE, REMOVE

accounts_receivable_payment_preference_identifier

(mandatory and applicable only on update or remove)

Accounts Receivable Payment Preference Identifier

The identifier of the accounts receivable payment preference to be updated. The allowed accounts receivable payment preference identifier fields are the following:

Name

Type

Description

(semi-optional)

String

The ID of accounts receivable payment preference

payment_preference_identifier

(semi-optional)

Identifier

The identifier of the payment preference. The allowed payment preference identifier fields are the following:

Name

Type

Description

(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

payment_medium_identifier

(semi-optional)

String

The payment medium identifier related with the accounts receivable payment preference

Available from CRM.COM R11.0.0

bank_account_number

(semi-optional)

String

The bank account number related with the accounts receivable payment preference

Available from CRM.COM R11.0.0

payment_preference_identifier

(mandatory and applicable only on add)

Payment Preference Identifier

The identifier of the payment preference to be updated on the related accounts receivable payment preference object. The allowed payment preference identifier fields are the following:

Name

Type

Description

(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

account_holder

(optional)

String

The account holder of the retrieved payment preference

is_default

(mandatory)

Boolean

Defines if the payment preference is default or not.

bank_account_number

(optional)

String

The bank account number of the retrieved payment preference

bank_account_type_identifier

(optional)

Bank Account Type 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

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

Bank 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

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

Bank Branch 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

(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

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

(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

(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

Available from CRM.COM R16.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

Available from CRM.COM R16.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

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

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

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

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

Referred Objects Response Data

payment_gateway_card_parameters object data

Name

Type

Description

action

(mandatory)

String

Defines if a new or existing payment gateway card will be added, updated or removed. The supported values are the following:

ADD, UPDATE, REMOVE

payment_gateway_card_identifier

(mandatory and applicable only on update or remove)

Payment Gateway Card Identifier

The identifier of the payment gateway card that will be updated. The allowed payment gateway card identifier fields are the following:

Name

Type

Description

(semi-optional)

String

The id of the payment gateway card

payment_gateway_reference_number

(semi-optional)

String

The card's reference number as provided by the payment gateway

last_digits

(semi-optional)

String

The last digits of the card as provided by the payment gateway provider

The retrieved cards are always filtered based on their related accounts receivable payment preference and not across all cards

number

(semi-optional and applicable only on add)

Number

The card's number, which should be a 16 digits number. This information is applicable only on adding a new card

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

last_digits

(semi-optional and applicable only on add)

String

The card last 4 digits

Available from CRM.COM R14.2.0

expiration_month

(mandatory on add, optional only on update)

Number

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

expiration_year

(mandatory on add, optional only on update)

Number

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

card_security_code

(optional, applicable only on add)

Number

The security code of the card, which should be a 3 digits number. This information is applicable only on adding a new card.

card_holder_name

(optional, applicable only on add and update)

String

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

brand

(mandatory on conditions, applicable only on add)

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

address_line_1

(optional, applicable only on add and update)

String

Information related with the card's billing address

address_line_2

(optional, applicable only on add and update)

String

Information related with the card's billing address

address_city

(optional, applicable only on add and update)

String

Information related with the card's billing address

address_zip

(optional, applicable on add and update)

String

Information related with the card's billing address

address_state

(optional, applicable only on add and update)

String

Information related with the card's billing address

address_country

(optional, applicable only on add and update)

String

Information related with the card's billing address

card_token

(optional, applicable only on add and update)

String

The token of the card that will be registered

Available from CRM.COM R14.2.0

consumer_token
(optional, applicable only on add and update)

String

The consumer token of the card that will be registered

Available from CRM.COM R14.26.0

default

(optional, applicable only on add and update)

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.

Note that on setting a card as the default, the previous default card is automatically replaced

access_token_parameters object data

Name

Type

Description

action

(mandatory)

String

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

ADD_NEW, ADD_EXISTING, REMOVE

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

access_token_identifier

(mandatory on add existing and remove)

Access Token identifier

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

Name

Type

Description

authentication_code

(semi-optional)

String

The authentication code of the access token

identifier

(semi-optional)

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

authentication_code

(mandatory on add new)

String

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

identifier

(mandatory on add new)

String

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

pass_code

(mandatory on add new)

String

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

classification_identifier

(optional)

Access Token Classification Identifier

The identifier of the access token classification that will be related with the access token. Applicable and if the action is set to ADD_NEW. The allowed access token classification identifier fields are the following:

Name

Type

Description

(semi-optional)

String

The ID of the classification

name

(semi-optional)

String

The name of the classification

alternative_code

(semi-optional)

String

The alternative code of the classification

Available from CRM.COM R13.1.0

card_masked_number

(optional)

String

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

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

Available from CRM.COM R16.2.0

udf_string_1

(optional)

String

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

Available from CRM.COM R10.1.0

udf_string_2

(optional)

String

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

Available from CRM.COM R10.1.0

udf_string_3

(optional)

String

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

Available from CRM.COM R10.1.0

udf_string_4

(optional)

String

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

Available from CRM.COM R10.1.0

udf_string_5

(optional)

String

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

Available from CRM.COM R10.1.0

udf_string_6

(optional)

String

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

Available from CRM.COM R10.1.0

udf_string_7

(optional)

String

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

Available from CRM.COM R10.1.0

udf_string_8

(optional)

String

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

Available from CRM.COM R10.1.0

udf_float_1

(optional)

Float

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

Available from CRM.COM R10.1.0

udf_float_2

(optional)

Float

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

Available from CRM.COM R10.1.0

udf_float_3

(optional)

Float

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

Available from CRM.COM R10.1.0

udf_float_4

(optional)

Float

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

Available from CRM.COM R10.1.0

udf_date_1

(optional)

Date

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

Available from CRM.COM R10.1.0

udf_date_2

(optional)

Date

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

Available from CRM.COM R10.1.0

udf_date_3

(optional)

Date

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

Available from CRM.COM R10.1.0

udf_date_4

(optional)

Date

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

Available from CRM.COM R10.1.0

Restrictions

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

Response Data

Name	Type	Description
id	String	The ID of the retrieved accounts receivable
type	String	The type of the retrieved accounts receivable which can be CUSTOMER or SYSTEM or ORGANISATIONAL ORGANISATIONAL type is available from CRM.COM R15.0.0
number	String	The number of the retrieved accounts receivable
name	String	The name of the retrieved accounts receivable
description	String	The description of the retrieved accounts receivable
notes	String	The notes of the retrieved accounts receivable
balance	Float	The aggregated amount of posted debits and credits allocated against the accounts receivable, as of a specific date. This information is calculated dynamically From CRM.COM R10.0.0, balance is calculated as the accounts receivable's opening balance plus the aggregated amount of posted debits and credits allocated against the accounts receivable and which are not related to any accounting period.
opening_balance	Float	The opening balance of the accounts receivable for the latest and still open Accounting Period. This information is calculated during the latest Accounting Period Closing process. Available from CRM.COM R10.0.0
opening_balance_date	Date	The date on which the opening balance of the accounts receivable was last calculated by an Accounting Period Closing process. Available from CRM.COM R10.0.0
outstanding_amount	Float	The total outstanding amount which is owned by the customer, as of a specific date, which is the aggregated amount of posted debits which are not paid and are past their due date. This information is calculated dynamically
credit_limit_status	String	Determines if the outstanding amount of the specific accounts receivable has exceeded the allowed credit limit. The supported values are NOT_EXCEEDED or EXCEEDED
credit_limit	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.
credit_period	Number	Credit period is the length of time for which a customer is allowed to settle any given debit Deprecated from CRM.COM R14.0.0
life_cycle_state	String	The life cycle state of the retrieved accounts receivable which can be ACTIVE, SUSPENDED or TERMINATED
primary_account	Boolean	Indicates if the accounts receivable is the primary accounts receivable for the specified customer or not
partner_account	Boolean	Indicates if the accounts receivable is owned by a partner group or a partner unit, i.e. is a partner account Available from CRM.COM R14.2.0
parent_account	Boolean	Indicates if the accounts receivable is a parent account in a group accounts Available from CRM.COM R14.2.0
is_tax_exempt	Boolean	Indicates if the account owner is tax exempt or not Available from CRM.COM R17.0.0
udf_string_1	String	User Defined Field of type String
udf_string_2	String	User Defined Field of type String
udf_string_3	String	User Defined Field of type String
udf_string_4	String	User Defined Field of type String
udf_string_5	String	User Defined Field of type String
udf_string_6	String	User Defined Field of type String
udf_string_7	String	User Defined Field of type String
udf_string_8	String	User Defined Field of type String
udf_float_1	Float	User Defined Field of type Float
udf_float_2	Float	User Defined Field of type Float
udf_float_3	Float	User Defined Field of type Float
udf_float_4	Float	User Defined Field of type Float
udf_date_1	Date	User Defined Field of type Date
udf_date_2	Date	User Defined Field of type Date
udf_date_3	Date	User Defined Field of type Date
udf_date_4	Date	User Defined Field of type Date
contact_information	Contact Information object	The contact information related with the specified accounts receivable
classification	Classification object	The classification of the retrieved accounts receivable
credit_rating	Credit Rating object	The credit rating of the retrieved accounts receivable
credit_period	Credit Period object	The credit period of the retrieved accounts receivable Available from CRM.COM R14.0.0
billing_address	Address object	The billing address of the retrieved accounts receivable
currency	Currency object	The accounts receivable's currency Available from CRM.COM R10.0.0
parent_account	Accounts Receivable Object	The parent accounts receivable. Applicable only if the retrieved Accounts Receivable is a member in a group of accounts. Available from CRM.COM R13.0.0
accounting_period	Accounting Period Object	The latest Accounting Period for which the accounts receivable's opening balance was calculated for. Available from CRM.COM R10.0.0
owned_by_group	Group Object	The group that is owning the accounts receivable Deprecated from CRM.COM R18.0.0 (replaced with owned_by_business_unit)
owned_by_business_unit	Business Unit Object	The business unit that is owning the accounts receivable Available from CRM.COM R18.0.0
privacy_level	Privacy Level Object	The accounts receivable privacy level Deprecated from CRM.COM R18.0.0
usage_allowance_limits	Usage Allowance Limits Object	The accounts receivable Usage Allowance Limits Available from CRM.COM R13.0.0 Deprecated from CRM.COM R17.0.0
log_information	Log Information Object	The log information related to the retrieved accounts receivable
account_manager	Users Object	The account manager of the retrieved accounts receivable Applicable only if the retrieved account is owned by a COMPANY Available from CRM.COM R14.0.0
pricing_agreement	Pricing Agreement Object	The pricing agreement of the retrieved accounts receivable Applicable only for an Accounts Receivable that is owned by a Company and a Price Plan and/or Usage Service Catalog was agreed as part of a special pricing agreement Available from CRM.COM R14.0.0 From CRM.COM R15.0.0, pricing_agreement is available for all CUSTOMER and ORGANISATIONAL accounts, for both persons and companies
recurring_payments_preferences	Recurring Payments Preferences Object	The recurring payments preferences associated with the accounts receivable Available from CRM.COM R14.0.0.
membership_information	Account Membership Information Object	The accounts receivable membership information in terms of funding scope and the services funded by the parent account. Applicable only if the retrieved accounts receivable is a member account of a group. Available from CRM.COM R13.1.0
rewards	Rewards Object	The rewards information of the accounts receivable Available from CRM.COM R17.0.0
presentment_preferences_set	Set of Accounts Receivable Presentment Preferences Objects	The presentment preferences of the retrieved accounts receivable
payment_preferences_set	Set of Accounts Receivable Payment Preferences Objects	The payment preferences of the retrieved accounts receivable
access_tokens_set	Set of Access Token objects	The access tokens associated with the accounts receivable Available from CRM.COM R8.0.0 Deprecated from CRM.COM R18.0.0
member_accounts	Set of Accounts Receivable Objects	The member accounts of the retrieved accounts receivable. Applicable only if the retrieved account is a Parent Account. Available from CRM.COM R13.0.0
usage_allowance_organisational_units	Set of Usage Organisational Conditions Objects	The usage organisational conditions (communities, groups, units) that services can be used at Available from CRM.COM R14.2.0 Deprecated from CRM.COM R17.0.0

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

classification object response data

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

credit_rating object response data

Name	Type	Description
code	String	The code of the retrieved credit rating
name	String	The name of the retrieved credit rating

credit period object response data

Name	Type	Description
credit_period_setting	String	The default Credit Period setting as this is set on the active Accounts Receivable Definition. Available values are: X_DAYS_AFTER_TRANSACTION_POSTED_DATE ON_N_DAY_X_MONTHS_AFTER
credit_period_number_of_days	Number	Defines the number of days after a financial transaction's posting date on which the financial transaction's due date will be set. Applicable only if credit_period_setting is set to X_DAYS_AFTER_TRANSACTION_POSTED_DATE
credit_period_day_of_month	Number	Defines the day of month on which the financial transaction's due date will be set. Applicable only if credit_period_setting is set to ON_N_DAY_X_MONTHS_AFTER
credit_period_after_x_months	Number	Defines the number of months after a financial transaction's posting date on which the financial transaction's due date will be set, i.e. it also defines the due date's month. Applicable only if credit_period_day_of_month is defines and credit_period_setting is set to ON_N_DAY_X_MONTHS_AFTER
credit_period_operator	String	Defines the credit period's operator. Available values are MINUS, PLUS and PLUS/MINUS
credit_period	Number	Credit period is the length of time for which a customer is allowed to settle any given debit. Always measured in days. From CRM.COM R14.2.0, credit period is measured in either Days or Months
credit_period_uot	String	Defines theunit of time for the credit period. Available values are DAYS or MONTHS Available from CRM.COM R14.2.0

address object response data

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

Name	Type	Description
id	String	The ID of the retrieved address
type	String	The type of the retrieved address which can be HOME, BUSINESS, POBOX, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5
postal_code	String	The postal code of the retrieved address
street_name	String	The street name of the retrieved address
street_number	String	The street number of the retrieved address
floor	Integer	The floor of the retrieved address
apartment_number	String	The apartment number of the retrieved address
area	String	The area of the retrieved address
town_city	String	The town / city of the retrieved address
district	String	The district of the retrieved address
municipality	String	The municipality of the retrieved address
po_box	String	The PO box of the retrieved address
po_box_postal_code	String	The PO box postal code of the retrieved address
care_of	String	The care of person of the retrieved address
udf_string_1	String	User Defined Field of type String
udf_string_2	String	User Defined Field of type String
udf_string_3	String	User Defined Field of type String
udf_string_4	String	User Defined Field of type String
udf_string_5	String	User Defined Field of type String
udf_string_6	String	User Defined Field of type String
udf_string_7	String	User Defined Field of type String
udf_string_8	String	User Defined Field of type String
udf_string_9	String	User Defined Field of type String
udf_string_10	String	User Defined Field of type String
udf_string_11	String	User Defined Field of type String
udf_string_12	String	User Defined Field of type String
udf_string_13	String	User Defined Field of type String
udf_string_14	String	User Defined Field of type String
udf_string_15	String	User Defined Field of type String
udf_string_16	String	User Defined Field of type String
udf_float_1	Float	User Defined Field of type Float
udf_float_2	Float	User Defined Field of type Float
udf_float_3	Float	User Defined Field of type Float
udf_float_4	Float	User Defined Field of type Float
udf_date_1	Date	User Defined Field of type Date
udf_date_2	Date	User Defined Field of type Date
udf_date_3	Date	User Defined Field of type Date
udf_date_4	Date	User Defined Field of type Date
country	Country Object	The country of the retrieved address
is_primary	Boolean	Defines if the address is the contact's primary address or not. Available from CRM.COM R15

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

Name	Type	Description
id	String	The ID of the retrieved address
type	String	The type of the retrieved address which can be HOME, BUSINESS, POBOX, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5
postal_code	String	The postal code of the retrieved address
town_city	String	The town / city of the retrieved address
address_line_1	String	The address line 1
address_line_2	String	The address line 2
state_province_county	String	The state or province or county of the address.
udf_string_1	String	User Defined Field of type String
udf_string_2	String	User Defined Field of type String
udf_string_3	String	User Defined Field of type String
udf_string_4	String	User Defined Field of type String
udf_string_5	String	User Defined Field of type String
udf_string_6	String	User Defined Field of type String
udf_string_7	String	User Defined Field of type String
udf_string_8	String	User Defined Field of type String
udf_string_9	String	User Defined Field of type String
udf_string_10	String	User Defined Field of type String
udf_string_11	String	User Defined Field of type String
udf_string_12	String	User Defined Field of type String
udf_string_13	String	User Defined Field of type String
udf_string_14	String	User Defined Field of type String
udf_string_15	String	User Defined Field of type String
udf_string_16	String	User Defined Field of type String
udf_float_1	Float	User Defined Field of type Float
udf_float_2	Float	User Defined Field of type Float
udf_float_3	Float	User Defined Field of type Float
udf_float_4	Float	User Defined Field of type Float
udf_date_1	Date	User Defined Field of type Date
udf_date_2	Date	User Defined Field of type Date
udf_date_3	Date	User Defined Field of type Date
udf_date_4	Date	User Defined Field of type Date
country	Country Object	The country of the retrieved address
is_primary	Boolean	Defines if the address is the contact's primary address or not. Available from CRM.COM R15

Referred Objects Response Data

country object response data

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

Referred Objects Response Data

country_flag object response data

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

Referred Objects Response Data

file object response data

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

currency object response data

Name	Type	Description
id	String	The ID of the retrieved currency
code	String	The code of the retrieved currency
prefix_symbol	String	The prefix symbol for the specified currency
suffix_symbol	String	The suffix symbol for the specified currency
life_cycle_state	String	The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE Available from CRM.COM R14.0.0
integer_part_name	String	The integer part name for the specified currency
decimal_part_name	String	The decimal part name for the specified currency

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

accounting period object response data

Name	Type	Description
number	String	The Accounting Period's number
name	String	The Accounting Period's name
from_date	Date	The Accounting Period's from date
to_date	Date	The Accounting Period's to date
life_cycle_state	Sting	The Accounting Period's life cycle state. Available values are OPEN and CLOSED
closed_date	Date	The Accounting Period's closed date. Available only for Accounting Periods in Closed life cycle state

group object response data

Name	Type	Description
id	String	The ID of the retrieved group
name	String	The name of the retrieved group
community_name	String	The name of the community that the retrieved group belongs to
alternative_code	String	The alternative code of the retrieved group
unified_code	String	The unified code of the retrieved group Available from CRM.COM R16.2.2
description	String	The description of the retrieved group

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

privacy_level object response data

Name	Type	Description
id	String	The id of the retrieved privacy level
number	String	The number of the retrieved privacy level
name	String	The name of the retrieved privacy level
hierarchy_level	String	The hierarchy level of the retrieved privacy level

accounts_receivable_usage_allowance_limits object response data

Name	Type	Description
block_services_not_included_in_usage_allowance_limits_settings	Boolean	Defines if the account owner can only consume services for which a Usage Allowance Limit is specified Available from CRM.COM R13.1.0
percentage_of_allowed_exceeded_usage_limit	Number	The percentage of amount that the limit can be exceeded for the related accounts receivable Available from CRM.COM R13.1.0
accumulated_maximum_rated_amount_per_day	Float	The accumulated maximum rated amount that the accounts receivable is allowed to use within a day.
accumulated_maximum_rated_amount_per_month	Float	The accumulated maximum rated amount that the accounts receivable is allowed to use within a month.
accumulated_maximum_rated_amount_per_transaction	Float	The accumulated maximum rated amount that the accounts receivable is allowed to use per transaction.
accumulated_maximum_usage_per_day	Integer	The accumulated maximum usage amount that the accounts receivable is allowed to use within a day.
accumulated_maximum_usage_per_month	Integer	The accumulated maximum usage amount that the accounts receivable is allowed to use within a month.
accumulated_maximum_usage_per_transaction	Integer	The accumulated maximum usage amount that the accounts receivable is allowed to use per transaction.
currency	Currency object	The accounts receivable's currency
usage_services_allowance	Set of Usage Services Allowance objects	The usage allowance limits per usage service, service type or service family

Referred Objects Response Data

currency object response data

Name	Type	Description
id	String	The ID of the retrieved currency
code	String	The code of the retrieved currency
prefix_symbol	String	The prefix symbol for the specified currency
suffix_symbol	String	The suffix symbol for the specified currency
life_cycle_state	String	The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE Available from CRM.COM R14.0.0
integer_part_name	String	The integer part name for the specified currency
decimal_part_name	String	The decimal part name for the specified currency

usage_allowance_limit_per_service object response data

Name	Type	Description
maximum_rated_amount_per_transaction	Number	The maximum rated amount that can be used per transaction on the specific usage service, service type or service family.
maximum_rated_amount_per_day	Number	The maximum rated amount that can be used within a day on the specific usage service, service type or service family.
maximum_rated_amount_per_billing_cycle	Number	The maximum rated amount that can be used within a billing cycle on the specific usage service, service type or service family. Available from CRM.COM R17.0.0
maximum_rated_amount_per_month	Number	The maximum rated amount that can be used within a month on the specific usage service, service type or service family. Deprecated in CRMCOM R17.0.0
maximum_usage_per_transaction	Number	The maximum usage amount that can be used per transaction on the specific usage service, service type or service family.
maximum_usage_per_day	Number	The maximum usage amount that can be used within a day on the specific usage service, service type or service family.
maximum_usage_per_billing_cycle	Number	The maximum usage amount that can be used within a billing cycle on the specific usage service, service type or service family. Available from CRM.COM R17.0.0
maximum_usage_per_month	Number	The maximum usage amount that can be used within a month on the specific usage service, service type or service family. Deprecated in CRM.COM R17.0.0
service	Product object	The product related with the retrieved usage allowance limit.
service_type	Product Type object	The product type related with the retrieved usage allowance limit.
service_family	Product Family object	The product family related with the retrieved usage allowance limit.

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

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

product_family object data response

Name	Type	Description
Id	String	The ID of the retrieved product family
name	String	The Name of the retrieved product family
code	String	The code of the retrieved product family
description	String	The Description of the retrieved product family

log_information object response data

Name	Type	Description
created_date	Date	The date that the retrieved record was created
updated_date	Date	The last date that the retrieved record was updated
created_by_unit	Unit Object	The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0
created_by_business_unit	Unit Object	The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Available from CRM.COM R18.0.0
created_by_user	User Object	The user that created the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled
updated_by_unit	Unit Object	The last unit that updated the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0
updated_by_business_unit	Unit Object	The last unit that updated the retrieved record Available from CRM.COM R18.0.0
updated_by_user	User Object	The last user that updated the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled

Referred Objects Response Data

unit object response data

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

business unit object response data

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

user object response data

Name	Type	Description
id	String	The ID of the retrieved user
username	String	The user name of the retrieved user
person_name	String	The full name of the retrieved user
email	String	The email of the retrieved user

pricing_agreement object response data

Name	Type	Description
price_plan	Price Plan Object	The price plan that was agreed for the specific accounts receivable
usage_service_catalog	Usage Service Catalog Object	The usage service catalog that was agreed for the specific accounts receivable Deprecated from CRM.COM R15.0.0
additive_discount_definitions_set	Set of Additive Discount Definition Objects	A list of Additive discount definitions that can only be applied when the specific accounts receivable is billed. Available from CRM.COM R14.9.0

Referred Objects Response Data

price_plan object data response

Name	Type	Description
Id	String	The ID of the retrieved price plan
name	String	The Name of the retrieved price plan
code	String	The Code of the retrieved price plan
description	String	The Description of the retrieved price plan
type	String	The Type of the retrieved price plan which can be BASE or CONDITIONAL
effective_date	Date	The Effective Date of the retrieved price plan
expiration_date	Date	The Expiration Date of the retrieved price plan
currency	Currency Object	The Currency of the retrieved price plan Available from CRM.COM R14.2.0

Referred Objects Response Data

currency object response data

Name	Type	Description
id	String	The ID of the retrieved currency
code	String	The code of the retrieved currency
prefix_symbol	String	The prefix symbol for the specified currency
suffix_symbol	String	The suffix symbol for the specified currency
life_cycle_state	String	The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE Available from CRM.COM R14.0.0
integer_part_name	String	The integer part name for the specified currency
decimal_part_name	String	The decimal part name for the specified currency

usage_service_catalog object data response

Name	Type	Description
Id	String	The ID of the retrieved usage service catalog
name	String	The Name of the retrieved usage service catalog
alternative_code	String	The Alternative Code of the retrieved usage service catalog
description	String	The Description of the retrieved usage service catalog
effective_date	Date	The Effective Date of the retrieved usage service catalog Available from CRM.COM R14.0.0
expiration_date	Date	The Expiration Date of the retrieved usage service catalog Available from CRM.COM R14.0.0

additive_discount_definition object response data

Name	Type	Description
id	String	The ID of the retrieved additive discount definition
alternative_code	String	The alternative code of the retrieved additive discount definition
name	String	The name of the retrieved additive discount definition
life_cycle_state	String	The life cycle state of the retrieved additive discount definition. The supported life cycle states are EFFECTIVE or NOT_EFFECTIVE
classification	String	The classification of the retrieved additive discount definition which can be either SUBSCRIPTIONS, JOBS or GENERAL GENERAL classification available from CRM.COM R15.0.0 JOB classification is not available from CRM.COM R17.0.0
type	String	The type of the additive discount definition which can be AUTO_APPLY or AD_HOC

accounts_receivable_recurring_payments_preference object response data

Name	Type	Description
enabled_payment_method	Payment Preference Object	The payment preference that will be used for recurring payments
wallet_top_up_rules	Wallet Top Up Rules	The wallet top up rules for the accounts receivable

Referred Objects Response Data

payment_preference object response data

Name	Type	Description
id	String	The id of the retrieved payment preference
name	String	The name of the retrieved payment preference
alternative_code	String	The alternative code of the retrieved payment preference
type	Sting	The type of the payment preference, such as DIRECT_DEBIT, STRIPE_PAYMENT_GATEWAY, PAYPAL_PAYMENT_GATEWAY, BRAINTREE_PAYMENT_GATEWAY GENERIC_PAYMENT_GATEWAY, CUSTOM_PAYMENT_GATEWAY, WALLET, OTHER, CUSTOM_1, CUSTOM_2, CUSTOM_3, CUSTOM_4, CUSTOM_5 BRAINTREE_PAYMENT_GATEWAY and CUSTOM_PAYMENT_GATEWAY are available from CRM.COM R14.2.0 WALLET available from CRM.COM R17.0.0
description	Sting	The description of the retrieved payment preference

accounts_receivable_wallet_top_up_rules object response data

Name	Type	Description
wallet_balance_threshold	Number	The wallet balance threshold that will trigger the automatic wallet top-up
top_up_amount	Number	The amount that will top up the wallet balance
frequency	Number	The minimum period (in days) between wallet top ups
product_conditions_set	Set of Wallet Top Up Allotment Product Condition Objects	The set of products that are allowed to consume the specified top up amount

Referred Objects Response Data

wallet_top_up_allotment_product_condition object response data

Name	Type	Description
id	String	The ID of the retrieved allotment condition
product	Product object	The product related with the retrieved allotment condition

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

accounts_receivable_membership_information object response data

Name	Type	Description
funding_scope	String	The funding scope of the member accounts receivable. Two options are available FULLY_FUNDED and PARTIALLY_FUNDED
funded_services	Set of Product objects	The Services / Service Types / Service Families that are funded by the Parent Account.

Referred Objects Response Data

funded_services object response data

Name	Type	Description
product	Product object	The product related with the retrieved member account
product_type	Product Type object	The product type related with the retrieved member account

Browser not supported