Versions Compared

Old Version 7

changes.mady.by.user Joseph Ioannou (Unlicensed)

Saved on

compared with

New Version 8

changes.mady.by.user Marios Michael

Saved on

Key

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

Available from CRM.COM R7.0.0

Excerpt

This method adds the usage of one or multiple subscription services belonging on a specific subscription.

...

Name

Type

Description

token

String

The token retrieved from the login method

subscription_identifier

(semi-optional)

Subscription identifier

The subscription to be modified. The allowed subscription identifier fields are the following:

Include Page
V4:subscription_identifier
V4:subscription_identifier

Tip

For releases prior to CRM.COM R13.0.0 the subscription_identifier is mandatory

accounts_receivable_identifier

(semi-optional)

Accounts Receivable Identifier

The accounts receivable identifier that can be used to perform the subscription modification. The allowed accounts receivable identifier fields are the following:

Include Page
V4:accounts_receivable_identifier_post
V4:accounts_receivable_identifier_post

Note

The ability to use the accounts_receivable_identifier instead of the subscription_identifier is applicable only when the specified Accounts Receivable owns only one Subscription

Tip

Available from CRM.COM R13.0.0

action_type_identifier

(optional)

Subscription action type identifier

The action type that should be used. The allowed subscription action type identifier fields are the following:

Include Page
V4:subscription_action_type_identifier
V4:subscription_action_type_identifier

sub_action_type_identifier

(optional)

Subscription sub action type identifier

Thesub actiontype that should be used. The allowed subscription sub action type identifier fields are the following:

Include Page
V4:subscription_sub_action_type_identifier
V4:subscription_sub_action_type_identifier

transaction_reference_number

(optional)

String

The transaction reference number of the performed subscription action. The transaction reference number is unique against already submitted subscription actions.

Tip

Available from CRM.COM R13.0.0

performed_by_user_identifier

(optional)

User identifier

 The user that actually performed the action. The allowed user identifier fields are the following:

Include Page
V4:user_identifier
V4:user_identifier

performed_by_unit_identifier

(optional)

Unit Identifier

 The unit that performed the action. The allowed unit identifier fields are the following:

Include Page
V4:unit_identifier
V4:unit_identifier

Tip

Available from CRM.COM R14.0.0

performed_on

(optional)

Date The date that the action was actually performed

billing_effective_date

(optional)

DateDetermines when the subscription services that are affected by the subscription action should be billed by the billing engine.

billable_period_start_date

(optional)

DateDetermines the start date of the billable period of each subscription service  (it answerstothe question “from which date should I start billing this service) that is affected by the subscription action.

scheduled_date

(optional)

Date

Defines the scheduled date of the subscription action. If not specified, then the subscription action will be immediately executed

Tip

Available from CRM.COM R12.1.0

intended_currency_identifier

(optional)

Currency Identifier

The currency that the user was intended to use for the added usage. If specified then it is validated against the currency of the specified accounts receivable and if they don't match then an erroris throw. Note that the intended currency is not saved within CRM.COM; it is just used for validation purposes. The allowed currency identifier fields are the following:

Include Page
V4:currency_identifier
V4:currency_identifier

Tip

Available from CRM.COM R12.0.0

usage_authorisation_id

(optional)

 

String

The unique identifier of the usage authorisation. Only usage authorizations in Blocked life cycle state is allowed to be specified.

Tip

Available from CRM.COM R13.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

usage_detail_record_setUsage Detail Record Objects SetThe set of usage detail records that should be added for each existing subscription service, classified as termed services

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

Tip

Available from CRM.COM R10.0.0

Anchor
services_add_usage referred objects parameters
services_add_usage referred objects parameters
Referred Parameter Objects Data

...

Expand
titleExample 2

HTTP Method: POST

 

Request:

Body:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
    "token":"E2CA46AC1DD04F08842777BBF3823FA3",
     "fields_set":"number,submitted_by,subscription,sub_action_type,job,action_type",
    "subscription_identifier":{
        "number":"S60708"
    },
