Versions Compared

Key

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

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

Available from CRM.COM R7.0.0

Excerpt

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

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

subscription_identifier

(semi-optional)

...

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

...

Tip

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

...

accounts_receivable_identifier

(semi-optional)

...

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

...

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)

...

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

...

sub_action_type_identifier

(optional)

...

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

...

transaction_reference_number

(optional)

...

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)

...

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

...

performed_on

(optional)

...

billing_effective_date

(optional)

...

billable_period_start_date

(optional)

...

scheduled_date

(optional)

...

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)

...

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:

...

Tip

Available from CRM.COM R12.0.0

...

usage_authorisation_id

(optional)

 

...

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)

...

User Defined Field of type String

...

udf_string_2 

(optional)

...

User Defined Field of type String

...

udf_string_3 

(optional)

...

User Defined Field of type String

...

udf_string_4 

(optional)

...

User Defined Field of type String

...

udf_string_5

(optional)

...

User Defined Field of type String

...

udf_string_6 

(optional)

...

User Defined Field of type String

...

udf_string_7

(optional)

...

User Defined Field of type String

...

udf_string_8

(optional)

...

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

...

fields_set

(optional)

...

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

...

Available from CRM.COM R10.0.0

...

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:

...

themeConfluence
languagejavascript
linenumberstrue

...


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.

Resource URL

Parameters

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

Tip

Deprecated from CRM.COM R15.0.0


sub_action_type_identifier

(optional)

Subscription sub action type identifier

The sub action type 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

Tip

Deprecated from CRM.COM R15.0.0


classification_identifier

(optional)

Subscription Action Classification Identifier

The subscription action's classification. The allowed subscription action classification identifier fields are the following:

Include Page
V4:subscription_action_classification_identifier
V4:subscription_action_classification_identifier

Tip

Available from CRM.COM R18.0.0


payment_gateway_card_identifier

(optional)

Payment Gateway Card Identifier

The payment gateway card that will be used to post a payment against the accounts receivable of the subscription. Applicable and required only for Subscriptions following the "Pay before bill" payment model. The applicable payment gateway card identifier fields are the following:

Include Page
V4:payment_gateway_card_identifier
V4:payment_gateway_card_identifier

Tip

Available from CRM.COM R14.3.0


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

Deprecated from CRM.COM R18.0.0


performed_by_business_unit_identifier

(optional)

Business Unit Identifier

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

Include Page
V4:business_unit_identifier
V4:business_unit_identifier

Tip

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


use_proposed_scheduled_date

(optional)

Boolean

Defines whether the scheduled date automatically calculated and proposed by the system based on business rules, will be automatically set as the subscription's scheduled date or not. Applicable only if the subscription action includes a scheduled date and only if this scheduled date does not meet the business rules.

Tip

Available from CRM.COM R15.0.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_string_9

(optional)

String

User Defined Field of type String

Tip

Available from CRM.COM R14.2.0


udf_string_10

(optional)

String

User Defined Field of type String

Tip

Available from CRM.COM R14.2.0


udf_string_11

(optional)

String

User Defined Field of type String

Tip

Available from CRM.COM R14.2.0


udf_string_12

(optional)

String

User Defined Field of type String

Tip

Available from CRM.COM R14.2.0


udf_string_13

(optional)

String

User Defined Field of type String

Tip

Available from CRM.COM R14.2.0


udf_string_14

(optional)

String

User Defined Field of type String

Tip

Available from CRM.COM R14.2.0


udf_string_15

(optional)

String

User Defined Field of type String

Tip

Available from CRM.COM R14.2.0


udf_string_16

(optional)

String

User Defined Field of type String

Tip

Available from CRM.COM R14.2.0


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_float_5

(optional)

Float

User Defined Field of type Float

Tip

Available from CRM.COM R14.2.0


udf_float_6

(optional)

Float

User Defined Field of type Float

Tip

Available from CRM.COM R14.2.0


