Skip to end of banner
Go to start of banner

GET accounts_receivable/list

Skip to end of metadata
Go to start of metadata

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

Compare with Current View Page History

« Previous Version 7 Next »

This method returns information related with accounts receivable. Multiple accounts receivables are returned by each call

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

subscription_identifier

(semi-optional)

Subscriptions identifier

The identifier of the subscription related with the accounts that will be returned as results. The allowed subscription identifier fields are the following:

Name

Type

Description

id 

(semi-optional)

String

The ID of subscription

number 

(semi-optional)

String

The number of subscription

contact_information_identifier

(semi-optional)

Contact information identifier

The identifier of the contact information related with the accounts that will be returned as results. The allowed contact information identifier fields are the following:

Name

Type

Description

id 

(semi-optional)

String

The ID of the contact information

id_number

(semi-optional)

String

The ID number of the contact information

Applicable only for contact information that represent PERSON

passport_number 

(semi-optional)

String

The passport number of the contact information

Applicable only for contact information that represent PERSON

social_security_number 

(semi-optional)

String

The social security number of the contact information

Applicable only for contact information that represent PERSON

vat_registration_number

(semi-optional)

String

The VAT registration number of the contact information

Applicable only for contact information that represent COMPANY

registration_number

(semi-optional)

String

The registration number of the contact information

Applicable only for contact information that represent COMPANY

Available from CRM.COM R14.0.0

payment_preference_identifier

(semi-optional)

Payment preference identifier

The identifier of the payment preference related with the accounts that will be returned as results. The allowed payment preference identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of payment preference

name 

(semi-optional)

String

The name of payment preference

alternative_code 

(semi-optional)

String

The alternative code of payment preference

presentment_preference_identifier

(semi-optional)

Presentment preference identifier

The identifier of the presentment preference related with the accounts that will be returned as results. The allowed presentment preference identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of presentment preference

name 

(semi-optional)

String

The name of presentment preference

alternative_code

(semi-optional)

String

The alternative code of presentment preference

wallet_identifier

(semi-optional)

Wallet identifier  

The identifier of the wallet elated with the accounts that should be returned as a result. The allowed wallet identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the wallet

number

(semi-optional)

String

The number of the wallet

Available from CRM.COM R10.0.0

email_address

(semi-optional)

String

The email address of the contact information owning the accounts that should be returned as a result.

Available from CRM.COM R13.0.0

phone_number

(semi-optional)

String

The phone number of the contact information owning the accounts that should be returned as a result.

Available from CRM.COM R13.0.0

owned_by_group_identifier

(semi-optional)

Organisational Group Identifier

The identifier of the organisational group related with the accounts that will be returned as results. The allowed contact information identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the group

name

(semi-optional)

String

The code of the group

alternative_code

(semi-optional)

String

The alternative code of  the group

Available from CRM.COM R14.15.0

number_of_results

(optional)

Number

The number of results that can be retrieved through each call

Available from CRM.COM R13.0.0

offset

(optional)

Number

Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number

Available from CRM.COM R13.0.0

fields_set

(optional)

List of Strings, comma separated 

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

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

typeString

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

descriptionStringThe description of the retrieved accounts receivable
notesStringThe 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_balanceFloat

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_dateDate

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_statusStringDetermines if the outstanding amount of the specific accounts receivable has exceeded the allowed credit limit. The supported values are NOT_EXCEEDED or EXCEEDED
credit_limitNumberIs 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_periodNumber

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_accountBoolean

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_accountBoolean

Indicates if the accounts receivable is a parent account in a group accounts

Available from CRM.COM R14.2.0

is_tax_exemptBoolean

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_periodCredit 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

currencyCurrency object

The accounts receivable's currency

Available from CRM.COM R10.0.0

parent_accountAccounts 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_periodAccounting 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_groupGroup 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_unitBusiness Unit Object

The business unit that is owning the accounts receivable

Available from CRM.COM R18.0.0

privacy_levelPrivacy Level Object

The accounts receivable privacy level

Deprecated from CRM.COM R18.0.0

usage_allowance_limitsUsage 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_managerUsers 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_agreementPricing 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_preferencesRecurring Payments Preferences Object

The recurring payments preferences associated with the accounts receivable

Available from CRM.COM R14.0.0.

membership_informationAccount 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

rewardsRewards 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_setSet 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_accountsSet 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_unitsSet 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_nameSting

The company name of the retrieved contact information

demographics

Demographics Object

The demographics information of the retrieved contact information

company_profile

Company profile object

The company profile of the retrieve contact information

Referred Objects Response Data

 demographics object response data

Name

Type

Description

gender

String

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

id_number

String

The ID number of the retrieved contact information

id_number_expiration_dateDate

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

Available from CRM.COM R14.0.0

passport_number

String

The passport number of the retrieved contact information

passport_number_expiration_dateDate

The passport's expiration date of the retrieved contact information

Available from CRM.COM R14.0.0

social_security_number

String

The social security number of the retrieved contact information

date_of_birth

Date of Birth Object

The date of birth of the retrieved contact information

name_day

Name Day Object

The name day of the retrieved contact information

country_of_residence

Country Object

The country of residence of the retrieved contact information

id_issued_by_country

Country Object

The ID issued country of retrieved contact information

passport_issued_by_country

Country Object

The passport  issued country of retrieved contact information

industry

Industry Object

The industry of retrieved contact information

industry_sector

Industry sector Object

The sector of retrieved contact information

Referred Objects Response Data

 date_of_birth object response data

Name

Type

Description

day

Integer

The day of the retrieved date of birth

month

Integer

The month of the retrieved date of birth

year

Integer

The year of the retrieved date of birth

 name_day object response data

Name

Type

Description

day

Integer

The day of the retrieved name day

month

Integer

The month of the retrieved name day

 country object response data

Name

Type

Description

id

String

The id of the retrieved country

name

String

The name of the retrieved country

alternative_codeString

The alternative code of the retrieved country

dialing_codeString

The dialing code of the retrieved country

Available from CRM.COM R15.1.0

two_character_codeString

The two character code of the retrieved country

three_character_codeString

The three character code of the retrieved country

country_flagImage Object

The flag of the retrieved country

Available from CRM.COM R15.1.0

Referred Objects Response Data

 country_flag object response data

Name

Type

Description

id

String

The ID of the retrieved country flag

fileFile ObjectThe information of the attached file

Referred Objects Response Data

 file object response data

 

Name

Type

Description

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

 industry object response data

Name

Type

Description

id

String

The id of the retrieved industry

name

String

The name of the retrieved industry

code

String

The code of the retrieved industry

 industry sector object response data

Name

Type

Description

id

String

The id of the retrieved industry sector

name

String

The name of the retrieved industry sector

alternative_code

String

The alternative code of the retrieved industry sector

 company profile object response data

Name

Type

Description

profile_year

Number

The profile year of the retrieved contact information

annual_turnover

Number

The annual turnover of the retrieved contact information

established_date

Date

The established date of the retrieved contact information

number_of_employeesNumber

The number of employees of the retrieved contact information

registration_number

String

The registration number of the retrieved contact information

vat_registration_numberString

The vat registration number of the retrieved contact information

vat_registered_byString

The vat registration by of the retrieved contact information

vat_registration_date

Date

The vat registration date of the retrieved contact information

tax_reference_numberString

The tax referenece number of the retrieved contact information

registered_in_country

Country Object

The country of residence of the retrieved contact information

industry

Industry Object

The industry of retrieved contact information

industry_sector

Industry sector Object

The sector of retrieved contact information

Referred Objects Response Data

 country object response data

Name

Type

Description

id

String

The id of the retrieved country

name

String

The name of the retrieved country

alternative_codeString

The alternative code of the retrieved country

dialing_codeString

The dialing code of the retrieved country

Available from CRM.COM R15.1.0

two_character_codeString

The two character code of the retrieved country

three_character_codeString

The three character code of the retrieved country

country_flagImage Object

The flag of the retrieved country

Available from CRM.COM R15.1.0

Referred Objects Response Data

 country_flag object response data

Name

Type

Description

id

String

The ID of the retrieved country flag

fileFile ObjectThe information of the attached file

Referred Objects Response Data

 file object response data

 

Name

Type

Description

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

 industry object response data

Name

Type

Description

id

String

The id of the retrieved industry

name

String

The name of the retrieved industry

code

String

The code of the retrieved industry

 industry sector object response data

Name

Type

Description

id

String

The id of the retrieved industry sector

name

String

The name of the retrieved industry sector

alternative_code

String

The alternative code of the retrieved industry sector

 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_monthNumber 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_monthsNumberDefines 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_operatorStringDefines the credit period's operator. Available values are MINUS, PLUS and PLUS/MINUS
credit_periodNumber

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_uotString

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_primaryBoolean

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

Available from CRM.COM R15

 

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

Name

Type

Description

id

String

The ID of the retrieved address

type

String

The type of the retrieved address which can be

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

postal_code

String

The postal code of the retrieved address

town_city

String

The town / city of the retrieved address

address_line_1

String

The address line 1

address_line_2

String

 The address line 2

state_province_county

String

The state or province or county of the address.

udf_string_1

String

User Defined Field of type String

udf_string_2

String

User Defined Field of type String

udf_string_3

String

User Defined Field of type String

udf_string_4

String

User Defined Field of type String

udf_string_5

String

User Defined Field of type String

udf_string_6

String

User Defined Field of type String

udf_string_7

String

User Defined Field of type String

udf_string_8

String

User Defined Field of type String

udf_string_9

String

User Defined Field of type String

udf_string_10

String

User Defined Field of type String

udf_string_11

String

User Defined Field of type String

udf_string_12

String

User Defined Field of type String

udf_string_13

String

User Defined Field of type String

udf_string_14

String

User Defined Field of type String

udf_string_15

String

User Defined Field of type String

udf_string_16

String

User Defined Field of type String

udf_float_1

Float

User Defined Field of type Float

udf_float_2

Float

User Defined Field of type Float

udf_float_3

Float

User Defined Field of type Float

udf_float_4

Float

User Defined Field of type Float

udf_date_1

Date

User Defined Field of type Date

udf_date_2

Date

User Defined Field of type Date

udf_date_3

Date

User Defined Field of type Date

udf_date_4

Date

User Defined Field of type Date

country

Country Object

The country of the retrieved address

is_primaryBoolean

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

Available from CRM.COM R15

Referred Objects Response Data

 country object response data

Name

Type

Description

id

String

The id of the retrieved country

name

String

The name of the retrieved country

alternative_codeString

The alternative code of the retrieved country

dialing_codeString

The dialing code of the retrieved country

Available from CRM.COM R15.1.0

two_character_codeString

The two character code of the retrieved country

three_character_codeString

The three character code of the retrieved country

country_flagImage Object

The flag of the retrieved country

Available from CRM.COM R15.1.0

Referred Objects Response Data

 country_flag object response data

Name

Type

Description

id

String

The ID of the retrieved country flag

fileFile ObjectThe information of the attached file

Referred Objects Response Data

 file object response data

 

Name

Type

Description

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

 currency object response data

Name

Type

Description

id

String

The ID of the retrieved currency

code

String

The code of the retrieved currency

prefix_symbolStringThe prefix symbol for the specified currency

suffix_symbol

StringThe suffix symbol for the specified currency
life_cycle_stateString

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

Available from CRM.COM R14.0.0

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

 accounts_receivable object response data

Name

Type

Description

id

String

The ID of the retrieved accounts receivable

number

String

The number of the retrieved accounts receivable

nameStringThe name of the retrieved accounts receivable

life_cycle_state

String

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

ACTIVE, SUSPENDED, TERMINATED

account_ownerContact information objectThe contact information owning the accounts receivable

Referred Objects Response Data

 contact_information object response data

