Versions Compared

Old Version 20

changes.mady.by.user Marios Michael

Saved on

compared with

New Version 21

changes.mady.by.user Marios Michael

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Tip

Available from CRM.COM R4.0.0

 

Table of Contents
maxLevel2

...

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:

Include Page
V4:notification_identifier
V4:notification_identifier

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:

Include Page
V4:communication_identifier
V4:communication_identifier

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

...

Expand
titleExample 1

HTTP Method: GET

 

Request:

Response:

Code Block
themeConfluence
languagejs
linenumberstrue
{
    "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.

...

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:

Include Page
V4:notification_type_identifier
V4:notification_type_identifier

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:

Include Page
V4:notification_run_identifier
V4:notification_run_identifier

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:

Include Page
V4:contact_information_identifier
V4:contact_information_identifier

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:

Include Page
V4:accounts_receivable_identifier
V4:accounts_receivable_identifier

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

...

Expand
titleExample 1

HTTP Method: GET

 

Request:

Response:

Code Block
themeConfluence
languagejs
linenumberstrue
{
    "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/get_latest_in_queue

...

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:

Include Page
V4:notification_type_identifier
V4:notification_type_identifier

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:

Include Page
V4:notification_run_identifier
V4:notification_run_identifier

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:

Include Page
V4:communication_queue_external_system_identifier
V4:communication_queue_external_system_identifier

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:

Include Page
V4:contact_information_identifier
V4:contact_information_identifier

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:

Include Page
V4:accounts_receivable_identifier
V4:accounts_receivable_identifier

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

...