udf_float_7

(optional)

Float

User Defined Field of type Float

Tip

Available from CRM.COM R14.2.0


udf_float_8

(optional)

Float

User Defined Field of type Float

Tip

Available from CRM.COM R14.2.0


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

Include Page
V4:subscription_usage_detail_record_parameters
V4:subscription_usage_detail_record_parameters

Restrictions

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

Response Data

Include Page
V4:subscription_action_short
V4:subscription_action_short

Examples

Expand
titleExample 1

HTTP Method: POST


Request:


Body

Code Block
languagejavascript
themeConfluence
linenumberstrue
{
    "token":"E2CA46AC1DD04F08842777BBF3823FA3",
    "subscription_identifier":{"number":"S60555"},
    "usage_detail_record_set" :[
        { 
            "product_identifier" : { "code" : "Movie 2" },
        	"source_system_identifier":{ "name" : "IVR" },
        	"type_identifier":{ "name" : "Discounted" },
            "device_identifier":{"name":"Tablet"},
            "usage_method_identifier":{"name":"Download"},
        	"billing_directive":"TO_BE_BILLED",
            "usage_service_catalog_identifier":{ "name" : "Catalog Story board 5" },
        	"from_date": "2015-09-23T19:07:44",
        	"to_date": "2015-09-30T19:07:44",
        	"usage_amount" : 20,
        	"subscription_service" : {"service_identifier": {"code":"Silver"}},
            "destination_category_identifier":{"name":"Voip Application"},
            "source_category_identifier":{"name":"United Kingdom"},
			"provisioning_distributor_identifier":{"id":"B192D909D9B041F89FA8A197DC0F709A"}
		},
		{ 
            "product_identifier" : { "code" : "Movie 3" },
        	"source_system_identifier":{ "name" : "IVR" },
        	"type_identifier":{ "name" : "Discounted" },
            "device_identifier":{"name":"Tablet"},
            "usage_method_identifier":{"name":"Download"},
        	"billing_directive":"TO_BE_BILLED",
            "usage_service_catalog_identifier":{ "name" : "Catalog Story board 5" },
        	"from_date": "2015-09-23T19:07:44",
        	"to_date": "2015-09-30T19:07:44",
        	"usage_amount" : 20,
        	"subscription_service" : {"service_identifier": {"code":"Silver"}},
            "destination_category_identifier":{"name":"Voip Application"},
            "source_category_identifier":{"name":"United Kingdom"}
        }
    ]
} 


Response

