Available from CRM.COM R4.0.0

GET notifications/show

This method returns information related with a notification. A single notification is returned by each call

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

notifications_identifier

(semi-optional)

Notification identifier

The identifier of the notification that should be returned as a result. The allowed notification identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the notification

number

(semi-optional)

String

The number of the notification

communication_identifier

(semi-optional)

Communication identifier

The identifier of the communication that was created for the notification that should be returned as a result. The allowed communication identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the communication

number

(semi-optional)

String

The number of the communicaiton

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 notification
number	String	The number of the retrieved notification
life_cycle_state	String	The life cycle state of the retrieved notification which can be PENDING, REJECTED or COMPLETED and is calculated dynamically based on the related communication queue entry life cycle state
total_notified_amount	Number	Additional information which is populated if the notification type is classified as financial, and if the notified information is set to Subscriptions, Bills or Jobs. It defines the total initial notified amount for each subscription or job or bill included in the notification
total_outstanding_amount	Number	Additional information which is populated if the notification type is classified as financial, and if the notified information is set to Subscriptions, Bills or Jobs. It defines the total amount which is still outstanding for each subscription or bill or job included in the notification
unsettled_amount	Number	Additional information which is populated if the notification type is classified as financial, and if the notified information is set to Subscriptions, Bills or Jobs. It defines the total amount which is still unsettled for each subscription or bill or job included in the notification
expiration_date	Date	The expiration date of the notification as provided through the Notification Type Available from R14.2.0
upcoming_bill_amount	Number	Additional information which is populated if the notification type is classified as financial and if the notified information is set to Bills, having the "Calculate upcoming bill" option enabled. It defines the total upcoming bill amount to be paid of each accounts receivable included in the notification Available from R14.5.0
upcoming_bill_as_of_date	Date	The as of date of the upcoming bill calculated Available from R14.5.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
type	Notification Type object	The type of the specific notification
notification_run	Notification Run object	The notification run that generated the specific notification
contact_information	Contact Information object	The contact information related with the specific notification
accounts_receivable	Accounts Receivable object	The accounts receivable related with the specific notification
communication_queue	Communication Queue Object	The communication queue entry that was created for the specific notification
currency_rate_period	Currency Rate Period Object	The notification's currency rate period
log_information	Log Information Object	The log information related with the retrieved notification
items_set	Set of Notification Item objects	The information for which the customer will be notified about by the specific notification. That information differentiates based on the notification type classification

Referred Objects Response Data

notification_type object response data

Name	Type	Description
id	String	The ID of the retrieved notification type
name	String	The name of the retrieved notification type
alternative_code	String	The alternative code of the retrieved notification type
description	String	A description of the retrieved notification type
classification	String	The classification of the retrieved notification type which can be one of the following: FINANCIAL CUSTOMER_CARE REWARD_OFFERS REWARD_OFFERS classification available from CRM.COM R12.0.0

notification_run object response data

Name	Type	Description
id	String	The ID of the retrieved notification run
number	String	The number of the retrieved notification run
life_cycle_state	String	The life cycle state of the notification run which can be PENDING, IN_PROGRESS or COMPLETED
start_date	Date	The date that the notification run started
end_date	Date	The date that the notification run ended

contact_information object response data

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

Referred Objects Response Data

demographics object response data

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

Referred Objects Response Data

date_of_birth object response data

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

name_day object response data

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

country object response data

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

Referred Objects Response Data

country_flag object response data

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

Referred Objects Response Data

file object response data

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

industry object response data

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

industry sector object response data

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

company profile object response data

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

Referred Objects Response Data

country object response data

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

Referred Objects Response Data

country_flag object response data

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

Referred Objects Response Data

file object response data

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

industry object response data

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

industry sector object response data

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

accounts_receivable object response data

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

Referred Objects Response Data

contact_information object response data

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

Referred Objects Response Data

demographics object response data

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

Referred Objects Response Data

date_of_birth object response data

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

name_day object response data

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

country object response data

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

Referred Objects Response Data

country_flag object response data

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

Referred Objects Response Data

file object response data

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

industry object response data

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

industry sector object response data

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

company profile object response data

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

Referred Objects Response Data

country object response data

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

Referred Objects Response Data

country_flag object response data

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

Referred Objects Response Data

file object response data

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

industry object response data

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

industry sector object response data

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

communication queue response data

Name	Type	Description
id	String	The ID of the retrieved communication queue entry
number	String	The number of the retrieved communication queue entry
life_cycle_state	String	The life cycle state of the retrieved communication queue entry which can be PENDING, REJECTED or COMPLETED
communication	Communication object	The communication that is sent through the retrieved communication queue entry
external_system	Communication Queue External System object	The external system which process the communication waiting in retrieved communication queue entry

Referred Objects Response Data

communication object response data

Name	Type	Description
Id	String	The ID of the communication
number	String	The code of communication
life_cycle_state	String	The lifecycle state of the retrieved communication which can be DRAFT or COMPLETE
subject	String	The subject of the retrieved communication
viewed	Boolean	Defines whether the communication was viewed, or not Available from CRM.COM R12.2.0
viewed_on	Date	The date that the communication was viewed Available from CRM.COM R12.2.0
contact_information	Contact Information object	The contact information related with the specified communication

Referred Objects Response Data

contact_information object response data

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

Referred Objects Response Data

demographics object response data

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

Referred Objects Response Data

date_of_birth object response data

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

name_day object response data

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

country object response data

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

Referred Objects Response Data

country_flag object response data

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

Referred Objects Response Data

file object response data

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

industry object response data

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

industry sector object response data

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

company profile object response data

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

Referred Objects Response Data

country object response data

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

Referred Objects Response Data

country_flag object response data

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

Referred Objects Response Data

file object response data

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

industry object response data

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

industry sector object response data

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

communication_queue_external_system object response data

Name	Type	Description
Id	String	The ID of the communication queue external system
name	String	The name of the communication queue external system
alternative_code	String	The alternative code of the communication queue external system

currency rate period object response data

Name	Type	Description
id	String	The ID of the retrieved currency rate period
rate	Number	The exchange rate of the currency rate period
inverse_rate	Number	The inverse exchange rate of the currency rate period
from_date	Date	The date from which the exchange rate is valid
to_date	Date	The date until which the exchange rate is valid
currency	Currency Object	The Currency with which the returned exchange rate information refers to

Referred Objects Response Data

currency object response data

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

log_information object response data

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

Referred Objects Response Data

unit object response data

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

business unit object response data

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

user object response data

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

notification item response data

Name	Type	Description
id	String	The ID of the retrieved notification item
entity_name	String	The entity name of the retrieved notification which can be one of the following: ACTIVITIES BILLS JOBS LEADS PAYMENTS PAYMENT_GATEWAY_CARDS PAYMENT_GATEWAY_REQUESTS AWARD_REWARD_TRANSACTIONS SPEND_REWARD_TRANSACTIONS REWARDS_PARTICIPANT SERVICE_REQUESTS SUBSCRIPTIONS WALLETS WALLET_PRODUCT_CONSUMPTION BUY_IN_ADVANCE_REQUESTS REWARD_OFFERS SUBSCRIPTION_ACTIONS REWARD_OFFERS entity name available from CRM.COM R12.0.0 SUBSCRIPTION_ACTIONS entity name is available from CRM.COM R14.2.0
entity_value	String	The primary key value of the notification item
notified_amount	Number	Additional information which is populated if the notification type is classified as financial, and if the notified information is set to Subscriptions or Bills or Jobs. It defines the total initial notified amount for each subscription or bill or job included in the notification
outstanding_amount	Number	Additional information which is populated if the notification type is classified as financial, and if the notified information is set to Subscriptions or Bills or Jobs. It defines the total amount which is still outstanding for each subscription or bill or job included in the notification
unsettled_amount	Number	Additional information which is populated if the notification type is classified as financial, and if the notified information is set to Subscriptions or Bills or Jobs. It defines the total amount which is still unsettled for each subscription or bill or job included in the notification
estimated_consumption_days	Number	Additional information which is populated if the notification type is classified as financial, and if the notified information is set to Wallets or Wallet Product Consumption.It defines the number of remaining days, as of the date of the notification
estimated_consumption_date	Date	Additional information which is populated if the notification type is classified as financial, and if the notified information is set to Wallets or Wallet Product Consumption. It defines the estimated consumption date, as of the date of the notification
expiration_amount	Number	Additional information which is populated if the notification type is classified as financial, and if the notified information is set to Wallets. It defines the amount that is about to be expired up to a specific date set in the notification's related run definition Available from CRM.COM R11.1.0
expiration_date	Date	Additional information which is populated if the notification type is classified as financial, and if the notified information is set to Wallets. It defines the date that the expiration amount will expire. Available from CRM.COM R11.1.0
upcoming_bill_amount	Number	Additional information which is populated if the notification type is classified as financial and if the notified information is set to Bills, having the "Calculate upcoming bill" option enabled. It defines the total upcoming bill amount to be paid of each entity (Subscription or Job) included in the notification Available from R14.5.0

Examples

Example 1

HTTP Method: GET

Request:

Response:

{
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    {
        "udf_float_1": null,
        "udf_float_2": null,
        "udf_float_3": null,
        "number": "51",
        "udf_float_4": null,
        "udf_string_1": null,
        "udf_string_2": null,
        "udf_string_3": null,
        "contact_information":
        {
            "last_name": "Litt",
            "life_cycle_state": "FINANCIAL",
            "middle_name": null,
            "company_profile": null,
            "title": "Mr",
            "type": "PERSON",
            "first_name": "Mathew",
            "name": "Mathew Litt",
            "id": "921C66776CBFEC5D839CA0DBFA1A1B76",
            "company_name": null,
            "demographics":
            {
                "gender": "MALE",
                "passport_issued_by_country": null,
                "passport_number": "111",
                "social_security_number": "111",
                "country_of_residence":
                {
                    "name": "JAPAN",
                    "id": "237"
                },
                "industry_sector": null,
                "date_of_birth":
                {
                    "month": null,
                    "day": null,
                    "year": null
                },
                "name_day":
                {
                    "month": null,
                    "day": null
                },
                "id_number": "111",
                "id_issued_by_country": null,
                "industry": null
            }
        },
        "udf_string_4": null,
        "udf_string_5": null,
        "udf_string_6": null,
        "udf_string_7": null,
        "udf_string_8": null,
        "accounts_receivable":
        {
            "account_owner":
            {
                "last_name": "Litt",
                "life_cycle_state": "FINANCIAL",
                "middle_name": null,
                "company_profile": null,
                "title": "Mr",
                "type": "PERSON",
                "first_name": "Mathew",
                "name": "Mathew Litt",
                "id": "921C66776CBFEC5D839CA0DBFA1A1B76",
                "company_name": null,
                "demographics":
                {
                    "gender": "MALE",
                    "passport_issued_by_country": null,
                    "passport_number": "111",
                    "social_security_number": "111",
                    "country_of_residence":
                    {
                        "name": "JAPAN",
                        "id": "237"
                    },
                    "industry_sector": null,
                    "date_of_birth":
                    {
                        "month": null,
                        "day": null,
                        "year": null
                    },
                    "name_day":
                    {
                        "month": null,
                        "day": null
                    },
                    "id_number": "111",
                    "id_issued_by_country": null,
                    "industry": null
                }
            },
            "life_cycle_state": "ACTIVE",
            "number": "165",
            "name": "Mathew Litt",
            "id": "63755A788E078C16D506AD5CD1AB3E03"
        },
        "id": "49B37FA3E001C43F28CFEAFEB3E451D5",
        "items_set":
        [
            {
                "estimated_consumption_date": null,
                "entity_value": "102410D8E524A59109A440C3027E4595",
                "unsettled_amount": 69.74,
                "entity_name": "BILLS",
                "id": "F0F7D7E12DB7783323640ACF69AB51D7",
                "outstanding_amount": 69.74,
                "estimated_consumption_days": null,
                "notified_amount": 133.73999999999998
            }
        ],
        "total_notified_amount": 133.73999999999998,
        "udf_date_1": null,
        "communication_queue":
        {
            "external_system": null,
            "life_cycle_state": "COMPLETED",
            "communication":
            {
                "life_cycle_state": "COMPLETED",
                "number": "110",
                "id": "764AF4FCC072E1C6A2AD3A40E08A05C0",
                "contact_information":
                {
                    "last_name": "Litt",
                    "life_cycle_state": "FINANCIAL",
                    "middle_name": null,
                    "company_profile": null,
                    "title": "Mr",
                    "type": "PERSON",
                    "first_name": "Mathew",
                    "name": null,
                    "id": "921C66776CBFEC5D839CA0DBFA1A1B76",
                    "company_name": null,
                    "demographics":
                    {
                        "gender": "MALE",
                        "passport_issued_by_country": null,
                        "passport_number": "111",
                        "social_security_number": "111",
                        "industry_sector": null,
                        "date_of_birth":
                        {
                            "month": null,
                            "day": null,
                            "year": null
                        },
                        "name_day":
                        {
                            "month": null,
                            "day": null
                        },
                        "id_number": "111",
                        "id_issued_by_country": null,
                        "industry": null
                    }
                }
            },
            "number": "37",
            "id": "9FAF189919D671E1AF50CE20890F53CD"
        },
        "udf_date_2": null,
        "udf_date_3": null,
        "udf_date_4": null,
        "log_information":
        {
            "updated_date": "2014-10-10T17:56:43",
            "created_by_unit":
            {
                "community_name": "Main Community",
                "group_name": "Main Group",
                "name": "Admin Unit",
                "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                "description": "r1",
                "alternative_code": "MG"
            },
            "created_date": "2014-10-10T17:56:43",
            "updated_by_unit":
            {
                "community_name": "Main Community",
                "group_name": "Main Group",
                "name": "Admin Unit",
                "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                "description": "r1",
                "alternative_code": "MG"
            },
            "created_by_user":
            {
                "person_name": "MPAdministrator",
                "username": "MPAdministrator",
                "id": "1",
                "email": "mp@ministrator.com"
            },
            "updated_by_user":
            {
                "person_name": "MPAdministrator",
                "username": "MPAdministrator",
                "id": "1",
                "email": "mp@ministrator.com"
            }
        },
        "life_cycle_state": "COMPLETED",
        "unsettled_amount": 69.74,
        "notification_run":
        {
            "end_date": "2014-10-10T17:56:44",
            "life_cycle_state": "COMPLETED",
            "number": "222",
            "start_date": "2014-10-10T17:56:30",
            "id": "96361A44AC30FDFE38A6D1A58C2A1821"
        },
        "total_outstanding_amount": 69.74,
        "type":
        {
            "classification": "FINANCIAL",
            "name": "Notification Bill",
            "id": "C52A0BFC52ED720CC4EA34B8E599CE1A",
            "description": null,
            "alternative_code": "NB"
        }
    }
}

GET notifications/list

This method returns information related with notifications. Multiple notifications are returned by each call.

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

type_identifier
(semi-optional)

Notification type identifier

The identifier of the notification type related with the notification that should be returned as a result. The allowed notification type identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the notification type

name

(semi-optional)

String

The name of the notification type

alternative_code

(semi-optional)

String

The alternative code of the notification type

notification_run_identifier

(semi-optional)

Notification run identifier

The identifier of the notification run that created the notifications that should be returned as a result. The allowed notification run identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the notification run

number

(semi-optional)

String

The number of the notification run

contact_information_identifier

(optional)

Contact Information identifier

The identifier of the contact information notified by the notifications that should be returned as a result. 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

accounts_receivable_identifier

(optional)

Accounts receivable identifier

The identifier of the accounts receivable notified by the notifications that should be returned as a result. The allowed contact information identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the accounts receivable

number

(semi-optional)

String

The number of the accounts receivable

name

(semi-optional)

String

The name of the accounts receivable

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 notification
number	String	The number of the retrieved notification
life_cycle_state	String	The life cycle state of the retrieved notification which can be PENDING, REJECTED or COMPLETED and is calculated dynamically based on the related communication queue entry life cycle state
total_notified_amount	Number	Additional information which is populated if the notification type is classified as financial, and if the notified information is set to Subscriptions, Bills or Jobs. It defines the total initial notified amount for each subscription or job or bill included in the notification
total_outstanding_amount	Number	Additional information which is populated if the notification type is classified as financial, and if the notified information is set to Subscriptions, Bills or Jobs. It defines the total amount which is still outstanding for each subscription or bill or job included in the notification
unsettled_amount	Number	Additional information which is populated if the notification type is classified as financial, and if the notified information is set to Subscriptions, Bills or Jobs. It defines the total amount which is still unsettled for each subscription or bill or job included in the notification
expiration_date	Date	The expiration date of the notification as provided through the Notification Type Available from R14.2.0
upcoming_bill_amount	Number	Additional information which is populated if the notification type is classified as financial and if the notified information is set to Bills, having the "Calculate upcoming bill" option enabled. It defines the total upcoming bill amount to be paid of each accounts receivable included in the notification Available from R14.5.0
upcoming_bill_as_of_date	Date	The as of date of the upcoming bill calculated Available from R14.5.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
type	Notification Type object	The type of the specific notification
notification_run	Notification Run object	The notification run that generated the specific notification
contact_information	Contact Information object	The contact information related with the specific notification
accounts_receivable	Accounts Receivable object	The accounts receivable related with the specific notification
communication_queue	Communication Queue Object	The communication queue entry that was created for the specific notification
currency_rate_period	Currency Rate Period Object	The notification's currency rate period
log_information	Log Information Object	The log information related with the retrieved notification
items_set	Set of Notification Item objects	The information for which the customer will be notified about by the specific notification. That information differentiates based on the notification type classification

Referred Objects Response Data

notification_type object response data

Name	Type	Description
id	String	The ID of the retrieved notification type
name	String	The name of the retrieved notification type
alternative_code	String	The alternative code of the retrieved notification type
description	String	A description of the retrieved notification type
classification	String	The classification of the retrieved notification type which can be one of the following: FINANCIAL CUSTOMER_CARE REWARD_OFFERS REWARD_OFFERS classification available from CRM.COM R12.0.0

notification_run object response data

Name	Type	Description
id	String	The ID of the retrieved notification run
number	String	The number of the retrieved notification run
life_cycle_state	String	The life cycle state of the notification run which can be PENDING, IN_PROGRESS or COMPLETED
start_date	Date	The date that the notification run started
end_date	Date	The date that the notification run ended

contact_information object response data

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

Referred Objects Response Data

demographics object response data

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

Referred Objects Response Data

date_of_birth object response data

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

name_day object response data

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

country object response data

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

Referred Objects Response Data

country_flag object response data

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

Referred Objects Response Data

file object response data

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

industry object response data

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

industry sector object response data

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

company profile object response data

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

Referred Objects Response Data

country object response data

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

Referred Objects Response Data

country_flag object response data

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

Referred Objects Response Data

file object response data

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

industry object response data

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

industry sector object response data

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

accounts_receivable object response data

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

Referred Objects Response Data

contact_information object response data

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

Referred Objects Response Data

demographics object response data

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

Referred Objects Response Data

date_of_birth object response data

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

name_day object response data

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

country object response data

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

Referred Objects Response Data

country_flag object response data

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

Referred Objects Response Data

file object response data

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

industry object response data

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

industry sector object response data

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

company profile object response data

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

Referred Objects Response Data

country object response data

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

Referred Objects Response Data

country_flag object response data

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

Referred Objects Response Data

file object response data

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

industry object response data

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

industry sector object response data

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

communication queue response data

Name	Type	Description
id	String	The ID of the retrieved communication queue entry
number	String	The number of the retrieved communication queue entry
life_cycle_state	String	The life cycle state of the retrieved communication queue entry which can be PENDING, REJECTED or COMPLETED
communication	Communication object	The communication that is sent through the retrieved communication queue entry
external_system	Communication Queue External System object	The external system which process the communication waiting in retrieved communication queue entry

Referred Objects Response Data

communication object response data

Name	Type	Description
Id	String	The ID of the communication
number	String	The code of communication
life_cycle_state	String	The lifecycle state of the retrieved communication which can be DRAFT or COMPLETE
subject	String	The subject of the retrieved communication
viewed	Boolean	Defines whether the communication was viewed, or not Available from CRM.COM R12.2.0
viewed_on	Date	The date that the communication was viewed Available from CRM.COM R12.2.0
contact_information	Contact Information object	The contact information related with the specified communication

Referred Objects Response Data

contact_information object response data

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

Referred Objects Response Data

demographics object response data

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

Referred Objects Response Data

date_of_birth object response data

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

name_day object response data

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

country object response data

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

Referred Objects Response Data

country_flag object response data

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

Referred Objects Response Data

file object response data

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

industry object response data

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

industry sector object response data

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

company profile object response data

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

Referred Objects Response Data

country object response data

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

Referred Objects Response Data

country_flag object response data

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

Referred Objects Response Data

file object response data

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

industry object response data

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

industry sector object response data

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

communication_queue_external_system object response data

Name	Type	Description
Id	String	The ID of the communication queue external system
name	String	The name of the communication queue external system
alternative_code	String	The alternative code of the communication queue external system

currency rate period object response data

Name	Type	Description
id	String	The ID of the retrieved currency rate period
rate	Number	The exchange rate of the currency rate period
inverse_rate	Number	The inverse exchange rate of the currency rate period
from_date	Date	The date from which the exchange rate is valid
to_date	Date	The date until which the exchange rate is valid
currency	Currency Object	The Currency with which the returned exchange rate information refers to

Referred Objects Response Data

currency object response data

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

log_information object response data

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

Referred Objects Response Data

unit object response data

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

business unit object response data

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

user object response data

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

notification item response data

