Tip
Available from CRM.COM R5.0.0

Table of Contents

maxLevel	2

GET customer_events/purchases/show

Tip
Available from CRM.COM R5.0.0

Table of Contents

maxLevel	2

GET customer_events/purchases/show

This method returns information related with a purchase customer event. A single purchase customer event is returned by each call

...

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 Identifier

The 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 Identifier

The 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 Identifier

The 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 Identifier

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

Date

The date that the customer event was actually performed

description

(optional)

String

A description of the customer event

process_immediately

(optional)

boolean

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

reference_number

(optional)

String

The reference number of the retrieved purchase customer event

invoice_identifier

(optional)

Invoice Identifier

The 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 Objects

The purchased products, along with the total amount, net amount and VAT amount for each product

...

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
   "token":"608642920F77C0EDDED7D77E6CDDF075",
   "rewards_participant_identifier":{"number":"11"},
   "classification_identifier":{"name":"Event Class Test 2"},
   "performed_by_unit_identifier":{"name":"Admin Unit"},
   "performed_on":"2014-05-05T15:49:59",
   "description":"first purchase event",
   "process_immediately":1,
   "reference_number":"RF333",
   "total_amount":220,
   "net_amount":200,
   "vat_amount":20,
   "invoice_identifier":{"number":"15"},
   "udf_string_1":"udf string 1",
   "udf_string_2":"udf string 2",
   "udf_string_3":"udf string 3",
   "udf_string_4":"udf string 4",
   "udf_string_5":"udf string 5",
   "udf_string_6":"udf string 6",
   "udf_string_7":"udf string 7",
   "udf_string_8":"udf string 8",
   "udf_float_1":10,
   "udf_float_2":20,
   "udf_float_3":30,
   "udf_float_4":40,
   "udf_float_5":50,
   "udf_float_6":60,
   "udf_float_7":70,
   "udf_float_8":80,
   "udf_date_1":"2014-05-05T15:49:59",
   "udf_date_2":"2014-06-05T15:49:59",
   "udf_date_3":"2014-07-05T15:49:59",
   "udf_date_4":"2014-08-05T15:49:59",
   "products_set":
   [
     {
       "product_identifier":{"code":"Documentaries"},
       "total_amount":55,
       "net_amount":50,
       "vat_amount":5
     },
     {
       "product_identifier":{"code":"International"},
       "total_amount":165,
       "net_amount":150,
       "vat_amount":15
     }
   ]
 }

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

 
      {
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    {
        "udf_float_1": 10,
        "products_set":
        [
            {
                "total_amount": 55,
                "net_amount": 50,
                "id": "520BF5797B906663D394C5F3303FB204",
                "vat_amount": 5,
                "product":
                {
                    "product_type": null,
                    "id": "DE37CF1696E3CD4E8EF89F522019D385",
                    "description": "Documentaries",
                    "code": "Documentaries",
                    "alternative_code": null
                }
            },
            {
                "total_amount": 165,
                "net_amount": 150,
                "id": "9B93D63B6F9DE8C94D2044663988F63F",
                "vat_amount": 15,
                "product":
                {
                    "product_type": null,
                    "id": "CA05E389D3874A44278047A6109AC975",
                    "description": "International",
                    "code": "International",
                    "alternative_code": null
                }
            }
        ],
        "udf_float_2": 20,
        "udf_float_3": 30,
        "number": "9",
        "udf_float_4": 40,
        "udf_string_1": "udf string 1",
        "udf_string_2": "udf string 2",
        "udf_string_3": "udf string 3",
        "udf_string_4": "udf string 4",
        "udf_string_5": "udf string 5",
        "udf_string_6": "udf string 6",
        "udf_string_7": "udf string 7",
        "udf_string_8": "udf string 8",
        "accounts_receivable":
        {
            "account_owner":
            {
                "last_name": "Papapavlou",
                "life_cycle_state": "FINANCIAL",
                "middle_name": "Andreas",
                "company_profile": null,
                "title": "Ms",
                "type": "PERSON",
                "first_name": "Lucia",
                "name": "Lucia Papapavlou",
                "id": "1D92B269658D80DEDF2499E25201739E",
                "company_name": null,
                "demographics":
                {
                    "gender": "FEMALE",
                    "passport_issued_by_country":
                    {
                        "name": "GREECE",
                        "id": "209"
                    },
                    "passport_number": "113115",
                    "social_security_number": "113116",
                    "country_of_residence":
                    {
                        "name": "UNITED KINGDOM",
                        "id": "126"
                    },
                    "industry_sector":
                    {
                        "name": "GOVERNMENTAL",
                        "id": "A9BDEBD4D8FAEDB0BACE40C041156D12",
                        "alternative_code": "GOV"
                    },
                    "date_of_birth":
                    {
                        "month": 1,
                        "day": 1,
                        "year": 1990
                    },
                    "name_day":
                    {
                        "month": 5,
                        "day": 5
                    },
                    "id_number": "113114",
                    "id_issued_by_country":
                    {
                        "name": "GREECE",
                        "id": "209"
                    },
                    "industry":
                    {
                        "name": "Interior Design",
                        "id": "06B638258885DA26FA2BD40D9128D04E",
                        "code": "INTDS"
                    }
                }
            },
            "life_cycle_state": "ACTIVE",
            "number": "399",
            "name": "Lucia Papapavlou",
            "id": "2B669B8EB009BF42352C00B05FAB61CF"
        },
        "id": "99FE2CFD65E9CB1F8DE1E6C26B9A45C1",
        "classification":
        {
            "name": "Event Class Test 2",
            "id": "C4CD55F1641D9D9711A780B6302475C0",
            "alternative_code": "ect2"
        },
        "udf_date_1": "2014-05-05T15:49:59",
        "udf_date_2": "2014-06-05T15:49:59",
        "udf_date_3": "2014-07-05T15:49:59",
        "expected_completion_date": "2014-05-05T15:49:59",
        "udf_date_4": "2014-08-05T15:49:59",
        "performed_by_unit":
        {
            "community_name": "Main Community",
            "group_name": "Main Group",
            "name": "Admin Unit",
            "id": "48305F8849E3C18B227C5BE3A27BA6DF",
            "description": "r1",
            "alternative_code": "MG"
        },
        "invoice":
        {
            "total_amount": 42.24,
            "issued_on": null,
            "life_cycle_state": "POSTED",
            "unsettled_amount": 42.24,
            "number": "15",
            "due_on": "2011-06-05T00:00:00",
            "id": "D5694986DADA9E4E3FF477BBA55F2AF5",
            "outstanding_amount": 42.24,
            "reference_number": null,
            "posted_on": "2011-05-30T14:49:41"
        },
        "process_immediately": 1,
        "vat_amount": 20,
        "log_information":
        {
            "updated_date": "2014-11-14T15:29:00",
            "created_by_unit":
            {
                "community_name": "Main Community",
                "group_name": "Main Group",
                "name": "Admin Unit",
                "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                "description": "r1",
                "alternative_code": "MG"
            },
            "created_date": "2014-11-14T15:28:46",
            "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": "Marios Lannister",
                "username": "MPAdministrator",
                "id": "1",
                "email": null
            },
            "updated_by_user":
            {
                "person_name": "Marios Lannister",
                "username": "MPAdministrator",
                "id": "1",
                "email": null
            }
        },
        "total_amount": 220,
        "life_cycle_state": "POSTED",
        "type": "PURCHASE",
        "net_amount": 200,
        "description": "first purchase event",
        "reference_number": "RF333"
    }
}},
        "total_amount": 220,
        "life_cycle_state": "POSTED",
        "type": "PURCHASE",
        "net_amount": 200,
        "description": "first purchase event",
        "reference_number": "RF333"
    }
}

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

Resource URL

Parameters

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 Identifier

The 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 Identifier

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

Date

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

process_immediately

(optional)

boolean

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

purchase_customer_event

(mandatory)

Purchase Customer Event Object

Information related with the purchase customer event to be created

spend_request_customer_event

(mandatory)

Spend Request Customer Event Object

Information related with the spend request that should be created. The spend request will automatically be related with the specified purchase customer event.

Anchor
create spend purchase customer event referred parameters
create spend purchase customer event referred parameters
Referred Parameter Objects

Include Page

	V4:purchase_customer_event_create_spend_parameters
	V4:purchase_customer_event_create_spend_parameters

Include Page

	V4:spend_request_customer_event_create_spend_parameters
	V4:spend_request_customer_event_create_spend_parameters

Restrictions

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

Response Data

Include Page

	V4:purchase_customer_event_create_spend_complete
	V4:purchase_customer_event_create_spend_complete

Examples

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

GET customer_events/referrals/show

This method returns information related with a referral customer event. A single referral customer event is returned by each call

Resource URL

Parameters

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

Restrictions

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

Response Data

Include Page

	V4:referral_customer_event_complete
	V4:referral_customer_event_complete

Examples

Expand

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

 
      {
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    {
        "referred_rewards_participant":
        {
            "accounts_receivable":
            {
                "account_owner": null,
                "life_cycle_state": "ACTIVE",
                "number": "13",
                "name": "Persia Xenopoulou",
                "id": "FCCEE118F7FA82FAC60195F2876D6C32"
            },
            "number": "2",
            "id": "A7C4E68432DFEF65283564FF80EFC380"
        },
        "number": "6",
        "type": "REFERRAL",
        "id": "8D1AF9E02C92ECAA51CE81AC20A8FC3B",
        "referred_by_rewards_participant":
        {
            "accounts_receivable":
            {
                "account_owner":
                {
                    "last_name": "Papapavlou",
                    "life_cycle_state": "FINANCIAL",
                    "middle_name": "Andreas",
                    "company_profile": null,
                    "title": "Ms",
                    "type": "PERSON",
                    "first_name": "Lucia",
                    "name": null,
                    "id": "1D92B269658D80DEDF2499E25201739E",
                    "company_name": null,
                    "demographics":
                    {
                        "gender": "FEMALE",
                        "passport_number": "113115",
                        "social_security_number": "113116",
                        "date_of_birth":
                        {
                            "month": 1,
                            "day": 1,
                            "year": 1990
                        },
                        "name_day":
                        {
                            "month": 5,
                            "day": 5
                        },
                        "id_number": "113114"
                    }
                },
                "life_cycle_state": "ACTIVE",
                "number": "399",
                "name": "Lucia Papapavlou",
                "id": "2B669B8EB009BF42352C00B05FAB61CF"
            },
            "number": "11",
            "id": "D6576EBBEDF74533E9C2C0CEE2FAD3BA"
        }
    }
}

...

This method returns information related with referral customer events. Multiple referral customer events are returned by each call

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

referred_rewards_participant_identifier

(semi-optional)

Rewards Participant Identifier

The 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 Identifier

The 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

Restrictions

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

Response Data

Include Page

	V4:referral_customer_event_complete
	V4:referral_customer_event_complete

Examples

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	js
linenumbers	true