Code Block
languagejavascript
themeConfluence
linenumberstrue
{
    "status":
    {
        "message": "",
        "description": "",
        "code": "OK"
    },
    "data":
    {
        "scheduled_date": "2015-09-24T11:45:58",
        "submitted_on": "2015-09-24T11:45:58",
        "action_type": null,
        "sub_action_type": null,
        "business_classification_code": "ADD_SERVICE_USAGE",
        "number": "1939",
        "executed_on": "2015-09-24T11:46:11",
        "life_cycle_state": "EXECUTED",
        "performed_by": null,
        "behavior_code": "ADD_SERVICE_USAGE",
        "id": "D9C5C4685973423895E6A291C15AA8A4",
        "submitted_by":
        {
            "person_name": "Marios Lannister",
            "username": "MPAdministrator",
            "id": "1"
        },
        "subscription":
        {
            "life_cycle_state": "EFFECTIVE",
            "accounts_receivable":
            {
                "account_owner":
                {
                    "last_name": "Ioannou97",
                    "middle_name": null,
                    "life_cycle_state": "FINANCIAL",
                    "company_profile": null,
                    "title": null,
                    "first_name": "Marios",
                    "type": "PERSON",
                    "id": "82CAA74F74324D26825E444460F4B65C",
                    "name": "Ioannou97 Marios",
                    "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": "435345",
                        "industry": null,
                        "id_issued_by_country": null
                    }
                },
                "life_cycle_state": "ACTIVE",
                "number": "ACR000778",
                "id": "917763A6499545B593DFBBC21A3689CB",
                "name": "mar97"
            },
            "number": "S60555",
            "type":
            {
                "udf_float_1": null,
                "udf_float_2": null,
                "udf_date_1": null,
                "udf_float_3": null,
                "udf_date_2": null,
                "udf_float_4": null,
                "udf_date_3": null,
                "udf_date_4": null,
                "name": "London",
                "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,
                "log_information":
                {
                    "updated_date": "2015-09-15T10:02:30",
                    "created_date": "2014-06-23T14:59:40",
                    "productcreated_by_identifierunit":
: { "code" : "Movie 2" },         	"source_system_identifier":{ "name" : "IVR" }, {
       	"type_identifier":{ "name" : "Discounted" },             "device_identifierid":{ "name":"Tablet"},48305F8849E3C18B227C5BE3A27BA6DF",
                        "usage_method_identifier":{"name": "DownloadAdmin Unit"},
           	"billing_directive":"TO_BE_BILLED",             "usage_service_catalog_identifiergroup_name":{ "nameMain Group",
: "Catalog Story board 5" },         	"from_date": "2015-09-23T19:07:44",         	"to_datedescription": "2015-09-30T19:07:44",
        	"usage_amount" : 20r1 Test Description for resource  request tab.Test Description for resource  request tab.",
        	"subscription_service" : {"service_identifier": {"code":"Silver"}},             "destinationalternative_category_identifiercode":{ "name":"Voip Application"},MG"
                   "source_category_identifier":{"name":"United Kingdom"},
			"provisioning_distributor_identifier":{"id":"B192D909D9B041F89FA8A197DC0F709A"}
		},
		{
                    "productupdated_by_identifierunit":
: { "code" : "Movie 3" },         	"source_system_identifier":{ "name" : "IVR" }, {
       	"type_identifier":{ "name" : "Discounted" },             "device_identifierid":{ "name48305F8849E3C18B227C5BE3A27BA6DF":"Tablet"},
             "usage_method_identifier":{"name":"Download"},           	"billing_directivename":"TO_BE_BILLED",
    "Admin Unit",
        "usage_service_catalog_identifier":{ "name" : "Catalog Story board 5" },         	"fromgroup_datename": "2015-09-23T19:07:44Main Group",
          	"to_date": "2015-09-30T19:07:44",              	"usage_amountdescription" : 20,"r1 Test Description for resource  request tab.Test  	"subscription_service" : {"service_identifier": {"code":"Silver"}}Description for resource  request tab.",
            "destination_category_identifier":{"name":"Voip Application"},             "sourcealternative_category_identifiercode":{ "name":"United Kingdom"}MG"
              }     ]
} 

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{ },
      "status":     {         "messagecreated_by_user":
"",         "description": "",         "code": "OK" {
    },     "data":      {         "scheduledperson_datename": "2015-09-24T11:45:58MPAdministrator",
              "submitted_on": "2015-09-24T11:45:58",         "action_typeusername": null,"MPAdministrator",
           "sub_action_type": null,             "business_classification_codeid": "ADD_SERVICE_USAGE",1"
           "number": "1939",         "executed_on": "2015-09-24T11:46:11",},
          "life_cycle_state": "EXECUTED",         "performedupdated_by_user":
null,         "behavior_code": "ADD_SERVICE_USAGE",         "id": "D9C5C4685973423895E6A291C15AA8A4", {
        "submitted_by":         {             "person_name": "Marios LannisterMPAdministrator",
                        "username": "MPAdministrator",
             "id": "1"           },
"id": "1"
       "subscription":         {    }
        "life_cycle_state": "EFFECTIVE",       },
     "accounts_receivable":             {"udf_string_8": null,
                "account_ownerid": "3100B0D56E7C7EADF073C34BCE1E42AF",
               {    "description": null,
                "lastalternative_namecode": "Ioannou97",LND"
            },
            "middle_nameid": null,"16C09DFDDF444C25A97953191DE653DC"
           },
        "lifeperformed_cycle_stateon": "FINANCIAL",null
    }
          } 



Expand
titleExample 2

HTTP Method: POST


Request:

Body:

Code Block
languagejavascript
themeConfluence
linenumberstrue
{
    "company_profiletoken": null,
    "E2CA46AC1DD04F08842777BBF3823FA3",
               "title": null"fields_set":"number,submitted_by,subscription,sub_action_type,job,action_type",
    "subscription_identifier":{
        "number":"S60708"
    },
 "first_name": "Marios",usage_detail_record_set" :[
        {
            "typeproduct_identifier" : { "PERSONcode", :      "Movie 2" },
             "idtype_identifier":{ "82CAA74F74324D26825E444460F4B65Cname", : "Discounted" },
                 "usage_service_catalog_identifier":{"name": "Ioannou97Test MariosProduct"},
            "billing_directive":"TO_BE_BILLED",
            "companyfrom_namedate": null,
       "2015-09-23T19:07:44",
            "demographicsto_date": "2015-09-30T19:07:44",
            "usage_amount" :  20,
   {         "subscription_service" : {"service_identifier": {"code":"Gold"}},
            "genderdestination_category_identifier":{"name":"Voip nullApplication"},
            "source_category_identifier":{"name":"United Kingdom"},
            "passportprovisioning_issued_by_country": null,distributor_identifier":{"name":"Nagra Media Live 1"}
        }
    ]
} 


Response:

Code Block
languagejavascript
themeConfluence
linenumberstrue
{
  "status":  {
       "social_security_number"message": null"",
    "description": "",
    "code": "OK"
  },
  "data":  {
    "passportaction_numbertype": null,
    "sub_action_type": null,
    "number": "4345",
    "submitted_by": {
      "industryperson_sectorname": "Marios nullLannister",
      "username": "MPAdministrator",
      "id": "1",
      "email":  "country_of_residence":"sakkascy1986@hotmail.com"
    },
    "job": null,
    "subscription": {
       {"life_cycle_state": "EFFECTIVE",
      "accounts_receivable": {
        "account_owner": {
          "threelast_character_codename": "USAMika",
                "middle_name": null,
           "twolife_charactercycle_codestate": "USFINANCIAL",
          "company_profile": null,
          "title": "Ms",
          "idfirst_name": "127Dina",
                 "type": "PERSON",
          "nameid": "UNITED STATES9ED00E7228634EF986807DF4D86A3F84",
          "name":    "Mika Dina",
             "alternativecompany_codename": null,
          "demographics": {
            "gender": }null,
            "passport_issued_by_country": null,
            "namesocial_security_daynumber": null,
            "passport_number": null,
         {    "industry_sector": null,
            "country_of_residence": {
              "monththree_character_code": null,"USA",
              "two_character_code": "US",
              "dayid": null"127",
              "name": "UNITED STATES",
       },       "alternative_code": null
            },
   "date_of_birth":         "name_day": {
              {
"month": null,
              "day": null
           "month": null},
            "date_of_birth": {
              "daymonth": null,
              "day": null,
              "year": null
            },
           }, "id_number": "14587522",
            "industry": null,
            "id_issued_by_numbercountry": "435345", null
          }
        },
        "industrylife_cycle_state": null"ACTIVE",
           "number": "ACR000525",
            "id_issued_by_country": null"C8A54A6BB4B9423AA560D6B955CD1271",
        "name": "Dina Mika"
      },
  }    "number": "S60708",
      "type": {
   },     "id": "D433A85FB6CD4880A1BCEEB1E164EFA4",
          "life_cycle_state"name": "ACTIVELondon",
        "description": "Subscription for London customers",
        "numberalternative_code": "ACR000778LND",
         },
      "id": "917763A6499545B593DFBBC21A3689CBC9EE8F9CC81143538BE2462684D04733",
      "first_activated_date": "2016-02-18T14:42:41",
        "namerating_state": "mar97PENDING"
    }
  }
}