Name	Type	Description
id	String	The ID of the retrieved notification item
entity_name	String	The entity name of the retrieved notification which can be one of the following: ACTIVITIES BILLS JOBS LEADS PAYMENTS PAYMENT_GATEWAY_CARDS PAYMENT_GATEWAY_REQUESTS AWARD_REWARD_TRANSACTIONS SPEND_REWARD_TRANSACTIONS REWARDS_PARTICIPANT SERVICE_REQUESTS SUBSCRIPTIONS WALLETS WALLET_PRODUCT_CONSUMPTION BUY_IN_ADVANCE_REQUESTS REWARD_OFFERS SUBSCRIPTION_ACTIONS REWARD_OFFERS entity name available from CRM.COM R12.0.0 SUBSCRIPTION_ACTIONS entity name is available from CRM.COM R14.2.0
entity_value	String	The primary key value of the notification item
notified_amount	Number	Additional information which is populated if the notification type is classified as financial, and if the notified information is set to Subscriptions or Bills or Jobs. It defines the total initial notified amount for each subscription or bill or job included in the notification
outstanding_amount	Number	Additional information which is populated if the notification type is classified as financial, and if the notified information is set to Subscriptions or Bills or Jobs. It defines the total amount which is still outstanding for each subscription or bill or job included in the notification
unsettled_amount	Number	Additional information which is populated if the notification type is classified as financial, and if the notified information is set to Subscriptions or Bills or Jobs. It defines the total amount which is still unsettled for each subscription or bill or job included in the notification
estimated_consumption_days	Number	Additional information which is populated if the notification type is classified as financial, and if the notified information is set to Wallets or Wallet Product Consumption.It defines the number of remaining days, as of the date of the notification
estimated_consumption_date	Date	Additional information which is populated if the notification type is classified as financial, and if the notified information is set to Wallets or Wallet Product Consumption. It defines the estimated consumption date, as of the date of the notification
expiration_amount	Number	Additional information which is populated if the notification type is classified as financial, and if the notified information is set to Wallets. It defines the amount that is about to be expired up to a specific date set in the notification's related run definition Available from CRM.COM R11.1.0
expiration_date	Date	Additional information which is populated if the notification type is classified as financial, and if the notified information is set to Wallets. It defines the date that the expiration amount will expire. Available from CRM.COM R11.1.0
upcoming_bill_amount	Number	Additional information which is populated if the notification type is classified as financial and if the notified information is set to Bills, having the "Calculate upcoming bill" option enabled. It defines the total upcoming bill amount to be paid of each entity (Subscription or Job) included in the notification Available from R14.5.0

Examples

Example 1

HTTP Method: GET

Request:

Response:

{
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    [
        {
            "udf_float_1": null,
            "udf_float_2": null,
            "udf_float_3": null,
            "number": "51",
            "udf_float_4": null,
            "udf_string_1": null,
            "udf_string_2": null,
            "udf_string_3": null,
            "contact_information":
            {
                "last_name": "Litt",
                "life_cycle_state": "FINANCIAL",
                "middle_name": null,
                "company_profile": null,
                "title": "Mr",
                "type": "PERSON",
                "first_name": "Mathew",
                "name": "Mathew Litt",
                "id": "921C66776CBFEC5D839CA0DBFA1A1B76",
                "company_name": null,
                "demographics":
                {
                    "gender": "MALE",
                    "passport_issued_by_country": null,
                    "passport_number": "111",
                    "social_security_number": "111",
                    "country_of_residence":
                    {
                        "name": "JAPAN",
                        "id": "237"
                    },
                    "industry_sector": null,
                    "date_of_birth":
                    {
                        "month": null,
                        "day": null,
                        "year": null
                    },
                    "name_day":
                    {
                        "month": null,
                        "day": null
                    },
                    "id_number": "111",
                    "id_issued_by_country": null,
                    "industry": null
                }
            },
            "udf_string_4": null,
            "udf_string_5": null,
            "udf_string_6": null,
            "udf_string_7": null,
            "udf_string_8": null,
            "accounts_receivable":
            {
                "account_owner":
                {
                    "last_name": "Litt",
                    "life_cycle_state": "FINANCIAL",
                    "middle_name": null,
                    "company_profile": null,
                    "title": "Mr",
                    "type": "PERSON",
                    "first_name": "Mathew",
                    "name": "Mathew Litt",
                    "id": "921C66776CBFEC5D839CA0DBFA1A1B76",
                    "company_name": null,
                    "demographics":
                    {
                        "gender": "MALE",
                        "passport_issued_by_country": null,
                        "passport_number": "111",
                        "social_security_number": "111",
                        "country_of_residence":
                        {
                            "name": "JAPAN",
                            "id": "237"
                        },
                        "industry_sector": null,
                        "date_of_birth":
                        {
                            "month": null,
                            "day": null,
                            "year": null
                        },
                        "name_day":
                        {
                            "month": null,
                            "day": null
                        },
                        "id_number": "111",
                        "id_issued_by_country": null,
                        "industry": null
                    }
                },
                "life_cycle_state": "ACTIVE",
                "number": "165",
                "name": "Mathew Litt",
                "id": "63755A788E078C16D506AD5CD1AB3E03"
            },
            "id": "49B37FA3E001C43F28CFEAFEB3E451D5",
            "items_set":
            [
                {
                    "estimated_consumption_date": null,
                    "entity_value": "102410D8E524A59109A440C3027E4595",
                    "unsettled_amount": 69.74,
                    "entity_name": "BILLS",
                    "id": "F0F7D7E12DB7783323640ACF69AB51D7",
                    "outstanding_amount": 69.74,
                    "estimated_consumption_days": null,
                    "notified_amount": 133.73999999999998
                }
            ],
            "total_notified_amount": 133.73999999999998,
            "udf_date_1": null,
            "communication_queue":
            {
                "external_system": null,
                "life_cycle_state": "COMPLETED",
                "communication":
                {
                    "life_cycle_state": "COMPLETED",
                    "number": "110",
                    "id": "764AF4FCC072E1C6A2AD3A40E08A05C0",
                    "contact_information":
                    {
                        "last_name": "Litt",
                        "life_cycle_state": "FINANCIAL",
                        "middle_name": null,
                        "company_profile": null,
                        "title": "Mr",
                        "type": "PERSON",
                        "first_name": "Mathew",
                        "name": null,
                        "id": "921C66776CBFEC5D839CA0DBFA1A1B76",
                        "company_name": null,
                        "demographics":
                        {
                            "gender": "MALE",
                            "passport_issued_by_country": null,
                            "passport_number": "111",
                            "social_security_number": "111",
                            "industry_sector": null,
                            "date_of_birth":
                            {
                                "month": null,
                                "day": null,
                                "year": null
                            },
                            "name_day":
                            {
                                "month": null,
                                "day": null
                            },
                            "id_number": "111",
                            "id_issued_by_country": null,
                            "industry": null
                        }
                    }
                },
                "number": "37",
                "id": "9FAF189919D671E1AF50CE20890F53CD"
            },
            "udf_date_2": null,
            "udf_date_3": null,
            "udf_date_4": null,
            "log_information":
            {
                "updated_date": "2014-10-10T17:56:43",
                "created_by_unit":
                {
                    "community_name": "Main Community",
                    "group_name": "Main Group",
                    "name": "Admin Unit",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "description": "r1",
                    "alternative_code": "MG"
                },
                "created_date": "2014-10-10T17:56:43",
                "updated_by_unit":
                {
                    "community_name": "Main Community",
                    "group_name": "Main Group",
                    "name": "Admin Unit",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "description": "r1",
                    "alternative_code": "MG"
                },
                "created_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1",
                    "email": "mp@ministrator.com"
                },
                "updated_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1",
                    "email": "mp@ministrator.com"
                }
            },
            "life_cycle_state": "COMPLETED",
            "unsettled_amount": 69.74,
            "notification_run":
            {
                "end_date": "2014-10-10T17:56:44",
                "life_cycle_state": "COMPLETED",
                "number": "222",
                "start_date": "2014-10-10T17:56:30",
                "id": "96361A44AC30FDFE38A6D1A58C2A1821"
            },
            "total_outstanding_amount": 69.74,
            "type":
            {
                "classification": "FINANCIAL",
                "name": "Notification Bill",
                "id": "C52A0BFC52ED720CC4EA34B8E599CE1A",
                "description": null,
                "alternative_code": "NB"
            }
        }
    ]
}

Example 2

HTTP Method: GET

Request:

Response:

