Page Comparison

...

Excerpt
This method returns information related to the purchase customer events. Multiple purchase 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 to 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

Tip
Deprecated from CRM.COM R17.0.0

accounts_receivable_identifier

(semi-optional)

Accounts Receivable Identifier

The identifier of the accounts receivable related to 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 to 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

spend_requests_applied

(optional)

Boolean

Determines whether the retrieved information related to the purchase customer events should have any spend request customer events submitted against them. The following options are available:

True - Retrieved purchase customer events should have at least one spend request customer event submitted against them
False - Retrieved purchase customer events should not have any spend request customer events submitted against them
Not Specified - Any purchase customer event should be retrieved

Tip
Available from CRM.COM R12.2.0

eligible_for_spending

(optional)

Boolean

Determines whether the retrieved information related to the purchase customer events are eligible to have a spend request customer event submitted against them, based on:

The time period that the purchase customer event was performed on does not exceed the maximum period of time that a potential spend request can be submitted (performed on) against it as of today
The purchase customer event should not have another spend request against it (other than canceled or Instant)

The following options are available:

True - Retrieved purchase customer events should be validated successfully against both rules
False - Retrieve the purchase customer events that are not eligible for spending
Not Specified - Any purchase customer event should be retrieved

Tip
Available from CRM.COM R13.1.0

submitted_after_date

(optional)

Date

If specified then information related to the purchase customer events that were submitted after the specified date should be retrieved

Tip
Available from CRM.COM R12.2.0

submitted_before_date

(optional)

Date

If specified then information related to the purchase customer events that were submitted before the specified date should be retrieved

Tip
Available from CRM.COM R12.2.0

created_after_date

(semi-optional)

Date

If specified then information related with purchase customer events that was created after the specified date should be retrieved

Tip
Available from CRM.COM R15.1.0

created_before_date

(optional)

Date

If specified then information related with purchase customer events that was created before the specified date should be retrieved

Tip
Available from CRM.COM R15.1.0

number_of_results

(optional)

Number

The number of results that can be retrieved through each call

Tip
Available from CRM.COM R13.0.0

offset

(optional)

Number

Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise, the results will begin from the provided offset number

Tip
Available from CRM.COM R13.0.0

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.

...

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

language	js
theme	Confluence	language	js
linenumbers	true

{
   "token":"9969B701F9437F397C5DF4558724282A",
   "rewards_participant_identifier":{"access_token_identifier":{"identifier":"6666", "pass_code":"9999"}},
   "fields_set":"id, number, products_set"
}

Response:

Code Block

language	javascript
theme	Confluence
language	javascript
linenumbers	true

   
      {
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    [
        {
            "products_set":
            [
                {
                    "total_amount": 100,
                    "net_amount": 80,
                    "id": "B2A93E80EED200BE6A826D57377B188A",
                    "vat_amount": 20,
                    "product":
                    {
                        "product_type": null,
                        "id": "E7558FAB3E126741558578B6471C07C9",
                        "description": "Sports ",
                        "code": "Sports ",
                        "alternative_code": null
                    }
                }
            ],
            "number": "5",
            "id": "9C232D22DC0D0B5A353DC4A1E511AADE"
        },
        {
            "products_set":
            [
                {
                    "total_amount": 110,
                    "net_amount": 100,
                    "id": "9BE53B6AFE97A9AF5FB608ECA33F7A4A",
                    "vat_amount": 10,
                    "product":
                    {
                        "product_type": null,
                        "id": "EAC7A30429364176616CFEF5DF709941",
                        "description": "Smartcard 1",
                        "code": "Smartcard 1",
                        "alternative_code": "SC1"
                    }
                }
            ],
            "number": "11",
            "id": "A73B5B716215AA433E9BE02F6A2BE952"
        }
    ]
}

...

Expand

title	Example 2

HTTP Method: POST

Request:

Body:

Code Block

language

language	js
theme	Confluence
js	linenumbers	true

{
    "token":"{{token}}",
    "accounts_receivable_identifier":{"number":"ACR0000000050"},
      "fields_set":"id, number, products_set,currency_rate_period"
}

Response:

Code Block

