Tip
Available from CRM.COM R6.0.0

Table of Contents

maxLevel	2

...

Name

Type

Description

token

String

The token retrieved from the login method

buy_in_advance_request_identifier

(mandatory)

Buy in Advance Request identifier

The identifier of the buy in advance request that should be returned as a result. The allowed buy in advance request identifier fields are the following:

Include Page

	V4:buy_in_advance_request_identifier
	V4:buy_in_advance_request_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

...

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 requests that should be returned as a result. The allowed subscription identifier fields are the following:

Include Page

	V4:subscription_identifier
	V4:subscription_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

...

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 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

...

Name

Type

Description

token

String

The token retrieved from the login method

buy_in_advance_request_identifier

(mandatory)

Buy in Advance Request identifier

The identifier of the buy in advance request that should be updated. The allowed buy in advance request identifier fields are the following:

Include Page

	V4:buy_in_advance_request_identifier
	V4:buy_in_advance_request_identifier

duration

(optional)

Number

The duration that is requested to be bough in advance

unit_of_time

(optional)

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

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 prepaid pre-rated subscription services that are bough in advance through this request

Include Page

	V4:Web API - Updating Sets
	V4:Web API - Updating Sets

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

...

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	js
linenumbers	true

{
 "token": "C586BC3AC28048BE9FCC2A79B197F33B",
 "buy_in_advance_request_identifier":{"id":"90A52D7CF4B147F3A4D1740003B9B0D4"}, 
 "duration":"87",
 "unit_of_time":"DAYS",
 "description":"test desc 2"
}

Response:

Code Block

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:25:00",
    "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": 87,
    "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:25:00",
      "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": "mpadministrator",
        "username": "mpadministrator",
        "id": "1",
        "email": "mp@ministrator.com"
      },
      "updated_by_user": {
        "person_name": "Marios Lannister",
        "username": "mpadministrator",
        "id": "1"
      }
    },
    "life_cycle_state": "EFFECTIVE",
    "unit_of_time": "DAYS",
    "description": "test desc 2"
  }
}

Expand

title	Example 2

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	js
linenumbers	true

{
 "token": "C586BC3AC28048BE9FCC2A79B197F33B",
 {
 "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9",
 "buy_in_advance_request_identifier":{"id":"98E1278FD88A4E79A92C4E31FD7CB698"},
 "services_set":[
        {
            "action":"remove",
            "buy_in_advance_request_service_identifier":{"id":"1E74BAA0D6B84007BD4B3763FD2A37BA"}
        },
        {
            "action":"remove",
            "buy_in_advance_request_service_identifier":{"id":"011DA1070B2248718741D72B1AC18CB6"}
        },
 { "action":"add",
            "service_identifier":{
                "code":"Gold"
            }
        }
    ]
}

Response:

Code Block

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-22T08:04:01",
                "updated_date": "2017-02-22T08:15:48",
                "updated_by_user":
                {
                    "person_name": "CRM COM",
                    "id": "1",
                    "username": "MPAdministrator"
                },
                "created_by_user":
                {
                    "person_name": "MPAdministrator",
                    "id": "1",
                    "email": "dev@crm.com",
                    "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": "25342C90426E4E4ABE2F1A55F4117E06"
                }
            ],
            "description": "test desc",
            "rating_state": "PENDING",
            "subscription":
            {
                "number": "S0000007955",
                "first_activated_date": null,
                "rating_state": "PENDING",
                "accounts_receivable":
                {
                    "number": "ACR0000007960",
                    "name": "ACR0000007960",
                    "id": "A950FCFAF5D047D88696DB6EB23A4465",
                    "life_cycle_state": "ACTIVE",
                    "account_owner":
                    {
                        "company_profile": null,
                        "company_name": null,
                        "name": "Buy_Extra Advance_8",
                        "last_name": "Advance_8",
                        "id": "4F12FFCC1561491F8FFE467B305F7CCF",
                        "life_cycle_state": "FINANCIAL",
                        "middle_name": null,
                        "title": null,
                        "type": "PERSON",
                        "first_name": "Buy_Extra",
                        "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": "5FFC4F341C02486AAAD69F1D43CBDE9B",
                "life_cycle_state": "DRAFT",
                "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": "58",
            "udf_float_3": null,
            "udf_float_4": null,
            "billing_state": "NOT_RATED",
            "id": "98E1278FD88A4E79A92C4E31FD7CB698",
            "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-22T08:15:13",
            "udf_string_6": null,
            "udf_string_7": null,
            "udf_string_8": null
        },
        "status":
        {
            "code": "OK",
            "description": "",
            "message": ""
        }
    }

POST buy_in_advance_requests/cancel

...

Name

Type

Description

token

String

The token retrieved from the login method

buy_in_advance_request_identifier

(mandatory)

Buy in Advance Request identifier

The identifier of the buy in advance request that should be cancelled. The allowed buy in advance request identifier fields are the following:

Include Page

	V4:buy_in_advance_request_identifier
	V4:buy_in_advance_request_identifier

udf_date_4
(optional)

Date

User Defined Field of type Date

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

...

Versions Compared

Old Version 16

New Version 17

Key

POST buy_in_advance_requests/cancel

Page Comparison

Versions Compared

Old Version 16

New Version 17

Key

POST buy_in_advance_requests/cancel