{
  "data": [
    {
      "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-24T15:27:06",
        "updated_date": "2016-03-24T15:27: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"
        }
      },
      "contact_information": {
        "company_profile": null,
        "company_name": null,
        "name": "Matt Grey",
        "last_name": "Grey",
        "id": "19646B486C02471A92E6E0EDF6F8D516",
        "life_cycle_state": "FINANCIAL",
        "middle_name": null,
        "title": null,
        "type": "PERSON",
        "first_name": "Matt",
        "demographics": {
          "name_day": {
            "month": null,
            "day": null
          },
          "id_number": "324324",
          "gender": null,
          "country_of_residence": {
            "alternative_code": "IRN",
            "three_character_code": null,
            "name": "IRAN (ISLAMIC REPUBLIC OF)",
            "id": "231",
            "two_character_code": null
          },
          "date_of_birth": {
            "month": null,
            "year": null,
            "day": null
          },
          "industry_sector": null,
          "passport_number": "234234",
          "industry": null,
          "social_security_number": null,
          "id_issued_by_country": null,
          "passport_issued_by_country": null
        }
      },
      "currency_rate_period": {
        "from_date": "C7D7ED57F21B47028144967E015DCBE5",
        "to_date": 2.3,
        "rate": 2.3,
        "inverse_rate": 0.23000000417232513,
        "currency": {
          "suffix_symbol": null,
          "prefix_symbol": "£",
          "decimal_part_name": null,
          "code": "GBP",
          "integer_part_name": null,
          "id": "9"
        },
        "id": "C7D7ED57F21B47028144967E015DCBE5"
      },
      "udf_date_2": null,
      "type": {
        "alternative_code": "WWDA",
        "name": "Wallet with debited amount",
        "description": null,
        "id": "928A6098889A416391F61D418D041B72",
        "classification": "FINANCIAL"
      },
      "udf_date_1": null,
      "udf_date_4": null,
      "udf_date_3": null,
      "number": "39",
      "udf_float_3": null,
      "udf_float_4": null,
      "total_outstanding_amount": 0,
      "items_set": [
        {
          "entity_value": "B9A2246D05D046819CE94BF5AF16EFDE",
          "estimated_consumption_days": 0,
          "notified_amount": -14,
          "entity_name": "WALLETS",
          "unsettled_amount": 0,
          "estimated_consumption_date": "2016-03-03T17:48:39",
          "id": "649366F8972945F9977A86F0874CBA82",
          "outstanding_amount": 0
        }
      ],
      "id": "E8A1CDA9360C4C9AA778B8B32C5F8398",
      "udf_float_1": null,
      "communication_queue": {
        "number": "144",
        "id": "B2755779BFC34796814171D5B45399B9",
        "life_cycle_state": "COMPLETED",
        "communication": {
          "number": "214",
          "subject": "Your wallet is below zero",
          "contact_information": {
            "company_profile": null,
            "company_name": null,
            "name": null,
            "last_name": "Grey",
            "id": "19646B486C02471A92E6E0EDF6F8D516",
            "life_cycle_state": "FINANCIAL",
            "middle_name": null,
            "title": null,
            "type": "PERSON",
            "first_name": "Matt",
            "demographics": {
              "name_day": {
                "month": null,
                "day": null
              },
              "id_number": "324324",
              "gender": null,
              "date_of_birth": {
                "month": null,
                "year": null,
                "day": null
              },
              "industry_sector": null,
              "passport_number": "234234",
              "industry": null,
              "social_security_number": null,
              "id_issued_by_country": null,
              "passport_issued_by_country": null
            }
          },
          "id": "B563F9C788744A36B1F2C6EE16E3D357",
          "life_cycle_state": "COMPLETED"
        },
        "external_system": null
      },
      "udf_float_2": null,
      "udf_string_2": null,
      "udf_string_3": null,
      "udf_string_4": null,
      "udf_string_5": null,
      "notification_run": {
        "end_date": "2016-03-24T15:27:12",
        "number": "157",
        "id": "1EA68767F6D7414595C125C29CD42941",
        "life_cycle_state": "COMPLETED",
        "start_date": "2016-03-24T15:27:06"
      },
      "udf_string_1": null,
      "total_notified_amount": -14,
      "accounts_receivable": {
        "number": "ACR0000000065",
        "name": "ACR0000000065 Matt Grey",
        "id": "D1D74C3040F746E09C1D051E70202A9A",
        "life_cycle_state": "ACTIVE",
        "account_owner": {
          "company_profile": null,
          "company_name": null,
          "name": "Matt Grey",
          "last_name": "Grey",
          "id": "19646B486C02471A92E6E0EDF6F8D516",
          "life_cycle_state": "FINANCIAL",
          "middle_name": null,
          "title": null,
          "type": "PERSON",
          "first_name": "Matt",
          "demographics": {
            "name_day": {
              "month": null,
              "day": null
            },
            "id_number": "324324",
            "gender": null,
            "country_of_residence": {
              "alternative_code": "IRN",
              "three_character_code": null,
              "name": "IRAN (ISLAMIC REPUBLIC OF)",
              "id": "231",
              "two_character_code": null
            },
            "date_of_birth": {
              "month": null,
              "year": null,
              "day": null
            },
            "industry_sector": null,
            "passport_number": "234234",
            "industry": null,
            "social_security_number": null,
            "id_issued_by_country": null,
            "passport_issued_by_country": null
          }
        }
      },
      "life_cycle_state": "COMPLETED",
      "unsettled_amount": 0,
      "udf_string_6": null,
      "udf_string_7": null,
      "udf_string_8": 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-24T15:24:07",
        "updated_date": "2016-03-24T15:24:07",
        "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"
        }
      },
      "contact_information": {
        "company_profile": null,
        "company_name": null,
        "name": "Matt Black",
        "last_name": "Black",
        "id": "76E0E43E7CD74157979230819FD41B8E",
        "life_cycle_state": "FINANCIAL",
        "middle_name": "Y",
        "title": null,
        "type": "PERSON",
        "first_name": "Matt",
        "demographics": {
          "name_day": {
            "month": null,
            "day": null
          },
          "id_number": "1212128596",
          "gender": "MALE",
          "country_of_residence": {
            "alternative_code": "IRN",
            "three_character_code": null,
            "name": "IRAN (ISLAMIC REPUBLIC OF)",
            "id": "231",
            "two_character_code": null
          },
          "date_of_birth": {
            "month": null,
            "year": null,
            "day": null
          },
          "industry_sector": null,
          "passport_number": null,
          "industry": null,
          "social_security_number": "999999998",
          "id_issued_by_country": null,
          "passport_issued_by_country": null
        }
      },
      "currency_rate_period": {
        "from_date": "C7D7ED57F21B47028144967E015DCBE5",
        "to_date": 2.3,
        "rate": 2.3,
        "inverse_rate": 0.23000000417232513,
        "currency": {
          "suffix_symbol": null,
          "prefix_symbol": "£",
          "decimal_part_name": null,
          "code": "GBP",
          "integer_part_name": null,
          "id": "9"
        },
        "id": "C7D7ED57F21B47028144967E015DCBE5"
      },
      "udf_date_2": null,
      "type": {
        "alternative_code": "WWDA",
        "name": "Wallet with debited amount",
        "description": null,
        "id": "928A6098889A416391F61D418D041B72",
        "classification": "FINANCIAL"
      },
      "udf_date_1": null,
      "udf_date_4": null,
      "udf_date_3": null,
      "number": "36",
      "udf_float_3": null,
      "udf_float_4": null,
      "total_outstanding_amount": 0,
      "items_set": [
        {
          "entity_value": "8DC6C1AC7578439F88A45B1FED69E45C",
          "estimated_consumption_days": 0,
          "notified_amount": -30.83,
          "entity_name": "WALLETS",
          "unsettled_amount": 0,
          "estimated_consumption_date": "2016-03-11T00:00:00",
          "id": "CBC521244FB94D449E437982FC68131B",
          "outstanding_amount": 0
        }
      ],
      "id": "CFA566DBA8494BC6AC9ADB2D2254D4B0",
      "udf_float_1": null,
      "communication_queue": {
        "number": "141",
        "id": "68961FF1394C4B90B0358414DFAA000D",
        "life_cycle_state": "COMPLETED",
        "communication": {
          "number": "211",
          "subject": "Your wallet is below zero",
          "contact_information": {
            "company_profile": null,
            "company_name": null,
            "name": null,
            "last_name": "Black",
            "id": "76E0E43E7CD74157979230819FD41B8E",
            "life_cycle_state": "FINANCIAL",
            "middle_name": "Y",
            "title": null,
            "type": "PERSON",
            "first_name": "Matt",
            "demographics": {
              "name_day": {
                "month": null,
                "day": null
              },
              "id_number": "1212128596",
              "gender": "MALE",
              "date_of_birth": {
                "month": null,
                "year": null,
                "day": null
              },
              "industry_sector": null,
              "passport_number": null,
              "industry": null,
              "social_security_number": "999999998",
              "id_issued_by_country": null,
              "passport_issued_by_country": null
            }
          },
          "id": "CA1E45E4EFF14D7BB34EB814A72E9EF4",
          "life_cycle_state": "COMPLETED"
        },
        "external_system": null
      },
      "udf_float_2": null,
      "udf_string_2": null,
      "udf_string_3": null,
      "udf_string_4": null,
      "udf_string_5": null,
      "notification_run": {
        "end_date": "2016-03-24T15:24:08",
        "number": "156",
        "id": "F815D9C7DADA4214B8F07A96BBD31353",
        "life_cycle_state": "COMPLETED",
        "start_date": "2016-03-24T15:24:06"
      },
      "udf_string_1": null,
      "total_notified_amount": -30.83,
      "accounts_receivable": {
        "number": "ACR0000000015",
        "name": "ACR0000000015 Matt Black",
        "id": "FD29F02AA14344B1AD1B401706D865CE",
        "life_cycle_state": "ACTIVE",
        "account_owner": {
          "company_profile": null,
          "company_name": null,
          "name": "Matt Black",
          "last_name": "Black",
          "id": "76E0E43E7CD74157979230819FD41B8E",
          "life_cycle_state": "FINANCIAL",
          "middle_name": "Y",
          "title": null,
          "type": "PERSON",
          "first_name": "Matt",
          "demographics": {
            "name_day": {
              "month": null,
              "day": null
            },
            "id_number": "1212128596",
            "gender": "MALE",
            "country_of_residence": {
              "alternative_code": "IRN",
              "three_character_code": null,
              "name": "IRAN (ISLAMIC REPUBLIC OF)",
              "id": "231",
              "two_character_code": null
            },
            "date_of_birth": {
              "month": null,
              "year": null,
              "day": null
            },
            "industry_sector": null,
            "passport_number": null,
            "industry": null,
            "social_security_number": "999999998",
            "id_issued_by_country": null,
            "passport_issued_by_country": null
          }
        }
      },
      "life_cycle_state": "COMPLETED",
      "unsettled_amount": 0,
      "udf_string_6": null,
      "udf_string_7": null,
      "udf_string_8": 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-24T15:24:07",
        "updated_date": "2016-03-24T15:24:07",
        "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"
        }
      },
      "contact_information": {
        "company_profile": null,
        "company_name": null,
        "name": "Matt Grey",
        "last_name": "Grey",
        "id": "19646B486C02471A92E6E0EDF6F8D516",
        "life_cycle_state": "FINANCIAL",
        "middle_name": null,
        "title": null,
        "type": "PERSON",
        "first_name": "Matt",
        "demographics": {
          "name_day": {
            "month": null,
            "day": null
          },
          "id_number": "324324",
          "gender": null,
          "country_of_residence": {
            "alternative_code": "IRN",
            "three_character_code": null,
            "name": "IRAN (ISLAMIC REPUBLIC OF)",
            "id": "231",
            "two_character_code": null
          },
          "date_of_birth": {
            "month": null,
            "year": null,
            "day": null
          },
          "industry_sector": null,
          "passport_number": "234234",
          "industry": null,
          "social_security_number": null,
          "id_issued_by_country": null,
          "passport_issued_by_country": null
        }
      },
      "currency_rate_period": {
        "from_date": "C7D7ED57F21B47028144967E015DCBE5",
        "to_date": 2.3,
        "rate": 2.3,
        "inverse_rate": 0.23000000417232513,
        "currency": {
          "suffix_symbol": null,
          "prefix_symbol": "£",
          "decimal_part_name": null,
          "code": "GBP",
          "integer_part_name": null,
          "id": "9"
        },
        "id": "C7D7ED57F21B47028144967E015DCBE5"
      },
      "udf_date_2": null,
      "type": {
        "alternative_code": "WWDA",
        "name": "Wallet with debited amount",
        "description": null,
        "id": "928A6098889A416391F61D418D041B72",
        "classification": "FINANCIAL"
      },
      "udf_date_1": null,
      "udf_date_4": null,
      "udf_date_3": null,
      "number": "38",
      "udf_float_3": null,
      "udf_float_4": null,
      "total_outstanding_amount": 0,
      "items_set": [
        {
          "entity_value": "5FD64EF707FC48AB8DA4CE0F72E633DE",
          "estimated_consumption_days": 0,
          "notified_amount": -10.32,
          "entity_name": "WALLETS",
          "unsettled_amount": 0,
          "estimated_consumption_date": "2016-03-16T00:00:00",
          "id": "1CAA465858D947F0AF4484CCC8C17568",
          "outstanding_amount": 0
        }
      ],
      "id": "CB58FC353B8A498DBCB48F8E071FB9E9",
      "udf_float_1": null,
      "communication_queue": {
        "number": "143",
        "id": "CEF52B52D1584011BB446A41D4B1DD43",
        "life_cycle_state": "COMPLETED",
        "communication": {
          "number": "213",
          "subject": "Your wallet is below zero",
          "contact_information": {
            "company_profile": null,
            "company_name": null,
            "name": null,
            "last_name": "Grey",
            "id": "19646B486C02471A92E6E0EDF6F8D516",
            "life_cycle_state": "FINANCIAL",
            "middle_name": null,
            "title": null,
            "type": "PERSON",
            "first_name": "Matt",
            "demographics": {
              "name_day": {
                "month": null,
                "day": null
              },
              "id_number": "324324",
              "gender": null,
              "date_of_birth": {
                "month": null,
                "year": null,
                "day": null
              },
              "industry_sector": null,
              "passport_number": "234234",
              "industry": null,
              "social_security_number": null,
              "id_issued_by_country": null,
              "passport_issued_by_country": null
            }
          },
          "id": "9BB7C1B359D64EBEABF6E75C541310A4",
          "life_cycle_state": "COMPLETED"
        },
        "external_system": null
      },
      "udf_float_2": null,
      "udf_string_2": null,
      "udf_string_3": null,
      "udf_string_4": null,
      "udf_string_5": null,
      "notification_run": {
        "end_date": "2016-03-24T15:24:08",
        "number": "156",
        "id": "F815D9C7DADA4214B8F07A96BBD31353",
        "life_cycle_state": "COMPLETED",
        "start_date": "2016-03-24T15:24:06"
      },
      "udf_string_1": null,
      "total_notified_amount": -10.32,
      "accounts_receivable": {
        "number": "ACR0000000064",
        "name": "ACR0000000064 Matt Grey",
        "id": "D4D336F964DA4CDB8421AA16841B37CB",
        "life_cycle_state": "ACTIVE",
        "account_owner": {
          "company_profile": null,
          "company_name": null,
          "name": "Matt Grey",
          "last_name": "Grey",
          "id": "19646B486C02471A92E6E0EDF6F8D516",
          "life_cycle_state": "FINANCIAL",
          "middle_name": null,
          "title": null,
          "type": "PERSON",
          "first_name": "Matt",
          "demographics": {
            "name_day": {
              "month": null,
              "day": null
            },
            "id_number": "324324",
            "gender": null,
            "country_of_residence": {
              "alternative_code": "IRN",
              "three_character_code": null,
              "name": "IRAN (ISLAMIC REPUBLIC OF)",
              "id": "231",
              "two_character_code": null
            },
            "date_of_birth": {
              "month": null,
              "year": null,
              "day": null
            },
            "industry_sector": null,
            "passport_number": "234234",
            "industry": null,
            "social_security_number": null,
            "id_issued_by_country": null,
            "passport_issued_by_country": null
          }
        }
      },
      "life_cycle_state": "COMPLETED",
      "unsettled_amount": 0,
      "udf_string_6": null,
      "udf_string_7": null,
      "udf_string_8": 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-24T15:24:07",
        "updated_date": "2016-03-24T15:24:07",
        "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"
        }
      },
      "contact_information": {
        "company_profile": null,
        "company_name": null,
        "name": "Matt Black",
        "last_name": "Black",
        "id": "76E0E43E7CD74157979230819FD41B8E",
        "life_cycle_state": "FINANCIAL",
        "middle_name": "Y",
        "title": null,
        "type": "PERSON",
        "first_name": "Matt",
        "demographics": {
          "name_day": {
            "month": null,
            "day": null
          },
          "id_number": "1212128596",
          "gender": "MALE",
          "country_of_residence": {
            "alternative_code": "IRN",
            "three_character_code": null,
            "name": "IRAN (ISLAMIC REPUBLIC OF)",
            "id": "231",
            "two_character_code": null
          },
          "date_of_birth": {
            "month": null,
            "year": null,
            "day": null
          },
          "industry_sector": null,
          "passport_number": null,
          "industry": null,
          "social_security_number": "999999998",
          "id_issued_by_country": null,
          "passport_issued_by_country": null
        }
      },
      "currency_rate_period": {
        "from_date": "C7D7ED57F21B47028144967E015DCBE5",
        "to_date": 2.3,
        "rate": 2.3,
        "inverse_rate": 0.23000000417232513,
        "currency": {
          "suffix_symbol": null,
          "prefix_symbol": "£",
          "decimal_part_name": null,
          "code": "GBP",
          "integer_part_name": null,
          "id": "9"
        },
        "id": "C7D7ED57F21B47028144967E015DCBE5"
      },
      "udf_date_2": null,
      "type": {
        "alternative_code": "WWDA",
        "name": "Wallet with debited amount",
        "description": null,
        "id": "928A6098889A416391F61D418D041B72",
        "classification": "FINANCIAL"
      },
      "udf_date_1": null,
      "udf_date_4": null,
      "udf_date_3": null,
      "number": "37",
      "udf_float_3": null,
      "udf_float_4": null,
      "total_outstanding_amount": 0,
      "items_set": [
        {
          "entity_value": "93C947DA245B47A8AB09FACFA17432D5",
          "estimated_consumption_days": 0,
          "notified_amount": -69.085,
          "entity_name": "WALLETS",
          "unsettled_amount": 0,
          "estimated_consumption_date": "2016-03-11T00:00:00",
          "id": "F3EC8A4AD450418CAE8C01B922CC5623",
          "outstanding_amount": 0
        }
      ],
      "id": "15A05FBCE2A44EC489E6384E892563B7",
      "udf_float_1": null,
      "communication_queue": {
        "number": "142",
        "id": "F97E8B9DC89F4D29B9AA0796946E911B",
        "life_cycle_state": "COMPLETED",
        "communication": {
          "number": "212",
          "subject": "Your wallet is below zero",
          "contact_information": {
            "company_profile": null,
            "company_name": null,
            "name": null,
            "last_name": "Black",
            "id": "76E0E43E7CD74157979230819FD41B8E",
            "life_cycle_state": "FINANCIAL",
            "middle_name": "Y",
            "title": null,
            "type": "PERSON",
            "first_name": "Matt",
            "demographics": {
              "name_day": {
                "month": null,
                "day": null
              },
              "id_number": "1212128596",
              "gender": "MALE",
              "date_of_birth": {
                "month": null,
                "year": null,
                "day": null
              },
              "industry_sector": null,
              "passport_number": null,
              "industry": null,
              "social_security_number": "999999998",
              "id_issued_by_country": null,
              "passport_issued_by_country": null
            }
          },
          "id": "B4E1F5B5E67F41A6877E66FA772C6966",
          "life_cycle_state": "COMPLETED"
        },
        "external_system": null
      },
      "udf_float_2": null,
      "udf_string_2": null,
      "udf_string_3": null,
      "udf_string_4": null,
      "udf_string_5": null,
      "notification_run": {
        "end_date": "2016-03-24T15:24:08",
        "number": "156",
        "id": "F815D9C7DADA4214B8F07A96BBD31353",
        "life_cycle_state": "COMPLETED",
        "start_date": "2016-03-24T15:24:06"
      },
      "udf_string_1": null,
      "total_notified_amount": -69.085,
      "accounts_receivable": {
        "number": "ACR0000000041",
        "name": "ACR0000000041 Matt Black",
        "id": "B489E6E057154A71AADD02C7E29F1FAB",
        "life_cycle_state": "ACTIVE",
        "account_owner": {
          "company_profile": null,
          "company_name": null,
          "name": "Matt Black",
          "last_name": "Black",
          "id": "76E0E43E7CD74157979230819FD41B8E",
          "life_cycle_state": "FINANCIAL",
          "middle_name": "Y",
          "title": null,
          "type": "PERSON",
          "first_name": "Matt",
          "demographics": {
            "name_day": {
              "month": null,
              "day": null
            },
            "id_number": "1212128596",
            "gender": "MALE",
            "country_of_residence": {
              "alternative_code": "IRN",
              "three_character_code": null,
              "name": "IRAN (ISLAMIC REPUBLIC OF)",
              "id": "231",
              "two_character_code": null
            },
            "date_of_birth": {
              "month": null,
              "year": null,
              "day": null
            },
            "industry_sector": null,
            "passport_number": null,
            "industry": null,
            "social_security_number": "999999998",
            "id_issued_by_country": null,
            "passport_issued_by_country": null
          }
        }
      },
      "life_cycle_state": "COMPLETED",
      "unsettled_amount": 0,
      "udf_string_6": null,
      "udf_string_7": null,
      "udf_string_8": 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-24T15:27:07",
        "updated_date": "2016-03-24T15:27:07",
        "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"
        }
      },
      "contact_information": {
        "company_profile": null,
        "company_name": null,
        "name": "Matt Grey",
        "last_name": "Grey",
        "id": "19646B486C02471A92E6E0EDF6F8D516",
        "life_cycle_state": "FINANCIAL",
        "middle_name": null,
        "title": null,
        "type": "PERSON",
        "first_name": "Matt",
        "demographics": {
          "name_day": {
            "month": null,
            "day": null
          },
          "id_number": "324324",
          "gender": null,
          "country_of_residence": {
            "alternative_code": "IRN",
            "three_character_code": null,
            "name": "IRAN (ISLAMIC REPUBLIC OF)",
            "id": "231",
            "two_character_code": null
          },
          "date_of_birth": {
            "month": null,
            "year": null,
            "day": null
          },
          "industry_sector": null,
          "passport_number": "234234",
          "industry": null,
          "social_security_number": null,
          "id_issued_by_country": null,
          "passport_issued_by_country": null
        }
      },
      "currency_rate_period": {
        "from_date": "C7D7ED57F21B47028144967E015DCBE5",
        "to_date": 2.3,
        "rate": 2.3,
        "inverse_rate": 0.23000000417232513,
        "currency": {
          "suffix_symbol": null,
          "prefix_symbol": "£",
          "decimal_part_name": null,
          "code": "GBP",
          "integer_part_name": null,
          "id": "9"
        },
        "id": "C7D7ED57F21B47028144967E015DCBE5"
      },
      "udf_date_2": null,
      "type": {
        "alternative_code": "WWDA",
        "name": "Wallet with debited amount",
        "description": null,
        "id": "928A6098889A416391F61D418D041B72",
        "classification": "FINANCIAL"
      },
      "udf_date_1": null,
      "udf_date_4": null,
      "udf_date_3": null,
      "number": "42",
      "udf_float_3": null,
      "udf_float_4": null,
      "total_outstanding_amount": 0,
      "items_set": [
        {
          "entity_value": "5FD64EF707FC48AB8DA4CE0F72E633DE",
          "estimated_consumption_days": 0,
          "notified_amount": -10.32,
          "entity_name": "WALLETS",
          "unsettled_amount": 0,
          "estimated_consumption_date": "2016-03-16T00:00:00",
          "id": "279218B66AA54A3F929683AD32C493D7",
          "outstanding_amount": 0
        }
      ],
      "id": "F6AD285707F2418BB7FB24F12313951E",
      "udf_float_1": null,
      "communication_queue": {
        "number": "147",
        "id": "B36B75B7F91C4FF3BD362ED625E740FE",
        "life_cycle_state": "COMPLETED",
        "communication": {
          "number": "217",
          "subject": "Your wallet is below zero",
          "contact_information": {
            "company_profile": null,
            "company_name": null,
            "name": null,
            "last_name": "Grey",
            "id": "19646B486C02471A92E6E0EDF6F8D516",
            "life_cycle_state": "FINANCIAL",
            "middle_name": null,
            "title": null,
            "type": "PERSON",
            "first_name": "Matt",
            "demographics": {
              "name_day": {
                "month": null,
                "day": null
              },
              "id_number": "324324",
              "gender": null,
              "date_of_birth": {
                "month": null,
                "year": null,
                "day": null
              },
              "industry_sector": null,
              "passport_number": "234234",
              "industry": null,
              "social_security_number": null,
              "id_issued_by_country": null,
              "passport_issued_by_country": null
            }
          },
          "id": "F3C31B1DCF1C4EE59389974E626B5E75",
          "life_cycle_state": "COMPLETED"
        },
        "external_system": null
      },
      "udf_float_2": null,
      "udf_string_2": null,
      "udf_string_3": null,
      "udf_string_4": null,
      "udf_string_5": null,
      "notification_run": {
        "end_date": "2016-03-24T15:27:12",
        "number": "157",
        "id": "1EA68767F6D7414595C125C29CD42941",
        "life_cycle_state": "COMPLETED",
        "start_date": "2016-03-24T15:27:06"
      },
      "udf_string_1": null,
      "total_notified_amount": -10.32,
      "accounts_receivable": {
        "number": "ACR0000000064",
        "name": "ACR0000000064 Matt Grey",
        "id": "D4D336F964DA4CDB8421AA16841B37CB",
        "life_cycle_state": "ACTIVE",
        "account_owner": {
          "company_profile": null,
          "company_name": null,
          "name": "Matt Grey",
          "last_name": "Grey",
          "id": "19646B486C02471A92E6E0EDF6F8D516",
          "life_cycle_state": "FINANCIAL",
          "middle_name": null,
          "title": null,
          "type": "PERSON",
          "first_name": "Matt",
          "demographics": {
            "name_day": {
              "month": null,
              "day": null
            },
            "id_number": "324324",
            "gender": null,
            "country_of_residence": {
              "alternative_code": "IRN",
              "three_character_code": null,
              "name": "IRAN (ISLAMIC REPUBLIC OF)",
              "id": "231",
              "two_character_code": null
            },
            "date_of_birth": {
              "month": null,
              "year": null,
              "day": null
            },
            "industry_sector": null,
            "passport_number": "234234",
            "industry": null,
            "social_security_number": null,
            "id_issued_by_country": null,
            "passport_issued_by_country": null
          }
        }
      },
      "life_cycle_state": "COMPLETED",
      "unsettled_amount": 0,
      "udf_string_6": null,
      "udf_string_7": null,
      "udf_string_8": 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-24T15:32:07",
        "updated_date": "2016-03-24T15:32:07",
        "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"
        }
      },
      "contact_information": {
        "company_profile": null,
        "company_name": null,
        "name": "Matt Black",
        "last_name": "Black",
        "id": "76E0E43E7CD74157979230819FD41B8E",
        "life_cycle_state": "FINANCIAL",
        "middle_name": "Y",
        "title": null,
        "type": "PERSON",
        "first_name": "Matt",
        "demographics": {
          "name_day": {
            "month": null,
            "day": null
          },
          "id_number": "1212128596",
          "gender": "MALE",
          "country_of_residence": {
            "alternative_code": "IRN",
            "three_character_code": null,
            "name": "IRAN (ISLAMIC REPUBLIC OF)",
            "id": "231",
            "two_character_code": null
          },
          "date_of_birth": {
            "month": null,
            "year": null,
            "day": null
          },
          "industry_sector": null,
          "passport_number": null,
          "industry": null,
          "social_security_number": "999999998",
          "id_issued_by_country": null,
          "passport_issued_by_country": null
        }
      },
      "currency_rate_period": {
        "from_date": "C7D7ED57F21B47028144967E015DCBE5",
        "to_date": 2.3,
        "rate": 2.3,
        "inverse_rate": 0.23000000417232513,
        "currency": {
          "suffix_symbol": null,
          "prefix_symbol": "£",
          "decimal_part_name": null,
          "code": "GBP",
          "integer_part_name": null,
          "id": "9"
        },
        "id": "C7D7ED57F21B47028144967E015DCBE5"
      },
      "udf_date_2": null,
      "type": {
        "alternative_code": "WWDA",
        "name": "Wallet with debited amount",
        "description": null,
        "id": "928A6098889A416391F61D418D041B72",
        "classification": "FINANCIAL"
      },
      "udf_date_1": null,
      "udf_date_4": null,
      "udf_date_3": null,
      "number": "44",
      "udf_float_3": null,
      "udf_float_4": null,
      "total_outstanding_amount": 0,
      "items_set": [
        {
          "entity_value": "8DC6C1AC7578439F88A45B1FED69E45C",
          "estimated_consumption_days": 0,
          "notified_amount": -30.83,
          "entity_name": "WALLETS",
          "unsettled_amount": 0,
          "estimated_consumption_date": "2016-03-11T00:00:00",
          "id": "38FCC18CC0204C22B3A08E057951BB93",
          "outstanding_amount": 0
        }
      ],
      "id": "7713AC959E384D099A3679D137A1140F",
      "udf_float_1": null,
      "communication_queue": {
        "number": "149",
        "id": "F06B63E944FD49E6A24F567E5763FB7B",
        "life_cycle_state": "COMPLETED",
        "communication": {
          "number": "219",
          "subject": "Your wallet is below zero",
          "contact_information": {
            "company_profile": null,
            "company_name": null,
            "name": null,
            "last_name": "Black",
            "id": "76E0E43E7CD74157979230819FD41B8E",
            "life_cycle_state": "FINANCIAL",
            "middle_name": "Y",
            "title": null,
            "type": "PERSON",
            "first_name": "Matt",
            "demographics": {
              "name_day": {
                "month": null,
                "day": null
              },
              "id_number": "1212128596",
              "gender": "MALE",
              "date_of_birth": {
                "month": null,
                "year": null,
                "day": null
              },
              "industry_sector": null,
              "passport_number": null,
              "industry": null,
              "social_security_number": "999999998",
              "id_issued_by_country": null,
              "passport_issued_by_country": null
            }
          },
          "id": "217461EEE29749B8B8A426758BE5DBA6",
          "life_cycle_state": "COMPLETED"
        },
        "external_system": null
      },
      "udf_float_2": null,
      "udf_string_2": null,
      "udf_string_3": null,
      "udf_string_4": null,
      "udf_string_5": null,
      "notification_run": {
        "end_date": "2016-03-24T15:32:08",
        "number": "158",
        "id": "49CC4F41B4AF447280AE04865DD18D2A",
        "life_cycle_state": "COMPLETED",
        "start_date": "2016-03-24T15:32:06"
      },
      "udf_string_1": null,
      "total_notified_amount": -30.83,
      "accounts_receivable": {
        "number": "ACR0000000015",
        "name": "ACR0000000015 Matt Black",
        "id": "FD29F02AA14344B1AD1B401706D865CE",
        "life_cycle_state": "ACTIVE",
        "account_owner": {
          "company_profile": null,
          "company_name": null,
          "name": "Matt Black",
          "last_name": "Black",
          "id": "76E0E43E7CD74157979230819FD41B8E",
          "life_cycle_state": "FINANCIAL",
          "middle_name": "Y",
          "title": null,
          "type": "PERSON",
          "first_name": "Matt",
          "demographics": {
            "name_day": {
              "month": null,
              "day": null
            },
            "id_number": "1212128596",
            "gender": "MALE",
            "country_of_residence": {
              "alternative_code": "IRN",
              "three_character_code": null,
              "name": "IRAN (ISLAMIC REPUBLIC OF)",
              "id": "231",
              "two_character_code": null
            },
            "date_of_birth": {
              "month": null,
              "year": null,
              "day": null
            },
            "industry_sector": null,
            "passport_number": null,
            "industry": null,
            "social_security_number": "999999998",
            "id_issued_by_country": null,
            "passport_issued_by_country": null
          }
        }
      },
      "life_cycle_state": "COMPLETED",
      "unsettled_amount": 0,
      "udf_string_6": null,
      "udf_string_7": null,
      "udf_string_8": 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-24T15:32:07",
        "updated_date": "2016-03-24T15:32:07",
        "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"
        }
      },
      "contact_information": {
        "company_profile": null,
        "company_name": null,
        "name": "Matt Grey",
        "last_name": "Grey",
        "id": "19646B486C02471A92E6E0EDF6F8D516",
        "life_cycle_state": "FINANCIAL",
        "middle_name": null,
        "title": null,
        "type": "PERSON",
        "first_name": "Matt",
        "demographics": {
          "name_day": {
            "month": null,
            "day": null
          },
          "id_number": "324324",
          "gender": null,
          "country_of_residence": {
            "alternative_code": "IRN",
            "three_character_code": null,
            "name": "IRAN (ISLAMIC REPUBLIC OF)",
            "id": "231",
            "two_character_code": null
          },
          "date_of_birth": {
            "month": null,
            "year": null,
            "day": null
          },
          "industry_sector": null,
          "passport_number": "234234",
          "industry": null,
          "social_security_number": null,
          "id_issued_by_country": null,
          "passport_issued_by_country": null
        }
      },
      "currency_rate_period": {
        "from_date": "C7D7ED57F21B47028144967E015DCBE5",
        "to_date": 2.3,
        "rate": 2.3,
        "inverse_rate": 0.23000000417232513,
        "currency": {
          "suffix_symbol": null,
          "prefix_symbol": "£",
          "decimal_part_name": null,
          "code": "GBP",
          "integer_part_name": null,
          "id": "9"
        },
        "id": "C7D7ED57F21B47028144967E015DCBE5"
      },
      "udf_date_2": null,
      "type": {
        "alternative_code": "WWDA",
        "name": "Wallet with debited amount",
        "description": null,
        "id": "928A6098889A416391F61D418D041B72",
        "classification": "FINANCIAL"
      },
      "udf_date_1": null,
      "udf_date_4": null,
      "udf_date_3": null,
      "number": "46",
      "udf_float_3": null,
      "udf_float_4": null,
      "total_outstanding_amount": 0,
      "items_set": [
        {
          "entity_value": "5FD64EF707FC48AB8DA4CE0F72E633DE",
          "estimated_consumption_days": 0,
          "notified_amount": -10.32,
          "entity_name": "WALLETS",
          "unsettled_amount": 0,
          "estimated_consumption_date": "2016-03-16T00:00:00",
          "id": "0FE45DC8CA03402FA815A2492EF10299",
          "outstanding_amount": 0
        }
      ],
      "id": "2D6D05F3D2E24B7598AAB334A573C1A3",
      "udf_float_1": null,
      "communication_queue": {
        "number": "151",
        "id": "A7F06CB610734BAE9D52702ACD23FA89",
        "life_cycle_state": "COMPLETED",
        "communication": {
          "number": "221",
          "subject": "Your wallet is below zero",
          "contact_information": {
            "company_profile": null,
            "company_name": null,
            "name": null,
            "last_name": "Grey",
            "id": "19646B486C02471A92E6E0EDF6F8D516",
            "life_cycle_state": "FINANCIAL",
            "middle_name": null,
            "title": null,
            "type": "PERSON",
            "first_name": "Matt",
            "demographics": {
              "name_day": {
                "month": null,
                "day": null
              },
              "id_number": "324324",
              "gender": null,
              "date_of_birth": {
                "month": null,
                "year": null,
                "day": null
              },
              "industry_sector": null,
              "passport_number": "234234",
              "industry": null,
              "social_security_number": null,
              "id_issued_by_country": null,
              "passport_issued_by_country": null
            }
          },
          "id": "03664C3D09FA47DA94F85DEFB67A8E0B",
          "life_cycle_state": "COMPLETED"
        },
        "external_system": null
      },
      "udf_float_2": null,
      "udf_string_2": null,
      "udf_string_3": null,
      "udf_string_4": null,
      "udf_string_5": null,
      "notification_run": {
        "end_date": "2016-03-24T15:32:08",
        "number": "158",
        "id": "49CC4F41B4AF447280AE04865DD18D2A",
        "life_cycle_state": "COMPLETED",
        "start_date": "2016-03-24T15:32:06"
      },
      "udf_string_1": null,
      "total_notified_amount": -10.32,
      "accounts_receivable": {
        "number": "ACR0000000064",
        "name": "ACR0000000064 Matt Grey",
        "id": "D4D336F964DA4CDB8421AA16841B37CB",
        "life_cycle_state": "ACTIVE",
        "account_owner": {
          "company_profile": null,
          "company_name": null,
          "name": "Matt Grey",
          "last_name": "Grey",
          "id": "19646B486C02471A92E6E0EDF6F8D516",
          "life_cycle_state": "FINANCIAL",
          "middle_name": null,
          "title": null,
          "type": "PERSON",
          "first_name": "Matt",
          "demographics": {
            "name_day": {
              "month": null,
              "day": null
            },
            "id_number": "324324",
            "gender": null,
            "country_of_residence": {
              "alternative_code": "IRN",
              "three_character_code": null,
              "name": "IRAN (ISLAMIC REPUBLIC OF)",
              "id": "231",
              "two_character_code": null
            },
            "date_of_birth": {
              "month": null,
              "year": null,
              "day": null
            },
            "industry_sector": null,
            "passport_number": "234234",
            "industry": null,
            "social_security_number": null,
            "id_issued_by_country": null,
            "passport_issued_by_country": null
          }
        }
      },
      "life_cycle_state": "COMPLETED",
      "unsettled_amount": 0,
      "udf_string_6": null,
      "udf_string_7": null,
      "udf_string_8": 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-29T00:00:03",
        "updated_date": "2016-02-29T00:00:04",
        "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"
        }
      },
      "contact_information": {
        "company_profile": null,
        "company_name": null,
        "name": "Matt Black",
        "last_name": "Black",
        "id": "76E0E43E7CD74157979230819FD41B8E",
        "life_cycle_state": "FINANCIAL",
        "middle_name": "Y",
        "title": null,
        "type": "PERSON",
        "first_name": "Matt",
        "demographics": {
          "name_day": {
            "month": null,
            "day": null
          },
          "id_number": "1212128596",
          "gender": "MALE",
          "country_of_residence": {
            "alternative_code": "IRN",
            "three_character_code": null,
            "name": "IRAN (ISLAMIC REPUBLIC OF)",
            "id": "231",
            "two_character_code": null
          },
          "date_of_birth": {
            "month": null,
            "year": null,
            "day": null
          },
          "industry_sector": null,
          "passport_number": null,
          "industry": null,
          "social_security_number": "999999998",
          "id_issued_by_country": null,
          "passport_issued_by_country": null
        }
      },
      "currency_rate_period": {
        "from_date": "C7D7ED57F21B47028144967E015DCBE5",
        "to_date": 2.3,
        "rate": 2.3,
        "inverse_rate": 0.23000000417232513,
        "currency": {
          "suffix_symbol": null,
          "prefix_symbol": "£",
          "decimal_part_name": null,
          "code": "GBP",
          "integer_part_name": null,
          "id": "9"
        },
        "id": "C7D7ED57F21B47028144967E015DCBE5"
      },
      "udf_date_2": null,
      "type": {
        "alternative_code": "WWDA",
        "name": "Wallet with debited amount",
        "description": null,
        "id": "928A6098889A416391F61D418D041B72",
        "classification": "FINANCIAL"
      },
      "udf_date_1": null,
      "udf_date_4": null,
      "udf_date_3": null,
      "number": "22",
      "udf_float_3": null,
      "udf_float_4": null,
      "total_outstanding_amount": 0,
      "items_set": [
        {
          "entity_value": "93C947DA245B47A8AB09FACFA17432D5",
          "estimated_consumption_days": 0,
          "notified_amount": -22.275,
          "entity_name": "WALLETS",
          "unsettled_amount": 0,
          "estimated_consumption_date": "2016-02-12T15:23:26",
          "id": "9E522FE7E7F440C7B8D8F09BB70135C7",
          "outstanding_amount": 0
        }
      ],
      "id": "9847F392BDAF4D97A7ED9B44DA528641",
      "udf_float_1": null,
      "communication_queue": null,
      "udf_float_2": null,
      "udf_string_2": null,
      "udf_string_3": null,
      "udf_string_4": null,
      "udf_string_5": null,
      "notification_run": {
        "end_date": "2016-02-29T00:00:05",
        "number": "76",
        "id": "4BA4CB2C5CE0484A80F7798283E484D2",
        "life_cycle_state": "COMPLETED",
        "start_date": "2016-02-29T00:00:01"
      },
      "udf_string_1": null,
      "total_notified_amount": -22.275,
      "accounts_receivable": {
        "number": "ACR0000000041",
        "name": "ACR0000000041 Matt Black",
        "id": "B489E6E057154A71AADD02C7E29F1FAB",
        "life_cycle_state": "ACTIVE",
        "account_owner": {
          "company_profile": null,
          "company_name": null,
          "name": "Matt Black",
          "last_name": "Black",
          "id": "76E0E43E7CD74157979230819FD41B8E",
          "life_cycle_state": "FINANCIAL",
          "middle_name": "Y",
          "title": null,
          "type": "PERSON",
          "first_name": "Matt",
          "demographics": {
            "name_day": {
              "month": null,
              "day": null
            },
            "id_number": "1212128596",
            "gender": "MALE",
            "country_of_residence": {
              "alternative_code": "IRN",
              "three_character_code": null,
              "name": "IRAN (ISLAMIC REPUBLIC OF)",
              "id": "231",
              "two_character_code": null
            },
            "date_of_birth": {
              "month": null,
              "year": null,
              "day": null
            },
            "industry_sector": null,
            "passport_number": null,
            "industry": null,
            "social_security_number": "999999998",
            "id_issued_by_country": null,
            "passport_issued_by_country": null
          }
        }
      },
      "life_cycle_state": null,
      "unsettled_amount": 0,
      "udf_string_6": null,
      "udf_string_7": null,
      "udf_string_8": null
    }
  ],
  "status": {
    "code": "OK",
    "description": "",
    "message": ""
  }
}