Name

Type

Description

id

String

The ID of the retrieved contact information

type

String

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

life_cycle_state

String

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

name

String

The full name of the retrieved contact information

first_name

String

The first name of the retrieved contact information

middle_name

String

The middle name of the retrieved contact information

last_name

String

The last name of the retrieved contact information

title

String

The title of the retrieved contact information

company_nameSting

The company name of the retrieved contact information

demographics

Demographics Object

The demographics information of the retrieved contact information

company_profile

Company profile object

The company profile of the retrieve contact information

Referred Objects Response Data

 demographics object response data

Name

Type

Description

gender

String

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

id_number

String

The ID number of the retrieved contact information

id_number_expiration_dateDate

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

Available from CRM.COM R14.0.0

passport_number

String

The passport number of the retrieved contact information

passport_number_expiration_dateDate

The passport's expiration date of the retrieved contact information

Available from CRM.COM R14.0.0

social_security_number

String

The social security number of the retrieved contact information

date_of_birth

Date of Birth Object

The date of birth of the retrieved contact information

name_day

Name Day Object

The name day of the retrieved contact information

country_of_residence

Country Object

The country of residence of the retrieved contact information

id_issued_by_country

Country Object

The ID issued country of retrieved contact information

passport_issued_by_country

Country Object

The passport  issued country of retrieved contact information

industry

Industry Object

The industry of retrieved contact information

industry_sector

Industry sector Object

The sector of retrieved contact information

Referred Objects Response Data

 date_of_birth object response data

Name

Type

Description

day

Integer

The day of the retrieved date of birth

month

Integer

The month of the retrieved date of birth

year

Integer

The year of the retrieved date of birth

 name_day object response data

Name

Type

Description

day

Integer

The day of the retrieved name day

month

Integer

The month of the retrieved name day

 country object response data

Name

Type

Description

id

String

The id of the retrieved country

name

String

The name of the retrieved country

alternative_codeString

The alternative code of the retrieved country

dialing_codeString

The dialing code of the retrieved country

Available from CRM.COM R15.1.0

two_character_codeString

The two character code of the retrieved country

three_character_codeString

The three character code of the retrieved country

country_flagImage Object

The flag of the retrieved country

Available from CRM.COM R15.1.0

Referred Objects Response Data

 country_flag object response data

Name

Type

Description

id

String

The ID of the retrieved country flag

fileFile ObjectThe information of the attached file

Referred Objects Response Data

 file object response data

 

Name

Type

Description

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

 industry object response data

Name

Type

Description

id

String

The id of the retrieved industry

name

String

The name of the retrieved industry

code

String

The code of the retrieved industry

 industry sector object response data

Name

Type

Description

id

String

The id of the retrieved industry sector

name

String

The name of the retrieved industry sector

alternative_code

String

The alternative code of the retrieved industry sector

 company profile object response data

Name

Type

Description

profile_year

Number

The profile year of the retrieved contact information

annual_turnover

Number

The annual turnover of the retrieved contact information

established_date

Date

The established date of the retrieved contact information

number_of_employeesNumber

The number of employees of the retrieved contact information

registration_number

String

The registration number of the retrieved contact information

vat_registration_numberString

The vat registration number of the retrieved contact information

vat_registered_byString

The vat registration by of the retrieved contact information

vat_registration_date

Date

The vat registration date of the retrieved contact information

tax_reference_numberString

The tax referenece number of the retrieved contact information

registered_in_country

Country Object

The country of residence of the retrieved contact information

industry

Industry Object

The industry of retrieved contact information

industry_sector

Industry sector Object

The sector of retrieved contact information

Referred Objects Response Data

 country object response data

Name

Type

Description

id

String

The id of the retrieved country

name

String

The name of the retrieved country

alternative_codeString

The alternative code of the retrieved country

dialing_codeString

The dialing code of the retrieved country

Available from CRM.COM R15.1.0

two_character_codeString

The two character code of the retrieved country

three_character_codeString

The three character code of the retrieved country

country_flagImage Object

The flag of the retrieved country

Available from CRM.COM R15.1.0

Referred Objects Response Data

 country_flag object response data

Name

Type

Description

id

String

The ID of the retrieved country flag

fileFile ObjectThe information of the attached file

Referred Objects Response Data

 file object response data

 

Name

Type

Description

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

 industry object response data

Name

Type

Description

id

String

The id of the retrieved industry

name

String

The name of the retrieved industry

code

String

The code of the retrieved industry

 industry sector object response data

Name

Type

Description

id

String

The id of the retrieved industry sector

name

String

The name of the retrieved industry sector

alternative_code

String

The alternative code of the retrieved industry sector

 accounting period object response data

Name

Type

Description

number

String

The Accounting Period's number

name

String

The Accounting Period's name

from_dateDateThe Accounting Period's from date
to_dateDateThe Accounting Period's to date
life_cycle_stateStingThe Accounting Period's life cycle state. Available values are OPEN and CLOSED
closed_dateDateThe 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_codeString

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

codeStringThe code of the retrieved business unit
unified_codeString

The unified code of the retrieved business unit

description

String

The description of the retrieved business unit

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

 privacy_level object response data

Name

Type

Description

id

String

The id of the retrieved privacy level

numberStringThe number of the retrieved privacy level

name

String

The name of the retrieved privacy level

hierarchy_level

String

The hierarchy level of the retrieved privacy level

 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_dayFloatThe accumulated maximum rated amount that the accounts receivable is allowed to use within a day.
accumulated_maximum_rated_amount_per_monthFloatThe accumulated maximum rated amount that the accounts receivable is allowed to use within a month.
accumulated_maximum_rated_amount_per_transactionFloatThe accumulated maximum rated amount that the accounts receivable is allowed to use per transaction.
accumulated_maximum_usage_per_dayIntegerThe accumulated maximum usage amount that the accounts receivable is allowed to use within a day.
accumulated_maximum_usage_per_monthIntegerThe accumulated maximum usage amount that the accounts receivable is allowed to use within a month.
accumulated_maximum_usage_per_transactionIntegerThe accumulated maximum usage amount that the accounts receivable is allowed to use per transaction.
currencyCurrency objectThe accounts receivable's currency
usage_services_allowanceSet 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_symbolStringThe prefix symbol for the specified currency

suffix_symbol

StringThe suffix symbol for the specified currency
life_cycle_stateString

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

Available from CRM.COM R14.0.0

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

 usage_allowance_limit_per_service object response data

Name

Type

Description

maximum_rated_amount_per_transactionNumberThe maximum rated amount that can be used per transaction on the specific usage service, service type or service family.
maximum_rated_amount_per_dayNumberThe 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_cycleNumber

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_monthNumber

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_transactionNumberThe maximum usage amount that can be used per transaction on the specific usage service, service type or service family.
maximum_usage_per_dayNumberThe maximum usage amount that can be used within a day on the specific usage service, service type or service family.
maximum_usage_per_billing_cycleNumber

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_monthNumber

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

serviceProduct objectThe product related with the retrieved usage allowance limit.
service_type Product Type objectThe product type related with the retrieved  usage allowance limit.
service_family  Product Family objectThe product family related with the retrieved usage allowance limit.

Referred Objects Response Data

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

alternative_code

String

The alternative code of product

description

String

The description of product

priority_levelInteger

The priority level of the product

Available from CRM.COM R12.3.0

global_rateGlobal Rate Object

The global rate of the retrieved product

Available from CRM.COM R15.0.0

product_typeProduct type objectThe type of the product

Referred Objects Response Data

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

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

Available from CRM.COM R14.0.0

Referred Objects Response Data

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

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe identifier of the Unit of measurement

name

String

The name of the Unit of measurement

description

String

The description of the Unit of measurement

alternative_codeStringThe alternative code of the Unit of measurement

 

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

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe identifier of the Unit of measurement

name

String

The name of the Unit of measurement

description

String

The description of the Unit of measurement

alternative_codeStringThe alternative code of the Unit of measurement

 global rate object response data

Name

Type

Description

id

String

The ID of the retrieved rate

rate_model

String

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

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

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

global_base_amountNumber

The base price of the product in the Global Price Plan

base_rate_applied_perString

The value for 'Base Rate Applied per'

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

  • Period
  • Period_Item
uotString

The 'UOT' applicable for the rate

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

Available for one-time services

time_periodTime Period Object

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

uomString

The 'UOM' applicable for the rate

Available when the product type is of Usage Service Classification 

Referred Objects Response Data

 period object response data

Name

Type

Description

time_period_valueNumber

The time period value

time_period_uot

String

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

MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS

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

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

Available from CRM.COM R14.0.0

Referred Objects Response Data

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

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe identifier of the Unit of measurement

name

String

The name of the Unit of measurement

description

String

The description of the Unit of measurement

alternative_codeStringThe alternative code of the Unit of measurement

 

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

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe identifier of the Unit of measurement

name

String

The name of the Unit of measurement

description

String

The description of the Unit of measurement

alternative_codeStringThe alternative code of the Unit of measurement

 product_family object data response
NameType Description
IdStringThe ID of the retrieved product family
nameStringThe Name of the retrieved product family
codeStringThe code of the retrieved product family
descriptionStringThe 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

codeStringThe code of the retrieved business unit
unified_codeString

The unified code of the retrieved business unit

description

String

The description of the retrieved business unit

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

 user object response data

Name

Type

Description

id

String

The ID of the retrieved user

username

String

The user name of the retrieved user

person_name

String

The full name of the retrieved user

email

String

The email of the retrieved user

 pricing_agreement object response data

Name

Type

Description

price_planPrice Plan ObjectThe price plan that was agreed for the specific accounts receivable
usage_service_catalogUsage 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_setSet 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
NameType Description
IdStringThe ID of the retrieved price plan
nameStringThe Name of the retrieved price plan
codeStringThe Code of the retrieved price plan
descriptionStringThe Description of the retrieved price plan
typeStringThe Type of the retrieved price plan which can be BASE or CONDITIONAL
effective_date DateThe Effective Date of the retrieved price plan
expiration_date Date

The Expiration Date of the retrieved price plan

currencyCurrency Object

The Currency of the retrieved price plan

Available from CRM.COM R14.2.0

Referred Objects Response Data

 currency object response data

Name

Type

Description

id

String

The ID of the retrieved currency

code

String

The code of the retrieved currency

prefix_symbolStringThe prefix symbol for the specified currency

suffix_symbol

StringThe suffix symbol for the specified currency
life_cycle_stateString

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

Available from CRM.COM R14.0.0

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

 usage_service_catalog object data response
NameType Description
IdStringThe ID of the retrieved usage service catalog
nameStringThe Name of the retrieved usage service catalog
alternative_codeStringThe Alternative Code of the retrieved usage service catalog
descriptionStringThe Description of the retrieved usage service catalog
effective_dateDate

The Effective Date of the retrieved usage service catalog

Available from CRM.COM R14.0.0

expiration_dateDate

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_codeStringThe alternative code of the retrieved additive discount definition
nameStringThe name of the retrieved additive discount definition
life_cycle_stateString

The life cycle state of the retrieved additive discount definition. The supported life cycle states are EFFECTIVE or NOT_EFFECTIVE

classificationString

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

typeStringThe 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 ObjectThe payment preference that will be used for recurring payments

wallet_top_up_rules

Wallet Top Up RulesThe 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

typeSting

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

descriptionStingThe 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 ObjectsThe 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

productProduct objectThe product related with the retrieved allotment condition

Referred Objects Response Data

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

alternative_code

String

The alternative code of product

description

String

The description of product

priority_levelInteger

The priority level of the product

Available from CRM.COM R12.3.0

global_rateGlobal Rate Object

The global rate of the retrieved product

Available from CRM.COM R15.0.0

product_typeProduct type objectThe type of the product