{
  "token":"476A07F7C99133EA35D9AEA25475C8C1",
  "referred_rewards_participant_identifier":{"access_token_identifier":{"authentication_code":"1234"}}
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

 
    
      {
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    [
        {
            "udf_float_1": null,
            "udf_float_2": null,
            "udf_float_3": null,
            "udf_float_4": null,
            "number": "7",
            "udf_string_1": null,
            "udf_string_2": null,
            "udf_string_3": null,
            "udf_string_4": null,
            "udf_string_5": null,
            "udf_string_6": null,
            "referred_reward_participant":
            {
                "accounts_receivable":
                {
                    "account_owner":
                    {
                        "last_name": "RewPar",
                        "life_cycle_state": "FINANCIAL",
                        "middle_name": null,
                        "company_profile": null,
                        "title": null,
                        "type": "PERSON",
                        "first_name": "Marios",
                        "name": "Marios RewPar",
                        "id": "44829CCDBBD99A854554A6721B5784EE",
                        "company_name": null,
                        "demographics":
                        {
                            "gender": null,
                            "passport_issued_by_country": null,
                            "passport_number": "111424555600",
                            "social_security_number": "1114245556",
                            "country_of_residence":
                            {
                                "name": "UNITED KINGDOM",
                                "id": "126"
                            },
                            "industry_sector": null,
                            "date_of_birth":
                            {
                                "month": null,
                                "day": null,
                                "year": null
                            },
                            "name_day":
                            {
                                "month": null,
                                "day": null
                            },
                            "id_number": "1114245556",
                            "id_issued_by_country": null,
                            "industry": null
                        }
                    },
                    "life_cycle_state": "ACTIVE",
                    "number": "405",
                    "name": "MariosM2",
                    "id": "6A303394941962F5DBF7516FD2F35994"
                },
                "number": "10",
                "id": "B6838B7C46968C2A23F6C162959FA96F"
            },
            "udf_string_7": null,
            "udf_string_8": null,
            "accounts_receivable":
            {
                "account_owner":
                {
                    "last_name": "Xenofontos ",
                    "life_cycle_state": "FINANCIAL",
                    "middle_name": "Iatrou",
                    "company_profile": null,
                    "title": null,
                    "type": "PERSON",
                    "first_name": "Kyriakos",
                    "name": "Kyriakos Xenofontos",
                    "id": "31260911295E70BB660EBEB0C4F941AC",
                    "company_name": null,
                    "demographics":
                    {
                        "gender": "MALE",
                        "passport_issued_by_country": null,
                        "passport_number": null,
                        "social_security_number": null,
                        "country_of_residence":
                        {
                            "name": "UNITED KINGDOM",
                            "id": "126"
                        },
                        "industry_sector": null,
                        "date_of_birth":
                        {
                            "month": null,
                            "day": null,
                            "year": null
                        },
                        "name_day":
                        {
                            "month": null,
                            "day": null
                        },
                        "id_number": "87878000",
                        "id_issued_by_country": null,
                        "industry": null
                    }
                },
                "life_cycle_state": "ACTIVE",
                "number": "195",
                "name": "Xenofontos",
                "id": "5B51429862A7BCBAD60CC81982BBD45B"
            },
            "id": "B568245CF015508BCA63C979F592419D",
            "referred_by_reward_participant":
            {
                "accounts_receivable":
                {
                    "account_owner":
                    {
                        "last_name": "Xenofontos ",
                        "life_cycle_state": "FINANCIAL",
                        "middle_name": "Iatrou",
                        "company_profile": null,
                        "title": null,
                        "type": "PERSON",
                        "first_name": "Kyriakos",
                        "name": "Kyriakos Xenofontos",
                        "id": "31260911295E70BB660EBEB0C4F941AC",
                        "company_name": null,
                        "demographics":
                        {
                            "gender": "MALE",
                            "passport_issued_by_country": null,
                            "passport_number": null,
                            "social_security_number": null,
                            "country_of_residence":
                            {
                                "name": "UNITED KINGDOM",
                                "id": "126"
                            },
                            "industry_sector": null,
                            "date_of_birth":
                            {
                                "month": null,
                                "day": null,
                                "year": null
                            },
                            "name_day":
                            {
                                "month": null,
                                "day": null
                            },
                            "id_number": "87878000",
                            "id_issued_by_country": null,
                            "industry": null
                        }
                    },
                    "life_cycle_state": "ACTIVE",
                    "number": "195",
                    "name": "Xenofontos",
                    "id": "5B51429862A7BCBAD60CC81982BBD45B"
                },
                "number": "9",
                "id": "26953ECA946B87D6925654784AB44930"
            },
            "classification":
            {
                "name": "Classification Test 1",
                "id": "37DA1DB4A0E325A37D12CD0B8AA7CDF5",
                "alternative_code": "ct1"
            },
            "udf_date_1": null,
            "udf_date_2": null,
            "udf_date_3": null,
            "udf_date_4": null,
            "performed_by_unit":
            {
                "community_name": "Main Community",
                "group_name": "Developers Group",
                "name": "Developers Unit",
                "id": "C4370788B2630BC8A99E8C7397406C09",
                "description": null,
                "alternative_code": null
            },
            "process_immediately": 0,
            "log_information":
            {
                "updated_date": "2014-11-13T16:44: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-11-05T09:21:29",
                "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": null
                },
                "updated_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1",
                    "email": null
                }
            },
            "life_cycle_state": "POSTED",
            "type": "REFERRAL",
            "description": "Test for Award Event",
            "performed_on": "2014-11-05T09:21:41"
        }
    ]
}

...

This method is used to create a referral customer event in a posted life cycle state

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

classification_identifier

(optional)

Customer Event Classification Identifier

The 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 Identifier

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

Date

The date that the customer event was actually performed

description

(optional)

String

A description of the customer event

process_immediately

(optional)

boolean

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

referred_rewards_participant_identifier

(mandatory)

Rewards Participant Identifier

The 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 Identifier

The 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

Restrictions

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

Response Data

Include Page

	V4:referral_customer_event_complete
	V4:referral_customer_event_complete

Examples

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

 {
   "token":"608642920F77C0EDDED7D77E6CDDF075",
   "classification_identifier":{"name":"Event Class Test 2"},
   "performed_by_unit_identifier":{"name":"Admin Unit"},
   "performed_on":"2014-05-05T15:49:59",
   "description":"first purchase event",
   "process_immediately":1,
   "udf_string_1":"udf string 1",
   "udf_string_2":"udf string 2",
   "udf_string_3":"udf string 3",
   "udf_string_4":"udf string 4",
   "udf_string_5":"udf string 5",
   "udf_string_6":"udf string 6",
   "udf_string_7":"udf string 7",
   "udf_string_8":"udf string 8",
   "udf_float_1":10,
   "udf_float_2":20,
   "udf_float_3":30,
   "udf_float_4":40,
   "udf_float_5":50,
   "udf_float_6":60,
   "udf_float_7":70,
   "udf_float_8":80,
   "udf_date_1":"2014-05-05T15:49:59",
   "udf_date_2":"2014-06-05T15:49:59",
   "udf_date_3":"2014-07-05T15:49:59",
   "udf_date_4":"2014-08-05T15:49:59",
   "referred_rewards_participant_identifier":{"number":"10"},
   "referred_by_rewards_participant_identifier":{"number":"11"}
   
 }

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

 
      {
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    {
        "udf_float_1": 10,
        "udf_float_2": 20,
        "udf_float_3": 30,
        "udf_float_4": 40,
        "number": "9",
        "udf_string_1": "udf string 1",
        "udf_string_2": "udf string 2",
        "udf_string_3": "udf string 3",
        "udf_string_4": "udf string 4",
        "udf_string_5": "udf string 5",
        "udf_string_6": "udf string 6",
        "referred_rewards_participant":
        {
            "accounts_receivable":
            {
                "account_owner":
                {
                    "last_name": "RewPar",
                    "life_cycle_state": "FINANCIAL",
                    "middle_name": null,
                    "company_profile": null,
                    "title": null,
                    "type": "PERSON",
                    "first_name": "Marios",
                    "name": null,
                    "id": "44829CCDBBD99A854554A6721B5784EE",
                    "company_name": null,
                    "demographics":
                    {
                        "gender": null,
                        "passport_issued_by_country": null,
                        "passport_number": "111424555600",
                        "social_security_number": "1114245556",
                        "industry_sector": null,
                        "date_of_birth":
                        {
                            "month": null,
                            "day": null,
                            "year": null
                        },
                        "name_day":
                        {
                            "month": null,
                            "day": null
                        },
                        "id_number": "1114245556",
                        "id_issued_by_country": null,
                        "industry": null
                    }
                },
                "life_cycle_state": "ACTIVE",
                "number": "405",
                "name": "MariosM2",
                "id": "6A303394941962F5DBF7516FD2F35994"
            },
            "number": "10",
            "id": "B6838B7C46968C2A23F6C162959FA96F"
        },
        "udf_string_7": "udf string 7",
        "udf_string_8": "udf string 8",
        "accounts_receivable":
        {
            "account_owner":
            {
                "last_name": "Papapavlou",
                "life_cycle_state": "FINANCIAL",
                "middle_name": "Andreas",
                "company_profile": null,
                "title": "Ms",
                "type": "PERSON",
                "first_name": "Lucia",
                "name": "Lucia Papapavlou",
                "id": "1D92B269658D80DEDF2499E25201739E",
                "company_name": null,
                "demographics":
                {
                    "gender": "FEMALE",
                    "passport_issued_by_country":
                    {
                        "name": "GREECE",
                        "id": "209"
                    },
                    "passport_number": "113115",
                    "social_security_number": "113116",
                    "country_of_residence":
                    {
                        "name": "UNITED KINGDOM",
                        "id": "126"
                    },
                    "industry_sector":
                    {
                        "name": "GOVERNMENTAL",
                        "id": "A9BDEBD4D8FAEDB0BACE40C041156D12",
                        "alternative_code": "GOV"
                    },
                    "date_of_birth":
                    {
                        "month": 1,
                        "day": 1,
                        "year": 1990
                    },
                    "name_day":
                    {
                        "month": 5,
                        "day": 5
                    },
                    "id_number": "113114",
                    "id_issued_by_country":
                    {
                        "name": "GREECE",
                        "id": "209"
                    },
                    "industry":
                    {
                        "name": "Interior Design",
                        "id": "06B638258885DA26FA2BD40D9128D04E",
                        "code": "INTDS"
                    }
                }
            },
            "life_cycle_state": "ACTIVE",
            "number": "399",
            "name": "Lucia Papapavlou",
            "id": "2B669B8EB009BF42352C00B05FAB61CF"
        },
        "id": "7AF6D991704C66AB17EDB6C93A84E77D",
        "referred_by_rewards_participant":
        {
            "accounts_receivable":
            {
                "account_owner":
                {
                    "last_name": "Papapavlou",
                    "life_cycle_state": "FINANCIAL",
                    "middle_name": "Andreas",
                    "company_profile": null,
                    "title": "Ms",
                    "type": "PERSON",
                    "first_name": "Lucia",
                    "name": "Lucia Papapavlou",
                    "id": "1D92B269658D80DEDF2499E25201739E",
                    "company_name": null,
                    "demographics":
                    {
                        "gender": "FEMALE",
                        "passport_issued_by_country":
                        {
                            "name": "GREECE",
                            "id": "209"
                        },
                        "passport_number": "113115",
                        "social_security_number": "113116",
                        "country_of_residence":
                        {
                            "name": "UNITED KINGDOM",
                            "id": "126"
                        },
                        "industry_sector":
                        {
                            "name": "GOVERNMENTAL",
                            "id": "A9BDEBD4D8FAEDB0BACE40C041156D12",
                            "alternative_code": "GOV"
                        },
                        "date_of_birth":
                        {
                            "month": 1,
                            "day": 1,
                            "year": 1990
                        },
                        "name_day":
                        {
                            "month": 5,
                            "day": 5
                        },
                        "id_number": "113114",
                        "id_issued_by_country":
                        {
                            "name": "GREECE",
                            "id": "209"
                        },
                        "industry":
                        {
                            "name": "Interior Design",
                            "id": "06B638258885DA26FA2BD40D9128D04E",
                            "code": "INTDS"
                        }
                    }
                },
                "life_cycle_state": "ACTIVE",
                "number": "399",
                "name": "Lucia Papapavlou",
                "id": "2B669B8EB009BF42352C00B05FAB61CF"
            },
            "number": "11",
            "id": "D6576EBBEDF74533E9C2C0CEE2FAD3BA"
        },
        "classification":
        {
            "name": "Event Class Test 2",
            "id": "C4CD55F1641D9D9711A780B6302475C0",
            "alternative_code": "ect2"
        },
        "udf_date_1": "2014-05-05T15:49:59",
        "udf_date_2": "2014-06-05T15:49:59",
        "expected_completion_date": "2014-05-05T15:49:59",
        "udf_date_3": "2014-07-05T15:49:59",
        "udf_date_4": "2014-08-05T15:49:59",
        "performed_by_unit":
        {
            "community_name": "Main Community",
            "group_name": "Main Group",
            "name": "Admin Unit",
            "id": "48305F8849E3C18B227C5BE3A27BA6DF",
            "description": "r1",
            "alternative_code": "MG"
        },
        "process_immediately": 1,
        "log_information":
        {
            "updated_date": "2014-11-14T16:01:44",
            "created_by_unit":
            {
                "community_name": "Main Community",
                "group_name": "Main Group",
                "name": "Admin Unit",
                "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                "description": "r1",
                "alternative_code": "MG"
            },
            "created_date": "2014-11-14T16:01:44",
            "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": "Marios Lannister",
                "username": "MPAdministrator",
                "id": "1",
                "email": null
            },
            "updated_by_user":
            {
                "person_name": "Marios Lannister",
                "username": "MPAdministrator",
                "id": "1",
                "email": null
            }
        },
        "life_cycle_state": "POSTED",
        "type": "REFERRAL",
        "description": "first purchase event"
    }
}

