Versions Compared

Key

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

Available from CRM.COM R5.0.0

Table of Contents
maxLevel2

...

Name

Type

Description

token

String

The token retrieved from the login method

customer_event_identifier

(mandatory)

Customer Event identifier  

The identifier of the customer event that should be returned as a result. Only customer events of type purchase can be specified. The allowed customer event identifier fields are the following:

Include Page
V4:customer_event_identifier
V4:customer_event_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

...

Name

Type

Description

token

String

The token retrieved from the login method

rewards_participant_identifier

(semi-optional)

Rewards Participant IdentifierThe identifier of the rewards participant related with the customer events that should be retrieved. The allowed rewards participant identifier fields are the following:

Include Page
V4:rewards_participants_identifier
V4:rewards_participants_identifier

accounts_receivable_identifier

(semi-optional)

Accounts Receivable Identifier  

The identifier of the accounts receivable related with the customer events that should be retrieved. The allowed accounts receivable identifier fields are the following:

Include Page
V4:accounts_receivable_identifier
V4:accounts_receivable_identifier

classification_identifier

(semi-optional)

Customer Event Classification Identifier

The identifier of the classification related with the customer events that should be retrieved. The allowed customer event classification identifier fields are the following:

Include Page
V4:customer_event_classification_identifier
V4:customer_event_classification_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

...

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

(semi-optional)

Accounts receivable Identifier

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

Include Page
V4:accounts_receivable_identifier
V4:accounts_receivable_identifier

rewards_participant_identifier

(semi-optional)

Rewards Participant IdentifierThe related rewards participant. The allowed rewards participant identifier fields are the following:

Include Page
V4:rewards_participants_identifier
V4:rewards_participants_identifier

classification_identifier

(optional)

Customer Event Classification IdentifierThe classification of the customer event. The allowed customer event classification identifier fields are the following:

Include Page
V4:customer_event_classification_identifier
V4:customer_event_classification_identifier

performed_by_unit_identifier

(mandatory)

Unit IdentifierThe unit that initiated the customer event. The allowed unit identifier fields are the following:

Include Page
V4:unit_identifier
V4:unit_identifier

performed_on

(mandatory)

DateThe date that the customer event was actually performed

description

(optional)

StringA description of the customer event

process_immediately

(optional)

booleanDefines if the customer event was processed immediately by various business processes or not

reference_number

(optional)

StringThe reference number of the retrieved purchase customer event

invoice_identifier

(optional)

Invoice IdentifierThe CRM.COM invoice related with the purchase. The allowed invoice identifier fields are the following:

Include Page
V4:invoice_identifier
V4:invoice_identifier

udf_string_1

(optional)

String

User Defined Field of type String

udf_string_2

(optional)

String

User Defined Field of type String

udf_string_3

(optional)

String

User Defined Field of type String

udf_string_4

(optional)

String

User Defined Field of type String

udf_string_5

(optional)

String

User Defined Field of type String

udf_string_6

(optional)

String

User Defined Field of type String

udf_string_7

(optional)

String

User Defined Field of type String

udf_string_8

(optional)

String

User Defined Field of type String

udf_float_1

(optional)

Float

User Defined Field of type Float

udf_float_2

(optional)

Float

User Defined Field of type Float

udf_float_3

(optional)

Float

User Defined Field of type Float

udf_float_4

(optional)

Float

User Defined Field of type Float

udf_date_1

(optional)

Date

User Defined Field of type Date

udf_date_2

(optional)

Date

User Defined Field of type Date

udf_date_3

(optional)

Date

User Defined Field of type Date

udf_date_4

(optional)

Date

User Defined Field of type Date

 products_set

(mandatory)

Set of  Purchase Product ObjectsThe purchased products, along with the total amount, net amount and VAT amount for each product

...

POST customer_events/purchases/create_spend

Tip

Available from CRM.COM R9.0.0

This method is used to create a purchase customer event in a posted life cycle state, and a spend request customer event related with that purchase customer event. In case of an error none of the customer events is created

...

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

(semi-optional)

Accounts receivable Identifier