GET notifications/get_latest_in_queue

This method returns the latest notifications having a communication created and also pending in the communication queue. Multiple notifications are returned by each call.

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

type_identifier
(semi-optional)

Notification type identifier

The identifier of the notification type related with the notification that should be returned as a result. The allowed notification type identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the notification type

name

(semi-optional)

String

The name of the notification type

alternative_code

(semi-optional)

String

The alternative code of the notification type

notification_run_identifier

(semi-optional)

Notification run identifier

The identifier of the notification run that created the notifications that should be returned as a result. The allowed notification run identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the notification run

number

(semi-optional)

String

The number of the notification run

communication_queue_external_system_identifier

(optional)

Communication Queue External System Identifier

The identifier of the external system that should process the notification communication through the communication queue. The allowed communication queue external system identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the communication queue external system

name

(semi-optional)

String

The code of the communication queue external system

alternative_code

(semi-optional)

String

The alternative code of the communication queue external system

contact_information_identifier

(optional)

Contact Information identifier

The identifier of the contact information notified by the notifications that should be returned as a result. 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

accounts_receivable_identifier

(optional)

Accounts receivable identifier

The identifier of the accounts receivable notified by the notifications that should be returned as a result. The allowed contact information identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the accounts receivable

number

(semi-optional)