...

This method returns information related with a social media customer event. A single social media customer event is returned by each call

Resource URL

Parameters

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

Restrictions

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

Response Data

Include Page

	V4:social_media_customer_event_complete
	V4:social_media_customer_event_complete

Examples

Expand

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    {
        "udf_float_1": 10,
        "udf_float_2": 20,
        "udf_float_3": 30,
        "udf_float_4": 40,
        "number": "11",
        "udf_string_1": "udf string 1",
        "udf_string_2": "udf string 2",
        "udf_string_3": "udf string 3",
        "udf_string_4": "udf string 4",
        "udf_string_5": "udf string 5",
        "udf_string_6": "udf string 6",
        "udf_string_7": "udf string 7",
        "udf_string_8": "udf string 8",
        "social_media": "FACEBOOK",
        "accounts_receivable":
        {
            "account_owner":
            {
                "last_name": "Papapavlou",
                "life_cycle_state": "FINANCIAL",
                "middle_name": "Andreas",
                "company_profile": null,
                "title": "Ms",
                "type": "PERSON",
                "first_name": "Lucia",
                "name": "Lucia Papapavlou",
                "id": "1D92B269658D80DEDF2499E25201739E",
                "company_name": null,
                "demographics":
                {
                    "gender": "FEMALE",
                    "passport_issued_by_country":
                    {
                        "name": "GREECE",
                        "id": "209"
                    },
                    "passport_number": "113115",
                    "social_security_number": "113116",
                    "country_of_residence":
                    {
                        "name": "UNITED KINGDOM",
                        "id": "126"
                    },
                    "industry_sector":
                    {
                        "name": "GOVERNMENTAL",
                        "id": "A9BDEBD4D8FAEDB0BACE40C041156D12",
                        "alternative_code": "GOV"
                    },
                    "date_of_birth":
                    {
                        "month": 1,
                        "day": 1,
                        "year": 1990
                    },
                    "name_day":
                    {
                        "month": 5,
                        "day": 5
                    },
                    "id_number": "113114",
                    "id_issued_by_country":
                    {
                        "name": "GREECE",
                        "id": "209"
                    },
                    "industry":
                    {
                        "name": "Interior Design",
                        "id": "06B638258885DA26FA2BD40D9128D04E",
                        "code": "INTDS"
                    }
                }
            },
            "life_cycle_state": "ACTIVE",
            "number": "399",
            "name": "Lucia Papapavlou",
            "id": "2B669B8EB009BF42352C00B05FAB61CF"
        },
        "id": "3672A7B2F1099DDFEB93663E675EC257",
        "classification":
        {
            "name": "Event Class Test 2",
            "id": "C4CD55F1641D9D9711A780B6302475C0",
            "alternative_code": "ect2"
        },
        "udf_date_1": "2014-05-05T15:49:59",
        "udf_date_2": "2014-06-05T15:49:59",
        "profile": "www.facebook.com/lucia",
        "udf_date_3": "2014-07-05T15:49:59",
        "udf_date_4": "2014-08-05T15:49:59",
        "performed_by_unit":
        {
            "community_name": "Main Community",
            "group_name": "Main Group",
            "name": "Admin Unit",
            "id": "48305F8849E3C18B227C5BE3A27BA6DF",
            "description": "r1",
            "alternative_code": "MG"
        },
        "process_immediately": 1,
        "log_information":
        {
            "updated_date": "2015-02-02T08:46:57",
            "created_by_unit":
            {
                "community_name": "Main Community",
                "group_name": "Main Group",
                "name": "Admin Unit",
                "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                "description": "r1",
                "alternative_code": "MG"
            },
            "created_date": "2015-02-02T08:46: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": null
            },
            "updated_by_user":
            {
                "person_name": "MPAdministrator",
                "username": "MPAdministrator",
                "id": "1",
                "email": null
            }
        },
        "life_cycle_state": "POSTED",
        "action": "LIKE",
        "type": "SOCIAL_MEDIA",
        "description": "first purchase event",
        "performed_on": "2014-05-05T15:49:59"
    }
}

...

This method returns information related with social media customer events. Multiple social media customer events are returned by each call

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

rewards_participant_identifier

(semi-optional)

Rewards Participant Identifier

The 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

Restrictions

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

Response Data

Include Page

	V4:social_media_customer_event_complete
	V4:social_media_customer_event_complete

Examples

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	js
linenumbers	true

{
  "token":"476A07F7C99133EA35D9AEA25475C8C1",
  "rewards_participant_identifier":{"number":"15"}
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

 

      {
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    [
        {
            "udf_float_1": null,
            "udf_float_2": null,
            "udf_float_3": null,
            "udf_float_4": null,
            "number": "3",
            "udf_string_1": null,
            "udf_string_2": null,
            "udf_string_3": null,
            "udf_string_4": null,
            "udf_string_5": null,
            "udf_string_6": null,
            "udf_string_7": null,
            "udf_string_8": null,
            "social_media": "FACEBOOK",
            "accounts_receivable":
            {
                "account_owner":
                {
                    "last_name": "Ioannou17",
                    "life_cycle_state": "FINANCIAL",
                    "middle_name": "P",
                    "company_profile": null,
                    "title": "Mr",
                    "type": "PERSON",
                    "first_name": "Marios",
                    "name": "Marios Ioannou17",
                    "id": "D73AA349B9319CEF0C25351DF4C7DFF6",
                    "company_name": null,
                    "demographics":
                    {
                        "gender": "MALE",
                        "passport_issued_by_country": null,
                        "passport_number": "8788989",
                        "social_security_number": "8788980",
                        "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": "8788988",
                        "id_issued_by_country": null,
                        "industry": null
                    }
                },
                "life_cycle_state": "ACTIVE",
                "number": "95",
                "name": "mar17",
                "id": "F5235112A7A9FFFBF8C9AE7DA20CD7C4"
            },
            "id": "89A283AE0BDF065C243463C1099FBDC5",
            "classification":
            {
                "name": "Media Event Classification",
                "id": "941813952637F8F744F8E9EB41F7BC26",
                "alternative_code": "mec"
            },
            "udf_date_1": null,
            "udf_date_2": null,
            "profile": "www.facebook.com/crmcom",
            "udf_date_3": null,
            "udf_date_4": null,
            "performed_by_unit":
            {
                "community_name": "Main Community",
                "group_name": "Main Group",
                "name": "Admin Unit",
                "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                "description": "r1",
                "alternative_code": "MG"
            },
            "process_immediately": 1,
            "log_information":
            {
                "updated_date": "2014-12-04T11:27:02",
                "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-13T18:53:50",
                "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": null
                },
                "updated_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1",
                    "email": null
                }
            },
            "life_cycle_state": "POSTED",
            "action": "LIKE",
            "type": "SOCIAL_MEDIA",
            "description": "Facebook like event to CRM.COM page.",
            "performed_on": "2014-10-28T18:54:08"
        }
    ]
}

...

This method is used to create a social media customer event in a posted life cycle state

Resource URL

Parameters

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 Identifier

The 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 Identifier

The 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 Identifier

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

Date

The date that the customer event was actually performed

description

(optional)

String

A description of the customer event

process_immediately

(optional)

boolean

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

String

The 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

Restrictions

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

Response Data

Include Page

	V4:social_media_customer_event_complete
	V4:social_media_customer_event_complete

