Page Comparison

...

Tip
Available from CRM.COM R6Deprecated from R17.0.0

Excerpt
This method creates a buy in advance request. A single buy in advance request can be created by each call.

Resource URL

Parameters

Name

Type

Description


token	String	The token retrieved from the login method

subscription_identifier
(mandatory)

Subscription Identifier

The identifier of the subscription related with the buy in advance request. The allowed subscription identifier fields are the following:

Include Page

	V4:subscription_identifier
	V4:subscription_identifier

duration

(mandatory)

Number

The duration that is requested to be

bough

bought in advance

unit_of_time

(mandatory)

String

The unit of time that measures the specified duration. The supported values are DAYS, WEEKS, MONTHS or YEARS

description

(optional)

String

A description of the retrieved buy in advance request

billing_effective_date

(optional)

Date

The billing effective date of the buy in advance request, that determines the earliest date that the request can be picked up by the billing engine. If not specified then it is automatically set to the date that the request is submitted


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

services_set

(optional)

Set of Buy in advance request services

A set of services which are bough in advance through this request. Applicable only for prepaid subscriptions and only for such subscriptions' pre-rated services

Tip
Available from CRM.COM R12.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": "E79D2DDBA8F5499D801F1724EDDBD207",
 "subscription_identifier":{"id":"A60B45D48F24CE3C1099FEB5D4FCEC2E"}, 
 "duration":"3",
 "unit_of_time":"MONTHS",
 "description":"test desc"
}

Response:

Code Block

language	javascript
theme	Confluence
language	javascript
linenumbers	true

{
  "status": {
    "message": null,
    "description": null,
    "code": "OK"
  },
  "data": {
    "udf_float_1": null,
    "udf_float_2": null,
    "udf_float_3": null,
    "number": "14",
    "udf_float_4": null,
    "billing_effective_date": "2015-03-12T15:23:13",
    "udf_string_1": null,
    "udf_string_2": null,
    "udf_string_3": null,
    "billing_state": "NOT_RATED",
    "udf_string_4": null,
    "udf_string_5": null,
    "udf_string_6": null,
    "udf_string_7": null,
    "udf_string_8": null,
    "duration": 3,
    "id": "326A0E7F3BD7479B9D9FB115DDB2627B",
    "subscription": {
      "accounts_receivable": {
        "account_owner": {
          "last_name": "Vrikkis",
          "life_cycle_state": "FINANCIAL",
          "middle_name": null,
          "company_profile": null,
          "title": "Mr",
          "type": "PERSON",
          "first_name": "Nikos",
          "name": "Nikos Vrikkis",
          "id": "E129EFE1236D24644350B8A263ECC23D",
          "company_name": null,
          "demographics": {
            "gender": "MALE",
            "passport_issued_by_country": null,
            "passport_number": "54673457543",
            "social_security_number": "5467357",
            "country_of_residence": {
              "name": "JAPAN",
              "id": "237"
            },
            "industry_sector": null,
            "date_of_birth": {
              "month": null,
              "day": null,
              "year": null
            },
            "name_day": {
              "month": null,
              "day": null
            },
            "id_number": "835667",
            "id_issued_by_country": null,
            "industry": null
          }
        },
        "life_cycle_state": "ACTIVE",
        "number": "79",
        "name": "Nikos Vrikkis",
        "id": "A59E791DCF07FC9D96CD4BA4DAFAE381"
      },
      "life_cycle_state": "EFFECTIVE",
      "number": "S60055",
      "type": {
        "name": "Normal Subscription",
        "id": "6BB2B984CC9309775D06650C7493A836",
        "description": null,
        "alternative_code": "ST"
      },
      "id": "A60B45D48F24CE3C1099FEB5D4FCEC2E"
    },
    "udf_date_1": null,
    "udf_date_2": null,
    "udf_date_3": null,
    "udf_date_4": null,
    "log_information": {
      "updated_date": "2015-03-12T15:23:48",
      "created_by_unit": {
        "community_name": "Main Community",
        "group_name": "Main Group",
        "name": "Admin Unit",
        "id": "48305F8849E3C18B227C5BE3A27BA6DF",
        "description": "r1",
        "alternative_code": "MG"
      },
      "created_date": "2015-03-12T15:23:10",
      "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"
      },
      "updated_by_user": {
        "person_name": "Marios Lannister",
        "username": "mpadministrator",
        "id": "1"
      }
    },
    "life_cycle_state": "EFFECTIVE",
    "unit_of_time": "MONTHS",
    "description": "test desc"
  }
}