String

The number of the accounts receivable

name

(semi-optional)

String

The name of the accounts receivable

number

(mandatory)

Number

The number of notifications to be retrieved, starting from the latest one

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 notification
number	String	The number of the retrieved notification
life_cycle_state	String	The life cycle state of the retrieved notification which can be PENDING, REJECTED or COMPLETED and is calculated dynamically based on the related communication queue entry life cycle state
total_notified_amount	Number	Additional information which is populated if the notification type is classified as financial, and if the notified information is set to Subscriptions, Bills or Jobs. It defines the total initial notified amount for each subscription or job or bill included in the notification
total_outstanding_amount	Number	Additional information which is populated if the notification type is classified as financial, and if the notified information is set to Subscriptions, Bills or Jobs. It defines the total amount which is still outstanding for each subscription or bill or job included in the notification
unsettled_amount	Number	Additional information which is populated if the notification type is classified as financial, and if the notified information is set to Subscriptions, Bills or Jobs. It defines the total amount which is still unsettled for each subscription or bill or job included in the notification
expiration_date	Date	The expiration date of the notification as provided through the Notification Type Available from R14.2.0
upcoming_bill_amount	Number	Additional information which is populated if the notification type is classified as financial and if the notified information is set to Bills, having the "Calculate upcoming bill" option enabled. It defines the total upcoming bill amount to be paid of each accounts receivable included in the notification Available from R14.5.0
upcoming_bill_as_of_date	Date	The as of date of the upcoming bill calculated Available from R14.5.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
type	Notification Type object	The type of the specific notification
notification_run	Notification Run object	The notification run that generated the specific notification
contact_information	Contact Information object	The contact information related with the specific notification
accounts_receivable	Accounts Receivable object	The accounts receivable related with the specific notification
communication_queue	Communication Queue Object	The communication queue entry that was created for the specific notification
currency_rate_period	Currency Rate Period Object	The notification's currency rate period
log_information	Log Information Object	The log information related with the retrieved notification
items_set	Set of Notification Item objects	The information for which the customer will be notified about by the specific notification. That information differentiates based on the notification type classification