Examples

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

 {
   "token":"0924D913093D58127990487F27CEF594",
   "rewards_participant_identifier":{"number":"11"},
   "classification_identifier":{"name":"Event Class Test 2"},
   "performed_by_unit_identifier":{"name":"Admin Unit"},
   "performed_on":"2014-05-05T15:49:59",
   "description":"first purchase event",
   "process_immediately":1,
   "udf_string_1":"udf string 1",
   "udf_string_2":"udf string 2",
   "udf_string_3":"udf string 3",
   "udf_string_4":"udf string 4",
   "udf_string_5":"udf string 5",
   "udf_string_6":"udf string 6",
   "udf_string_7":"udf string 7",
   "udf_string_8":"udf string 8",
   "udf_float_1":10,
   "udf_float_2":20,
   "udf_float_3":30,
   "udf_float_4":40,
   "udf_float_5":50,
   "udf_float_6":60,
   "udf_float_7":70,
   "udf_float_8":80,
   "udf_date_1":"2014-05-05T15:49:59",
   "udf_date_2":"2014-06-05T15:49:59",
   "udf_date_3":"2014-07-05T15:49:59",
   "udf_date_4":"2014-08-05T15:49:59",
   "social_media":"FACEBOOK",
   "profile":"www.facebook.com/lucia",
   "action":"LIKE"
   

 }

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

 {
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    {
        "udf_float_1": 10,
        "udf_float_2": 20,
        "udf_float_3": 30,
        "udf_float_4": 40,
        "number": "6",
        "udf_string_1": "udf string 1",
        "udf_string_2": "udf string 2",
        "udf_string_3": "udf string 3",
        "udf_string_4": "udf string 4",
        "udf_string_5": "udf string 5",
        "udf_string_6": "udf string 6",
        "udf_string_7": "udf string 7",
        "udf_string_8": "udf string 8",
        "social_media": "FACEBOOK",
        "accounts_receivable":
        {
            "account_owner":
            {
                "last_name": "Papapavlou",
                "life_cycle_state": "FINANCIAL",
                "middle_name": "Andreas",
                "company_profile": null,
                "title": "Ms",
                "type": "PERSON",
                "first_name": "Lucia",
                "name": "Lucia Papapavlou",
                "id": "1D92B269658D80DEDF2499E25201739E",
                "company_name": null,
                "demographics":
                {
                    "gender": "FEMALE",
                    "passport_issued_by_country":
                    {
                        "name": "GREECE",
                        "id": "209"
                    },
                    "passport_number": "113115",
                    "social_security_number": "113116",
                    "country_of_residence":
                    {
                        "name": "UNITED KINGDOM",
                        "id": "126"
                    },
                    "industry_sector":
                    {
                        "name": "GOVERNMENTAL",
                        "id": "A9BDEBD4D8FAEDB0BACE40C041156D12",
                        "alternative_code": "GOV"
                    },
                    "date_of_birth":
                    {
                        "month": 1,
                        "day": 1,
                        "year": 1990
                    },
                    "name_day":
                    {
                        "month": 5,
                        "day": 5
                    },
                    "id_number": "113114",
                    "id_issued_by_country":
                    {
                        "name": "GREECE",
                        "id": "209"
                    },
                    "industry":
                    {
                        "name": "Interior Design",
                        "id": "06B638258885DA26FA2BD40D9128D04E",
                        "code": "INTDS"
                    }
                }
            },
            "life_cycle_state": "ACTIVE",
            "number": "399",
            "name": "Lucia Papapavlou",
            "id": "2B669B8EB009BF42352C00B05FAB61CF"
        },
        "id": "9C99111B077131FA545444659366AB2A",
        "classification":
        {
            "name": "Event Class Test 2",
            "id": "C4CD55F1641D9D9711A780B6302475C0",
            "alternative_code": "ect2"
        },
        "udf_date_1": "2014-05-05T15:49:59",
        "udf_date_2": "2014-06-05T15:49:59",
        "profile": "www.facebook.com/lucia",
        "expected_completion_date": "2014-05-05T15:49:59",
        "udf_date_3": "2014-07-05T15:49:59",
        "udf_date_4": "2014-08-05T15:49:59",
        "performed_by_unit":
        {
            "community_name": "Main Community",
            "group_name": "Main Group",
            "name": "Admin Unit",
            "id": "48305F8849E3C18B227C5BE3A27BA6DF",
            "description": "r1",
            "alternative_code": "MG"
        },
        "process_immediately": 1,
        "log_information":
        {
            "updated_date": "2014-11-14T12:58:06",
            "created_by_unit":
            {
                "community_name": "Main Community",
                "group_name": "Main Group",
                "name": "Admin Unit",
                "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                "description": "r1",
                "alternative_code": "MG"
            },
            "created_date": "2014-11-14T12:58:05",
            "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": null
            },
            "updated_by_user":
            {
                "person_name": "MPAdministrator",
                "username": "MPAdministrator",
                "id": "1",
                "email": null
            }
        },
        "life_cycle_state": "POSTED",
        "action": "LIKE",
        "type": "SOCIAL_MEDIA",
        "description": "sixth social media event"
    }
}

...

This method returns information related with a web customer event. A single web customer event is returned by each call

Resource URL

Parameters

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

Restrictions

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

Response Data

Include Page

	V4:web_customer_event_complete
	V4:web_customer_event_complete

Examples

Expand

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    {
        "udf_float_1": 10,
        "udf_float_2": 20,
        "udf_float_3": 30,
        "udf_float_4": 40,
        "number": "10",
        "udf_string_1": "udf string 1",
        "udf_string_2": "udf string 2",
        "udf_string_3": "udf string 3",
        "udf_string_4": "udf string 4",
        "udf_string_5": "udf string 5",
        "udf_string_6": "udf string 6",
        "udf_string_7": "udf string 7",
        "udf_string_8": "udf string 8",
        "accounts_receivable":
        {
            "account_owner":
            {
                "last_name": "Papapavlou",
                "life_cycle_state": "FINANCIAL",
                "middle_name": "Andreas",
                "company_profile": null,
                "title": "Ms",
                "type": "PERSON",
                "first_name": "Lucia",
                "name": "Lucia Papapavlou",
                "id": "1D92B269658D80DEDF2499E25201739E",
                "company_name": null,
                "demographics":
                {
                    "gender": "FEMALE",
                    "passport_issued_by_country":
                    {
                        "name": "GREECE",
                        "id": "209"
                    },
                    "passport_number": "113115",
                    "social_security_number": "113116",
                    "country_of_residence":
                    {
                        "name": "UNITED KINGDOM",
                        "id": "126"
                    },
                    "industry_sector":
                    {
                        "name": "GOVERNMENTAL",
                        "id": "A9BDEBD4D8FAEDB0BACE40C041156D12",
                        "alternative_code": "GOV"
                    },
                    "date_of_birth":
                    {
                        "month": 1,
                        "day": 1,
                        "year": 1990
                    },
                    "name_day":
                    {
                        "month": 5,
                        "day": 5
                    },
                    "id_number": "113114",
                    "id_issued_by_country":
                    {
                        "name": "GREECE",
                        "id": "209"
                    },
                    "industry":
                    {
                        "name": "Interior Design",
                        "id": "06B638258885DA26FA2BD40D9128D04E",
                        "code": "INTDS"
                    }
                }
            },
            "life_cycle_state": "ACTIVE",
            "number": "399",
            "name": "Lucia Papapavlou",
            "id": "2B669B8EB009BF42352C00B05FAB61CF"
        },
        "id": "07A2356C19DBF7B1051C771E75F537AB",
        "website": "www.crm.com",
        "classification":
        {
            "name": "Event Class Test 2",
            "id": "C4CD55F1641D9D9711A780B6302475C0",
            "alternative_code": "ect2"
        },
        "udf_date_1": "2014-05-05T15:49:59",
        "udf_date_2": "2014-06-05T15:49:59",
        "udf_date_3": "2014-07-05T15:49:59",
        "udf_date_4": "2014-08-05T15:49:59",
        "performed_by_unit":
        {
            "community_name": "Main Community",
            "group_name": "Main Group",
            "name": "Admin Unit",
            "id": "48305F8849E3C18B227C5BE3A27BA6DF",
            "description": "r1",
            "alternative_code": "MG"
        },
        "process_immediately": 1,
        "log_information":
        {
            "updated_date": "2015-02-02T08:55:35",
            "created_by_unit":
            {
                "community_name": "Main Community",
                "group_name": "Main Group",
                "name": "Admin Unit",
                "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                "description": "r1",
                "alternative_code": "MG"
            },
            "created_date": "2015-02-02T08:55:33",
            "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": null
            },
            "updated_by_user":
            {
                "person_name": "MPAdministrator",
                "username": "MPAdministrator",
                "id": "1",
                "email": null
            }
        },
        "life_cycle_state": "POSTED",
        "type": "WEB",
        "description": "first purchase event",
        "performed_on": "2014-05-05T15:49:59"
    }
}

...

This method returns information related with web customer events. Multiple web customer events are returned by each call

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

rewards_participant_identifier

(semi-optional)

Rewards Participant Identifier

The 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

Restrictions

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

Response Data

Include Page

	V4:web_customer_event_complete
	V4:web_customer_event_complete

Examples

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	js
linenumbers	true

{
  "token":"476A07F7C99133EA35D9AEA25475C8C1",
  "rewards_participant_identifier":{"number":"18"}
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

 
   
      {
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    [
        {
            "udf_float_1": 10,
            "udf_float_2": 20,
            "udf_float_3": 30,
            "udf_float_4": 40,
            "number": "4",
            "udf_string_1": "udf string 1",
            "udf_string_2": "udf string 2",
            "udf_string_3": "udf string 3",
            "udf_string_4": "udf string 4",
            "udf_string_5": "udf string 5",
            "udf_string_6": "udf string 6",
            "udf_string_7": "udf string 7",
            "udf_string_8": "udf string 8",
            "accounts_receivable":
            {
                "account_owner":
                {
                    "last_name": "Wallas",
                    "life_cycle_state": "FINANCIAL",
                    "middle_name": null,
                    "company_profile": null,
                    "title": "Mr",
                    "type": "PERSON",
                    "first_name": "Oscar",
                    "name": "Oscar Wallas",
                    "id": "EE75535741F519A353F29B23E2360FEA",
                    "company_name": null,
                    "demographics":
                    {
                        "gender": "MALE",
                        "passport_issued_by_country": null,
                        "passport_number": "111111",
                        "social_security_number": "111111",
                        "country_of_residence":
                        {
                            "name": "UNITED KINGDOM",
                            "id": "126"
                        },
                        "industry_sector": null,
                        "date_of_birth":
                        {
                            "month": null,
                            "day": null,
                            "year": null
                        },
                        "name_day":
                        {
                            "month": null,
                            "day": null
                        },
                        "id_number": "80908090",
                        "id_issued_by_country": null,
                        "industry": null
                    }
                },
                "life_cycle_state": "ACTIVE",
                "number": "191",
                "name": "Oscar Wallas",
                "id": "20960302C3AD8A9CF317C815E5280511"
            },
            "id": "7C1B5BA8641C6BA5A2EEC25D2DD05242",
            "website": "www.crm.com",
            "classification":
            {
                "name": "Media Event Classification",
                "id": "941813952637F8F744F8E9EB41F7BC26",
                "alternative_code": "mec"
            },
            "udf_date_1": "2014-05-05T15:49:59",
            "udf_date_2": "2014-06-05T15:49:59",
            "udf_date_3": "2014-07-05T15:49:59",
            "udf_date_4": "2014-08-05T15:49:59",
            "performed_by_unit":
            {
                "community_name": "Main Community",
                "group_name": "Main Group",
                "name": "Admin Unit",
                "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                "description": "r1",
                "alternative_code": "MG"
            },
            "process_immediately": 1,
            "log_information":
            {
                "updated_date": "2014-11-26T15:03:41",
                "created_by_unit":
                {
                    "community_name": "Main Community",
                    "group_name": "Main Group",
                    "name": "Admin Unit",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "description": "r1",
                    "alternative_code": "MG"
                },
                "created_date": "2014-11-14T14:10:51",
                "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": null
                },
                "updated_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1",
                    "email": null
                }
            },
            "life_cycle_state": "POSTED",
            "type": "WEB",
            "description": "this is a web customer event",
            "performed_on": "2014-05-05T15:49:59"
        },
        {
            "udf_float_1": 10,
            "udf_float_2": 20,
            "udf_float_3": 30,
            "udf_float_4": 40,
            "number": "5",
            "udf_string_1": "udf string 1",
            "udf_string_2": "udf string 2",
            "udf_string_3": "udf string 3",
            "udf_string_4": "udf string 4",
            "udf_string_5": "udf string 5",
            "udf_string_6": "udf string 6",
            "udf_string_7": "udf string 7",
            "udf_string_8": "udf string 8",
            "accounts_receivable":
            {
                "account_owner":
                {
                    "last_name": "Wallas",
                    "life_cycle_state": "FINANCIAL",
                    "middle_name": null,
                    "company_profile": null,
                    "title": "Mr",
                    "type": "PERSON",
                    "first_name": "Oscar",
                    "name": "Oscar Wallas",
                    "id": "EE75535741F519A353F29B23E2360FEA",
                    "company_name": null,
                    "demographics":
                    {
                        "gender": "MALE",
                        "passport_issued_by_country": null,
                        "passport_number": "111111",
                        "social_security_number": "111111",
                        "country_of_residence":
                        {
                            "name": "UNITED KINGDOM",
                            "id": "126"
                        },
                        "industry_sector": null,
                        "date_of_birth":
                        {
                            "month": null,
                            "day": null,
                            "year": null
                        },
                        "name_day":
                        {
                            "month": null,
                            "day": null
                        },
                        "id_number": "80908090",
                        "id_issued_by_country": null,
                        "industry": null
                    }
                },
                "life_cycle_state": "ACTIVE",
                "number": "191",
                "name": "Oscar Wallas",
                "id": "20960302C3AD8A9CF317C815E5280511"
            },
            "id": "4FB8ADB4D7AB206C9DAF31DA48EE9967",
            "website": "www.google.com",
            "classification":
            {
                "name": "Media Event Classification",
                "id": "941813952637F8F744F8E9EB41F7BC26",
                "alternative_code": "mec"
            },
            "udf_date_1": "2014-05-05T15:49:59",
            "udf_date_2": "2014-06-05T15:49:59",
            "udf_date_3": "2014-07-05T15:49:59",
            "udf_date_4": "2014-08-05T15:49:59",
            "performed_by_unit":
            {
                "community_name": "Main Community",
                "group_name": "Main Group",
                "name": "Admin Unit",
                "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                "description": "r1",
                "alternative_code": "MG"
            },
            "process_immediately": 1,
            "log_information":
            {
                "updated_date": "2014-11-26T15:05:08",
                "created_by_unit":
                {
                    "community_name": "Main Community",
                    "group_name": "Main Group",
                    "name": "Admin Unit",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "description": "r1",
                    "alternative_code": "MG"
                },
                "created_date": "2014-11-14T16:29:28",
                "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": null
                },
                "updated_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1",
                    "email": null
                }
            },
            "life_cycle_state": "POSTED",
            "type": "WEB",
            "description": "first purchase event",
            "performed_on": "2014-05-05T15:49:59"
        }
    ]
}

