Tip
Available from CRM.COM R4.0.0

Table of Contents

maxLevel	2

GET

...

notifications/show

This method returns information related with a voucher. Single voucher notification. A single notification is returned by each call

Resource URL

...

mandatoryVoucher the voucher vouchers vouchervoucher

Name

Type

Description

token

String

The token retrieved from the login method

vouchernotifications_identifier

(semi-optional)

Notification identifier

The identifier of the notification that should be returned as a result. The allowed notification identifier fields are the following:

Include Page

	V4:notification_identifier
	V4:notification_identifier

communication_identifier

(

semi-optional)

Communication identifier

The identifier of

the communication that was created for the notification that should be returned as a result. The allowed

communication identifier fields are the following:

Include Page

	V4:

communication_identifier
	V4:

communication_identifier

fields_set

(optional)

List of Strings, comma separated

A list of fields that should be included in the results. If not specified then all the available fields will be returned

...

Response Data

Include Page

	V4:vouchernotification_complete
	V4:vouchernotification_complete

Examples

Expand

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	js
linenumbers	true

{
  "status": {
    "message": null,
    "description": null,
    "code": "OK"
  },
  "data": {
    "extra_added_value": 10,
    "payment": {
      "payment_amount": 12,
      "issued_on": "2014-08-22T12:28:30",
      "life_cycle_state": "POSTED",
      "number": "120",
      "id": "780EC0BBD82BAF7B40A6B3C5FD555C42",
      "reference_number": "141",
      "posted_on": "2014-08-22T12:28:30"
    },
    "effective_date": "2014-08-01T00:00:00",
    "udf_float_1": null,
    "products_set": [
      {
        "id": "B2C3C187A2B9D76BCF15AC1DF56C50DA",
        "product": {
          "product_type": null,
          "id": "E7558FAB3E126741558578B6471C07C9",
          "description": "Sports ",
          "code": "Sports ",
          "alternative_code": null
        }
      },
      {
        "id": "2F4CCAB93A98AAE631527584B214F6D5",
        "product": {
          "product_type": null,
          "id": "CA05E389D3874A44278047A6109AC975",
          "description": "International",
          "code": "International",
          "alternative_code": null
        }
      },
      {
        "id": "769B8BC241302A7BC122F25D0EE81F11",
        "product": {
          "product_type": null,
          "id": "DE37CF1696E3CD4E8EF89F522019D385",
          "description": "Documentaries",
          "code": "Documentaries",
          "alternative_code": null
        }
      }
    ],
    "udf_float_2": null,
    "udf_float_3": null,
    "number": "900",
    "udf_float_4": null,
    "udf_string_1": null,
    "udf_string_2": null,
    "udf_string_3": null,
    "udf_string_4": null,
    "udf_string_5": null,
    "allowed_organisational_units_set": [
      {
        "community_name": null,
        "group_name": "Developers Group",
        "name": null,
        "id": "50419727229B1243340E9C1F66D1975A",
        "description": null,
        "alternative_code": null
      }
    ],
    "udf_string_6": null,
    "udf_string_7": null,
    "lot": {
      "number": "37",
      "id": "83219EA73671E800298CAC49DB1A3F58",
      "description": null,
      "alternative_code": "TEST2"
    },
    "udf_string_8": null,
    "id": "28CC7CBCC1F267A83C9AC0BBCD03FE16",
    "udf_date_1": null,
    "udf_date_2": null,
    "udf_date_3": null,
    "udf_date_4": null,
    "log_information": {
      "updated_date": "2014-08-22T12:28:31",
      "created_by_unit": {
        "community_name": "Main Community",
        "group_name": "Main Group",
        "name": "Admin Unit",
        "id": "48305F8849E3C18B227C5BE3A27BA6DF",
        "description": "r1",
        "alternative_code": "MG"
      },
      "created_date": "2014-08-21T12:41:34",
      "updated_by_unit": {
        "community_name": "Main Community",
        "group_name": "Main Group",
        "name": "Admin Unit",
        "id": "48305F8849E3C18B227C5BE3A27BA6DF",
        "description": "r1",
        "alternative_code": "MG"
      },
      "created_by_user": {
        "person_name": "MPAdministrator",
        "username": "MPAdministrator",
        "id": "1",
        "email": "mp@ministrator.com"
      },
      "updated_by_user": {
        "person_name": "MPAdministrator",
        "username": "MPAdministrator",
        "id": "1",
        "email": "mp@ministrator.com"
      }
    },
    "value": 12,
    "life_cycle_state": "USED",
    "type": {
      "name": "Fixed Voucher Type",
      "id": "3F1F84F4195B7804483B0C6823A90AD3",
      "alternative_code": "FVT"
    },
    "description": null,
    "expiration_date": "2015-08-01T00:00:00",
    "alternative_code": null
  }
}