Expand
titleExample 3

HTTP Method: POST


Request:

Body:

Code Block
languagejavascript
themeConfluence
linenumberstrue
{
"token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9",
  },    "subscription_identifier":{
        "number": "S60555S0000009206",
            "type":
},
"usage_detail_record_set" :[
           {
            "product_identifier" :  { "udf_float_1code" : null,"Usage Service 3"  },
            "udfusage_service_float_2": null,
catalog_identifier":{"name":"Test"},
               "udfbilling_date_1": null,
                "udf_float_3": null,
 directive":"TO_BE_BILLED",
              "udfusage_date_2amount" : null5,
            "subscription_service" :   {"udfservice_float_4identifier": null,{"code":"Bronze"}}
        },
       "udf_date_3": null, {
                "udfproduct_date_4identifier" : null,{ "code" : "Serendipity" },
            "usage_service_catalog_identifier":{"name":"Require Installed Item"London"},
                "udf_string_1": null,
   "billing_directive":"TO_BE_BILLED",
            "udfusage_string_2amount" : null5,
            "subscription_service" :   {"udfservice_string_3identifier": null{"code":"Bronze"}},
                "udf_string_4": null,"installed_item_identifier":{"serial_number":"smartcard_7385_01"}
        }
        "udf_string_5": null,
   ]
}