...

This method is used to create a web customer event in a posted life cycle state

Resource URL

Parameters

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 Identifier

The 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 Identifier

The 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 Identifier

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

Date

The date that the customer event was actually performed

description

(optional)

String

A description of the customer event

process_immediately

(optional)

boolean

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

website

(mandatory)

String

The 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

Restrictions

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

Response Data

Include Page

	V4:web_customer_event_complete
	V4:web_customer_event_complete

Examples

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

 {
   "token":"608642920F77C0EDDED7D77E6CDDF075",
   "rewards_participant_identifier":{"number":"11"},
   "classification_identifier":{"name":"Event Class Test 2"},
   "performed_by_unit_identifier":{"name":"Admin Unit"},
   "performed_on":"2014-05-05T15:49:59",
   "description":"first purchase event",
   "process_immediately":1,
   "udf_string_1":"udf string 1",
   "udf_string_2":"udf string 2",
   "udf_string_3":"udf string 3",
   "udf_string_4":"udf string 4",
   "udf_string_5":"udf string 5",
   "udf_string_6":"udf string 6",
   "udf_string_7":"udf string 7",
   "udf_string_8":"udf string 8",
   "udf_float_1":10,
   "udf_float_2":20,
   "udf_float_3":30,
   "udf_float_4":40,
   "udf_float_5":50,
   "udf_float_6":60,
   "udf_float_7":70,
   "udf_float_8":80,
   "udf_date_1":"2014-05-05T15:49:59",
   "udf_date_2":"2014-06-05T15:49:59",
   "udf_date_3":"2014-07-05T15:49:59",
   "udf_date_4":"2014-08-05T15:49:59",
   "website":"www.crm.com"
 }

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

...

This method returns information related with an achievement customer event. A single achievement customer event is returned by each call

Resource URL

Parameters

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

Restrictions

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

Response Data

Include Page

	V4:achievement_customer_event_complete
	V4:achievement_customer_event_complete

Examples

Expand

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

 
      {
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    {
        "udf_float_1": 10,
        "udf_float_2": 20,
        "udf_float_3": 30,
        "udf_float_4": 40,
        "number": "7",
        "udf_string_1": "udf string 1",
        "udf_string_2": "udf string 2",
        "udf_string_3": "udf string 3",
        "udf_string_4": "udf string 4",
        "udf_string_5": "udf string 5",
        "udf_string_6": "udf string 6",
        "udf_string_7": "udf string 7",
        "udf_string_8": "udf string 8",
        "accounts_receivable":
        {
            "account_owner":
            {
                "last_name": "Papapavlou",
                "life_cycle_state": "FINANCIAL",
                "middle_name": "Andreas",
                "company_profile": null,
                "title": "Ms",
                "type": "PERSON",
                "first_name": "Lucia",
                "name": "Lucia Papapavlou",
                "id": "1D92B269658D80DEDF2499E25201739E",
                "company_name": null,
                "demographics":
                {
                    "gender": "FEMALE",
                    "passport_issued_by_country":
                    {
                        "name": "GREECE",
                        "id": "209"
                    },
                    "passport_number": "113115",
                    "social_security_number": "113116",
                    "country_of_residence":
                    {
                        "name": "UNITED KINGDOM",
                        "id": "126"
                    },
                    "industry_sector":
                    {
                        "name": "GOVERNMENTAL",
                        "id": "A9BDEBD4D8FAEDB0BACE40C041156D12",
                        "alternative_code": "GOV"
                    },
                    "date_of_birth":
                    {
                        "month": 1,
                        "day": 1,
                        "year": 1990
                    },
                    "name_day":
                    {
                        "month": 5,
                        "day": 5
                    },
                    "id_number": "113114",
                    "id_issued_by_country":
                    {
                        "name": "GREECE",
                        "id": "209"
                    },
                    "industry":
                    {
                        "name": "Interior Design",
                        "id": "06B638258885DA26FA2BD40D9128D04E",
                        "code": "INTDS"
                    }
                }
            },
            "life_cycle_state": "ACTIVE",
            "number": "399",
            "name": "Lucia Papapavlou",
            "id": "2B669B8EB009BF42352C00B05FAB61CF"
        },
        "id": "C02D41333C8086AB1042FB667509794D",
        "classification":
        {
            "name": "Event Class Test 2",
            "id": "C4CD55F1641D9D9711A780B6302475C0",
            "alternative_code": "ect2"
        },
        "udf_date_1": "2014-05-05T15:49:59",
        "udf_date_2": "2014-06-05T15:49:59",
        "expected_completion_date": "2014-05-05T15:49:59",
        "udf_date_3": "2014-07-05T15:49:59",
        "udf_date_4": "2014-08-05T15:49:59",
        "performed_by_unit":
        {
            "community_name": "Main Community",
            "group_name": "Main Group",
            "name": "Admin Unit",
            "id": "48305F8849E3C18B227C5BE3A27BA6DF",
            "description": "r1",
            "alternative_code": "MG"
        },
        "process_immediately": 1,
        "log_information":
        {
            "updated_date": "2014-11-14T15:00:51",
            "created_by_unit":
            {
                "community_name": "Main Community",
                "group_name": "Main Group",
                "name": "Admin Unit",
                "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                "description": "r1",
                "alternative_code": "MG"
            },
            "created_date": "2014-11-14T15:00:50",
            "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": "Marios Lannister",
                "username": "MPAdministrator",
                "id": "1",
                "email": null
            },
            "updated_by_user":
            {
                "person_name": "Marios Lannister",
                "username": "MPAdministrator",
                "id": "1",
                "email": null
            }
        },
        "life_cycle_state": "POSTED",
        "type": "ACHIEVEMENT",
        "description": "first purchase event"
    }
}

...

This method returns information related with achievements customer events. Multiple achievements customer events are returned by each call

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

rewards_participant_identifier

(semi-optional)

Rewards Participant Identifier

The 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

Restrictions

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

Response Data

Include Page

	V4:achievement_customer_event_complete
	V4:achievement_customer_event_complete

Examples

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	js
linenumbers	true

{
  "token":"476A07F7C99133EA35D9AEA25475C8C1",
  "rewards_participant_identifier":{"number":"13"}
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

 
  
      {
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    [
        {
            "udf_float_1": null,
            "udf_float_2": null,
            "udf_float_3": null,
            "udf_float_4": null,
            "number": "3",
            "udf_string_1": null,
            "udf_string_2": null,
            "udf_string_3": 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": "DosSantos",
                    "life_cycle_state": "FINANCIAL",
                    "middle_name": null,
                    "company_profile": null,
                    "title": null,
                    "type": "PERSON",
                    "first_name": "Freddy",
                    "name": "Freddy DosSantos",
                    "id": "A71495DD306A15CCCB9E130EF1119E52",
                    "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": "88889654",
                        "id_issued_by_country": null,
                        "industry": null
                    }
                },
                "life_cycle_state": "ACTIVE",
                "number": "50",
                "name": "DosSantos",
                "id": "E5A3CD26B72C9D4D7903BE885EAAFB95"
            },
            "id": "EAC87C2EF350DFEB385CFBA5BD791799",
            "classification":
            {
                "name": "Classification Test 1",
                "id": "37DA1DB4A0E325A37D12CD0B8AA7CDF5",
                "alternative_code": "ct1"
            },
            "udf_date_1": null,
            "udf_date_2": null,
            "udf_date_3": null,
            "udf_date_4": null,
            "performed_by_unit":
            {
                "community_name": "myCommunity",
                "group_name": "Installation Group",
                "name": "Installation Team 1",
                "id": "2B35083ECB69BD57A4C1CC7ADC2F473B",
                "description": null,
                "alternative_code": "IT1"
            },
            "process_immediately": 1,
            "log_information":
            {
                "updated_date": "2014-11-14T15:11:06",
                "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-17T11:35:06",
                "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": null
                },
                "updated_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1",
                    "email": null
                }
            },
            "life_cycle_state": "POSTED",
            "type": "ACHIEVEMENT",
            "description": "sd",
            "performed_on": "2014-10-17T11:35:22"
        },
        {
            "udf_float_1": null,
            "udf_float_2": null,
            "udf_float_3": null,
            "udf_float_4": null,
            "number": "4",
            "udf_string_1": null,
            "udf_string_2": null,
            "udf_string_3": 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": "DosSantos",
                    "life_cycle_state": "FINANCIAL",
                    "middle_name": null,
                    "company_profile": null,
                    "title": null,
                    "type": "PERSON",
                    "first_name": "Freddy",
                    "name": "Freddy DosSantos",
                    "id": "A71495DD306A15CCCB9E130EF1119E52",
                    "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": "88889654",
                        "id_issued_by_country": null,
                        "industry": null
                    }
                },
                "life_cycle_state": "ACTIVE",
                "number": "50",
                "name": "DosSantos",
                "id": "E5A3CD26B72C9D4D7903BE885EAAFB95"
            },
            "id": "27580CBC38023E3716D51E89196733E3",
            "classification":
            {
                "name": "Classification Test 1",
                "id": "37DA1DB4A0E325A37D12CD0B8AA7CDF5",
                "alternative_code": "ct1"
            },
            "udf_date_1": null,
            "udf_date_2": null,
            "udf_date_3": null,
            "udf_date_4": null,
            "performed_by_unit":
            {
                "community_name": "Verification Community",
                "group_name": "Verification Group",
                "name": "Sales Branch 1",
                "id": "DC4805750EB10DE151F8908F5D19D870",
                "description": null,
                "alternative_code": "SB1"
            },
            "process_immediately": 1,
            "log_information":
            {
                "updated_date": "2014-12-04T11:32:36",
                "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-17T11:40:57",
                "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": null
                },
                "updated_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1",
                    "email": null
                }
            },
            "life_cycle_state": "POSTED",
            "type": "ACHIEVEMENT",
            "description": null,
            "performed_on": "2014-10-17T11:41:09"
        }
    ]
}

...

This method is used to create an achievement customer event in a posted life cycle state