"usage_detail_record_set" :[
        {
            "product_identifier" : { "code" : "Movie 2" },
            "type_identifier":{ "name" : "Discounted" },
            "usage_service_catalog_identifier":{"name":"Test Product"},
            "billing_directive":"TO_BE_BILLED",
            "from_date": "2015-09-23T19:07:44",
            "to_date": "2015-09-30T19:07:44",
            "usage_amount" : 20,
            "subscription_service" : {"service_identifier": {"code":"Gold"}},
            "destination_category_identifier":{"name":"Voip Application"},
            "source_category_identifier":{"name":"United Kingdom"},
            "provisioning_distributor_identifier":{"name":"Nagra Media Live 1"}
        }
    ]
}


Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
  "status": {
    "message": "",
    "description": "",
    "code": "OK"
  },
  "data": {
    "action_type": null,
    "sub_action_type": null,
    "number": "4345",
    "submitted_by": {
      "person_name": "Marios Lannister",
      "username": "MPAdministrator",
      "id": "1",
      "email": "sakkascy1986@hotmail.com"
    },
    "job": null,
    "subscription": {
      "life_cycle_state": "EFFECTIVE",
      "accounts_receivable": {
        "account_owner": {
          "last_name": "Mika",
          "middle_name": null,
          "life_cycle_state": "FINANCIAL",
          "company_profile": null,
          "title": "Ms",
          "first_name": "Dina",
          "type": "PERSON",
          "id": "9ED00E7228634EF986807DF4D86A3F84",
          "name": "Mika Dina",
          "company_name": null,
          "demographics": {
            "gender": null,
            "passport_issued_by_country": null,
            "social_security_number": null,
            "passport_number": null,
            "industry_sector": null,
            "country_of_residence": {
              "three_character_code": "USA",
              "two_character_code": "US",
              "id": "127",
              "name": "UNITED STATES",
              "alternative_code": null
            },
            "name_day": {
              "month": null,
              "day": null
            },
            "date_of_birth": {
              "month": null,
              "day": null,
              "year": null
            },
            "id_number": "14587522",
            "industry": null,
            "id_issued_by_country": null
          }
        },
        "life_cycle_state": "ACTIVE",
        "number": "ACR000525",
        "id": "C8A54A6BB4B9423AA560D6B955CD1271",
        "name": "Dina Mika"
      },
      "number": "S60708",
      "type": {
        "id": "D433A85FB6CD4880A1BCEEB1E164EFA4",
        "name": "London",
        "description": "Subscription for London customers",
        "alternative_code": "LND"
      },
      "id": "C9EE8F9CC81143538BE2462684D04733",
      "first_activated_date": "2016-02-18T14:42:41",
      "rating_state": "PENDING"
    }
  }
}
Expand
titleExample 3

HTTP Method: POST

 

Request:

Body:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
"token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9",
    "subscription_identifier":{
        "number":"S0000009206"
    },
"usage_detail_record_set" :[
        {
            "product_identifier" : { "code" : "Usage Service 3" },
            "usage_service_catalog_identifier":{"name":"Test"},
            "billing_directive":"TO_BE_BILLED",
            "usage_amount" : 5,
            "subscription_service" : {"service_identifier": {"code":"Bronze"}}
        },
        {
            "product_identifier" : { "code" : "Serendipity" },
            "usage_service_catalog_identifier":{"name":"Require Installed Item"},
            "billing_directive":"TO_BE_BILLED",
            "usage_amount" : 5,
            "subscription_service" : {"service_identifier": {"code":"Bronze"}},
            "installed_item_identifier":{"serial_number":"smartcard_7385_01"}
        }
    ]
}


Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
    {
        "data":
        {
            "performed_by": null,
            "action_type": null,
            "transaction_reference_number": null,
            "submitted_by":
            {
                "person_name": "CRM COM",
                "id": "1",
                "username": "MPAdministrator"
            },
            "executed_on": "2017-10-18T10:07:48",
            "life_cycle_state": "EXECUTED",
            "subscription":
            {
                "number": "S0000009206",
                "first_activated_date": "2017-10-18T08:48:58",
                "rating_state": "PENDING",
                "accounts_receivable":
                {
                    "number": "ACR0000012733",
                    "name": "ACR0000012733 Test 7738_02",
                    "id": "8A0A9CCA05BB4B5F8625CB20C73C123A",
                    "life_cycle_state": "ACTIVE",
                    "account_owner":
                    {
                        "company_profile": null,
                        "company_name": null,
                        "name": "Test 7738_02",
                        "last_name": "7738_02",
                        "id": "A3755B28A26A4E76B294093F159BDDBA",
                        "life_cycle_state": "FINANCIAL",
                        "middle_name": null,
                        "title": null,
                        "type": "PERSON",
                        "first_name": "Test",
                        "demographics":
                        {
                            "name_day":
                            {
                                "month": null,
                                "day": null
                            },
                            "id_number": "7738_02",
                            "gender": null,
                            "country_of_residence":
                            {
                                "alternative_code": "CYP",
                                "three_character_code": "CYP",
                                "name": "CYPRUS",
                                "id": "181",
                                "two_character_code": "CY"
                            },
                            "date_of_birth":
                            {
                                "month": null,
                                "year": null,
                                "day": null
                            },
                            "industry_sector": null,
                            "passport_number": null,
                            "industry": null,
                            "social_security_number": null,
                            "id_issued_by_country": null,
                            "passport_issued_by_country": null
                        }
                    }
                },
                "id": "9B6C8150B5CB401F982729D1FF5AED56",
                "life_cycle_state": "EFFECTIVE",
                "type":
                {
                    "alternative_code": "normalsub",
                    "name": "Normal",
                    "description": null,
                    "id": "D1BAE6454A2248189EBCD7ADD3B4B65F"
                }
            },
            "scheduled_date": "2017-10-18T10:07:25",
            "performed_on": null,
            "sub_action_type": null,
            "business_classification_code": "ADD_SERVICE_USAGE",
            "number": "25508",
            "submitted_on": "2017-10-18T10:07:25",
            "id": "B9977262DC624794ACACC469D1ECF237",
            "job": null,
            "behavior_code": "ADD_SERVICE_USAGE",
            "performed_by_unit": null
        },
        "status":
        {
            "code": "OK",
            "description": "",
            "message": ""
        }
    }