Versions Compared

Old Version 4

changes.mady.by.user Former user

Saved on

compared with

New Version Current

changes.mady.by.user p_demou

Saved on

Key

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

...

...

...

...


Tip

Deprecated from R17.0.0


Excerpt

This method returns information related with a buy in advance request.  A single buy in advance request is returned by each call

Resource URL

Parameters

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

Restrictions

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

...

Expand
titleExample 1

HTTP Method: GET 


Request:

Response:

Code Block
languagejs
themeConfluence
languagejs
linenumberstrue
{
  "udf_float_1": null,
  "udf_float_2": null,
  "udf_float_3": null,
  "udf_float_4": null,
  "number": "13",
  "billing_effective_date": "2015-03-10T18:58:42",
  "udf_string_1": null,
  "udf_string_2": null,
  "billing_state": "NOT_RATED",
  "udf_string_3": null,
  "udf_string_4": null,
  "udf_string_5": null,
  "udf_string_6": null,
  "udf_string_7": null,
  "udf_string_8": null,
  "duration": 87,
  "id": "90A52D7CF4B147F3A4D1740003B9B0D4",
  "subscription": {
    "life_cycle_state": "EFFECTIVE",
    "accounts_receivable": {
      "account_owner": {
        "last_name": "Vrikkis",
        "middle_name": null,
        "life_cycle_state": "FINANCIAL",
        "company_profile": null,
        "title": "Mr",
        "first_name": "Nikos",
        "type": "PERSON",
        "id": "E129EFE1236D24644350B8A263ECC23D",
        "name": "Nikos Vrikkis",
        "company_name": null,
        "demographics": {
          "gender": "MALE",
          "passport_issued_by_country": null,
          "social_security_number": "5467357",
          "passport_number": "54673457543",
          "industry_sector": null,
          "country_of_residence": {
            "id": "237",
            "name": "JAPAN"
          },
          "name_day": {
            "month": null,
            "day": null
          },
          "date_of_birth": {
            "month": null,
            "day": null,
            "year": null
          },
          "id_number": "835667",
          "industry": null,
          "id_issued_by_country": null
        }
      },
      "life_cycle_state": "ACTIVE",
      "number": "79",
      "id": "A59E791DCF07FC9D96CD4BA4DAFAE381",
      "name": "Nikos Vrikkis"
    },
    "number": "S60055",
    "type": {
      "id": "6BB2B984CC9309775D06650C7493A836",
      "name": "Normal Subscription",
      "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-10T18:59:38",
    "created_date": "2015-03-10T18:54:37",
    "created_by_unit": {
      "community_name": "Main Community",
      "id": "48305F8849E3C18B227C5BE3A27BA6DF",
      "name": "Admin Unit",
      "group_name": "Main Group",
      "description": "r1",
      "alternative_code": "MG"
    },
    "updated_by_unit": {
      "community_name": "Main Community",
      "id": "48305F8849E3C18B227C5BE3A27BA6DF",
      "name": "Admin Unit",
      "group_name": "Main Group",
      "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"
    }
  },
  "life_cycle_state": "EFFECTIVE",
  "unit_of_time": "DAYS",
  "description": "test desc 2"
}


...

Expand
titleExample 2

HTTP Method: GET 


Request:

Response:

Code Block
languagejs
themeConfluencelanguagejs
linenumberstrue
	{
        "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-21T11:27:18",
                "updated_date": "2017-02-21T13:17:32",
                "updated_by_user":
                {
                    "person_name": "MPAdministrator",
                    "id": "1",
                    "email": "dev@crm.com",
                    "username": "MPAdministrator"
                },
                "created_by_user":
                {
                    "person_name": "MPAdministrator",
                    "id": "1",
                    "email": "dev@crm.com",
                    "username": "MPAdministrator"
                }
            },
            "services_set":
            [
                {
                    "service":
                    {
                        "code": "Movies 1",
                        "product_type":
                        {
                            "service_type": "TERMED",
                            "used_for_provisioning": true,
                            "alternative_code": "AS",
                            "composition_method": "FLAT",
                            "name": "Additional Services",
                            "description": null,
                            "id": "C8321F0BCA8A4051857BC35CEEE41555",
                            "classification": "SERVICES",
                            "physical_good_type": null
                        },
                        "alternative_code": "M1",
                        "description": "Movies 1",
                        "id": "571C10876AF840088372A94A14D0A02C"
                    },
                    "id": "AEFE9C62523A41498C1255EB2D15143E"
                },
                {
                    "service":
                    {
                        "code": "Sports 1",
                        "product_type":
                        {
                            "service_type": "TERMED",
                            "used_for_provisioning": true,
                            "alternative_code": "AS",
                            "composition_method": "FLAT",
                            "name": "Additional Services",
                            "description": null,
                            "id": "C8321F0BCA8A4051857BC35CEEE41555",
                            "classification": "SERVICES",
                            "physical_good_type": null
                        },
                        "alternative_code": "S1",
                        "description": "Sports 1",
                        "id": "02191FFC231D4FBD844D0BB66EBAB14B"
                    },
                    "id": "E4077D4300EB4E36B094B038B0121A3A"
                }
            ],
            "description": null,
            "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": "45",
            "udf_float_3": null,
            "udf_float_4": null,
            "billing_state": "NOT_RATED",
            "id": "9AFE71B81BDE4F52B683A6420A3410DE",
            "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-21T11:27:18",
            "udf_string_6": null,
            "udf_string_7": null,
            "udf_string_8": null
        },
        "status":
        {
            "code": "OK",
            "description": "",
            "message": ""
        }
    }


...