Resource URL

Parameters

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 Identifier

The 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 Identifier

The 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 Identifier

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

Date

The date that the customer event was actually performed

description

(optional)

String

A description of the customer event

process_immediately

(optional)

boolean

Defines 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

Restrictions

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

Response Data

Include Page

	V4:achievement_customer_event_complete
	V4:achievement_customer_event_complete

Examples

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
   "token":"608642920F77C0EDDED7D77E6CDDF075",
   "accounts_receivable_identifier":{"number":"399"},
   "classification_identifier":{"name":"Event Class Test 2"},
   "performed_by_unit_identifier":{"name":"Admin Unit"},
   "performed_on":"2014-05-05T15:49:59",
   "description":"first purchase event",
   "process_immediately":1,
   "udf_string_1":"udf string 1",
   "udf_string_2":"udf string 2",
   "udf_string_3":"udf string 3",
   "udf_string_4":"udf string 4",
   "udf_string_5":"udf string 5",
   "udf_string_6":"udf string 6",
   "udf_string_7":"udf string 7",
   "udf_string_8":"udf string 8",
   "udf_float_1":10,
   "udf_float_2":20,
   "udf_float_3":30,
   "udf_float_4":40,
   "udf_float_5":50,
   "udf_float_6":60,
   "udf_float_7":70,
   "udf_float_8":80,
   "udf_date_1":"2014-05-05T15:49:59",
   "udf_date_2":"2014-06-05T15:49:59",
   "udf_date_3":"2014-07-05T15:49:59",
   "udf_date_4":"2014-08-05T15:49:59"
 }

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

      {
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    {
        "udf_float_1": 10,
        "udf_float_2": 20,
        "udf_float_3": 30,
        "udf_float_4": 40,
        "number": "7",
        "udf_string_1": "udf string 1",
        "udf_string_2": "udf string 2",
        "udf_string_3": "udf string 3",
        "udf_string_4": "udf string 4",
        "udf_string_5": "udf string 5",
        "udf_string_6": "udf string 6",
        "udf_string_7": "udf string 7",
        "udf_string_8": "udf string 8",
        "accounts_receivable":
        {
            "account_owner":
            {
                "last_name": "Papapavlou",
                "life_cycle_state": "FINANCIAL",
                "middle_name": "Andreas",
                "company_profile": null,
                "title": "Ms",
                "type": "PERSON",
                "first_name": "Lucia",
                "name": "Lucia Papapavlou",
                "id": "1D92B269658D80DEDF2499E25201739E",
                "company_name": null,
                "demographics":
                {
                    "gender": "FEMALE",
                    "passport_issued_by_country":
                    {
                        "name": "GREECE",
                        "id": "209"
                    },
                    "passport_number": "113115",
                    "social_security_number": "113116",
                    "country_of_residence":
                    {
                        "name": "UNITED KINGDOM",
                        "id": "126"
                    },
                    "industry_sector":
                    {
                        "name": "GOVERNMENTAL",
                        "id": "A9BDEBD4D8FAEDB0BACE40C041156D12",
                        "alternative_code": "GOV"
                    },
                    "date_of_birth":
                    {
                        "month": 1,
                        "day": 1,
                        "year": 1990
                    },
                    "name_day":
                    {
                        "month": 5,
                        "day": 5
                    },
                    "id_number": "113114",
                    "id_issued_by_country":
                    {
                        "name": "GREECE",
                        "id": "209"
                    },
                    "industry":
                    {
                        "name": "Interior Design",
                        "id": "06B638258885DA26FA2BD40D9128D04E",
                        "code": "INTDS"
                    }
                }
            },
            "life_cycle_state": "ACTIVE",
            "number": "399",
            "name": "Lucia Papapavlou",
            "id": "2B669B8EB009BF42352C00B05FAB61CF"
        },
        "id": "C02D41333C8086AB1042FB667509794D",
        "classification":
        {
            "name": "Event Class Test 2",
            "id": "C4CD55F1641D9D9711A780B6302475C0",
            "alternative_code": "ect2"
        },
        "udf_date_1": "2014-05-05T15:49:59",
        "udf_date_2": "2014-06-05T15:49:59",
        "expected_completion_date": "2014-05-05T15:49:59",
        "udf_date_3": "2014-07-05T15:49:59",
        "udf_date_4": "2014-08-05T15:49:59",
        "performed_by_unit":
        {
            "community_name": "Main Community",
            "group_name": "Main Group",
            "name": "Admin Unit",
            "id": "48305F8849E3C18B227C5BE3A27BA6DF",
            "description": "r1",
            "alternative_code": "MG"
        },
        "process_immediately": 1,
        "log_information":
        {
            "updated_date": "2014-11-14T15:00:51",
            "created_by_unit":
            {
                "community_name": "Main Community",
                "group_name": "Main Group",
                "name": "Admin Unit",
                "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                "description": "r1",
                "alternative_code": "MG"
            },
            "created_date": "2014-11-14T15:00:50",
            "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": "Marios Lannister",
                "username": "MPAdministrator",
                "id": "1",
                "email": null
            },
            "updated_by_user":
            {
                "person_name": "Marios Lannister",
                "username": "MPAdministrator",
                "id": "1",
                "email": null
            }
        },
        "life_cycle_state": "POSTED",
        "type": "ACHIEVEMENT",
        "description": "first purchase event"
    }
}

...

This method returns information related with a spend request customer event. A single spend request customer event is returned by each call

Resource URL

Parameters

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

Restrictions

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

Response Data

Include Page

	V4:spend_request_customer_event_complete
	V4:spend_request_customer_event_complete

...

This method returns information related with spend requests customer events. Multiple spend request customer events are returned by each call

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

rewards_participant_identifier

(semi-optional)

Rewards Participant Identifier

The 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

Restrictions

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

Response Data

Include Page

	V4:spend_request_customer_event_complete
	V4:spend_request_customer_event_complete

Examples

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	js
linenumbers	true