Referred Objects Response Data

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

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

Available from CRM.COM R14.0.0

Referred Objects Response Data

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

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe identifier of the Unit of measurement

name

String

The name of the Unit of measurement

description

String

The description of the Unit of measurement

alternative_codeStringThe alternative code of the Unit of measurement

 

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

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe identifier of the Unit of measurement

name

String

The name of the Unit of measurement

description

String

The description of the Unit of measurement

alternative_codeStringThe alternative code of the Unit of measurement

 global rate object response data

Name

Type

Description

id

String

The ID of the retrieved rate

rate_model

String

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

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

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

global_base_amountNumber

The base price of the product in the Global Price Plan

base_rate_applied_perString

The value for 'Base Rate Applied per'

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

  • Period
  • Period_Item
uotString

The 'UOT' applicable for the rate

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

Available for one-time services

time_periodTime Period Object

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

uomString

The 'UOM' applicable for the rate

Available when the product type is of Usage Service Classification 

Referred Objects Response Data

 period object response data

Name

Type

Description

time_period_valueNumber

The time period value

time_period_uot

String

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

MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS

 accounts_receivable_membership_information object response data

Name

Type

Description

funding_scopeString

The funding scope of the member accounts receivable. Two options are available FULLY_FUNDED and PARTIALLY_FUNDED

funded_servicesSet 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

productProduct objectThe product related with the retrieved member account
product_typeProduct Type objectThe product type related with the retrieved member account
product_familyProduct Family objectThe product family related with the retrieved the retrieved member account.

Referred Objects Response Data

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

alternative_code

String

The alternative code of product

description

String

The description of product

priority_levelInteger

The priority level of the product

Available from CRM.COM R12.3.0

global_rateGlobal Rate Object

The global rate of the retrieved product

Available from CRM.COM R15.0.0

product_typeProduct type objectThe type of the product

Referred Objects Response Data

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

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

Available from CRM.COM R14.0.0

Referred Objects Response Data

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

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe identifier of the Unit of measurement

name

String

The name of the Unit of measurement

description

String

The description of the Unit of measurement

alternative_codeStringThe alternative code of the Unit of measurement

 

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

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe identifier of the Unit of measurement

name

String

The name of the Unit of measurement

description

String

The description of the Unit of measurement

alternative_codeStringThe alternative code of the Unit of measurement

 global rate object response data

Name

Type

Description

id

String

The ID of the retrieved rate

rate_model

String

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

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

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

global_base_amountNumber

The base price of the product in the Global Price Plan

base_rate_applied_perString

The value for 'Base Rate Applied per'

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

  • Period
  • Period_Item
uotString

The 'UOT' applicable for the rate

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

Available for one-time services

time_periodTime Period Object

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

uomString

The 'UOM' applicable for the rate

Available when the product type is of Usage Service Classification 

Referred Objects Response Data

 period object response data

Name

Type

Description

time_period_valueNumber

The time period value

time_period_uot

String

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

MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS

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

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

Available from CRM.COM R14.0.0

Referred Objects Response Data

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

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe identifier of the Unit of measurement

name

String

The name of the Unit of measurement

description

String

The description of the Unit of measurement

alternative_codeStringThe alternative code of the Unit of measurement

 

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

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe identifier of the Unit of measurement

name

String

The name of the Unit of measurement

description

String

The description of the Unit of measurement

alternative_codeStringThe alternative code of the Unit of measurement

 product_family object data response
NameType Description
IdStringThe ID of the retrieved product family
nameStringThe Name of the retrieved product family
codeStringThe code of the retrieved product family
descriptionStringThe Description of the retrieved product family

 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

 accounts_receivable_presentment_preference object data response
NameType Description
IdStringThe ID of the retrieved presentment preference
stateStringIndicates if the retrieved presentment preference is active or not. The supported values are ACTIVE or INACTIVE
presentment_preferencePresentment Preference ObjectThe presentment method of the retrieved presentment preference
emailEmail Object

The email related with the presentment preference. This information is available only if the selected presentment method is of type Email

phonePhone Object

The phone related with the presentment preference. This information is available only if the selected presentment method is of type SMS

Referred Objects Response Data

 presentment_preference object response data

Name

Type

Description

id

String

The id of the retrieved presentment method

name

String

The name of the retrieved presentment method

alternative_code

String

The alternative code of the retrieved presentment method

type

Sting

The presentment method type which can be one of the following:

POST, EMAIL, SMS, F2F, OTHER, CUSTOM_1, CUSTOM_2, CUSTOM_3, CUSTOM_4, CUSTOM_5

From CRM.COM R12.0.0, value F2F is replaced by FACE_TO_FACE.

stateStringThe state of the presentment preference, which can be ACTIVE or INACTIVE
descriptionStringA description of the presentment preference

contact_information

Contact Information Object

The contact information related with the retrieved presentment preference

Referred Objects Response Data

 contact_information object response data

Name

Type

Description

id

String

The ID of the retrieved contact information

type

String

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

life_cycle_state

String

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

name

String

The full name of the retrieved contact information

first_name

String

The first name of the retrieved contact information

middle_name

String

The middle name of the retrieved contact information

last_name

String

The last name of the retrieved contact information

title

String

The title of the retrieved contact information

company_nameSting

The company name of the retrieved contact information

demographics

Demographics Object

The demographics information of the retrieved contact information

company_profile

Company profile object

The company profile of the retrieve contact information

Referred Objects Response Data

 demographics object response data

Name

Type

Description

gender

String

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

id_number

String

The ID number of the retrieved contact information

id_number_expiration_dateDate

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

Available from CRM.COM R14.0.0

passport_number

String

The passport number of the retrieved contact information

passport_number_expiration_dateDate

The passport's expiration date of the retrieved contact information

Available from CRM.COM R14.0.0

social_security_number

String

The social security number of the retrieved contact information

date_of_birth

Date of Birth Object

The date of birth of the retrieved contact information

name_day

Name Day Object

The name day of the retrieved contact information

country_of_residence

Country Object

The country of residence of the retrieved contact information

id_issued_by_country

Country Object

The ID issued country of retrieved contact information

passport_issued_by_country

Country Object

The passport  issued country of retrieved contact information

industry

Industry Object

The industry of retrieved contact information

industry_sector

Industry sector Object

The sector of retrieved contact information

Referred Objects Response Data

 date_of_birth object response data

Name

Type

Description

day

Integer

The day of the retrieved date of birth

month

Integer

The month of the retrieved date of birth

year

Integer

The year of the retrieved date of birth

 name_day object response data

Name

Type

Description

day

Integer

The day of the retrieved name day

month

Integer

The month of the retrieved name day

 country object response data

Name

Type

Description

id

String

The id of the retrieved country

name

String

The name of the retrieved country

alternative_codeString

The alternative code of the retrieved country

dialing_codeString

The dialing code of the retrieved country

Available from CRM.COM R15.1.0

two_character_codeString

The two character code of the retrieved country

three_character_codeString

The three character code of the retrieved country

country_flagImage Object

The flag of the retrieved country

Available from CRM.COM R15.1.0

Referred Objects Response Data

 country_flag object response data

Name

Type

Description

id

String

The ID of the retrieved country flag

fileFile ObjectThe information of the attached file

Referred Objects Response Data

 file object response data

 

Name

Type

Description

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

 industry object response data

Name

Type

Description

id

String

The id of the retrieved industry

name

String

The name of the retrieved industry

code

String

The code of the retrieved industry

 industry sector object response data

Name

Type

Description

id

String

The id of the retrieved industry sector

name

String

The name of the retrieved industry sector

alternative_code

String

The alternative code of the retrieved industry sector

 company profile object response data

Name

Type

Description

profile_year

Number

The profile year of the retrieved contact information

annual_turnover

Number

The annual turnover of the retrieved contact information

established_date

Date

The established date of the retrieved contact information

number_of_employeesNumber

The number of employees of the retrieved contact information

registration_number

String

The registration number of the retrieved contact information

vat_registration_numberString

The vat registration number of the retrieved contact information

vat_registered_byString

The vat registration by of the retrieved contact information

vat_registration_date

Date

The vat registration date of the retrieved contact information

tax_reference_numberString

The tax referenece number of the retrieved contact information

registered_in_country

Country Object

The country of residence of the retrieved contact information

industry

Industry Object

The industry of retrieved contact information

industry_sector

Industry sector Object

The sector of retrieved contact information

Referred Objects Response Data

 country object response data

Name

Type

Description

id

String

The id of the retrieved country

name

String

The name of the retrieved country

alternative_codeString

The alternative code of the retrieved country

dialing_codeString

The dialing code of the retrieved country

Available from CRM.COM R15.1.0

two_character_codeString

The two character code of the retrieved country

three_character_codeString

The three character code of the retrieved country

country_flagImage Object

The flag of the retrieved country

Available from CRM.COM R15.1.0

Referred Objects Response Data

 country_flag object response data

Name

Type

Description

id

String

The ID of the retrieved country flag

fileFile ObjectThe information of the attached file

Referred Objects Response Data

 file object response data

 

Name

Type

Description

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

 industry object response data

Name

Type

Description

id

String

The id of the retrieved industry

name

String

The name of the retrieved industry

code

String

The code of the retrieved industry

 industry sector object response data

Name

Type

Description

id

String

The id of the retrieved industry sector

name

String

The name of the retrieved industry sector

alternative_code

String

The alternative code of the retrieved industry sector

 email object response data

Name

Type

Description

id

String

The ID of the retrieved email

type

String

The type of the retrieved email which can be

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

email_address

String

The address of the retrieved email

notesStringThe notes of the retrieved email

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

is_primary

 

Boolean

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

Available from CRM.COM R15

 phone object response data

Name

Type

Description

id

String

The ID of the retrieved phone

type

String

The type of the retrieved phone which can be

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

number

String

The number of the retrieved phone

area_code

String

The area code of the retrieved phone

full_number

String

The full number of the retrieved phone

notesStringThe notes of the retrieved phone

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

country

Country Object

The country of the retrieved phone

is_primaryBoolean

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

Available from CRM.COM R15

Referred Objects Response Data

 country object response data

Name

Type

Description

id

String

The id of the retrieved country

name

String

The name of the retrieved country

alternative_codeString

The alternative code of the retrieved country

dialing_codeString

The dialing code of the retrieved country

Available from CRM.COM R15.1.0

two_character_codeString

The two character code of the retrieved country

three_character_codeString

The three character code of the retrieved country

country_flagImage Object

The flag of the retrieved country

Available from CRM.COM R15.1.0

Referred Objects Response Data

 country_flag object response data

Name

Type

Description

id

String

The ID of the retrieved country flag

fileFile ObjectThe information of the attached file

Referred Objects Response Data

 file object response data

 

Name

Type

Description

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

 

 accounts_receivable_payment_preference object response data

Name

Type

Description

id

String

The ID of the retrieved payment preference

account_holder

String

The account holder of the retrieved payment preference

bank_account_number

String

The bank account number of the retrieved payment preference

default

Boolean

Indicates if the retrieved payment preference is the default for the related accounts receivable

stateString

Indicates if the retrieved payment preference is active or not. The supported values are ACTIVE or INACTIVE

Available from CRM.COM R15.0.0

use_for_recurring_payments

Boolean

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

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

 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.

Available from CRM.COM R16.0.0

 opt_in_for_purchases

 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.

Available from CRM.COM R16.0.0

notesString

The notes of the retrieved payment preference object.

Available from CRM.COM R10.1.0

payment_medium_identifierString

The payment medium identifier related with the retrieved payment preference

Available from CRM.COM R11.0.0

iban

String

The international bank account number

Available from CRM.COM R13.1.0

business_identifier_code

String

The business identifier code that identifies the bank

Available from CRM.COM R13.1.0

unique_mandate_reference