Referred Objects Response Data

notification_type object response data

Name	Type	Description
id	String	The ID of the retrieved notification type
name	String	The name of the retrieved notification type
alternative_code	String	The alternative code of the retrieved notification type
description	String	A description of the retrieved notification type
classification	String	The classification of the retrieved notification type which can be one of the following: FINANCIAL CUSTOMER_CARE REWARD_OFFERS REWARD_OFFERS classification available from CRM.COM R12.0.0

notification_run object response data

Name	Type	Description
id	String	The ID of the retrieved notification run
number	String	The number of the retrieved notification run
life_cycle_state	String	The life cycle state of the notification run which can be PENDING, IN_PROGRESS or COMPLETED
start_date	Date	The date that the notification run started
end_date	Date	The date that the notification run ended

contact_information object response data

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

Referred Objects Response Data

demographics object response data

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

Referred Objects Response Data

date_of_birth object response data

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

name_day object response data

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

country object response data

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

Referred Objects Response Data

country_flag object response data

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

Referred Objects Response Data

file object response data

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

industry object response data

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

industry sector object response data

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

company profile object response data

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

Referred Objects Response Data

country object response data

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

Referred Objects Response Data

country_flag object response data

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

Referred Objects Response Data

file object response data

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

industry object response data

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

industry sector object response data

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