{
  "token":"476A07F7C99133EA35D9AEA25475C8C1",
  "rewards_participant_identifier":{"access_token_identifier": {"identifier":"luciap","pass_code":"123456"}}
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

 
      {
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    [
        {
            "udf_float_1": 10,
            "udf_float_2": 20,
            "udf_float_3": 30,
            "udf_float_4": 40,
            "number": "2",
            "udf_string_1": "udf string 1",
            "udf_string_2": "udf string 2",
            "udf_string_3": "udf string 3",
            "udf_string_4": "udf string 4",
            "udf_string_5": "udf string 5",
            "udf_string_6": "udf string 6",
            "udf_string_7": "udf string 7",
            "udf_string_8": "udf string 8",
            "accounts_receivable":
            {
                "account_owner":
                {
                    "last_name": "Papapavlou",
                    "life_cycle_state": "FINANCIAL",
                    "middle_name": "Andreas",
                    "company_profile": null,
                    "title": "Ms",
                    "type": "PERSON",
                    "first_name": "Lucia",
                    "name": "Lucia Papapavlou",
                    "id": "1D92B269658D80DEDF2499E25201739E",
                    "company_name": null,
                    "demographics":
                    {
                        "gender": "FEMALE",
                        "passport_issued_by_country":
                        {
                            "name": "GREECE",
                            "id": "209"
                        },
                        "passport_number": "113115",
                        "social_security_number": "113116",
                        "country_of_residence":
                        {
                            "name": "UNITED KINGDOM",
                            "id": "126"
                        },
                        "industry_sector":
                        {
                            "name": "GOVERNMENTAL",
                            "id": "A9BDEBD4D8FAEDB0BACE40C041156D12",
                            "alternative_code": "GOV"
                        },
                        "date_of_birth":
                        {
                            "month": 1,
                            "day": 1,
                            "year": 1990
                        },
                        "name_day":
                        {
                            "month": 5,
                            "day": 5
                        },
                        "id_number": "113114",
                        "id_issued_by_country":
                        {
                            "name": "GREECE",
                            "id": "209"
                        },
                        "industry":
                        {
                            "name": "Interior Design",
                            "id": "06B638258885DA26FA2BD40D9128D04E",
                            "code": "INTDS"
                        }
                    }
                },
                "life_cycle_state": "ACTIVE",
                "number": "399",
                "name": "Lucia Papapavlou",
                "id": "2B669B8EB009BF42352C00B05FAB61CF"
            },
            "id": "EF01EDAD1341EAF60698E98804DEC684",
            "classification":
            {
                "name": "Event Class Test 2",
                "id": "C4CD55F1641D9D9711A780B6302475C0",
                "alternative_code": "ect2"
            },
            "udf_date_1": "2014-05-05T15:49:59",
            "udf_date_2": "2014-06-05T15:49:59",
            "udf_date_3": "2014-07-05T15:49:59",
            "udf_date_4": "2014-08-05T15:49:59",
            "performed_by_unit":
            {
                "community_name": "Main Community",
                "group_name": "Main Group",
                "name": "Admin Unit",
                "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                "description": "r1",
                "alternative_code": "MG"
            },
            "process_immediately": 1,
            "log_information":
            {
                "updated_date": "2014-11-17T14:02:28",
                "created_by_unit":
                {
                    "community_name": "Main Community",
                    "group_name": "Main Group",
                    "name": "Admin Unit",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "description": "r1",
                    "alternative_code": "MG"
                },
                "created_date": "2014-11-17T14:02:26",
                "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": null
                },
                "updated_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1",
                    "email": null
                }
            },
            "life_cycle_state": "POSTED",
            "purchase_customer_event":
            {
                "number": "9",
                "performed_by_unit":
                {
                    "community_name": "Main Community",
                    "group_name": "Main Group",
                    "name": "Admin Unit",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "description": "r1",
                    "alternative_code": "MG"
                },
                "vat_amount": 20,
                "process_immediately": 1,
                "log_information":
                {
                    "updated_date": "2014-11-28T14:56:22",
                    "created_by_unit":
                    {
                        "community_name": null,
                        "group_name": "Main Group",
                        "name": "Admin Unit",
                        "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                        "description": "r1",
                        "alternative_code": "MG"
                    },
                    "created_date": "2014-11-14T15:28:46",
                    "updated_by_unit":
                    {
                        "community_name": null,
                        "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": null
                    },
                    "updated_by_user":
                    {
                        "person_name": "MPAdministrator",
                        "username": "MPAdministrator",
                        "id": "1",
                        "email": null
                    }
                },
                "total_amount": 220,
                "accounts_receivable":
                {
                    "account_owner":
                    {
                        "last_name": "Papapavlou",
                        "life_cycle_state": "FINANCIAL",
                        "middle_name": "Andreas",
                        "company_profile": null,
                        "title": "Ms",
                        "type": "PERSON",
                        "first_name": "Lucia",
                        "name": "Lucia Papapavlou",
                        "id": "1D92B269658D80DEDF2499E25201739E",
                        "company_name": null,
                        "demographics":
                        {
                            "gender": "FEMALE",
                            "passport_issued_by_country":
                            {
                                "name": "GREECE",
                                "id": "209"
                            },
                            "passport_number": "113115",
                            "social_security_number": "113116",
                            "country_of_residence":
                            {
                                "name": "UNITED KINGDOM",
                                "id": "126"
                            },
                            "industry_sector":
                            {
                                "name": "GOVERNMENTAL",
                                "id": "A9BDEBD4D8FAEDB0BACE40C041156D12",
                                "alternative_code": "GOV"
                            },
                            "date_of_birth":
                            {
                                "month": 1,
                                "day": 1,
                                "year": 1990
                            },
                            "name_day":
                            {
                                "month": 5,
                                "day": 5
                            },
                            "id_number": "113114",
                            "id_issued_by_country":
                            {
                                "name": "GREECE",
                                "id": "209"
                            },
                            "industry":
                            {
                                "name": "Interior Design",
                                "id": "06B638258885DA26FA2BD40D9128D04E",
                                "code": "INTDS"
                            }
                        }
                    },
                    "life_cycle_state": "ACTIVE",
                    "number": "399",
                    "name": "Lucia Papapavlou",
                    "id": "2B669B8EB009BF42352C00B05FAB61CF"
                },
                "life_cycle_state": "POSTED",
                "net_amount": 200,
                "type": "PURCHASE",
                "id": "99FE2CFD65E9CB1F8DE1E6C26B9A45C1",
                "description": "first purchase event",
                "reference_number": "RF333",
                "performed_on": "2014-11-05T15:49:59"
            },
            "type": "SPEND_REQUEST",
            "description": "standard spend request event",
            "performed_on": "2014-05-05T15:49:59"
        },
        {
            "udf_float_1": null,
            "udf_float_2": null,
            "udf_float_3": null,
            "udf_float_4": null,
            "number": "4",
            "udf_string_1": null,
            "udf_string_2": null,
            "udf_string_3": 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": "Papapavlou",
                    "life_cycle_state": "FINANCIAL",
                    "middle_name": "Andreas",
                    "company_profile": null,
                    "title": "Ms",
                    "type": "PERSON",
                    "first_name": "Lucia",
                    "name": "Lucia Papapavlou",
                    "id": "1D92B269658D80DEDF2499E25201739E",
                    "company_name": null,
                    "demographics":
                    {
                        "gender": "FEMALE",
                        "passport_issued_by_country":
                        {
                            "name": "GREECE",
                            "id": "209"
                        },
                        "passport_number": "113115",
                        "social_security_number": "113116",
                        "country_of_residence":
                        {
                            "name": "UNITED KINGDOM",
                            "id": "126"
                        },
                        "industry_sector":
                        {
                            "name": "GOVERNMENTAL",
                            "id": "A9BDEBD4D8FAEDB0BACE40C041156D12",
                            "alternative_code": "GOV"
                        },
                        "date_of_birth":
                        {
                            "month": 1,
                            "day": 1,
                            "year": 1990
                        },
                        "name_day":
                        {
                            "month": 5,
                            "day": 5
                        },
                        "id_number": "113114",
                        "id_issued_by_country":
                        {
                            "name": "GREECE",
                            "id": "209"
                        },
                        "industry":
                        {
                            "name": "Interior Design",
                            "id": "06B638258885DA26FA2BD40D9128D04E",
                            "code": "INTDS"
                        }
                    }
                },
                "life_cycle_state": "ACTIVE",
                "number": "399",
                "name": "Lucia Papapavlou",
                "id": "2B669B8EB009BF42352C00B05FAB61CF"
            },
            "id": "18573C92130B031F198E6D4657A19327",
            "classification":
            {
                "name": "Classification Test 1",
                "id": "37DA1DB4A0E325A37D12CD0B8AA7CDF5",
                "alternative_code": "ct1"
            },
            "udf_date_1": null,
            "udf_date_2": null,
            "udf_date_3": null,
            "udf_date_4": null,
            "performed_by_unit":
            {
                "community_name": "Main Community",
                "group_name": "Main Group",
                "name": "Admin Unit",
                "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                "description": "r1",
                "alternative_code": "MG"
            },
            "process_immediately": 0,
            "log_information":
            {
                "updated_date": "2014-11-17T14:49:00",
                "created_by_unit":
                {
                    "community_name": "Main Community",
                    "group_name": "Main Group",
                    "name": "Admin Unit",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "description": "r1",
                    "alternative_code": "MG"
                },
                "created_date": "2014-11-17T14:48:29",
                "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": null
                },
                "updated_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1",
                    "email": null
                }
            },
            "life_cycle_state": "POSTED",
            "purchase_customer_event":
            {
                "number": "7",
                "performed_by_unit":
                {
                    "community_name": "Main Community",
                    "group_name": "Main Group",
                    "name": "Admin Unit",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "description": "r1",
                    "alternative_code": "MG"
                },
                "vat_amount": 5,
                "process_immediately": 1,
                "log_information":
                {
                    "updated_date": "2014-11-28T14:56:06",
                    "created_by_unit":
                    {
                        "community_name": null,
                        "group_name": "Main Group",
                        "name": "Admin Unit",
                        "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                        "description": "r1",
                        "alternative_code": "MG"
                    },
                    "created_date": "2014-11-13T15:05:00",
                    "updated_by_unit":
                    {
                        "community_name": null,
                        "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": null
                    },
                    "updated_by_user":
                    {
                        "person_name": "MPAdministrator",
                        "username": "MPAdministrator",
                        "id": "1",
                        "email": null
                    }
                },
                "total_amount": 155,
                "accounts_receivable":
                {
                    "account_owner":
                    {
                        "last_name": "Papapavlou",
                        "life_cycle_state": "FINANCIAL",
                        "middle_name": "Andreas",
                        "company_profile": null,
                        "title": "Ms",
                        "type": "PERSON",
                        "first_name": "Lucia",
                        "name": "Lucia Papapavlou",
                        "id": "1D92B269658D80DEDF2499E25201739E",
                        "company_name": null,
                        "demographics":
                        {
                            "gender": "FEMALE",
                            "passport_issued_by_country":
                            {
                                "name": "GREECE",
                                "id": "209"
                            },
                            "passport_number": "113115",
                            "social_security_number": "113116",
                            "country_of_residence":
                            {
                                "name": "UNITED KINGDOM",
                                "id": "126"
                            },
                            "industry_sector":
                            {
                                "name": "GOVERNMENTAL",
                                "id": "A9BDEBD4D8FAEDB0BACE40C041156D12",
                                "alternative_code": "GOV"
                            },
                            "date_of_birth":
                            {
                                "month": 1,
                                "day": 1,
                                "year": 1990
                            },
                            "name_day":
                            {
                                "month": 5,
                                "day": 5
                            },
                            "id_number": "113114",
                            "id_issued_by_country":
                            {
                                "name": "GREECE",
                                "id": "209"
                            },
                            "industry":
                            {
                                "name": "Interior Design",
                                "id": "06B638258885DA26FA2BD40D9128D04E",
                                "code": "INTDS"
                            }
                        }
                    },
                    "life_cycle_state": "ACTIVE",
                    "number": "399",
                    "name": "Lucia Papapavlou",
                    "id": "2B669B8EB009BF42352C00B05FAB61CF"
                },
                "life_cycle_state": "POSTED",
                "net_amount": 150,
                "type": "PURCHASE",
                "id": "F9E275A8842E16740F38BEFDB2A7B74B",
                "description": "first purchase event",
                "reference_number": "RF333",
                "performed_on": "2014-11-20T15:49:59"
            },
            "type": "SPEND_REQUEST",
            "description": null,
            "performed_on": "2014-11-17T14:48:36"
        },
        {
            "udf_float_1": 10,
            "udf_float_2": 20,
            "udf_float_3": 30,
            "udf_float_4": 40,
            "number": "5",
            "udf_string_1": "udf string 1",
            "udf_string_2": "udf string 2",
            "udf_string_3": "udf string 3",
            "udf_string_4": "udf string 4",
            "udf_string_5": "udf string 5",
            "udf_string_6": "udf string 6",
            "udf_string_7": "udf string 7",
            "udf_string_8": "udf string 8",
            "accounts_receivable":
            {
                "account_owner":
                {
                    "last_name": "Papapavlou",
                    "life_cycle_state": "FINANCIAL",
                    "middle_name": "Andreas",
                    "company_profile": null,
                    "title": "Ms",
                    "type": "PERSON",
                    "first_name": "Lucia",
                    "name": "Lucia Papapavlou",
                    "id": "1D92B269658D80DEDF2499E25201739E",
                    "company_name": null,
                    "demographics":
                    {
                        "gender": "FEMALE",
                        "passport_issued_by_country":
                        {
                            "name": "GREECE",
                            "id": "209"
                        },
                        "passport_number": "113115",
                        "social_security_number": "113116",
                        "country_of_residence":
                        {
                            "name": "UNITED KINGDOM",
                            "id": "126"
                        },
                        "industry_sector":
                        {
                            "name": "GOVERNMENTAL",
                            "id": "A9BDEBD4D8FAEDB0BACE40C041156D12",
                            "alternative_code": "GOV"
                        },
                        "date_of_birth":
                        {
                            "month": 1,
                            "day": 1,
                            "year": 1990
                        },
                        "name_day":
                        {
                            "month": 5,
                            "day": 5
                        },
                        "id_number": "113114",
                        "id_issued_by_country":
                        {
                            "name": "GREECE",
                            "id": "209"
                        },
                        "industry":
                        {
                            "name": "Interior Design",
                            "id": "06B638258885DA26FA2BD40D9128D04E",
                            "code": "INTDS"
                        }
                    }
                },
                "life_cycle_state": "ACTIVE",
                "number": "399",
                "name": "Lucia Papapavlou",
                "id": "2B669B8EB009BF42352C00B05FAB61CF"
            },
            "id": "49F03F54CBAB7714E493FDDB4AE47C2C",
            "classification":
            {
                "name": "Event Class Test 2",
                "id": "C4CD55F1641D9D9711A780B6302475C0",
                "alternative_code": "ect2"
            },
            "udf_date_1": "2014-05-05T15:49:59",
            "udf_date_2": "2014-06-05T15:49:59",
            "udf_date_3": "2014-07-05T15:49:59",
            "udf_date_4": "2014-08-05T15:49:59",
            "performed_by_unit":
            {
                "community_name": "Main Community",
                "group_name": "Main Group",
                "name": "Admin Unit",
                "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                "description": "r1",
                "alternative_code": "MG"
            },
            "process_immediately": 1,
            "log_information":
            {
                "updated_date": "2014-11-17T15:17:15",
                "created_by_unit":
                {
                    "community_name": "Main Community",
                    "group_name": "Main Group",
                    "name": "Admin Unit",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "description": "r1",
                    "alternative_code": "MG"
                },
                "created_date": "2014-11-17T15:17:15",
                "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": null
                },
                "updated_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1",
                    "email": null
                }
            },
            "life_cycle_state": "POSTED",
            "purchase_customer_event":
            {
                "number": "9",
                "performed_by_unit":
                {
                    "community_name": "Main Community",
                    "group_name": "Main Group",
                    "name": "Admin Unit",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "description": "r1",
                    "alternative_code": "MG"
                },
                "vat_amount": 20,
                "process_immediately": 1,
                "log_information":
                {
                    "updated_date": "2014-11-28T14:56:22",
                    "created_by_unit":
                    {
                        "community_name": null,
                        "group_name": "Main Group",
                        "name": "Admin Unit",
                        "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                        "description": "r1",
                        "alternative_code": "MG"
                    },
                    "created_date": "2014-11-14T15:28:46",
                    "updated_by_unit":
                    {
                        "community_name": null,
                        "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": null
                    },
                    "updated_by_user":
                    {
                        "person_name": "MPAdministrator",
                        "username": "MPAdministrator",
                        "id": "1",
                        "email": null
                    }
                },
                "total_amount": 220,
                "accounts_receivable":
                {
                    "account_owner":
                    {
                        "last_name": "Papapavlou",
                        "life_cycle_state": "FINANCIAL",
                        "middle_name": "Andreas",
                        "company_profile": null,
                        "title": "Ms",
                        "type": "PERSON",
                        "first_name": "Lucia",
                        "name": "Lucia Papapavlou",
                        "id": "1D92B269658D80DEDF2499E25201739E",
                        "company_name": null,
                        "demographics":
                        {
                            "gender": "FEMALE",
                            "passport_issued_by_country":
                            {
                                "name": "GREECE",
                                "id": "209"
                            },
                            "passport_number": "113115",
                            "social_security_number": "113116",
                            "country_of_residence":
                            {
                                "name": "UNITED KINGDOM",
                                "id": "126"
                            },
                            "industry_sector":
                            {
                                "name": "GOVERNMENTAL",
                                "id": "A9BDEBD4D8FAEDB0BACE40C041156D12",
                                "alternative_code": "GOV"
                            },
                            "date_of_birth":
                            {
                                "month": 1,
                                "day": 1,
                                "year": 1990
                            },
                            "name_day":
                            {
                                "month": 5,
                                "day": 5
                            },
                            "id_number": "113114",
                            "id_issued_by_country":
                            {
                                "name": "GREECE",
                                "id": "209"
                            },
                            "industry":
                            {
                                "name": "Interior Design",
                                "id": "06B638258885DA26FA2BD40D9128D04E",
                                "code": "INTDS"
                            }
                        }
                    },
                    "life_cycle_state": "ACTIVE",
                    "number": "399",
                    "name": "Lucia Papapavlou",
                    "id": "2B669B8EB009BF42352C00B05FAB61CF"
                },
                "life_cycle_state": "POSTED",
                "net_amount": 200,
                "type": "PURCHASE",
                "id": "99FE2CFD65E9CB1F8DE1E6C26B9A45C1",
                "description": "first purchase event",
                "reference_number": "RF333",
                "performed_on": "2014-11-05T15:49:59"
            },
            "type": "SPEND_REQUEST",
            "description": "standard spend request event",
            "performed_on": "2014-05-05T15:49:59"
        }
    ]
}