Number

The unique reference, which identifies a mandate that was signed by a Debtor for any given Creditor

Available from CRM.COM R13.1.0

mandate_signing_date

Date

The date that the mandate was signed

Available from CRM.COM R13.1.0

mandate_termination_dateDate

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

Available from CRM.COM R13.1.0

payment_preference

Payment Preference Object

The payment preference of the retrieved payment preference

bank_account_type

Bank Account Type Object

The bank account type related with the retrieved payment preference

bank

Bank Object

The bank related with the retrieved payment preference

bank_branch

Bank Branch Object

The bank branch related with the retrieved payment preference

payment_medium_typePayment Medium Type

The payment medium type related with the retrieved payment preference

Available from CRM.COM R11.0.0

payment_medium_brandPayment Medium Brand

The payment medium brand related with the retrieved payment preference

Available from CRM.COM R11.0.0

default_cardPayment Gateway Card Objects

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. 

cards_setSet Payment Gateway Card Objects

The set of all payment gateway cards which are related with the specific accounts receivable payment preference

  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

typeSting

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

descriptionStingThe description of the retrieved payment preference

 

 bank_account_type object response data

Name

Type

Description

id

String

The id of the retrieved bank account type

name

String

The name of the retrieved bank account type

alternative_code

String

The alternative code of the retrieved bank account type

 

 bank object response data

Name

Type

Description

id

String

The id of the retrieved bank

name

String

The name of the retrieved bank

alternative_code

String

The alternative code of the retrieved bank

 

 bank_branch object response data

Name

Type

Description

id

String

The id of the retrieved bank branch

name

String

The name of the retrieved bank branch

alternative_code

String

The alternative code of the retrieved bank branch

 payment_medium_type object response data

Name

Type

Description

id

String

The id of the retrieved payment medium type

name

String

The name of the retrieved payment medium type

alternative_code

String

The alternative code of the retrieved payment medium type

descriptionString

The description  of the retrieved payment medium type

 

 payment_medium_brand object response data

Name

Type

Description

id

String

The id of the retrieved payment medium brand

name

String

The name of the retrieved payment medium brand

alternative_code

String

The alternative code of the retrieved payment medium brand

descriptionString

The description  of the retrieved payment medium brand

 

 payment gateway card object response data

Name

Type

Description

id

String

The id of the retrieved payment gateway card

payment_gateway_reference_number

String

The card's reference number as provided by the payment gateway. This number is used to submit transactions on the payment gateway that will be processed using that card

card_holder_name

String

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

The card's brand, as provided by the payment gateway provider. The supported brands by the payment gateways 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
expiration_monthNumberThe card's expiration month, which can be from 1 to 12
expiration_yearNumberThe card's expiration year which is a 4 digits number
typeString

The type of the card, as provided by the payment gateway provider. The supported types by the payment gateway are the following:

  • Stripe: CREDIT, DEBIT, PREPAID, UNKNOWN
last_digitsStringThe last 4 digits of the card as provided by the payment gateway provider. Those digits are masked with 12 asterisk characters for example **** ***** ***** 4242
consumer_tokenStringThe consumer token

 payment_gateway_cards object response data

Name

Type

Description

default

Boolean

Indicates if the retrieved payment gateway card is the default for the related accounts receivable payment preference

card

Payment Gateway Card Object

The represented payment gateway card

  Referred Objects Response Data

 payment gateway card object response data

Name

Type

Description

id

String

The id of the retrieved payment gateway card

payment_gateway_reference_number

String

The card's reference number as provided by the payment gateway. This number is used to submit transactions on the payment gateway that will be processed using that card

card_holder_name

String

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

The card's brand, as provided by the payment gateway provider. The supported brands by the payment gateways 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
expiration_monthNumberThe card's expiration month, which can be from 1 to 12
expiration_yearNumberThe card's expiration year which is a 4 digits number
typeString

The type of the card, as provided by the payment gateway provider. The supported types by the payment gateway are the following:

  • Stripe: CREDIT, DEBIT, PREPAID, UNKNOWN
last_digitsStringThe last 4 digits of the card as provided by the payment gateway provider. Those digits are masked with 12 asterisk characters for example **** ***** ***** 4242
consumer_tokenStringThe consumer token

 access_token object response data

Name

Type

Description

id

String

The ID of the retrieved access token

number

String

The number of the retrieved access token

life_cycle_stateString

The state of the retrieved access token which can be one of the following:

EFFECTIVE, NOT_EFFECTIVE

authentication_code

StringThe authentication code of the retrieved access token
identifierStringThe identifier of the retrieved access token
card_masked_numberString

The masked number of the card as provided

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

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

classificationAccess Token Classification Object

The classification of the access token

Available from CRM.COM R10.0.0

Referred Objects Response Data

 access token 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

 member_account object response data

Name

Type

Description

id

String

The ID of the retrieved accounts receivable

number

String

The number of the retrieved accounts receivable

nameStringThe name of the retrieved accounts receivable
life_cycle_stateString

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

ACTIVE, SUSPENDED, TERMINATED

funding_scopeString

The funding scope of the member accounts receivable. Two options are available FULLY_FUNDED and PARTIALLY_FUNDED

Deprecated from CRM.COM R13.1.0

account_ownerContact Information ObjectThe contact information owning the accounts receivable
funded_servicesSet of Product objects

The Services / Service Types / Service Families that are funded by the Parent Account.

Deprecated from CRM.COM R13.1.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_nameSting

The company name of the retrieved contact information

demographics

Demographics Object

The demographics information of the retrieved contact information

company_profile

Company profile object

The company profile of the retrieve contact information

Referred Objects Response Data

 demographics object response data

Name

Type

Description

gender

String

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

id_number

String

The ID number of the retrieved contact information

id_number_expiration_dateDate

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

Available from CRM.COM R14.0.0

passport_number

String

The passport number of the retrieved contact information

passport_number_expiration_dateDate

The passport's expiration date of the retrieved contact information

Available from CRM.COM R14.0.0

social_security_number

String

The social security number of the retrieved contact information

date_of_birth

Date of Birth Object

The date of birth of the retrieved contact information

name_day

Name Day Object

The name day of the retrieved contact information

country_of_residence

Country Object

The country of residence of the retrieved contact information

id_issued_by_country

Country Object

The ID issued country of retrieved contact information

passport_issued_by_country

Country Object

The passport  issued country of retrieved contact information

industry

Industry Object

The industry of retrieved contact information

industry_sector

Industry sector Object

The sector of retrieved contact information

Referred Objects Response Data

 date_of_birth object response data

Name

Type

Description

day

Integer

The day of the retrieved date of birth

month

Integer

The month of the retrieved date of birth

year

Integer

The year of the retrieved date of birth

 name_day object response data

Name

Type

Description

day

Integer

The day of the retrieved name day

month

Integer

The month of the retrieved name day

 country object response data

Name

Type

Description

id

String

The id of the retrieved country

name

String

The name of the retrieved country

alternative_codeString

The alternative code of the retrieved country

dialing_codeString

The dialing code of the retrieved country

Available from CRM.COM R15.1.0

two_character_codeString

The two character code of the retrieved country

three_character_codeString

The three character code of the retrieved country

country_flagImage Object

The flag of the retrieved country

Available from CRM.COM R15.1.0

Referred Objects Response Data

 country_flag object response data

Name

Type

Description

id

String

The ID of the retrieved country flag

fileFile ObjectThe information of the attached file

Referred Objects Response Data

 file object response data

 

Name

Type

Description

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

 industry object response data

Name

Type

Description

id

String

The id of the retrieved industry

name

String

The name of the retrieved industry

code

String

The code of the retrieved industry

 industry sector object response data

Name

Type

Description

id

String

The id of the retrieved industry sector

name

String

The name of the retrieved industry sector

alternative_code

String

The alternative code of the retrieved industry sector

 company profile object response data

Name

Type

Description

profile_year

Number

The profile year of the retrieved contact information

annual_turnover

Number

The annual turnover of the retrieved contact information

established_date

Date

The established date of the retrieved contact information

number_of_employeesNumber

The number of employees of the retrieved contact information

registration_number

String

The registration number of the retrieved contact information

vat_registration_numberString

The vat registration number of the retrieved contact information

vat_registered_byString

The vat registration by of the retrieved contact information

vat_registration_date

Date

The vat registration date of the retrieved contact information

tax_reference_numberString

The tax referenece number of the retrieved contact information

registered_in_country

Country Object

The country of residence of the retrieved contact information

industry

Industry Object

The industry of retrieved contact information

industry_sector

Industry sector Object

The sector of retrieved contact information

Referred Objects Response Data

 country object response data

Name

Type

Description

id

String

The id of the retrieved country

name

String

The name of the retrieved country

alternative_codeString

The alternative code of the retrieved country

dialing_codeString

The dialing code of the retrieved country

Available from CRM.COM R15.1.0

two_character_codeString

The two character code of the retrieved country

three_character_codeString

The three character code of the retrieved country

country_flagImage Object

The flag of the retrieved country

Available from CRM.COM R15.1.0

Referred Objects Response Data

 country_flag object response data

Name

Type

Description

id

String

The ID of the retrieved country flag

fileFile ObjectThe information of the attached file

Referred Objects Response Data

 file object response data

 

Name

Type

Description

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

 industry object response data

Name

Type

Description

id

String

The id of the retrieved industry

name

String

The name of the retrieved industry

code

String

The code of the retrieved industry

 industry sector object response data

Name

Type

Description

id

String

The id of the retrieved industry sector

name

String

The name of the retrieved industry sector

alternative_code

String

The alternative code of the retrieved industry sector

 funded_services object response data

Name

Type

Description

productProduct objectThe product related with the retrieved member account
product_typeProduct Type objectThe product type related with the retrieved member account
product_familyProduct Family objectThe product family related with the retrieved the retrieved member account.

Referred Objects Response Data

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

alternative_code

String

The alternative code of product

description

String

The description of product

priority_levelInteger

The priority level of the product

Available from CRM.COM R12.3.0

global_rateGlobal Rate Object

The global rate of the retrieved product

Available from CRM.COM R15.0.0

product_typeProduct type objectThe type of the product

Referred Objects Response Data

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

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

Available from CRM.COM R14.0.0

Referred Objects Response Data

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

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe identifier of the Unit of measurement

name

String

The name of the Unit of measurement

description

String

The description of the Unit of measurement

alternative_codeStringThe alternative code of the Unit of measurement

 

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

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe identifier of the Unit of measurement

name

String

The name of the Unit of measurement

description

String

The description of the Unit of measurement

alternative_codeStringThe alternative code of the Unit of measurement

 global rate object response data

Name

Type

Description

id

String

The ID of the retrieved rate

rate_model

String

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

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

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

global_base_amountNumber

The base price of the product in the Global Price Plan

base_rate_applied_perString

The value for 'Base Rate Applied per'

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

  • Period
  • Period_Item
uotString

The 'UOT' applicable for the rate

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

Available for one-time services

time_periodTime Period Object

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

uomString

The 'UOM' applicable for the rate

Available when the product type is of Usage Service Classification 

Referred Objects Response Data

 period object response data

Name

Type

Description

time_period_valueNumber

The time period value

time_period_uot

String

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

MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS

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

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

Available from CRM.COM R14.0.0

Referred Objects Response Data

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

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe identifier of the Unit of measurement

name

String

The name of the Unit of measurement

description

String

The description of the Unit of measurement

alternative_codeStringThe alternative code of the Unit of measurement

 

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

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe identifier of the Unit of measurement

name

String

The name of the Unit of measurement

description

String

The description of the Unit of measurement

alternative_codeStringThe alternative code of the Unit of measurement

 product_family object data response