Response:

Code Block
languagejavascript
themeConfluence
linenumberstrue
    {
        "udf_string_6data":
   null,     {
            "udfperformed_string_7by": null,
   
            "logaction_informationtype": null,
            "transaction_reference_number": null,
 {           "submitted_by":
         "updated_date": "2015-09-15T10:02:30",  {
                  "createdperson_datename": "2014-06-23T14:59:40CRM COM",

                   "created_by_unit"id": "1",
                   {"username": "MPAdministrator"
            },
            "idexecuted_on": "48305F8849E3C18B227C5BE3A27BA6DF2017-10-18T10:07:48",
            "life_cycle_state": "EXECUTED",
            "namesubscription":
 "Admin Unit",           {
                "group_namenumber": "Main GroupS0000009206",
                "first_activated_date": "2017-10-18T08:48:58",
      "description          "rating_state": "PENDING"r1,
Test Description for resource  request tab.Test Description for resource  request tab.",       "accounts_receivable":
                {
"alternative_code": "MG"                     }"number": "ACR0000012733",
                    "updated_by_unitname": "ACR0000012733 Test 7738_02",
                 {   "id": "8A0A9CCA05BB4B5F8625CB20C73C123A",
                    "idlife_cycle_state": "48305F8849E3C18B227C5BE3A27BA6DFACTIVE",
                    "account_owner":
   "name": "Admin Unit",               {
         "group_name": "Main Group",             "company_profile": null,
          "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab." "company_name": null,
                        "alternative_codename": "MG"Test 7738_02",
                      },   "last_name": "7738_02",
                        "created_by_userid": "A3755B28A26A4E76B294093F159BDDBA",
                   {     "life_cycle_state": "FINANCIAL",
                        "personmiddle_name": "MPAdministrator"null,
                        "usernametitle": "MPAdministrator"null,
                        "idtype": "1PERSON",
                       },  "first_name": "Test",
                     "updated_by_user":   "demographics":
                 {       {
                 "person_name": "MPAdministrator",          "name_day":
              "username": "MPAdministrator",             {
           "id": "1"                     }"month": null,
                },
                "udf_string_8day": null,
                     "id": "3100B0D56E7C7EADF073C34BCE1E42AF",      },
          "description": null,                 "alternativeid_codenumber": "LND"7738_02",
               },             "idgender": "16C09DFDDF444C25A97953191DE653DC"null,
        },         "performed_on": null     } } 
Expand
titleExample 2

HTTP Method: POST

 

Request:

Body:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{     "token":"E2CA46AC1DD04F08842777BBF3823FA3",      "fieldscountry_of_setresidence":"number,submitted_by,subscription,sub_action_type,job,action_type",
    "subscription_identifier":{         "number":"S60708"     }, "usage_detail_record_set" :[         {
            "product_identifier" : { "code" : "Movie 2" },             "typealternative_identifiercode":{ "nameCYP",
   : "Discounted" },             "usage_service_catalog_identifier":{"name":"Test Product"},             "billingthree_character_directivecode": "TO_BE_BILLEDCYP",
              "from_date": "2015-09-23T19:07:44",                  "to_datename": "2015-09-30T19:07:44CYPRUS",
            "usage_amount" : 20,                  "subscription_service" : {"service_identifierid": {"code":"Gold"}},181",
             "destination_category_identifier":{"name":"Voip Application"},                   "sourcetwo_categorycharacter_identifiercode":{ "name":"United Kingdom"},CY"
                "provisioning_distributor_identifier":{"name":"Nagra Media Live 1"}         },
       ]    } 

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{           "status": {     "messagedate_of_birth":
"",       "description": "",     "code": "OK"   },   "data": {     "action_type": null, {
   "sub_action_type": null,     "number": "4345",     "submitted_by": {       "person_name": "Marios Lannister",       "usernamemonth": "MPAdministrator",null,
             "id": "1",       "email": "sakkascy1986@hotmail.com"     },     "jobyear": null,
     "subscription":  {       "life_cycle_state": "EFFECTIVE",       "accounts_receivable": {         "account_ownerday": {null
          "last_name": "Mika",           "middle_name": null,     },
     "life_cycle_state": "FINANCIAL",           "company_profile": null,           "titleindustry_sector": "Ms",
      null,
    "first_name": "Dina",           "type": "PERSON",           "idpassport_number": "9ED00E7228634EF986807DF4D86A3F84"null,
            "name": "Mika Dina",                "company_nameindustry": null,
          "demographics": {                  "gendersocial_security_number": null,
              "passport_issued_by_country": null,             "socialid_issued_securityby_numbercountry": null,
             "passport_number": null,               "industry_sectorpassport_issued_by_country": null,
            "country_of_residence": {           }
   "three_character_code": "USA",                 "two_character_code": "US",}
               "id": "127" },
                "nameid": "UNITED STATES9B6C8150B5CB401F982729D1FF5AED56",
                "alternativelife_cycle_codestate": null"EFFECTIVE",
            },    "type":
        "name_day": {       {
       "month": null,               "day": null"alternative_code": "normalsub",
             },       "name": "Normal",
    "date_of_birth": {               "monthdescription": null,
                    "dayid": "D1BAE6454A2248189EBCD7ADD3B4B65F"
null,               "year": null}
            },
            "idscheduled_numberdate": "145875222017-10-18T10:07:25",
            "industryperformed_on": null,
            "idsub_issuedaction_by_countrytype": null,
          }  "business_classification_code": "ADD_SERVICE_USAGE",
     },
        "life_cycle_statenumber": "ACTIVE25508",
            "numbersubmitted_on": "ACR0005252017-10-18T10:07:25",
            "id": "C8A54A6BB4B9423AA560D6B955CD1271",B9977262DC624794ACACC469D1ECF237",
            "namejob": "Dinanull,
Mika"       },       "numberbehavior_code": "S60708ADD_SERVICE_USAGE",
       "type     "performed_by_unit": {null
        "id": "D433A85FB6CD4880A1BCEEB1E164EFA4"},
        "namestatus":
"London",        {
"description": "Subscription for London customers",         "alternative_code": "LNDOK"
,
     },       "iddescription": "C9EE8F9CC81143538BE2462684D04733",
      "first_activated_date": "2016-02-18T14:42:41",       "rating_statemessage": "PENDING"
        }
  }  }