GET vouchers/list

This method returns information related with vouchers. Multiple vouchers are returned by each call.

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

type_identifier
(semi-optional)

...

The identifier of the job type related with the jobs that should be returned as a result. The allowed job type identifier fields are the following:

...

The identifier of the lot related with the vouchers that should be returned as a result. The allowed lot 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

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	js
linenumbers	true

{
   "status":
   {
       "message": null,
       "description": null,
       "code": "OK"
   },
   "data":
   [
       {
           "extra_added_value": 10,
           "payment":
           {
               "payment_amount": 12,
               "issued_on": "2014-08-21T13:04:13",
               "life_cycle_state": "POSTED",
               "number": "115",
               "id": "5925B02446333B54F477A4461E4122BE",
               "reference_number": "136",
               "posted_on": "2014-08-21T13:04:14"
           },
           "effective_date": "2014-08-01T00:00:00",
           "udf_float_1": null,
           "products_set":
           [
               {
                   "id": "A9BFE06631992AF483AC01AF6F77B7A4",
                   "product":
                   {
                       "product_type": null,
                       "id": "DE37CF1696E3CD4E8EF89F522019D385",
                       "description": "Documentaries",
                       "code": "Documentaries",
                       "alternative_code": null
                   }
               },
               {
                   "id": "3C7F7CD1FB22903A1DFCD2DC971D6265",
                   "product":
                   {
                       "product_type": null,
                       "id": "CA05E389D3874A44278047A6109AC975",
                       "description": "International",
                       "code": "International",
                       "alternative_code": null
                   }
               },
               {
                   "id": "8192A1B943819B139AD48035EC57BFAD",
                   "product":
                   {
                       "product_type": null,
                       "id": "E7558FAB3E126741558578B6471C07C9",
                       "description": "Sports ",
                       "code": "Sports ",
                       "alternative_code": null
                   }
               }
           ],
           "udf_float_2": null,
           "udf_float_3": null,
           "number": "889",
           "udf_float_4": null,
           "udf_string_1": null,
           "udf_string_2": null,
           "udf_string_3": null,
           "udf_string_4": null,
           "udf_string_5": null,
           "allowed_organisational_units_set":
           [
               {
                   "community_name": null,
                   "group_name": "Developers Group",
                   "name": null,
                   "id": "46BEFE093BA3B5864602FA016D3CFFC2",
                   "description": null,
                   "alternative_code": null
               }
           ],
           "udf_string_6": null,
           "udf_string_7": null,
           "lot":
           {
               "number": "37",
               "id": "83219EA73671E800298CAC49DB1A3F58",
               "description": null,
               "alternative_code": "TEST2"
           },
           "udf_string_8": null,
           "id": "19B3FAF60C0BFFC3E756D7DAFD4F180D",
           "udf_date_1": null,
           "udf_date_2": null,
           "udf_date_3": null,
           "udf_date_4": null,
           "log_information":
           {
               "updated_date": "2014-08-21T13:04:16",
               "created_by_unit":
               {
                   "group_name": null,
                   "name": "Admin Unit",
                   "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                   "description": "r1",
                   "alternative_code": "MG"
               },
               "created_date": "2014-08-21T12:41:31",
               "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
               }
           },
           "value": 12,
           "life_cycle_state": "USED",
           "type":
           {
               "name": "Fixed Voucher Type",
               "id": "3F1F84F4195B7804483B0C6823A90AD3",
               "alternative_code": "FVT"
           },
           "description": null,
           "expiration_date": "2015-08-01T00:00:00",
           "alternative_code": null
       },
       {
           "extra_added_value": 10,
           "payment": null,
           "effective_date": "2014-08-01T00:00:00",
           "udf_float_1": null,
           "products_set":
           [
               {
                   "id": "AB67EA03C9BB8C3B5772AB6C02AB1ECA",
                   "product":
                   {
                       "product_type": null,
                       "id": "DE37CF1696E3CD4E8EF89F522019D385",
                       "description": "Documentaries",
                       "code": "Documentaries",
                       "alternative_code": null
                   }
               },
               {
                   "id": "C787C7981AD83013D5522E4DC8F53109",
                   "product":
                   {
                       "product_type": null,
                       "id": "E7558FAB3E126741558578B6471C07C9",
                       "description": "Sports ",
                       "code": "Sports ",
                       "alternative_code": null
                   }
               },
               {
                   "id": "8610C38D9D0C02F312DF94F580910171",
                   "product":
                   {
                       "product_type": null,
                       "id": "CA05E389D3874A44278047A6109AC975",
                       "description": "International",
                       "code": "International",
                       "alternative_code": null
                   }
               }
           ],
           "udf_float_2": null,
           "udf_float_3": null,
           "number": "890",
           "udf_float_4": null,
           "udf_string_1": null,
           "udf_string_2": null,
           "udf_string_3": null,
           "udf_string_4": null,
           "udf_string_5": null,
           "allowed_organisational_units_set":
           [
               {
                   "community_name": null,
                   "group_name": "Developers Group",
                   "name": null,
                   "id": "C9E14991CDE10569F4680EDBC28C5BF1",
                   "description": null,
                   "alternative_code": null
               }
           ],
           "udf_string_6": null,
           "udf_string_7": null,
           "lot":
           {
               "number": "37",
               "id": "83219EA73671E800298CAC49DB1A3F58",
               "description": null,
               "alternative_code": "TEST2"
           },
           "udf_string_8": null,
           "id": "D9308C6A7996E5E79B01BE60E5826128",
           "udf_date_1": null,
           "udf_date_2": null,
           "udf_date_3": null,
           "udf_date_4": null,
           "log_information":
           {
               "updated_date": "2014-08-21T12:45:54",
               "created_by_unit":
               {
                   "group_name": null,
                   "name": "Admin Unit",
                   "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                   "description": "r1",
                   "alternative_code": "MG"
               },
               "created_date": "2014-08-21T12:41:31",
               "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
               }
           },
           "value": 12,
           "life_cycle_state": "ACTIVATED",
           "type":
           {
               "name": "Fixed Voucher Type",
               "id": "3F1F84F4195B7804483B0C6823A90AD3",
               "alternative_code": "FVT"
           },
           "description": null,
           "expiration_date": "2015-08-01T00:00:00",
           "alternative_code": null
       },....
    ]
}