NameType Description
IdStringThe ID of the retrieved product family
nameStringThe Name of the retrieved product family
codeStringThe code of the retrieved product family
descriptionStringThe Description of the retrieved product family

 accounts_receivable_rewards object response data

Name

Type

Description

sign_up_onDateThe date that the accounts receivable signed up
sign_up_by_unitUnit Object

The unit that signed up the accounts receivable

Deprecated from CRM.COM R18.0.0

sign_up_by_business_unitBusiness Unit Object

The business unit that signed up the accounts receivable

Available from CRM.COM R18.0.0

auto_spend_authorisationAuto Spend Settings Object

The accounts receivable's automatic spend settings

spend_blocking_stateRewards Participant Spend Requests Blocking State Object

The accounts receivable's spend requests blocking state

reward_tierRewards Tier Information ObjectThe Rewards Tier information for the accounts receivable
participating_schemes_setSet of Rewards Participant Scheme ObjectsA list of reward schemes that the accounts receivable has joined

Referred Objects Response Data

 unit object response data

Name

Type

Description

id

String

The ID of the retrieved unit

name

String

The name of the retrieved unit

group_name

String

The name of the group that the retrieved unit belongs to

community_name

String

The name of the community that the retrieved unit belongs to

alternative_code

String

The alternative code of the retrieved unit

description

String

The description of the retrieved unit

 business unit object response data

Name

Type

Description

id

String

The ID of the retrieved business unit

name

String

The name of the retrieved business unit

codeStringThe code of the retrieved business unit
unified_codeString

The unified code of the retrieved business unit

description

String

The description of the retrieved business unit

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

 auto spend authorisation object response data

Name

Type

Description

enabled

Boolean

Defines whether automatic spend authorisation is enabled or not for the rewards participant

minimum_wallet_balanceFloat

The minimum wallet balance that should be available in order for an automatic awards spending to be applied. If specified then automatic awards spends will be created if the rewards participant has an available wallet amount which is equal or more than the minimum amount.

Available from CRM.COM R13.0.0

minimum_spend_amountFloat

The minimum amount that can be spend by that specific rewards participant during auto spend. If specified then automatic awards spends will be created if the rewards participant has an available amount that can be spend which is equal or more than the minimum amount.

Available from CRM.COM R13.0.0

maximum_spend_amountFloat

The maximum amount that can be spend by that specific rewards participant during auto spend. If specified then the amount of the automatic awards spends that will be created will be up to that specified amount, even if the available amount that can be spend is more than the maximum amount.

Available from CRM.COM R13.0.0

updated_date

Date

The last updated date on which the allow automatic spend setting was updated.

updated_by_userUsers ObjectThe User who last updated the allow automatic spend setting.
authorised_rewards_participating_merchants_setSet of Rewards Participating Merchants

It defines the list of merchants which are authorised to perform automatic awards spending on that specific rewards participant, considering that those merchants are also allowing automatic awards spendings. If not specified then all rewards participating merchants are considered as authorised

Available from CRM.COM R13.0.0

Referred Objects Response Data

 user object response data

Name

Type

Description

id

String

The ID of the retrieved user

username

String

The user name of the retrieved user

person_name

String

The full name of the retrieved user

email

String

The email of the retrieved user

 rewards participating merchants response object

NameType Description

id

String

The ID of the retrieved rewards participating merchant

life_cycle_state

String

The life cycle state of the retrieved rewards participating merchant that can be EFFECTIVE or NOT_EFFECTIVE

descriptionStringA description of the retrieved rewards participating merchant
business_unitBusiness Unit Object

The business unit that represents the rewards participating merchant

Available from CRM.COM R18.0.0

unitUnit Object

The unit that represents the rewards participating merchant

Deprecated from CRM.COM R18.0.0 (replaced with business_unit)

groupGroup Object

The group that the rewards participating merchant's unit belongs to

Deprecated from CRM.COM R18.0.0 (replaced with business_unit)

log_informationLog Information ObjectThe log information of the retrieved rewards participating merchant

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

 group object response data

Name

Type

Description

id

String

The ID of the retrieved group

name

String

The name of the retrieved group

community_name

String

The name of the community that the retrieved group belongs to

alternative_code

String

The alternative code of the retrieved group

unified_codeString

The unified code of the retrieved group

Available from CRM.COM R16.2.2

description

String

The description of the retrieved group

 log_information object response data

Name

Type

Description

created_date

Date

The date that the retrieved record was created

updated_date

Date

The last date that the retrieved record was updated

created_by_unit

Unit Object

The unit that created the retrieved record

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

Deprecated from CRM.COM R18.0.0

created_by_business_unit

Unit Object

The unit that created the retrieved record

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

Available from CRM.COM R18.0.0

created_by_user

User Object

The user that created the retrieved record

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

updated_by_unit

Unit Object

The last unit that updated the retrieved record

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

Deprecated from CRM.COM R18.0.0

updated_by_business_unit

Unit Object

The last unit that updated the retrieved record

Available from CRM.COM R18.0.0

updated_by_user

User Object

The last user that updated the retrieved record

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

Referred Objects Response Data

 unit object response data

Name

Type

Description

id

String

The ID of the retrieved unit

name

String

The name of the retrieved unit

group_name

String

The name of the group that the retrieved unit belongs to

community_name

String

The name of the community that the retrieved unit belongs to

alternative_code

String

The alternative code of the retrieved unit

description

String

The description of the retrieved unit

 business unit object response data

Name

Type

Description

id

String

The ID of the retrieved business unit

name

String

The name of the retrieved business unit

codeStringThe code of the retrieved business unit
unified_codeString

The unified code of the retrieved business unit

description

String

The description of the retrieved business unit

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

 user object response data

Name

Type

Description

id

String

The ID of the retrieved user

username

String

The user name of the retrieved user

person_name

String

The full name of the retrieved user

email

String

The email of the retrieved user

 business unit object response data

Name

Type

Description

id

String

The ID of the retrieved business unit

name

String

The name of the retrieved business unit

codeStringThe code of the retrieved business unit
unified_codeString

The unified code of the retrieved business unit

description

String

The description of the retrieved business unit

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

 spend request blocking state object response data

Name

Type

Description

enabled

Boolean

Defines whether the rewards participant is blocked from submitting spend requests

updated_date

Date

The date on which the rewards participant's blocking state was enabled/disabled

updated_by_userUsers ObjectThe user who enabled/disabled the rewards participant's blocking state

Referred Objects Response Data

 user object response data

Name

Type

Description

id

String

The ID of the retrieved user

username

String

The user name of the retrieved user

person_name

String

The full name of the retrieved user

email

String

The email of the retrieved user

 reward_tier_information object response data

Name

Type

Description

id

String

The id of the retrieved reward tier

nameStringThe name of the retrieved reward tier
codeStringThe code of the retrieved reward tier
marketing_informationReward Tier Marketing Information Object

The reward tier's marketing information

Referred Objects Response Data

 reward tier marketing information object response data

Name

Type

Description

tier_colorStringThe hexadecimal value of the tier's color

 rewards participant termination information object response data

Name

Type

Description

termination_reason

String

Defines the rewards participant's termination reason. Available values are CUSTOMERREQUEST, FRAUD, DUPLICATION

termination_date

Date

The date on which the rewards participant was terminated

terminated_by_userUsers ObjectThe user who terminated the rewards participant
replaced_by_rewards_participantRewards Participant ObjectThe Rewards Participant which replaced the terminated Rewards Participant. Applicable and mandatory only when the termination reason is set to DUPLICATION.

Referred Objects Response Data

 user object response data

Name

Type

Description

id

String

The ID of the retrieved user

username

String

The user name of the retrieved user

person_name

String

The full name of the retrieved user

email

String

The email of the retrieved user

 rewards participant object response data

Name

Type

Description

id

String

The ID of the retrieved reward participant

number

String

The number of the retrieved reward participant

life_cycle_stateString

The life cycle state of the rewards participant. Available values are EFFECTIVE and TERMINATED.

Available from CRM.COM R12.0.0

accounts_receivableAccounts receivable objectThe accounts receivable owned by the reward participant

Referred Objects Response Data

 accounts_receivable object response data

Name

Type

Description

id

String

The ID of the retrieved accounts receivable

number

String

The number of the retrieved accounts receivable

nameStringThe name of the retrieved accounts receivable

life_cycle_state

String

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

ACTIVE, SUSPENDED, TERMINATED

account_ownerContact information objectThe contact information owning the accounts receivable

Referred Objects Response Data

 contact_information object response data

Name

Type

Description

id

String

The ID of the retrieved contact information

type

String

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

life_cycle_state

String

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

name

String

The full name of the retrieved contact information

first_name

String

The first name of the retrieved contact information

middle_name

String

The middle name of the retrieved contact information

last_name

String

The last name of the retrieved contact information

title

String

The title of the retrieved contact information

company_nameSting

The company name of the retrieved contact information

demographics

Demographics Object

The demographics information of the retrieved contact information

company_profile

Company profile object

The company profile of the retrieve contact information

Referred Objects Response Data

 demographics object response data

Name

Type

Description

gender

String

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

id_number

String

The ID number of the retrieved contact information

id_number_expiration_dateDate

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

Available from CRM.COM R14.0.0

passport_number

String

The passport number of the retrieved contact information

passport_number_expiration_dateDate

The passport's expiration date of the retrieved contact information

Available from CRM.COM R14.0.0

social_security_number

String

The social security number of the retrieved contact information

date_of_birth

Date of Birth Object

The date of birth of the retrieved contact information

name_day

Name Day Object

The name day of the retrieved contact information

country_of_residence

Country Object

The country of residence of the retrieved contact information

id_issued_by_country

Country Object

The ID issued country of retrieved contact information

passport_issued_by_country

Country Object

The passport  issued country of retrieved contact information

industry

Industry Object

The industry of retrieved contact information

industry_sector

Industry sector Object

The sector of retrieved contact information

Referred Objects Response Data

 date_of_birth object response data

Name

Type

Description

day

Integer

The day of the retrieved date of birth

month

Integer

The month of the retrieved date of birth

year

Integer

The year of the retrieved date of birth

 name_day object response data

Name

Type

Description

day

Integer

The day of the retrieved name day

month

Integer

The month of the retrieved name day

 country object response data

Name

Type

Description

id

String

The id of the retrieved country

name

String

The name of the retrieved country

alternative_codeString

The alternative code of the retrieved country

dialing_codeString

The dialing code of the retrieved country

Available from CRM.COM R15.1.0

two_character_codeString

The two character code of the retrieved country

three_character_codeString

The three character code of the retrieved country

country_flagImage Object

The flag of the retrieved country

Available from CRM.COM R15.1.0

Referred Objects Response Data

 country_flag object response data

Name

Type

Description

id

String

The ID of the retrieved country flag

fileFile ObjectThe information of the attached file

Referred Objects Response Data

 file object response data

 

Name

Type

Description

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

 industry object response data

Name

Type

Description

id

String

The id of the retrieved industry

name

String

The name of the retrieved industry

code

String

The code of the retrieved industry

 industry sector object response data

Name

Type

Description

id

String

The id of the retrieved industry sector

name

String

The name of the retrieved industry sector

alternative_code

String

The alternative code of the retrieved industry sector

 company profile object response data

Name

Type

Description

profile_year

Number

The profile year of the retrieved contact information

annual_turnover

Number

The annual turnover of the retrieved contact information

established_date

Date

The established date of the retrieved contact information

number_of_employeesNumber

The number of employees of the retrieved contact information

registration_number

String

The registration number of the retrieved contact information

vat_registration_numberString

The vat registration number of the retrieved contact information

vat_registered_byString

The vat registration by of the retrieved contact information

vat_registration_date

Date

The vat registration date of the retrieved contact information

tax_reference_numberString

The tax referenece number of the retrieved contact information

registered_in_country