...

This method is used to create a spend request customer event in a posted life cycle state

Resource URL

Parameters

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 Identifier

The 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 Identifier

The 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 Identifier

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

Date

The date that the customer event was actually performed

description

(optional)

String

A description of the customer event

process_immediately

(optional)

boolean

Defines 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

Restrictions

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

Response Data

Include Page

	V4:spend_request_customer_event_complete
	V4:spend_request_customer_event_complete

Examples

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
  "token":"56C3E3600D8A20BE53626F7E1BD85329",
   "accounts_receivable_identifier":{"number":"463"},
   "classification_identifier":{"name":"Event Class Test 2"},
   "performed_by_unit_identifier":{"name":"Admin Unit"},
   "purchase_customer_request_identifier":{"number":"42"},
   "performed_on":"2015-02-02T08:49:59",
   "description":"first purchase event",
   "process_immediately":1,
   "udf_string_1":"udf string 1",
   "udf_string_2":"udf string 2",
   "udf_string_3":"udf string 3",
   "udf_string_4":"udf string 4",
   "udf_string_5":"udf string 5",
   "udf_string_6":"udf string 6",
   "udf_string_7":"udf string 7",
   "udf_string_8":"udf string 8",
   "udf_float_1":10,
   "udf_float_2":20,
   "udf_float_3":30,
   "udf_float_4":40,
   "udf_float_5":50,
   "udf_float_6":60,
   "udf_float_7":70,
   "udf_float_8":80,
   "udf_date_1":"2014-05-05T15:49:59",
   "udf_date_2":"2014-06-05T15:49:59",
   "udf_date_3":"2014-07-05T15:49:59",
   "udf_date_4":"2014-08-05T15:49:59"
 }

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    {
        "udf_float_1": 10,
        "udf_float_2": 20,
        "udf_float_3": 30,
        "udf_float_4": 40,
        "number": "12",
        "udf_string_1": "udf string 1",
        "udf_string_2": "udf string 2",
        "udf_string_3": "udf string 3",
        "udf_string_4": "udf string 4",
        "udf_string_5": "udf string 5",
        "udf_string_6": "udf string 6",
        "udf_string_7": "udf string 7",
        "udf_string_8": "udf string 8",
        "accounts_receivable":
        {
            "account_owner":
            {
                "last_name": "Papapavlou",
                "life_cycle_state": "FINANCIAL",
                "middle_name": "Andreas",
                "company_profile": null,
                "title": "Ms",
                "type": "PERSON",
                "first_name": "Lucia",
                "name": "Lucia Papapavlou",
                "id": "1D92B269658D80DEDF2499E25201739E",
                "company_name": null,
                "demographics":
                {
                    "gender": "FEMALE",
                    "passport_issued_by_country":
                    {
                        "name": "GREECE",
                        "id": "209"
                    },
                    "passport_number": "113115",
                    "social_security_number": "113116",
                    "country_of_residence":
                    {
                        "name": "UNITED KINGDOM",
                        "id": "126"
                    },
                    "industry_sector":
                    {
                        "name": "GOVERNMENTAL",
                        "id": "A9BDEBD4D8FAEDB0BACE40C041156D12",
                        "alternative_code": "GOV"
                    },
                    "date_of_birth":
                    {
                        "month": 1,
                        "day": 1,
                        "year": 1990
                    },
                    "name_day":
                    {
                        "month": 5,
                        "day": 5
                    },
                    "id_number": "113114",
                    "id_issued_by_country":
                    {
                        "name": "GREECE",
                        "id": "209"
                    },
                    "industry":
                    {
                        "name": "Interior Design",
                        "id": "06B638258885DA26FA2BD40D9128D04E",
                        "code": "INTDS"
                    }
                }
            },
            "life_cycle_state": "ACTIVE",
            "number": "463",
            "name": "Loukia Papapavlou",
            "id": "ECEBDFA26C8B04960EC1C6D99363D48C"
        },
        "id": "96BF1C19D1B15DD6F39CE1FE5CE041C7",
        "classification":
        {
            "name": "Event Class Test 2",
            "id": "C4CD55F1641D9D9711A780B6302475C0",
            "alternative_code": "ect2"
        },
        "udf_date_1": "2014-05-05T15:49:59",
        "udf_date_2": "2014-06-05T15:49:59",
        "udf_date_3": "2014-07-05T15:49:59",
        "udf_date_4": "2014-08-05T15:49:59",
        "performed_by_unit":
        {
            "community_name": "Main Community",
            "group_name": "Main Group",
            "name": "Admin Unit",
            "id": "48305F8849E3C18B227C5BE3A27BA6DF",
            "description": "r1",
            "alternative_code": "MG"
        },
        "process_immediately": 1,
        "log_information":
        {
            "updated_date": "2015-02-02T09:26:11",
            "created_by_unit":
            {
                "community_name": "Main Community",
                "group_name": "Main Group",
                "name": "Admin Unit",
                "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                "description": "r1",
                "alternative_code": "MG"
            },
            "created_date": "2015-02-02T09:26:11",
            "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": "Marios Lannister",
                "username": "MPAdministrator",
                "id": "1",
                "email": null
            },
            "updated_by_user":
            {
                "person_name": "Marios Lannister",
                "username": "MPAdministrator",
                "id": "1",
                "email": null
            }
        },
        "life_cycle_state": "POSTED",
        "purchase_customer_event":
        {
            "number": "42",
            "performed_by_unit":
            {
                "community_name": "Main Community",
                "group_name": "Main Group",
                "name": "Admin Unit",
                "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                "description": "r1",
                "alternative_code": "MG"
            },
            "vat_amount": 10,
            "process_immediately": 0,
            "log_information":
            {
                "updated_date": "2015-02-02T09:24:47",
                "created_by_unit":
                {
                    "community_name": null,
                    "group_name": "Main Group",
                    "name": "Admin Unit",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "description": "r1",
                    "alternative_code": "MG"
                },
                "created_date": "2015-02-02T09:23:45",
                "updated_by_unit":
                {
                    "community_name": null,
                    "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": null
                },
                "updated_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1",
                    "email": null
                }
            },
            "total_amount": 20,
            "accounts_receivable":
            {
                "account_owner":
                {
                    "last_name": "Papapavlou",
                    "life_cycle_state": "FINANCIAL",
                    "middle_name": "Andreas",
                    "company_profile": null,
                    "title": "Ms",
                    "type": "PERSON",
                    "first_name": "Lucia",
                    "name": "Lucia Papapavlou",
                    "id": "1D92B269658D80DEDF2499E25201739E",
                    "company_name": null,
                    "demographics":
                    {
                        "gender": "FEMALE",
                        "passport_issued_by_country":
                        {
                            "name": "GREECE",
                            "id": "209"
                        },
                        "passport_number": "113115",
                        "social_security_number": "113116",
                        "country_of_residence":
                        {
                            "name": "UNITED KINGDOM",
                            "id": "126"
                        },
                        "industry_sector":
                        {
                            "name": "GOVERNMENTAL",
                            "id": "A9BDEBD4D8FAEDB0BACE40C041156D12",
                            "alternative_code": "GOV"
                        },
                        "date_of_birth":
                        {
                            "month": 1,
                            "day": 1,
                            "year": 1990
                        },
                        "name_day":
                        {
                            "month": 5,
                            "day": 5
                        },
                        "id_number": "113114",
                        "id_issued_by_country":
                        {
                            "name": "GREECE",
                            "id": "209"
                        },
                        "industry":
                        {
                            "name": "Interior Design",
                            "id": "06B638258885DA26FA2BD40D9128D04E",
                            "code": "INTDS"
                        }
                    }
                },
                "life_cycle_state": "ACTIVE",
                "number": "463",
                "name": "Loukia Papapavlou",
                "id": "ECEBDFA26C8B04960EC1C6D99363D48C"
            },
            "life_cycle_state": "POSTED",
            "net_amount": 10,
            "type": "PURCHASE",
            "id": "C4A4C37BE30891479C6555A2E204875C",
            "description": null,
            "reference_number": "20",
            "performed_on": "2015-02-02T09:23:55"
        },
        "type": "SPEND_REQUEST",
        "description": "first purchase event",
        "performed_on": "2015-02-02T08:49:59"
    }
}

Page Comparison

Versions Compared

Old Version 75

New Version 76

Key

GET customer_events/purchases/show

GET customer_events/purchases/show

POST customer_events/purchases/create_spend

Resource URL

Parameters

Anchorcreate spend purchase customer event referred parameterscreate spend purchase customer event referred parametersReferred Parameter Objects

Restrictions

Response Data

Examples

GET customer_events/referrals/show

Resource URL

Parameters

Restrictions

Response Data

Examples

Resource URL

Parameters

Restrictions

Response Data

Examples

Resource URL

Parameters

Restrictions

Response Data

Examples

Resource URL

Parameters

Restrictions

Response Data

Examples

Resource URL

Parameters

Restrictions

Response Data

Examples

Resource URL

Parameters

Restrictions

Response Data

Examples

Resource URL

Parameters

Restrictions

Response Data

Examples

Resource URL

Parameters

Restrictions

Response Data

Examples

Resource URL

Parameters

Restrictions

Response Data

Examples

Resource URL

Parameters

Restrictions

Response Data

Examples

Resource URL

Parameters

Restrictions

Response Data

Examples

Resource URL

Parameters

Restrictions

Response Data

Examples

Resource URL

Parameters

Restrictions

Response Data

Resource URL

Anchor
create spend purchase customer event referred parameters
create spend purchase customer event referred parameters
Referred Parameter Objects