Versions Compared

Key

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

Available from CRM.COM R5.0.0

Table of Contents
maxLevel2

GET customer_events/spend_requests/show

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

...

(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:

...

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

...

Examples

Expand
titleExample 1

HTTP Method: GET

 

Request:

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
 
      {
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    {
        "purchase_customer_event":
        {
            "number": "4",
            "performed_by_unit":
            {
                "community_name": "Main Community",
                "group_name": "Developers Group",
                "name": "Developers Unit",
                "id": "C4370788B2630BC8A99E8C7397406C09",
                "description": null,
                "alternative_code": null
            },
            "vat_amount": 10,
            "process_immediately": 1,
            "log_information":
            {
                "updated_date": "2014-11-13T18:12:09",
                "created_by_unit":
                {
                    "group_name": null,
                    "name": "Admin Unit",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "description": "r1",
                    "alternative_code": "MG"
                },
                "created_date": "2014-10-09T11:55:44",
                "updated_by_unit":
                {
                    "group_name": null,
                    "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": 110,
            "accounts_receivable":
            {
                "account_owner":
                {
                    "last_name": "Marios",
                    "life_cycle_state": "FINANCIAL",
                    "middle_name": null,
                    "company_profile": null,
                    "title": null,
                    "type": "PERSON",
                    "first_name": "Ioannou",
                    "name": "Ioannou Marios",
                    "id": "B8C601694611DE7ECC29B232AB38D80A",
                    "company_name": null,
                    "demographics":
                    {
                        "gender": "MALE",
                        "passport_issued_by_country": null,
                        "passport_number": null,
                        "social_security_number": null,
                        "country_of_residence": null,
                        "industry_sector": null,
                        "date_of_birth":
                        {
                            "month": null,
                            "day": null,
                            "year": null
                        },
                        "name_day":
                        {
                            "month": null,
                            "day": null
                        },
                        "id_number": null,
                        "id_issued_by_country": null,
                        "industry": null
                    }
                },
                "life_cycle_state": "ACTIVE",
                "number": "000001",
                "name": "Photos Panayi",
                "id": "23E6B215D4ED39080314212774711C95"
            },
            "life_cycle_state": "POSTED",
            "net_amount": 100,
            "type": "PURCHASE",
            "id": "76C1B6CACE378DC1425687E63845DEA3",
            "description": null,
            "reference_number": "3",
            "performed_on": "2014-10-12T11:56:08"
        },
        "number": "1",
        "id": "9E086B77A29B3F2CD51DF071DA8B953B"
    }
}

POST customer_events/spend_requests/list

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)

...

(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:

...

(semi-optional)

...

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

...

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

...

Examples

...

titleExample 1

HTTP Method: POST

 

Request:

Body:

Code Block
themeConfluence
languagejs
linenumberstrue
{
  "token":"476A07F7C99133EA35D9AEA25475C8C1",
  "rewards_participant_identifier":{"access_token_identifier": {"identifier":"luciap","pass_code":"123456"}}
}

 

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
 
      {
    "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"
        }
    ]
}

POST customer_events/spend_requests/create

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)

...

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

...

Tip

Available from CRM.COM R8.0.0

...

rewards_participant_identifier

(semi-optional)

...

Tip

Available from CRM.COM R8.0.0

...

classification_identifier

(optional)

...

performed_by_unit_identifier

(mandatory)

...

performed_on

(mandatory)

...

description

(optional)

...

process_immediately

(optional)

...

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:

...

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)

...

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)

...

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

...

Examples

HTTP Method: POST

 

Request:

Body:

Expand
titleExample 1
Code Block
themeConfluence
languagejavascript
linenumberstrue
{
  "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
themeConfluence
languagejavascript
linenumberstrue
{ "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" } } Panel
nameblue

Child pages (Children Display)
excerpttrue