Country Object

The country of residence of the retrieved contact information

industry

Industry Object

The industry of retrieved contact information

industry_sector

Industry sector Object

The sector of retrieved contact information

Referred Objects Response Data

 country object response data

Name

Type

Description

id

String

The id of the retrieved country

name

String

The name of the retrieved country

alternative_codeString

The alternative code of the retrieved country

dialing_codeString

The dialing code of the retrieved country

Available from CRM.COM R15.1.0

two_character_codeString

The two character code of the retrieved country

three_character_codeString

The three character code of the retrieved country

country_flagImage Object

The flag of the retrieved country

Available from CRM.COM R15.1.0

Referred Objects Response Data

 country_flag object response data

Name

Type

Description

id

String

The ID of the retrieved country flag

fileFile ObjectThe information of the attached file

Referred Objects Response Data

 file object response data

 

Name

Type

Description

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

 industry object response data

Name

Type

Description

id

String

The id of the retrieved industry

name

String

The name of the retrieved industry

code

String

The code of the retrieved industry

 industry sector object response data

Name

Type

Description

id

String

The id of the retrieved industry sector

name

String

The name of the retrieved industry sector

alternative_code

String

The alternative code of the retrieved industry sector

 rewards participant scheme object response data

Name

Type

Description

id

String

The ID of the retrieved rewards participant participating reward scheme

sign_up_onDateThe date that the rewards participant signed up for that specific reward scheme
sign_off_onDate

Available from CRM.COM R9.0.0

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

reference_codeSting

The unique reference code that was used while signing up to that specific reward scheme. This is available only if it is required by the specific reward scheme

Available from CRM.COM R12.7.0

sign_up_by_unitUnit object

The unit that signed up the rewards participant to that specific reward scheme

Deprecated from CRM.COM R18.0.0

sign_up_by_business_unitBusiness Unit object

The business unit that signed up the rewards participant to that specific reward scheme

Available from CRM.COM R18.0.0

schemeReward Scheme ObjectThe reward scheme that the rewards participant has joint

Referred Objects Response Data

 unit object response data

Name

Type

Description

id

String

The ID of the retrieved unit

name

String

The name of the retrieved unit

group_name

String

The name of the group that the retrieved unit belongs to

community_name

String

The name of the community that the retrieved unit belongs to

alternative_code

String

The alternative code of the retrieved unit

description

String

The description of the retrieved unit

 business unit object response data

Name

Type

Description

id

String

The ID of the retrieved business unit

name

String

The name of the retrieved business unit

codeStringThe code of the retrieved business unit
unified_codeString

The unified code of the retrieved business unit

description

String

The description of the retrieved business unit

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

 reward scheme object response data

Name

Type

Description

id

String

The ID of the retrieved reward scheme

name

String

The name of the retrieved reward scheme

alternative_code

String

The alternative code of the retrieved reward scheme

descriptionStringA description of the retrieved reward scheme
life_cycle_stateStringThe life cycle state of the reward scheme which can be EFFECTIVE or NOT_EFFECTIVE

 accounts_receivable_usage_organisational_condition object response data

Name

Type

Description

business_unitBusiness Unit Object

The business unit included in the accounts receivable usage organisational condition

Available from CRM.COM R18.0.0

unitUnit object

The unit included in the accounts receivable usage organisational condition

Deprecated from CRM.COM R18.0.0 (replaced with business_unit)

groupGroup object

The group included in the accounts receivable usage organisational condition

Deprecated from CRM.COM R18.0.0 (replaced with business_unit)

communityCommunity object

The community included in the accounts receivable usage organisational condition

Deprecated from CRM.COM R18.0.0 (replaced with business_unit)

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

 group object response data

Name

Type

Description

id

String

The ID of the retrieved group

name

String

The name of the retrieved group

community_name

String

The name of the community that the retrieved group belongs to

alternative_code

String

The alternative code of the retrieved group

unified_codeString

The unified code of the retrieved group

Available from CRM.COM R16.2.2

description

String

The description of the retrieved group

 community object response data

Name

Type

Description

id

String

The ID of the retrieved community

name

String

The name of the retrieved community

alternative_code

String

The alternative code of the retrieved community

description

String

The description of the retrieved community

 business unit object response data

Name

Type

Description

id

String

The ID of the retrieved business unit

name

String

The name of the retrieved business unit

codeStringThe code of the retrieved business unit
unified_codeString

The unified code of the retrieved business unit

description

String

The description of the retrieved business unit

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

Examples

 Example 1

HTTP Method: GET


Request:


Response:

{
  "status": {
    "message": "",
    "description": "",
    "code": "OK"
  },
  "data": [
    {
      "notes": null,
      "udf_float_1": null,
      "credit_period": 0,
      "udf_float_2": null,
      "udf_float_3": null,
      "number": "ACR000929",
      "udf_float_4": null,
      "udf_string_1": null,
      "name": "ACR000929",
      "udf_string_2": null,
      "udf_string_3": null,
      "contact_information": {
        "last_name": "Tz",
        "middle_name": null,
        "life_cycle_state": "FINANCIAL",
        "company_profile": null,
        "title": null,
        "first_name": "Ek",
        "type": "PERSON",
        "id": "15D4F07E221E44088CDE00A96DB1A250",
        "name": "Tz Ek",
        "company_name": null,
        "demographics": {
          "gender": null,
          "passport_issued_by_country": null,
          "social_security_number": null,
          "passport_number": "18181818",
          "industry_sector": null,
          "country_of_residence": {
            "three_character_code": "CYP",
            "two_character_code": "CY",
            "id": "181",
            "name": "CYPRUS",
            "alternative_code": null
          },
          "name_day": {
            "month": null,
            "day": null
          },
          "date_of_birth": {
            "month": null,
            "day": null,
            "year": null
          },
          "id_number": null,
          "industry": null,
          "id_issued_by_country": null
        }
      },
      "privacy_level": null,
      "udf_string_4": null,
      "udf_string_5": null,
      "udf_string_6": null,
      "udf_string_7": null,
      "udf_string_8": null,
      "id": "0DA7BAB9909E49828BB84079AA588AF8",
      "credit_period_operator": "PLUS",
      "balance": 1245.31,
      "outstanding_amount": 1245.31,
      "payment_preferences_set": [],
      "credit_rating": {
        "name": "key_ba_-_subject_to_substantial_credit_risk",
        "code": "BA"
      },
      "classification": {
        "id": "DD764F3EB0334FC857F8BE5DD4CB41E1",
        "name": "VIP Customer",
        "alternative_code": "VC"
      },
      "udf_date_1": null,
      "udf_date_2": null,
      "udf_date_3": null,
      "udf_date_4": null,
      "accounting_period": {
        "closed_date": null,
        "to_date": "2016-05-31 00:00:00.0",
        "from_date": "2016-05-01 00:00:00.0",
        "life_cycle_state": "OPEN",
        "number": "052016",
        "name": "May 2016"
      },
      "primary_account": true,
      "billing_address": {
        "udf_string_10": null,
        "street_number": "435",
        "care_of": null,
        "udf_string_11": null,
        "udf_float_1": null,
        "street_name": "kassa",
        "udf_string_12": null,
        "udf_float_2": null,
        "udf_string_13": null,
        "udf_float_3": null,
        "udf_string_14": null,
        "udf_float_4": null,
        "udf_string_15": null,
        "udf_string_16": null,
        "po_box": null,
        "udf_string_1": null,
        "floor": null,
        "udf_string_2": null,
        "area": "Aglantzia",
        "udf_string_3": null,
        "district": null,
        "udf_string_4": null,
        "udf_string_5": null,
        "udf_string_6": null,
        "udf_string_7": null,
        "state": "Active",
        "udf_string_8": null,
        "udf_string_9": null,
        "country": {
          "three_character_code": "CMR",
          "two_character_code": "CM",
          "id": "164",
          "name": "CAMEROON",
          "alternative_code": null
        },
        "id": "CAB5EC4F32DB4C2F87C93BF0972024FD",
        "postal_code": "1212",
        "udf_date_1": null,
        "udf_date_2": null,
        "udf_date_3": null,
        "udf_date_4": null,
        "po_box_postal_code": null,
        "apartment_number": null,
        "town_city": "Nicosia",
        "type": "BUSINESS",
        "municipality": null
      },
      "log_information": {
        "updated_date": "2016-04-12T17:22:50",
        "created_date": "2015-12-30T10:43:17",
        "created_by_unit": {
          "community_name": "Internal Community",
          "id": "48305F8849E3C18B227C5BE3A27BA6DF",
          "name": "Admin Unit",
          "group_name": "Main Group",
          "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
          "alternative_code": "MG"
        },
        "updated_by_unit": {
          "community_name": "Internal Community",
          "id": "48305F8849E3C18B227C5BE3A27BA6DF",
          "name": "Admin Unit",
          "group_name": "Main Group",
          "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
          "alternative_code": "MG"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "username": "MPAdministrator",
          "id": "1",
          "email": "sakkascy1986@hotmail.com"
        },
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "username": "MPAdministrator",
          "id": "1",
          "email": "sakkascy1986@hotmail.com"
        }
      },
      "owned_by_group": {
        "community_name": "Internal Community",
        "id": "84F33366CB592BAAE7E2044D93611C6A",
        "name": "Main Group",
        "description": "Main Group",
        "alternative_code": "MG1"
      },
      "life_cycle_state": "ACTIVE",
      "opening_balance": 20,
      "credit_limit": 300,
      "presentment_preferences_set": [],
      "opening_balance_date": "2016-05-17 10:17:30.0",
      "access_tokens_set": [],
      "type": "CUSTOMER",
      "description": null,
      "credit_limit_status": "EXCEEDED"
    }
  ]
}
 Example 1

HTTP Method: GET


Request:


Response:

{
  "data": [
    {
      "notes": null,
      "log_information": {
        "created_by_unit": {
          "alternative_code": "adminunit",
          "group_name": "Main Group",
          "community_name": "Community",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "updated_by_unit": {
          "alternative_code": "adminunit",
          "group_name": "Main Group",
          "community_name": "Community",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "created_date": "2016-02-19T14:24:40",
        "updated_date": "2016-04-11T12:26:55",
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "email": "dev@crm.com",
          "username": "MPAdministrator"
        },
        "created_by_user": {
          "person_name": "Ekaterini Tzirtzipi",
          "id": "708FB289CCAA4DA3B5CCD186E023CF0C",
          "email": null,
          "username": "etzirtzipi"
        }
      },
      "payment_preferences_set": [],
      "owned_by_group": {
        "alternative_code": "MG",
        "community_name": "Community",
        "name": "Main Group",
        "description": "Main Group",
        "id": "1"
      },
      "description": null,
      "contact_information": {
        "company_profile": null,
        "company_name": null,
        "name": "Ekaterini Tzirtzipi",
        "last_name": "Tzirtzipi",
        "id": "3236797A43C746F8AD9F4A91A4035735",
        "life_cycle_state": "FINANCIAL",
        "middle_name": null,
        "title": null,
        "type": "PERSON",
        "first_name": "Ekaterini",
        "demographics": {
          "name_day": {
            "month": null,
            "day": null
          },
          "id_number": "343434",
          "gender": null,
          "country_of_residence": {
            "alternative_code": "CYP",
            "three_character_code": "CYP",
            "name": "CYPRUS",
            "id": "181",
            "two_character_code": "CY"
          },
          "date_of_birth": {
            "month": null,
            "year": null,
            "day": null
          },
          "industry_sector": null,
          "passport_number": null,
          "industry": null,
          "social_security_number": null,
          "id_issued_by_country": null,
          "passport_issued_by_country": null
        }
      },
      "billing_address": {
        "apartment_number": null,
        "care_of": null,
        "country": {
          "alternative_code": "CYP",
          "three_character_code": "CYP",
          "name": "CYPRUS",
          "id": "181",
          "two_character_code": "CY"
        },
        "municipality": null,
        "type": "BUSINESS",
        "udf_date_2": null,
        "udf_date_1": null,
        "street_name": "Lidras",
        "udf_date_4": null,
        "udf_date_3": null,
        "udf_float_3": null,
        "udf_float_4": null,
        "po_box_postal_code": null,
        "udf_string_15": null,
        "udf_string_16": null,
        "udf_string_13": null,
        "udf_string_14": null,
        "udf_string_11": null,
        "udf_string_12": null,
        "id": "79E72F8D36CA49C1999F090561AE0020",
        "state": "Active",
        "udf_string_10": null,
        "floor": null,
        "udf_float_1": null,
        "udf_float_2": null,
        "area": null,
        "udf_string_2": null,
        "udf_string_3": null,
        "udf_string_4": null,
        "udf_string_5": null,
        "udf_string_1": null,
        "po_box": null,
        "town_city": null,
        "district": null,
        "street_number": null,
        "postal_code": null,
        "udf_string_6": null,
        "udf_string_7": null,
        "udf_string_8": null,
        "udf_string_9": null
      },
      "primary_account": true,
      "type": "CUSTOMER",
      "udf_date_2": null,
      "udf_date_1": null,
      "udf_date_4": null,
      "udf_date_3": null,
      "number": "ACR0000000050",
      "udf_float_3": null,
      "udf_float_4": null,
      "balance": -38.15,
      "credit_period_operator": "PLUS",
      "credit_limit": null,
      "credit_period": 2,
      "currency": {
        "suffix_symbol": null,
        "prefix_symbol": "€",
        "decimal_part_name": null,
        "code": "EUR",
        "integer_part_name": null,
        "id": "2"
      },
      "id": "1B61E3A9DB864363A1502829952DF3CD",
      "opening_balance": null,
      "udf_float_1": null,
      "udf_float_2": null,
      "udf_string_2": null,
      "opening_balance_date": null,
      "udf_string_3": null,
      "udf_string_4": null,
      "udf_string_5": null,
      "privacy_level": null,
      "presentment_preferences_set": [],
      "udf_string_1": null,
      "life_cycle_state": "ACTIVE",
      "classification": {
        "alternative_code": "RC",
        "name": "Residential Customer",
        "id": "622533B94C749EE89D1933FD4D1FFFF7"
      },
      "credit_limit_status": "NOT_EXCEEDED",
      "credit_rating": {
        "code": "AAA",
        "name": "key_aaa_-_subject_to_minimal_credit_risk"
      },
      "name": "ACR0000000050 Ekaterini Tzirtzipi",
      "outstanding_amount": 0,
      "udf_string_6": null,
      "udf_string_7": null,
      "accounting_period": null,
      "access_tokens_set": [],
      "udf_string_8": null
    },
    {
      "notes": null,
      "log_information": {
        "created_by_unit": {
          "alternative_code": "adminunit",
          "group_name": "Main Group",
          "community_name": "Community",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "updated_by_unit": {
          "alternative_code": "adminunit",
          "group_name": "Main Group",
          "community_name": "Community",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "created_date": "2016-03-24T08:27:09",
        "updated_date": "2016-03-24T08:29:06",
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "email": "dev@crm.com",
          "username": "MPAdministrator"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "email": "dev@crm.com",
          "username": "MPAdministrator"
        }
      },
      "payment_preferences_set": [],
      "owned_by_group": {
        "alternative_code": "MG",
        "community_name": "Community",
        "name": "Main Group",
        "description": "Main Group",
        "id": "1"
      },
      "description": null,
      "contact_information": {
        "company_profile": null,
        "company_name": null,
        "name": "Ekaterini Tzirtzipi",
        "last_name": "Tzirtzipi",
        "id": "3236797A43C746F8AD9F4A91A4035735",
        "life_cycle_state": "FINANCIAL",
        "middle_name": null,
        "title": null,
        "type": "PERSON",
        "first_name": "Ekaterini",
        "demographics": {
          "name_day": {
            "month": null,
            "day": null
          },
          "id_number": "343434",
          "gender": null,
          "country_of_residence": {
            "alternative_code": "CYP",
            "three_character_code": "CYP",
            "name": "CYPRUS",
            "id": "181",
            "two_character_code": "CY"
          },
          "date_of_birth": {
            "month": null,
            "year": null,
            "day": null
          },
          "industry_sector": null,
          "passport_number": null,
          "industry": null,
          "social_security_number": null,
          "id_issued_by_country": null,
          "passport_issued_by_country": null
        }
      },
      "billing_address": {
        "apartment_number": null,
        "care_of": null,
        "country": {
          "alternative_code": "CYP",
          "three_character_code": "CYP",
          "name": "CYPRUS",
          "id": "181",
          "two_character_code": "CY"
        },
        "municipality": null,
        "type": "BUSINESS",
        "udf_date_2": null,
        "udf_date_1": null,
        "street_name": "Lidras",
        "udf_date_4": null,
        "udf_date_3": null,
        "udf_float_3": null,
        "udf_float_4": null,
        "po_box_postal_code": null,
        "udf_string_15": null,
        "udf_string_16": null,
        "udf_string_13": null,
        "udf_string_14": null,
        "udf_string_11": null,
        "udf_string_12": null,
        "id": "79E72F8D36CA49C1999F090561AE0020",
        "state": "Active",
        "udf_string_10": null,
        "floor": null,
        "udf_float_1": null,
        "udf_float_2": null,
        "area": null,
        "udf_string_2": null,
        "udf_string_3": null,
        "udf_string_4": null,
        "udf_string_5": null,
        "udf_string_1": null,
        "po_box": null,
        "town_city": null,
        "district": null,
        "street_number": null,
        "postal_code": null,
        "udf_string_6": null,
        "udf_string_7": null,
        "udf_string_8": null,
        "udf_string_9": null
      },
      "primary_account": false,
      "type": "CUSTOMER",
      "udf_date_2": null,
      "udf_date_1": null,
      "udf_date_4": null,
      "udf_date_3": null,
      "number": "ACR0000000145",
      "udf_float_3": null,
      "udf_float_4": null,
      "balance": 0,
      "credit_period_operator": "PLUS",
      "credit_limit": null,
      "credit_period": 2,
      "currency": {
        "suffix_symbol": null,
        "prefix_symbol": "€",
        "decimal_part_name": null,
        "code": "EUR",
        "integer_part_name": null,
        "id": "2"
      },
      "id": "71B5891495F540BE9097F524CA594F7E",
      "opening_balance": null,
      "udf_float_1": null,
      "udf_float_2": null,
      "udf_string_2": null,
      "opening_balance_date": null,
      "udf_string_3": null,
      "udf_string_4": null,
      "udf_string_5": null,
      "privacy_level": null,
      "presentment_preferences_set": [
        {
          "phone": null,
          "presentment_method": {
            "alternative_code": "P",
            "name": "Post",
            "description": null,
            "contact_information": {
              "company_profile": null,
              "company_name": null,
              "name": "Template CRM.COM User",
              "last_name": "CRM.COM User",
              "id": "CRM1",
              "life_cycle_state": null,
              "middle_name": null,
              "title": null,
              "type": "PERSON",
              "first_name": "Template",
              "demographics": {
                "name_day": {
                  "month": null,
                  "day": null
                },
                "id_number": " ",
                "gender": null,
                "country_of_residence": null,
                "date_of_birth": {
                  "month": 4,
                  "year": 1984,
                  "day": 2
                },
                "industry_sector": null,
                "passport_number": null,
                "industry": null,
                "social_security_number": "47006270010",
                "id_issued_by_country": null,
                "passport_issued_by_country": null
              }
            },
            "id": "DDCC4450F9311CA9BC6BD663889A16C9",
            "state": "ACTIVE",
            "type": "POST"
          },
          "id": "C78F160C3665412FA6F26033A883D40E",
          "state": "ACTIVE",
          "email": null
        }
      ],
      "udf_string_1": null,
      "life_cycle_state": "TERMINATED",
      "classification": {
        "alternative_code": "RC",
        "name": "Residential Customer",
        "id": "622533B94C749EE89D1933FD4D1FFFF7"
      },
      "credit_limit_status": "NOT_EXCEEDED",
      "credit_rating": {
        "code": "AAA",
        "name": "key_aaa_-_subject_to_minimal_credit_risk"
      },
      "name": "ACR0000000145 Ekaterini Tzirtzipi",
      "outstanding_amount": 0,
      "udf_string_6": null,
      "udf_string_7": null,
      "accounting_period": null,
      "access_tokens_set": [],
      "udf_string_8": null
    },
    {
      "notes": null,
      "log_information": {
        "created_by_unit": {
          "alternative_code": "adminunit",
          "group_name": "Main Group",
          "community_name": "Community",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "updated_by_unit": {
          "alternative_code": "adminunit",
          "group_name": "Main Group",
          "community_name": "Community",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "created_date": "2016-03-31T08:26:04",
        "updated_date": "2016-03-31T08:26:57",
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "email": "dev@crm.com",
          "username": "MPAdministrator"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "email": "dev@crm.com",
          "username": "MPAdministrator"
        }
      },
      "payment_preferences_set": [],
      "owned_by_group": {
        "alternative_code": "MG",
        "community_name": "Community",
        "name": "Main Group",
        "description": "Main Group",
        "id": "1"
      },
      "description": null,
      "contact_information": {
        "company_profile": null,
        "company_name": null,
        "name": "Ekaterini Tzirtzipi",
        "last_name": "Tzirtzipi",
        "id": "3236797A43C746F8AD9F4A91A4035735",
        "life_cycle_state": "FINANCIAL",
        "middle_name": null,
        "title": null,
        "type": "PERSON",
        "first_name": "Ekaterini",
        "demographics": {
          "name_day": {
            "month": null,
            "day": null
          },
          "id_number": "343434",
          "gender": null,
          "country_of_residence": {
            "alternative_code": "CYP",
            "three_character_code": "CYP",
            "name": "CYPRUS",
            "id": "181",
            "two_character_code": "CY"
          },
          "date_of_birth": {
            "month": null,
            "year": null,
            "day": null
          },
          "industry_sector": null,
          "passport_number": null,
          "industry": null,
          "social_security_number": null,
          "id_issued_by_country": null,
          "passport_issued_by_country": null
        }
      },
      "billing_address": {
        "apartment_number": null,
        "care_of": null,
        "country": {
          "alternative_code": "CYP",
          "three_character_code": "CYP",
          "name": "CYPRUS",
          "id": "181",
          "two_character_code": "CY"
        },
        "municipality": null,
        "type": "BUSINESS",
        "udf_date_2": null,
        "udf_date_1": null,
        "street_name": "Lidras",
        "udf_date_4": null,
        "udf_date_3": null,
        "udf_float_3": null,
        "udf_float_4": null,
        "po_box_postal_code": null,
        "udf_string_15": null,
        "udf_string_16": null,
        "udf_string_13": null,
        "udf_string_14": null,
        "udf_string_11": null,
        "udf_string_12": null,
        "id": "79E72F8D36CA49C1999F090561AE0020",
        "state": "Active",
        "udf_string_10": null,
        "floor": null,
        "udf_float_1": null,
        "udf_float_2": null,
        "area": null,
        "udf_string_2": null,
        "udf_string_3": null,
        "udf_string_4": null,
        "udf_string_5": null,
        "udf_string_1": null,
        "po_box": null,
        "town_city": null,
        "district": null,
        "street_number": null,
        "postal_code": null,
        "udf_string_6": null,
        "udf_string_7": null,
        "udf_string_8": null,
        "udf_string_9": null
      },
      "primary_account": false,
      "type": "CUSTOMER",
      "udf_date_2": null,
      "udf_date_1": null,
      "udf_date_4": null,
      "udf_date_3": null,
      "number": "ACR0000000189",
      "udf_float_3": null,
      "udf_float_4": null,
      "balance": 0,
      "credit_period_operator": "PLUS",
      "credit_limit": null,
      "credit_period": 2,
      "currency": {
        "suffix_symbol": null,
        "prefix_symbol": "€",
        "decimal_part_name": null,
        "code": "EUR",
        "integer_part_name": null,
        "id": "2"
      },
      "id": "394C7536686B46C6B786494C884C62EA",
      "opening_balance": null,
      "udf_float_1": null,
      "udf_float_2": null,
      "udf_string_2": null,
      "opening_balance_date": null,
      "udf_string_3": null,
      "udf_string_4": null,
      "udf_string_5": null,
      "privacy_level": null,
      "presentment_preferences_set": [],
      "udf_string_1": null,
      "life_cycle_state": "ACTIVE",
      "classification": {
        "alternative_code": "RC",
        "name": "Residential Customer",
        "id": "622533B94C749EE89D1933FD4D1FFFF7"
      },
      "credit_limit_status": "NOT_EXCEEDED",
      "credit_rating": {
        "code": "AAA",
        "name": "key_aaa_-_subject_to_minimal_credit_risk"
      },
      "name": "ACR0000000189 Ekaterini Tzirtzipi",
      "outstanding_amount": 0,
      "udf_string_6": null,
      "udf_string_7": null,
      "accounting_period": null,
      "access_tokens_set": [],
      "udf_string_8": null
    },
    {
      "notes": null,
      "log_information": {
        "created_by_unit": {
          "alternative_code": "adminunit",
          "group_name": "Main Group",
          "community_name": "Community",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "updated_by_unit": {
          "alternative_code": "adminunit",
          "group_name": "Main Group",
          "community_name": "Community",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "created_date": "2016-03-17T12:59:04",
        "updated_date": "2016-03-31T08:18:22",
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "email": "dev@crm.com",
          "username": "MPAdministrator"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "email": "dev@crm.com",
          "username": "MPAdministrator"
        }
      },
      "payment_preferences_set": [],
      "owned_by_group": {
        "alternative_code": "MG",
        "community_name": "Community",
        "name": "Main Group",
        "description": "Main Group",
        "id": "1"
      },
      "description": null,
      "contact_information": {
        "company_profile": null,
        "company_name": null,
        "name": "Ekaterini Tzirtzipi",
        "last_name": "Tzirtzipi",
        "id": "3236797A43C746F8AD9F4A91A4035735",
        "life_cycle_state": "FINANCIAL",
        "middle_name": null,
        "title": null,
        "type": "PERSON",
        "first_name": "Ekaterini",
        "demographics": {
          "name_day": {
            "month": null,
            "day": null
          },
          "id_number": "343434",
          "gender": null,
          "country_of_residence": {
            "alternative_code": "CYP",
            "three_character_code": "CYP",
            "name": "CYPRUS",
            "id": "181",
            "two_character_code": "CY"
          },
          "date_of_birth": {
            "month": null,
            "year": null,
            "day": null
          },
          "industry_sector": null,
          "passport_number": null,
          "industry": null,
          "social_security_number": null,
          "id_issued_by_country": null,
          "passport_issued_by_country": null
        }
      },
      "billing_address": {
        "apartment_number": null,
        "care_of": null,
        "country": {
          "alternative_code": "CYP",
          "three_character_code": "CYP",
          "name": "CYPRUS",
          "id": "181",
          "two_character_code": "CY"
        },
        "municipality": null,
        "type": "BUSINESS",
        "udf_date_2": null,
        "udf_date_1": null,
        "street_name": "Lidras",
        "udf_date_4": null,
        "udf_date_3": null,
        "udf_float_3": null,
        "udf_float_4": null,
        "po_box_postal_code": null,
        "udf_string_15": null,
        "udf_string_16": null,
        "udf_string_13": null,
        "udf_string_14": null,
        "udf_string_11": null,
        "udf_string_12": null,
        "id": "79E72F8D36CA49C1999F090561AE0020",
        "state": "Active",
        "udf_string_10": null,
        "floor": null,
        "udf_float_1": null,
        "udf_float_2": null,
        "area": null,
        "udf_string_2": null,
        "udf_string_3": null,
        "udf_string_4": null,
        "udf_string_5": null,
        "udf_string_1": null,
        "po_box": null,
        "town_city": null,
        "district": null,
        "street_number": null,
        "postal_code": null,
        "udf_string_6": null,
        "udf_string_7": null,
        "udf_string_8": null,
        "udf_string_9": null
      },
      "primary_account": false,
      "type": "CUSTOMER",
      "udf_date_2": null,
      "udf_date_1": null,
      "udf_date_4": null,
      "udf_date_3": null,
      "number": "ACR0000000108",
      "udf_float_3": null,
      "udf_float_4": null,
      "balance": 0,
      "credit_period_operator": "PLUS",
      "credit_limit": null,
      "credit_period": 2,
      "currency": {
        "suffix_symbol": null,
        "prefix_symbol": "€",
        "decimal_part_name": null,
        "code": "EUR",
        "integer_part_name": null,
        "id": "2"
      },
      "id": "EB017D73567040A6A220E5E76A090641",
      "opening_balance": null,
      "udf_float_1": null,
      "udf_float_2": null,
      "udf_string_2": null,
      "opening_balance_date": null,
      "udf_string_3": null,
      "udf_string_4": null,
      "udf_string_5": null,
      "privacy_level": null,
      "presentment_preferences_set": [],
      "udf_string_1": null,
      "life_cycle_state": "TERMINATED",
      "classification": {
        "alternative_code": "RC",
        "name": "Residential Customer",
        "id": "622533B94C749EE89D1933FD4D1FFFF7"
      },
      "credit_limit_status": "NOT_EXCEEDED",
      "credit_rating": {
        "code": "AAA",
        "name": "key_aaa_-_subject_to_minimal_credit_risk"
      },
      "name": "ACR0000000108 Ekaterini Tzirtzipi",
      "outstanding_amount": 0,
      "udf_string_6": null,
      "udf_string_7": null,
      "accounting_period": null,
      "access_tokens_set": [
        {
          "authentication_code": "15",
          "number": "AT0000000097",
          "identifier": "jimmyKimmel@gmail.com",
          "id": "5A8A728D81DB4C818989D023025760D7",
          "life_cycle_state": "EFFECTIVE",
          "classification": null
        }
      ],
      "udf_string_8": null
    },
    {
      "notes": null,
      "log_information": {
        "created_by_unit": {
          "alternative_code": "adminunit",
          "group_name": "Main Group",
          "community_name": "Community",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "updated_by_unit": {
          "alternative_code": "adminunit",
          "group_name": "Main Group",
          "community_name": "Community",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "created_date": "2016-03-23T15:16:59",
        "updated_date": "2016-03-31T08:12:08",
        "updated_by_user": {
          "person_name": "lpapapavlou",
          "id": "E89974529ECD47459FA7C0486F3BFA66",
          "email": null,
          "username": "lpapapavlou"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "email": "dev@crm.com",
          "username": "MPAdministrator"
        }
      },
      "payment_preferences_set": [],
      "owned_by_group": {
        "alternative_code": "MG",
        "community_name": "Community",
        "name": "Main Group",
        "description": "Main Group",
        "id": "1"
      },
      "description": null,
      "contact_information": {
        "company_profile": null,
        "company_name": null,
        "name": "Ekaterini Tzirtzipi",
        "last_name": "Tzirtzipi",
        "id": "3236797A43C746F8AD9F4A91A4035735",
        "life_cycle_state": "FINANCIAL",
        "middle_name": null,
        "title": null,
        "type": "PERSON",
        "first_name": "Ekaterini",
        "demographics": {
          "name_day": {
            "month": null,
            "day": null
          },
          "id_number": "343434",
          "gender": null,
          "country_of_residence": {
            "alternative_code": "CYP",
            "three_character_code": "CYP",
            "name": "CYPRUS",
            "id": "181",
            "two_character_code": "CY"
          },
          "date_of_birth": {
            "month": null,
            "year": null,
            "day": null
          },
          "industry_sector": null,
          "passport_number": null,
          "industry": null,
          "social_security_number": null,
          "id_issued_by_country": null,
          "passport_issued_by_country": null
        }
      },
      "billing_address": {
        "apartment_number": null,
        "care_of": null,
        "country": {
          "alternative_code": "CYP",
          "three_character_code": "CYP",
          "name": "CYPRUS",
          "id": "181",
          "two_character_code": "CY"
        },
        "municipality": null,
        "type": "BUSINESS",
        "udf_date_2": null,
        "udf_date_1": null,
        "street_name": "Lidras",
        "udf_date_4": null,
        "udf_date_3": null,
        "udf_float_3": null,
        "udf_float_4": null,
        "po_box_postal_code": null,
        "udf_string_15": null,
        "udf_string_16": null,
        "udf_string_13": null,
        "udf_string_14": null,
        "udf_string_11": null,
        "udf_string_12": null,
        "id": "79E72F8D36CA49C1999F090561AE0020",
        "state": "Active",
        "udf_string_10": null,
        "floor": null,
        "udf_float_1": null,
        "udf_float_2": null,
        "area": null,
        "udf_string_2": null,
        "udf_string_3": null,
        "udf_string_4": null,
        "udf_string_5": null,
        "udf_string_1": null,
        "po_box": null,
        "town_city": null,
        "district": null,
        "street_number": null,
        "postal_code": null,
        "udf_string_6": null,
        "udf_string_7": null,
        "udf_string_8": null,
        "udf_string_9": null
      },
      "primary_account": false,
      "type": "CUSTOMER",
      "udf_date_2": null,
      "udf_date_1": null,
      "udf_date_4": null,
      "udf_date_3": null,
      "number": "ACR0000000143",
      "udf_float_3": null,
      "udf_float_4": null,
      "balance": 0,
      "credit_period_operator": "PLUS",
      "credit_limit": null,
      "credit_period": 2,
      "currency": {
        "suffix_symbol": null,
        "prefix_symbol": "€",
        "decimal_part_name": null,
        "code": "EUR",
        "integer_part_name": null,
        "id": "2"
      },
      "id": "B6C9D4FD7E0D47D392A3705CCFB1E6E5",
      "opening_balance": null,
      "udf_float_1": null,
      "udf_float_2": null,
      "udf_string_2": null,
      "opening_balance_date": null,
      "udf_string_3": null,
      "udf_string_4": null,
      "udf_string_5": null,
      "privacy_level": null,
      "presentment_preferences_set": [],
      "udf_string_1": null,
      "life_cycle_state": "ACTIVE",
      "classification": {
        "alternative_code": "RC",
        "name": "Residential Customer",
        "id": "622533B94C749EE89D1933FD4D1FFFF7"
      },
      "credit_limit_status": "NOT_EXCEEDED",
      "credit_rating": {
        "code": "AAA",
        "name": "key_aaa_-_subject_to_minimal_credit_risk"
      },
      "name": "ACR0000000143 Ekaterini Tzirtzipi",
      "outstanding_amount": 0,
      "udf_string_6": null,
      "udf_string_7": null,
      "accounting_period": null,
      "access_tokens_set": [
        {
          "authentication_code": "14",
          "number": "AT0000000096",
          "identifier": "kathy_tz@gmail.com",
          "id": "817A02342D434E438CF64AF73CA22816",
          "life_cycle_state": "EFFECTIVE",
          "classification": null
        }
      ],
      "udf_string_8": null
    }
  ],
  "status": {
    "code": "OK",
    "description": "",
    "message": ""
  }
}
  • No labels