The accounts receivable that will be related with both the purchase customer event and the spend request customer event that will be created. The allowed accounts receivable identifier fields are the following:

Include Page
V4:accounts_receivable_identifier
V4:accounts_receivable_identifier

rewards_participant_identifier

(semi-optional)

Rewards Participant IdentifierThe rewards participant that will be related with both the purchase customer event and the spend request customer event that will be created. The allowed rewards participant identifier fields are the following:

Include Page
V4:rewards_participants_identifier
V4:rewards_participants_identifier

performed_by_unit_identifier

(mandatory)

Unit IdentifierThe unit that initiated both the purchase customer event and the spend request customer event that will be created. The allowed unit identifier fields are the following:

Include Page
V4:unit_identifier
V4:unit_identifier

performed_on

(mandatory)

DateThe date that both the purchase customer event and the spend request customer event that will be created were actually performed

process_immediately

(optional)

booleanDefines if the customer events should be processed immediately by various business processes or not

purchase_customer_event

(mandatory)

Purchase Customer Event ObjectInformation related with the purchase customer event to be created

spend_request_customer_event

(mandatory)

Spend Request Customer Event ObjectInformation related with the spend request that should be created. The spend request will automatically be related with the specified purchase customer event.

...

Expand
titleExample 1

HTTP Method: POST

 

Request:

Body:

Code Block
themeConfluence
languagejavascript
linenumberstrue
 

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
 
      {
    "token":"CA35E503E4D04DC6BB2AF96D1BFE62CD",
    "rewards_participant_identifier":{"number":"77"},
    "performed_by_unit_identifier":{"name":"Admin Unit"},
    "performed_on":"2015-12-15T15:50:59",
    "process_immediately":1,
    "purchase_customer_event":
    {
        "reference_number":"2312312",
        "total_amount":88,
        "net_amount":80,
        "vat_amount":8,
        "products_set":
        [
            {
                "product_identifier":{"code":"Product A"},
                "total_amount":88,
                "net_amount":80,
                "vat_amount":8
            }
        ]
    },
    "spend_request_customer_event":
    {
        "spend_amount":60
    }
}


Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
 
    {
        "status":
        {
            "message": "",
            "description": "",
            "code": "OK"
        },
        "data":
        {
            "purchase_customer_event":
            {
                "award_reward_transactions_set":
                [
                    {
                        "life_cycle_state": "POSTED",
                        "amount": 88,
                        "rewards_participant":
                        {
                            "accounts_receivable":
                            {
                                "account_owner":
                                {
                                    "last_name": "Arvanitidis",
                                    "middle_name": null,
                                    "life_cycle_state": "FINANCIAL",
                                    "company_profile": null,
                                    "title": null,
                                    "first_name": "Pasxalis",
                                    "type": "PERSON",
                                    "id": "6D2460AAF25D40E3953789A87FE6587D",
                                    "name": null,
                                    "company_name": null,
                                    "demographics":
                                    {
                                        "gender": null,
                                        "passport_issued_by_country": null,
                                        "social_security_number": null,
                                        "passport_number": null,
                                        "industry_sector": null,
                                        "name_day":
                                        {
                                            "month": null,
                                            "day": null
                                        },
                                        "date_of_birth":
                                        {
                                            "month": null,
                                            "day": null,
                                            "year": null
                                        },
                                        "id_number": "965677",
                                        "industry": null,
                                        "id_issued_by_country": null
                                    }
                                },
                                "life_cycle_state": "ACTIVE",
                                "number": "ACR000814",
                                "id": "CFB4A3DDED8541D987A48FE3DF0C7A64",
                                "name": "Arvanitidis"
                            },
                            "number": "77",
                            "id": "83D2955389594742BD15053539A474F7"
                        },
                        "number": "249",
                        "id": "EBA0BC1915D542C99135DC3842B358C7"
                    }
                ],
                "classification": null,
                "number": "274",
                "performed_by_unit":
                {
                    "community_name": "Internal Community",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "group_name": "Main Group",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "process_immediately": 1,
                "vat_amount": 8,
                "log_information":
                {
                    "updated_date": "2015-11-26T17:30:02",
                    "created_date": "2015-11-26T17:30:01",
                    "created_by_unit":
                    {
                        "community_name": "Internal Community",
                        "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                        "name": "Admin Unit",
                        "group_name": "Main Group",
                        "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                        "alternative_code": "MG"
                    },
                    "updated_by_unit":
                    {
                        "community_name": "Internal Community",
                        "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                        "name": "Admin Unit",
                        "group_name": "Main Group",
                        "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                        "alternative_code": "MG"
                    },
                    "created_by_user":
                    {
                        "person_name": "Marios Lannister",
                        "username": "MPAdministrator",
                        "id": "1"
                    },
                    "updated_by_user":
                    {
                        "person_name": "Marios Lannister",
                        "username": "MPAdministrator",
                        "id": "1"
                    }
                },
                "total_amount": 88,
                "life_cycle_state": "POSTED",
                "accounts_receivable":
                {
                    "account_owner":
                    {
                        "last_name": "Arvanitidis",
                        "middle_name": null,
                        "life_cycle_state": "FINANCIAL",
                        "company_profile": null,
                        "title": null,
                        "first_name": "Pasxalis",
                        "type": "PERSON",
                        "id": "6D2460AAF25D40E3953789A87FE6587D",
                        "name": null,
                        "company_name": null,
                        "demographics":
                        {
                            "gender": null,
                            "passport_issued_by_country": null,
                            "social_security_number": null,
                            "passport_number": null,
                            "industry_sector": null,
                            "name_day":
                            {
                                "month": null,
                                "day": null
                            },
                            "date_of_birth":
                            {
                                "month": null,
                                "day": null,
                                "year": null
                            },
                            "id_number": "965677",
                            "industry": null,
                            "id_issued_by_country": null
                        }
                    },
                    "life_cycle_state": "ACTIVE",
                    "number": "ACR000814",
                    "id": "CFB4A3DDED8541D987A48FE3DF0C7A64",
                    "name": "Arvanitidis"
                },
                "type": "PURCHASE",
                "net_amount": 80,
                "id": "FA4B17150F784BD3B3E7D0E5B35CDA6F",
                "description": null,
                "reference_number": "2312312",
                "performed_on": "2015-12-15T15:50:59"
            },
            "spend_request_customer_event":
            {
                "classification": null,
                "number": "39",
                "performed_by_unit":
                {
                    "community_name": "Internal Community",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "group_name": "Main Group",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "process_immediately": 1,
                "spend_reward_transaction":
                {
                    "total_amount": 60,
                    "life_cycle_state": "POSTED",
                    "rewards_participant":
                    {
                        "accounts_receivable":
                        {
                            "account_owner":
                            {
                                "last_name": "Arvanitidis",
                                "middle_name": null,
                                "life_cycle_state": "FINANCIAL",
                                "company_profile": null,
                                "title": null,
                                "first_name": "Pasxalis",
                                "type": "PERSON",
                                "id": "6D2460AAF25D40E3953789A87FE6587D",
                                "name": null,
                                "company_name": null,
                                "demographics":
                                {
                                    "gender": null,
                                    "passport_issued_by_country": null,
                                    "social_security_number": null,
                                    "passport_number": null,
                                    "industry_sector": null,
                                    "name_day":
                                    {
                                        "month": null,
                                        "day": null
                                    },
                                    "date_of_birth":
                                    {
                                        "month": null,
                                        "day": null,
                                        "year": null
                                    },
                                    "id_number": "965677",
                                    "industry": null,
                                    "id_issued_by_country": null
                                }
                            },
                            "life_cycle_state": "ACTIVE",
                            "number": "ACR000814",
                            "id": "CFB4A3DDED8541D987A48FE3DF0C7A64",
                            "name": "Arvanitidis"
                        },
                        "number": "77",
                        "id": "83D2955389594742BD15053539A474F7"
                    },
                    "number": "61",
                    "net_amount": 54.55,
                    "id": "804D54236E4C457687ABCA091AA03CA3",
                    "vat_amount": 5.45
                },
                "log_information":
                {
                    "updated_date": "2015-11-26T17:30:06",
                    "created_date": "2015-11-26T17:30:05",
                    "created_by_unit":
                    {
                        "community_name": "Internal Community",
                        "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                        "name": "Admin Unit",
                        "group_name": "Main Group",
                        "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                        "alternative_code": "MG"
                    },
                    "updated_by_unit":
                    {
                        "community_name": "Internal Community",
                        "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                        "name": "Admin Unit",
                        "group_name": "Main Group",
                        "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                        "alternative_code": "MG"
                    },
                    "created_by_user":
                    {
                        "person_name": "Marios Lannister",
                        "username": "MPAdministrator",
                        "id": "1"
                    },
                    "updated_by_user":
                    {
                        "person_name": "Marios Lannister",
                        "username": "MPAdministrator",
                        "id": "1"
                    }
                },
                "life_cycle_state": "POSTED",
                "accounts_receivable":
                {
                    "account_owner":
                    {
                        "last_name": "Arvanitidis",
                        "middle_name": null,
                        "life_cycle_state": "FINANCIAL",
                        "company_profile": null,
                        "title": null,
                        "first_name": "Pasxalis",
                        "type": "PERSON",
                        "id": "6D2460AAF25D40E3953789A87FE6587D",
                        "name": null,
                        "company_name": null,
                        "demographics":
                        {
                            "gender": null,
                            "passport_issued_by_country": null,
                            "social_security_number": null,
                            "passport_number": null,
                            "industry_sector": null,
                            "name_day":
                            {
                                "month": null,
                                "day": null
                            },
                            "date_of_birth":
                            {
                                "month": null,
                                "day": null,
                                "year": null
                            },
                            "id_number": "965677",
                            "industry": null,
                            "id_issued_by_country": null
                        }
                    },
                    "life_cycle_state": "ACTIVE",
                    "number": "ACR000814",
                    "id": "CFB4A3DDED8541D987A48FE3DF0C7A64",
                    "name": "Arvanitidis"
                },
                "spend_amount": 60,
                "type": "SPEND_REQUEST",
                "id": "75A55F01E54542F88FE1401FF6DB4A13",
                "description": null,
                "performed_on": "2015-12-15T15:50:59"
            }
        }
    }

GET customer_events/referrals/show

...

Name

Type

Description

token

String

The token retrieved from the login method

customer_event_identifier

(mandatory)

Customer Event identifier  

The identifier of the customer event that should be returned as a result. Only customer events of type referrals can be specified. The allowed customer event identifier fields are the following:

Include Page
V4:customer_event_identifier
V4:customer_event_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

...

Name

Type

Description

token

String

The token retrieved from the login method

referred_rewards_participant_identifier

(semi-optional)

Rewards Participant IdentifierThe identifier of the referred rewards participant related with the customer events that should be retrieved. The allowed rewards participant identifier fields are the following:

Include Page
V4:rewards_participants_identifier
V4:rewards_participants_identifier

referred_accounts_receivable_identifier

(semi-optional)

Accounts Receivable Identifier  

The identifier of the referred accounts receivable related with the customer events that should be retrieved. The allowed accounts receivable identifier fields are the following:

Include Page
V4:accounts_receivable_identifier
V4:accounts_receivable_identifier

referred_by_rewards_participant_identifier

(semi-optional)

Rewards Participant IdentifierThe identifier of the referred by rewards participant related with the customer events that should be retrieved. The allowed rewards participant identifier fields are the following:

Include Page
V4:rewards_participants_identifier
V4:rewards_participants_identifier

referred_by_accounts_receivable_identifier

(semi-optional)

Accounts Receivable Identifier  

The identifier of the referred by accounts receivable related with the customer events that should be retrieved. The allowed accounts receivable identifier fields are the following:

Include Page
V4:accounts_receivable_identifier
V4:accounts_receivable_identifier

 Customer Event Classification Identifier

The identifier of the classification related with the customer events that should be retrieved. The allowed customer event classification identifier fields are the following:

Include Page
V4:customer_event_classification_identifier
V4:customer_event_classification_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

...

Name

Type

Description

token

String

The token retrieved from the login method

classification_identifier

(optional)

Customer Event Classification IdentifierThe classification of the customer event. The allowed customer event classification identifier fields are the following:

Include Page
V4:customer_event_classification_identifier
V4:customer_event_classification_identifier

performed_by_unit_identifier

(mandatory)

Unit IdentifierThe unit that initiated the customer event. The allowed unit identifier fields are the following:

Include Page
V4:unit_identifier
V4:unit_identifier

performed_on

(mandatory)

DateThe date that the customer event was actually performed

description

(optional)

StringA description of the customer event

process_immediately

(optional)

booleanDefines if the customer event was processed immediately by various business processes or not

referred_rewards_participant_identifier

(mandatory)

Rewards Participant IdentifierThe referred rewards participant. The allowed rewards participant identifier fields are the following:

Include Page
V4:rewards_participants_identifier
V4:rewards_participants_identifier

referred_by_rewards_participant_identifier

(mandatory)

Rewards Participant IdentifierThe rewards participant that provided the referral. The allowed rewards participant identifier fields are the following:

Include Page
V4:rewards_participants_identifier
V4:rewards_participants_identifier

udf_string_1

(optional)

String

User Defined Field of type String

udf_string_2

(optional)

String

User Defined Field of type String

udf_string_3

(optional)

String

User Defined Field of type String

udf_string_4

(optional)

String

User Defined Field of type String

udf_string_5

(optional)

String

User Defined Field of type String

udf_string_6

(optional)

String

User Defined Field of type String

udf_string_7

(optional)

String

User Defined Field of type String

udf_string_8

(optional)

String

User Defined Field of type String

udf_float_1

(optional)

Float

User Defined Field of type Float

udf_float_2

(optional)

Float

User Defined Field of type Float

udf_float_3

(optional)

Float

User Defined Field of type Float

udf_float_4

(optional)

Float

User Defined Field of type Float

udf_date_1

(optional)

Date

User Defined Field of type Date

udf_date_2

(optional)

Date

User Defined Field of type Date

udf_date_3

(optional)

Date

User Defined Field of type Date

udf_date_4

(optional)

Date

User Defined Field of type Date

...

Name

Type

Description

token

String

The token retrieved from the login method

customer_event_identifier

(mandatory)

Customer Event identifier  

The identifier of the customer event that should be returned as a result. Only customer events of type social media can be specified. The allowed customer event identifier fields are the following:

Include Page
V4:customer_event_identifier
V4:customer_event_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

...

Name

Type

Description

token

String

The token retrieved from the login method

rewards_participant_identifier

(semi-optional)

Rewards Participant IdentifierThe identifier of the rewards participant related with the customer events that should be retrieved. The allowed rewards participant identifier fields are the following:

Include Page
V4:rewards_participants_identifier
V4:rewards_participants_identifier

accounts_receivable_identifier

(semi-optional)

Accounts Receivable Identifier  

The identifier of the accounts receivable related with the customer events that should be retrieved. The allowed accounts receivable identifier fields are the following:

Include Page
V4:accounts_receivable_identifier
V4:accounts_receivable_identifier

classification_identifier

(semi-optional)

Customer Event Classification Identifier

The identifier of the classification related with the customer events that should be retrieved. The allowed customer event classification identifier fields are the following:

Include Page
V4:customer_event_classification_identifier
V4:customer_event_classification_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

...

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

(semi-optional)

Accounts receivable Identifier

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

Include Page
V4:accounts_receivable_identifier
V4:accounts_receivable_identifier

rewards_participant_identifier

(semi-optional)

Rewards Participant IdentifierThe related rewards participant. The allowed rewards participant identifier fields are the following:

Include Page
V4:rewards_participants_identifier
V4:rewards_participants_identifier

classification_identifier

(optional)

Customer Event Classification IdentifierThe classification of the customer event. The allowed customer event classification identifier fields are the following:

Include Page
V4:customer_event_classification_identifier
V4:customer_event_classification_identifier

performed_by_unit_identifier

(mandatory)

Unit IdentifierThe unit that initiated the customer event. The allowed unit identifier fields are the following:

Include Page
V4:unit_identifier
V4:unit_identifier

performed_on

(mandatory)

DateThe date that the customer event was actually performed

description

(optional)

StringA description of the customer event

process_immediately

(optional)

booleanDefines if the customer event was processed immediately by various business processes or not

social_media

(mandatory)

String

The social media related with the customer event, which can be one of the following: FACEBOOK

profile

(mandatory)

StringThe social media profile related with the customer event

action

(mandatory)

String

The social media action that was performed. The following actions per social media are supported (if the social media is set to Facebook) LIKE

udf_string_1

(optional)

String

User Defined Field of type String

udf_string_2

(optional)

String

User Defined Field of type String

udf_string_3

(optional)

String

User Defined Field of type String

udf_string_4

(optional)

String

User Defined Field of type String

udf_string_5

(optional)

String

User Defined Field of type String

udf_string_6

(optional)

String

User Defined Field of type String

udf_string_7

(optional)

String

User Defined Field of type String

udf_string_8

(optional)

String

User Defined Field of type String

udf_float_1

(optional)

Float

User Defined Field of type Float

udf_float_2

(optional)

Float

User Defined Field of type Float

udf_float_3

(optional)

Float

User Defined Field of type Float

udf_float_4

(optional)

Float

User Defined Field of type Float

udf_date_1

(optional)

Date

User Defined Field of type Date

udf_date_2

(optional)

Date

User Defined Field of type Date

udf_date_3

(optional)

Date

User Defined Field of type Date

udf_date_4

(optional)

Date

User Defined Field of type Date

...

Name

Type

Description

token

String

The token retrieved from the login method

customer_event_identifier

(mandatory)

Customer Event identifier  

The identifier of the customer event that should be returned as a result. Only customer events of type web can be specified. The allowed customer event identifier fields are the following:

Include Page
V4:customer_event_identifier
V4:customer_event_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

...

Name

Type

Description

token

String

The token retrieved from the login method

rewards_participant_identifier

(semi-optional)

Rewards Participant IdentifierThe identifier of the rewards participant related with the customer events that should be retrieved. The allowed rewards participant identifier fields are the following:

Include Page
V4:rewards_participants_identifier
V4:rewards_participants_identifier

accounts_receivable_identifier

(semi-optional)

Accounts Receivable Identifier  

The identifier of the accounts receivable related with the customer events that should be retrieved. The allowed accounts receivable identifier fields are the following:

Include Page
V4:accounts_receivable_identifier
V4:accounts_receivable_identifier

classification_identifier

(semi-optional)

Customer Event Classification Identifier

The identifier of the classification related with the customer events that should be retrieved. The allowed customer event classification identifier fields are the following:

Include Page
V4:customer_event_classification_identifier
V4:customer_event_classification_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

...

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

(semi-optional)

Accounts receivable Identifier

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

Include Page
V4:accounts_receivable_identifier
V4:accounts_receivable_identifier

rewards_participant_identifier

(semi-optional)

Rewards Participant IdentifierThe related rewards participant. The allowed rewards participant identifier fields are the following:

Include Page
V4:rewards_participants_identifier
V4:rewards_participants_identifier

classification_identifier

(optional)

Customer Event Classification IdentifierThe classification of the customer event. The allowed customer event classification identifier fields are the following:

Include Page
V4:customer_event_classification_identifier
V4:customer_event_classification_identifier

performed_by_unit_identifier

(mandatory)

Unit IdentifierThe unit that initiated the customer event. The allowed unit identifier fields are the following:

Include Page
V4:unit_identifier
V4:unit_identifier

performed_on

(mandatory)

DateThe date that the customer event was actually performed

description

(optional)

StringA description of the customer event

process_immediately

(optional)

booleanDefines if the customer event was processed immediately by various business processes or not

website

(mandatory)

StringThe website URL related with the customer event

udf_string_1

(optional)

String

User Defined Field of type String

udf_string_2

(optional)

String

User Defined Field of type String

udf_string_3

(optional)

String

User Defined Field of type String

udf_string_4

(optional)

String

User Defined Field of type String

udf_string_5

(optional)

String

User Defined Field of type String

udf_string_6

(optional)

String

User Defined Field of type String

udf_string_7

(optional)

String

User Defined Field of type String

udf_string_8

(optional)

String

User Defined Field of type String

udf_float_1

(optional)

Float

User Defined Field of type Float

udf_float_2

(optional)

Float

User Defined Field of type Float

udf_float_3

(optional)

Float

User Defined Field of type Float

udf_float_4

(optional)

Float

User Defined Field of type Float

udf_date_1

(optional)

Date

User Defined Field of type Date

udf_date_2

(optional)

Date

User Defined Field of type Date

udf_date_3

(optional)

Date

User Defined Field of type Date

udf_date_4

(optional)

Date

User Defined Field of type Date

...

Name

Type

Description

token

String

The token retrieved from the login method

customer_event_identifier

(mandatory)

Customer Event identifier  

The identifier of the customer event that should be returned as a result. Only customer events of type achievement can be specified. The allowed customer event identifier fields are the following:

Include Page
V4:customer_event_identifier
V4:customer_event_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

...

Name

Type

Description

token

String

The token retrieved from the login method

rewards_participant_identifier

(semi-optional)

Rewards Participant IdentifierThe identifier of the rewards participant related with the customer events that should be retrieved. The allowed rewards participant identifier fields are the following:

Include Page
V4:rewards_participants_identifier
V4:rewards_participants_identifier

accounts_receivable_identifier

(semi-optional)

Accounts Receivable Identifier  

The identifier of the accounts receivable related with the customer events that should be retrieved. The allowed accounts receivable identifier fields are the following:

Include Page
V4:accounts_receivable_identifier
V4:accounts_receivable_identifier

classification_identifier

(semi-optional)

Customer Event Classification Identifier

The identifier of the classification related with the customer events that should be retrieved. The allowed customer event classification identifier fields are the following:

Include Page
V4:customer_event_classification_identifier
V4:customer_event_classification_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

...

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

(semi-optional)

Accounts receivable Identifier

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

Include Page
V4:accounts_receivable_identifier
V4:accounts_receivable_identifier

rewards_participant_identifier

(semi-optional)

Rewards Participant IdentifierThe related rewards participant. The allowed rewards participant identifier fields are the following:

Include Page
V4:rewards_participants_identifier
V4:rewards_participants_identifier

classification_identifier

(mandatory)

Customer Event Classification IdentifierThe classification of the customer event. The allowed customer event classification identifier fields are the following:

Include Page
V4:customer_event_classification_identifier
V4:customer_event_classification_identifier

performed_by_unit_identifier

(mandatory)

Unit IdentifierThe unit that initiated the customer event. The allowed unit identifier fields are the following:

Include Page
V4:unit_identifier
V4:unit_identifier

performed_on

(mandatory)

DateThe date that the customer event was actually performed

description

(optional)

StringA description of the customer event

process_immediately

(optional)

booleanDefines if the customer event was processed immediately by various business processes or not

udf_string_1

(optional)

String

User Defined Field of type String

udf_string_2

(optional)

String

User Defined Field of type String

udf_string_3

(optional)

String

User Defined Field of type String

udf_string_4

(optional)

String

User Defined Field of type String

udf_string_5

(optional)

String

User Defined Field of type String

udf_string_6

(optional)

String

User Defined Field of type String

udf_string_7

(optional)

String

User Defined Field of type String

udf_string_8

(optional)

String

User Defined Field of type String

udf_float_1

(optional)

Float

User Defined Field of type Float

udf_float_2

(optional)

Float

User Defined Field of type Float

udf_float_3

(optional)

Float

User Defined Field of type Float

udf_float_4

(optional)

Float

User Defined Field of type Float

udf_date_1

(optional)

Date

User Defined Field of type Date

udf_date_2

(optional)

Date

User Defined Field of type Date

udf_date_3

(optional)

Date

User Defined Field of type Date

udf_date_4

(optional)

Date

User Defined Field of type Date

...

Name

Type

Description

token

String

The token retrieved from the login method

customer_event_identifier

(mandatory)

Customer Event identifier  

The identifier of the customer event that should be returned as a result. Only customer events of type spend request can be specified. The allowed customer event identifier fields are the following:

Include Page
V4:customer_event_identifier
V4:customer_event_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

...

Name

Type

Description

token

String

The token retrieved from the login method

rewards_participant_identifier

(semi-optional)

Rewards Participant IdentifierThe identifier of the rewards participant related with the customer events that should be retrieved. The allowed rewards participant identifier fields are the following:

Include Page
V4:rewards_participants_identifier
V4:rewards_participants_identifier

accounts_receivable_identifier

(semi-optional)

Accounts Receivable Identifier  

The identifier of the accounts receivable related with the customer events that should be retrieved. The allowed accounts receivable identifier fields are the following:

Include Page
V4:accounts_receivable_identifier
V4:accounts_receivable_identifier

classification_identifier

(semi-optional)

Customer Event Classification Identifier

The identifier of the classification related with the customer events that should be retrieved. The allowed customer event classification identifier fields are the following:

Include Page
V4:customer_event_classification_identifier
V4:customer_event_classification_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

...

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

(semi-optional)

Accounts receivable Identifier

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

Include Page
V4:accounts_receivable_identifier
V4:accounts_receivable_identifier

Tip

Available from CRM.COM R8.0.0

rewards_participant_identifier

(semi-optional)

Rewards Participant IdentifierThe related rewards participant. The allowed rewards participant identifier fields are the following:

Include Page
V4:rewards_participants_identifier
V4:rewards_participants_identifier

Tip

Available from CRM.COM R8.0.0

classification_identifier

(optional)

Customer Event Classification IdentifierThe classification of the customer event. The allowed customer event classification identifier fields are the following:

Include Page
V4:customer_event_classification_identifier
V4:customer_event_classification_identifier

performed_by_unit_identifier

(mandatory)

Unit IdentifierThe unit that initiated the customer event. The allowed unit identifier fields are the following:

Include Page
V4:unit_identifier
V4:unit_identifier

performed_on

(mandatory)

DateThe date that the customer event was actually performed

description

(optional)

StringA description of the customer event

process_immediately

(optional)

booleanDefines if the customer event was processed immediately by various business processes or not

purchase_customer_request_identifier

(mandatory)

Customer Event identifier  

The purchase customer event which is requested to be settled by the specified spend request. Only customer events of type purchase can be specified. The allowed customer event identifier fields are the following:

Include Page
V4:customer_event_identifier
V4:customer_event_identifier

Tip

Starting from CRM.COM R8.0.0 the purchase customer event should belong to the account specified through the accounts_receivable_identifier or to the account related with the rewards participant specified through the rewards_participnat_identifier

spend_amount

(optional)

Float

The amount to be spend by the specified spend request. This is applicable depending on the classification of the spend request and only if it is allowed by a spend request customer event rule, as defined through the active customer event definition

Tip

Available from CRM.COM R9.0.0

udf_string_1

(optional)

String

User Defined Field of type String

udf_string_2

(optional)

String

User Defined Field of type String

udf_string_3

(optional)

String

User Defined Field of type String

udf_string_4

(optional)

String

User Defined Field of type String

udf_string_5

(optional)

String

User Defined Field of type String

udf_string_6

(optional)

String

User Defined Field of type String

udf_string_7

(optional)

String

User Defined Field of type String

udf_string_8

(optional)

String

User Defined Field of type String

udf_float_1

(optional)

Float

User Defined Field of type Float

udf_float_2

(optional)

Float

User Defined Field of type Float

udf_float_3

(optional)

Float

User Defined Field of type Float

udf_float_4

(optional)

Float

User Defined Field of type Float

udf_date_1

(optional)

Date

User Defined Field of type Date

udf_date_2

(optional)

Date

User Defined Field of type Date

udf_date_3

(optional)

Date

User Defined Field of type Date

udf_date_4

(optional)

Date

User Defined Field of type Date

...