POST vouchers/use

This method uses a voucher. Single voucher is used by each call

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

(mandatory)

...

The secret number of the voucher that will be used

...

account_receivable_identifier
(mandatory)

...

The identifier of the account receivable that the payment should be allocated in. The allowed accounts receivable identifier fields are the following:

...

The identifier of the payment category related with the payment that will be created. The allowed payment category identifier fields are the following:

...

notes
(optional)

...

Notes Object

...

The notes for the payment to be created

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

title	Example 1

HTTP Method: POST

Request:

Body

Code Block

theme	Confluence
language	js
linenumbers	true

{
    "token":"06A278ADF70A9571B39C63821E39F45A",
    "secret_number":"58978583",
    "account_receivable_identifier":{"id":"00F04DC1D3F923A15630751530EC1670"}
}

Response:

{ "status": { "message": null, "description": null, "code": "OK" }, "data": { "extra_added_value": 10, "payment": { "payment_amount": 12, "issued_on": "2014-08-26T14:29:44", "life_cycle_state": "POSTED", "number": "121", "id": "E62357633EBCA8C6205D53C102AE08AB", "reference_number": "143", "posted_on": "2014-08-26T14:29:44" }, "effective_date": "2014-08-01T00:00:00", "udf_float_1": null, "products_set": [ { "id": "A96F5EB7F7685BB89B92FA439C0485D6", "product": { "product_type": null, "id": "DE37CF1696E3CD4E8EF89F522019D385", "description": "Documentaries", "code": "Documentaries", "alternative_code": null } }, { "id": "82C3FA8E63B0661FCA220A2AF8D622A2", "product": { "product_type": null, "id": "CA05E389D3874A44278047A6109AC975", "description": "International", "code": "International", "alternative_code": null } }, { "id": "D4EFF2E62087DF447A82FE5CBCF0A464", "product": { "product_type": null, "id": "E7558FAB3E126741558578B6471C07C9", "description": "Sports ", "code": "Sports ", "alternative_code": null } } ], "udf_float_2": null, "udf_float_3": null, "number": "899", "udf_float_4": null, "udf_string_1": null, "udf_string_2": null, "udf_string_3": null, "udf_string_4": null, "udf_string_5": null, "allowed_organisational_units_set": [ { "community_name": null, "group_name": "Developers Group", "name": null, "id": "5AD3ED1C988E060FF4CC892C024A8312", "description": null, "alternative_code": null } ], "udf_string_6": null, "udf_string_7": null, "lot": { "number": "37", "id": "83219EA73671E800298CAC49DB1A3F58", "description": null, "alternative_code": "TEST2" }, "udf_string_8": null, "id": "136FFCCC86B0FEA1F518ABFCD675666E", "udf_date_1": null, "udf_date_2": null, "udf_date_3": null, "udf_date_4": null, "log_information": { "updated_date": "2014-08-26T14:29:46", "created_by_unit": { "community_name": "Main Community", "group_name": "Main Group", "name": "Admin Unit", "id": "48305F8849E3C18B227C5BE3A27BA6DF", "description": "r1", "alternative_code": "MG" }, "created_date": "2014-08-21T12:41: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": "mp@ministrator.com" }, "updated_by_user": { "person_name": "Marios Lannister", "username": "MPAdministrator", "id": "1", "email": null } }, "value": 12, "life_cycle_state": "USED", "type": { "name": "Fixed Voucher Type", "id": "3F1F84F4195B7804483B0C6823A90AD3", "alternative_code": "FVT" }, "description": null, "expiration_date": "2015-08-01T00:00:00", "alternative_code": null } }