language	javascript
theme	Confluence	language	javascript
linenumbers	true

 {
  "data": [
    {
      "number": "14",
      "currency_rate_period": null,
      "id": "3473931B763645F2A175F05D815F5A72",
      "products_set": [
        {
          "product": {
            "code": "Installation Service",
            "product_type": {
              "service_type": "ONETIME",
              "used_for_provisioning": false,
              "alternative_code": "I",
              "composition_method": "FLAT",
              "name": "Services",
              "description": null,
              "id": "7A2F73F07F944CBAB8C5ACDA1A7879B4",
              "classification": "SERVICES",
              "physical_good_type": null
            },
            "alternative_code": "IS",
            "description": null,
            "id": "DB4875A4EB7C46BF94AD72169B36FD90"
          },
          "quantity": 1,
          "vat_amount": null,
          "total_amount": null,
          "id": "DBC634F9D0764AE384FE5BF5CD958715",
          "net_amount": null
        }
      ]
    },
    {
      "number": "13",
      "currency_rate_period": null,
      "id": "67EFD04703264C63BCD106A3165B383F",
      "products_set": [
        {
          "product": {
            "code": "aionet",
            "product_type": {
              "service_type": "TERMED",
              "used_for_provisioning": true,
              "alternative_code": "Main Packages",
              "composition_method": "FLAT",
              "name": "Main Packages",
              "description": null,
              "id": "E186E293AAAB49EE86A729540A4287FE",
              "classification": "SERVICES",
              "physical_good_type": null
            },
            "alternative_code": "aionet",
            "description": null,
            "id": "100D15C611CD4B0591EF62F2163266B9"
          },
          "quantity": 1,
          "vat_amount": 0,
          "total_amount": 12,
          "id": "9466E8B8BE0E4AD3AC60A55DC9B9DCBE",
          "net_amount": 12
        }
      ]
    },
    {
      "number": "12",
      "currency_rate_period": null,
      "id": "DAB83CE333A34436A03A3F8A11D2877A",
      "products_set": [
        {
          "product": {
            "code": "Expense 2",
            "product_type": {
              "service_type": "EXPENSE",
              "used_for_provisioning": false,
              "alternative_code": "006",
              "composition_method": "FLAT",
              "name": "Fees",
              "description": "Fees One Time Services",
              "id": "6",
              "classification": "SERVICES",
              "physical_good_type": null
            },
            "alternative_code": "E2",
            "description": null,
            "id": "1CEB8D2B86134B138469F8F3E12EB792"
          },
          "quantity": 1,
          "vat_amount": 0,
          "total_amount": 5,
          "id": "B301001C3D7D442DB0F3ECA31EBDE3EB",
          "net_amount": 5
        }
      ]
    },
    {
      "number": "10",
      "currency_rate_period": null,
      "id": "3B02F6A58A1145C68C48D731416B85BE",
      "products_set": [
        {
          "product": {
            "code": "Bronze",
            "product_type": {
              "service_type": "TERMED",
              "used_for_provisioning": true,
              "alternative_code": "Main Packages",
              "composition_method": "FLAT",
              "name": "Main Packages",
              "description": null,
              "id": "E186E293AAAB49EE86A729540A4287FE",
              "classification": "SERVICES",
              "physical_good_type": null
            },
            "alternative_code": "B",
            "description": null,
            "id": "F50CC52934BD4F119B6E18E215A4FC55"
          },
          "quantity": 1,
          "vat_amount": 0,
          "total_amount": 5,
          "id": "1998DCB0E057487099B1048105BF8CBE",
          "net_amount": 5
        }
      ]
    },
    {
      "number": "11",
      "currency_rate_period": {
        "from_date": "C7D7ED57F21B47028144967E015DCBE5",
        "to_date": 2.3,
        "rate": 2.3,
        "inverse_rate": 0.23000000417232513,
        "currency": {
          "suffix_symbol": null,
          "prefix_symbol": "£",
          "decimal_part_name": null,
          "code": "GBP",
          "integer_part_name": null,
          "id": "9"
        },
        "id": "C7D7ED57F21B47028144967E015DCBE5"
      },
      "id": "380837B7B5AB4FFFBA5E4EFD08C287D4",
      "products_set": [
        {
          "product": {
            "code": "Expense 1",
            "product_type": {
              "service_type": "EXPENSE",
              "used_for_provisioning": false,
              "alternative_code": "006",
              "composition_method": "FLAT",
              "name": "Fees",
              "description": "Fees One Time Services",
              "id": "6",
              "classification": "SERVICES",
              "physical_good_type": null
            },
            "alternative_code": "E1",
            "description": null,
            "id": "A9917A7895044BEF9499DD6958539D33"
          },
          "quantity": 1,
          "vat_amount": 0.02,
          "total_amount": 10.02,
          "id": "ED8CEC26AF2D4EAD9D5A02A4ED45DC32",
          "net_amount": 10
        }
      ]
    }
  ],
  "status": {
    "code": "OK",
    "description": "",
    "message": ""
  }
}

...

Expand

title	Example 3

HTTP Method: POST

Request:

Body:

Code Block

language	js
theme	Confluence	language	js
linenumbers	true

{
    "token":"{{token}}",
    "accounts_receivable_identifier":{"number":"ACR0000000391"},
      "fields_set": "number,performed_on",
  "submitted_after_date":"2016-07-01T17:00:12",
  "submitted_before_date":"2016-11-03T15:00:12",
  "spend_requests_applied":true
}

Response:

Code Block

language	javascript
theme	Confluence	language	javascript
linenumbers	true

 {
  "data": [
    {
      "number": "473",
      "performed_on": "2016-07-21T10:15:02"
    },
    {
      "number": "479",
      "performed_on": "2016-07-21T11:02:59"
    }
  ],
  "status": {
    "code": "OK",
    "description": "",
    "message": ""
  }
}

...

Versions Compared

Old Version 5

New Version 6

Key

Resource URL

Parameters

Restrictions