accounts_receivable object response data

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

Referred Objects Response Data

contact_information object response data

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

Referred Objects Response Data

demographics object response data

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

Referred Objects Response Data

date_of_birth object response data

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

name_day object response data

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

country object response data

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

Referred Objects Response Data

country_flag object response data

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

Referred Objects Response Data

file object response data

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

industry object response data

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

industry sector object response data

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

company profile object response data

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

Referred Objects Response Data

country object response data

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

Referred Objects Response Data

country_flag object response data

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

Referred Objects Response Data

file object response data

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

industry object response data

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

industry sector object response data

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

communication queue response data

Name	Type	Description
id	String	The ID of the retrieved communication queue entry
number	String	The number of the retrieved communication queue entry
life_cycle_state	String	The life cycle state of the retrieved communication queue entry which can be PENDING, REJECTED or COMPLETED
communication	Communication object	The communication that is sent through the retrieved communication queue entry
external_system	Communication Queue External System object	The external system which process the communication waiting in retrieved communication queue entry

Referred Objects Response Data

communication object response data

Name	Type	Description
Id	String	The ID of the communication
number	String	The code of communication
life_cycle_state	String	The lifecycle state of the retrieved communication which can be DRAFT or COMPLETE
subject	String	The subject of the retrieved communication
viewed	Boolean	Defines whether the communication was viewed, or not Available from CRM.COM R12.2.0
viewed_on	Date	The date that the communication was viewed Available from CRM.COM R12.2.0
contact_information	Contact Information object	The contact information related with the specified communication

Referred Objects Response Data

contact_information object response data

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

Referred Objects Response Data

demographics object response data

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

Referred Objects Response Data

date_of_birth object response data

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

name_day object response data

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

country object response data

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

Referred Objects Response Data

country_flag object response data

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

Referred Objects Response Data

file object response data

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

industry object response data

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

industry sector object response data

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

company profile object response data

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

Referred Objects Response Data

country object response data

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

Referred Objects Response Data

country_flag object response data

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

Referred Objects Response Data

file object response data

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

industry object response data

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

industry sector object response data

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

communication_queue_external_system object response data

Name	Type	Description
Id	String	The ID of the communication queue external system
name	String	The name of the communication queue external system
alternative_code	String	The alternative code of the communication queue external system

currency rate period object response data

Name	Type	Description
id	String	The ID of the retrieved currency rate period
rate	Number	The exchange rate of the currency rate period
inverse_rate	Number	The inverse exchange rate of the currency rate period
from_date	Date	The date from which the exchange rate is valid
to_date	Date	The date until which the exchange rate is valid
currency	Currency Object	The Currency with which the returned exchange rate information refers to

Referred Objects Response Data

currency object response data

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

log_information object response data

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

Referred Objects Response Data

unit object response data

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

business unit object response data

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

user object response data

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

notification item response data

Name	Type	Description
id	String	The ID of the retrieved notification item
entity_name	String	The entity name of the retrieved notification which can be one of the following: ACTIVITIES BILLS JOBS LEADS PAYMENTS PAYMENT_GATEWAY_CARDS PAYMENT_GATEWAY_REQUESTS AWARD_REWARD_TRANSACTIONS SPEND_REWARD_TRANSACTIONS REWARDS_PARTICIPANT SERVICE_REQUESTS SUBSCRIPTIONS WALLETS WALLET_PRODUCT_CONSUMPTION BUY_IN_ADVANCE_REQUESTS REWARD_OFFERS SUBSCRIPTION_ACTIONS REWARD_OFFERS entity name available from CRM.COM R12.0.0 SUBSCRIPTION_ACTIONS entity name is available from CRM.COM R14.2.0
entity_value	String	The primary key value of the notification item
notified_amount	Number	Additional information which is populated if the notification type is classified as financial, and if the notified information is set to Subscriptions or Bills or Jobs. It defines the total initial notified amount for each subscription or bill or job included in the notification
outstanding_amount	Number	Additional information which is populated if the notification type is classified as financial, and if the notified information is set to Subscriptions or Bills or Jobs. It defines the total amount which is still outstanding for each subscription or bill or job included in the notification
unsettled_amount	Number	Additional information which is populated if the notification type is classified as financial, and if the notified information is set to Subscriptions or Bills or Jobs. It defines the total amount which is still unsettled for each subscription or bill or job included in the notification
estimated_consumption_days	Number	Additional information which is populated if the notification type is classified as financial, and if the notified information is set to Wallets or Wallet Product Consumption.It defines the number of remaining days, as of the date of the notification
estimated_consumption_date	Date	Additional information which is populated if the notification type is classified as financial, and if the notified information is set to Wallets or Wallet Product Consumption. It defines the estimated consumption date, as of the date of the notification
expiration_amount	Number	Additional information which is populated if the notification type is classified as financial, and if the notified information is set to Wallets. It defines the amount that is about to be expired up to a specific date set in the notification's related run definition Available from CRM.COM R11.1.0
expiration_date	Date	Additional information which is populated if the notification type is classified as financial, and if the notified information is set to Wallets. It defines the date that the expiration amount will expire. Available from CRM.COM R11.1.0
upcoming_bill_amount	Number	Additional information which is populated if the notification type is classified as financial and if the notified information is set to Bills, having the "Calculate upcoming bill" option enabled. It defines the total upcoming bill amount to be paid of each entity (Subscription or Job) included in the notification Available from R14.5.0

Examples

Example 1

HTTP Method: GET

Request:

Response:

{
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    [
        {
            "udf_float_1": null,
            "udf_float_2": null,
            "udf_float_3": null,
            "number": "63",
            "udf_float_4": null,
            "udf_string_1": null,
            "udf_string_2": null,
            "udf_string_3": null,
            "contact_information":
            {
                "last_name": "kosta",
                "life_cycle_state": "FINANCIAL",
                "middle_name": null,
                "company_profile": null,
                "title": null,
                "type": "PERSON",
                "first_name": "kostas",
                "name": "kostas kosta",
                "id": "CB6347011E6C4CC67277F3E1A98F93C0",
                "company_name": null,
                "demographics":
                {
                    "gender": null,
                    "passport_issued_by_country": null,
                    "passport_number": null,
                    "social_security_number": null,
                    "country_of_residence":
                    {
                        "name": "JAPAN",
                        "id": "237"
                    },
                    "industry_sector": null,
                    "date_of_birth":
                    {
                        "month": null,
                        "day": null,
                        "year": null
                    },
                    "name_day":
                    {
                        "month": null,
                        "day": null
                    },
                    "id_number": null,
                    "id_issued_by_country": null,
                    "industry": null
                }
            },
            "udf_string_4": null,
            "udf_string_5": null,
            "udf_string_6": null,
            "udf_string_7": null,
            "udf_string_8": null,
            "accounts_receivable":
            {
                "account_owner":
                {
                    "last_name": "kosta",
                    "life_cycle_state": "FINANCIAL",
                    "middle_name": null,
                    "company_profile": null,
                    "title": null,
                    "type": "PERSON",
                    "first_name": "kostas",
                    "name": "kostas kosta",
                    "id": "CB6347011E6C4CC67277F3E1A98F93C0",
                    "company_name": null,
                    "demographics":
                    {
                        "gender": null,
                        "passport_issued_by_country": null,
                        "passport_number": null,
                        "social_security_number": null,
                        "country_of_residence":
                        {
                            "name": "JAPAN",
                            "id": "237"
                        },
                        "industry_sector": null,
                        "date_of_birth":
                        {
                            "month": null,
                            "day": null,
                            "year": null
                        },
                        "name_day":
                        {
                            "month": null,
                            "day": null
                        },
                        "id_number": null,
                        "id_issued_by_country": null,
                        "industry": null
                    }
                },
                "life_cycle_state": "ACTIVE",
                "number": "103",
                "name": "kostas1",
                "id": "F5190A359F5FD678AC55CFE368676A3D"
            },
            "id": "FC106FA2D781910E1A02A7331D4756DB",
            "items_set":
            [
                {
                    "estimated_consumption_date": null,
                    "entity_value": "DE3EF0FDA61B38A87200B71ECDB889D9",
                    "unsettled_amount": 18714.67,
                    "entity_name": "SUBSCRIPTIONS",
                    "id": "686A4F810E4C8E65804818ED70F83728",
                    "outstanding_amount": 18714.67,
                    "estimated_consumption_days": null,
                    "notified_amount": 18714.67
                }
            ],
            "total_notified_amount": 18714.67,
            "udf_date_1": null,
            "communication_queue":
            {
                "external_system":
                {
                    "name": "New Test",
                    "id": "86F416641DB5E549D230C010302E9666",
                    "alternative_code": "NT"
                },
                "life_cycle_state": "PENDING",
                "communication":
                {
                    "life_cycle_state": "COMPLETED",
                    "number": "117",
                    "id": "7B423B4163CB1B5889235FEF4F9250DB",
                    "contact_information":
                    {
                        "last_name": "kosta",
                        "life_cycle_state": "FINANCIAL",
                        "middle_name": null,
                        "company_profile": null,
                        "title": null,
                        "type": "PERSON",
                        "first_name": "kostas",
                        "name": null,
                        "id": "CB6347011E6C4CC67277F3E1A98F93C0",
                        "company_name": null,
                        "demographics":
                        {
                            "gender": null,
                            "passport_issued_by_country": null,
                            "passport_number": null,
                            "social_security_number": null,
                            "industry_sector": null,
                            "date_of_birth":
                            {
                                "month": null,
                                "day": null,
                                "year": null
                            },
                            "name_day":
                            {
                                "month": null,
                                "day": null
                            },
                            "id_number": null,
                            "id_issued_by_country": null,
                            "industry": null
                        }
                    }
                },
                "number": "44",
                "id": "C572ADB944858D7432119925186F725E"
            },
            "udf_date_2": null,
            "udf_date_3": null,
            "udf_date_4": null,
            "log_information":
            {
                "updated_date": "2014-10-19T12:16:17",
                "created_by_unit":
                {
                    "community_name": "Main Community",
                    "group_name": "Main Group",
                    "name": "Admin Unit",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "description": "r1",
                    "alternative_code": "MG"
                },
                "created_date": "2014-10-19T12:15:56",
                "updated_by_unit":
                {
                    "community_name": "Main Community",
                    "group_name": "Main Group",
                    "name": "Admin Unit",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "description": "r1",
                    "alternative_code": "MG"
                },
                "created_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1",
                    "email": "mp@ministrator.com"
                },
                "updated_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1",
                    "email": "mp@ministrator.com"
                }
            },
            "life_cycle_state": "PENDING",
            "unsettled_amount": 18714.67,
            "notification_run":
            {
                "end_date": "2014-10-19T12:16:18",
                "life_cycle_state": "COMPLETED",
                "number": "309",
                "start_date": "2014-10-19T12:15:54",
                "id": "352F7AB4F1F04046686FBB71ED57F354"
            },
            "total_outstanding_amount": 18714.67,
            "type":
            {
                "classification": "FINANCIAL",
                "name": "Subscription",
                "id": "A7323954167D42CC35EB846B153D91A3",
                "description": null,
                "alternative_code": "Subscription"
            }
        }
    ]
}