Code Block

theme	Confluence
language	js
linenumbers	true

GET notifications/list

This method returns information related with notifications. Multiple notifications are returned by each call.

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

type_identifier
(semi-optional)

Notification type identifier

The identifier of the notification type related with the notification that should be returned as a result. The allowed notification type identifier fields are the following:

Include Page

	V4:notification_type_identifier
	V4:notification_type_identifier

notification_run_identifier

(semi-optional)

Notification run identifier

The identifier of the notification run that created the notifications that should be returned as a result. The allowed notification run identifier fields are the following:

Include Page

	V4:notification_run_identifier
	V4:notification_run_identifier

contact_information_identifier

(optional)

Contact Information identifier

The identifier of the contact information notified by the notifications that should be returned as a result. The allowed contact information identifier fields are the following:

Include Page

	V4:contact_information_identifier
	V4:contact_information_identifier

accounts_receivable_identifier

(optional)

Accounts receivable identifier

The identifier of the accounts receivable notified by the notifications that should be returned as a result. The allowed contact information identifier fields are the following:

Include Page

	V4:accounts_receivable_identifier
	V4:accounts_receivable_identifier

fields_set

(optional)

List of Strings, comma separated

A list of fields that should be included in the results. If not specified then all the available fields will be returned

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:notification_complete
	V4:notification_complete

Examples

Expand

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	js
linenumbers	true

GET notifications/get_latest_in_queue

This method returns information related with a notification. A single notification is returned by each call

Version	Old Version 1	New Version 2
Changes made by	George Rossides	George Rossides
Saved on	Sept 08, 2014	Sept 08, 2014

Versions Compared

Key

GET

notifications/show

Resource URL

Response Data

Examples

GET vouchers/list

Resource URL

Parameters

Restrictions

Response Data

Examples

POST vouchers/use

Resource URL

Parameters

Restrictions

Response Data

Examples

GET notifications/list

Resource URL

Parameters

Restrictions

Response Data

Examples

GET notifications/get_latest_in_queue

Page Comparison

Versions Compared

Key

GET

notifications/show

Resource URL

Response Data

Examples

GET vouchers/list

Resource URL

Parameters

Restrictions

Response Data

Examples

POST vouchers/use

Resource URL

Parameters

Restrictions

Response Data

Examples

GET notifications/list

Resource URL

Parameters

Restrictions

Response Data

Examples

GET notifications/get_latest_in_queue