...

Expand

title	Example 2

HTTP Method: POST

Request:

Body:

Code Block

language	js
theme	Confluence
language	js
linenumbers	true

{
 "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9",
 "subscription_identifier":{"id":"BD703F144E76463ABCF0AD22CA30ECC0"},
 "duration":"1",
 "unit_of_time":"MONTHS",
 "description":"test desc",
 "services_set":[
        {
            "service_identifier":{
                "code":"Gold"
            }
        }
    ]
}

Response:

Code Block

language	javascript
theme	Confluence	language	javascript
linenumbers	true

    {
        "data":
        {
            "unit_of_time": "MONTHS",
            "log_information":
            {
                "created_by_unit":
                {
                    "alternative_code": "adminunit",
                    "group_name": "Main Group",
                    "community_name": "Community",
                    "name": "Admin Unit",
                    "description": "admin unit",
                    "id": "1"
                },
                "updated_by_unit":
                {
                    "alternative_code": "adminunit",
                    "group_name": "Main Group",
                    "community_name": "Community",
                    "name": "Admin Unit",
                    "description": "admin unit",
                    "id": "1"
                },
                "created_date": "2017-02-21T15:42:06",
                "updated_date": "2017-02-21T15:42:06",
                "updated_by_user":
                {
                    "person_name": "CRM COM",
                    "id": "1",
                    "username": "MPAdministrator"
                },
                "created_by_user":
                {
                    "person_name": "CRM COM",
                    "id": "1",
                    "username": "MPAdministrator"
                }
            },
            "services_set":
            [
                {
                    "service":
                    {
                        "code": "Gold",
                        "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": "G",
                        "description": "Gold",
                        "id": "D1EB074DFD904E54A0C67CAB9DC7E010"
                    },
                    "id": "CECD0CE99D3F4CA797D7389281CF51F0"
                }
            ],
            "description": "test desc",
            "rating_state": "PENDING",
            "subscription":
            {
                "number": "S0000007944",
                "first_activated_date": "2017-02-21T11:27:11",
                "rating_state": "PENDING",
                "accounts_receivable":
                {
                    "number": "ACR0000007951",
                    "name": "ACR0000007951",
                    "id": "0F511841B22B4755BB04832D7A9351AB",
                    "life_cycle_state": "ACTIVE",
                    "account_owner":
                    {
                        "company_profile": null,
                        "company_name": null,
                        "name": "Sub Pre-Rate",
                        "last_name": "Pre-Rate",
                        "id": "AE8C8565D90B4FCDA2A74CD7F60D13E5",
                        "life_cycle_state": "FINANCIAL",
                        "middle_name": null,
                        "title": null,
                        "type": "PERSON",
                        "first_name": "Sub",
                        "demographics":
                        {
                            "name_day":
                            {
                                "month": null,
                                "day": null
                            },
                            "id_number": null,
                            "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": "BD703F144E76463ABCF0AD22CA30ECC0",
                "life_cycle_state": "EFFECTIVE",
                "type":
                {
                    "alternative_code": "Prepaid Pre-rate",
                    "name": "Prepaid Pre-rate",
                    "description": null,
                    "id": "CC1AA5B0D9F24FD083572E70BA27CE90"
                }
            },
            "udf_date_2": null,
            "udf_date_1": null,
            "udf_date_4": null,
            "udf_date_3": null,
            "duration": 1,
            "number": "47",
            "udf_float_3": null,
            "udf_float_4": null,
            "billing_state": "NOT_RATED",
            "id": "7F11EC4787E34584B2FB59FA41C00A16",
            "udf_float_1": null,
            "udf_float_2": null,
            "udf_string_2": null,
            "udf_string_3": null,
            "udf_string_4": null,
            "udf_string_5": null,
            "udf_string_1": null,
            "life_cycle_state": "EFFECTIVE",
            "billing_effective_date": "2017-02-21T15:42:06",
            "udf_string_6": null,
            "udf_string_7": null,
            "udf_string_8": null
        },
        "status":
        {
            "code": "OK",
            "description": "",
            "message": ""
        }
    }

...

Versions Compared

Old Version 3

New Version Current

Key

Resource URL

Parameters

Restrictions