Versions Compared

Old Version 9

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

Saved on

compared with

New Version 10

changes.mady.by.user Christina Georgiou (Unlicensed)

Saved on

Key

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

This method is ending the short term activation period of a specific subscription. This method can be applied only on subscription in Short Term Effective life cycle state. The method can be applied on a single subscription only

...

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:

Name

Type

Description

id 

(semi-optional)

String

The ID of subscription

number 

(semi-optional)

String

The number of subscription

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:

Name

Type

Description

id

(semi-optional)

String

The ID of the subscription action type

name

(semi-optional)

String

The name of the subscription action type

alternative_code

(semi-optional)

String

The alternative code of  the subscription action type

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:

Name

Type

Description

id

(semi-optional)

String

The ID of the subscription sub action type

name

(semi-optional)

String

The name of the subscription sub action type

alternative_code

(semi-optional)

String

The alternative code of  the subscription sub action type

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)

DateThe 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 answers to the question “from which date should I start billing this service) that is affected by the subscription action.

scheduled_date

(optional)

Date

The date that the action is scheduled to be executed. If not specified then the action will be executed immediately

Tip

Deprecated from CRM.COM R12.1.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

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

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

Request:

Body:

Code Block
themeConfluence
languagejavascript
linenumberstrue
 {
 "token": "D10FEF73C8094F4E87B592C142DAC91F",
 "subscription_identifier":{"id":"41C6A0AC2C9538DDED4B3CB25E72C6A7"}
}


Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
     {
       "status":
       {
           "message": null,
           "description": null,
           "code": "OK"
       },
       "data":
       {
           "scheduled_date": "2015-04-29T13:13:22",
           "action_type": null,
           "submitted_on": "2015-04-29T13:13:22",
           "sub_action_type": null,
           "business_classification_code": "END_SHORT_TERM_SUB_ACTIVATION",
           "number": "978",
           "executed_on": "2015-04-29T13:13:22",
           "life_cycle_state": "EXECUTED",
           "performed_by":
           {
               "person_name": "Marios Lannister",
               "username": "MPAdministrator",
               "id": "1"
           },
           "behavior_code": "END_SHORT_TERM_SUB_ACTIVATION",
           "submitted_by":
           {
               "person_name": "Marios Lannister",
               "username": "MPAdministrator",
               "id": "1"
           },
           "id": "0CBFEDF373E742608266CF04AA0D2D63",
           "subscription":
           {
               "accounts_receivable":
               {
                   "account_owner":
                   {
                       "last_name": "McMillan",
                       "life_cycle_state": "FINANCIAL",
                       "middle_name": null,
                       "company_profile": null,
                       "title": null,
                       "type": "PERSON",
                       "first_name": "Adrew",
                       "name": "Adrew McMillan",
                       "id": "403B55EA7311D3C9543C7D3B4D4682ED",
                       "company_name": null,
                       "demographics":
                       {
                           "gender": "MALE",
                           "passport_issued_by_country":
                           {
                               "name": "UNITED KINGDOM",
                               "id": "126"
                           },
                           "passport_number": "943030",
                           "social_security_number": "940321",
                           "country_of_residence":
                           {
                               "name": "UNITED KINGDOM",
                               "id": "126"
                           },
                           "industry_sector":
                           {
                               "name": "EDUCATION",
                               "id": "AF6E0855324153EAB8B582A277147BCE",
                               "alternative_code": "1"
                           },
                           "date_of_birth":
                           {
                               "month": 5,
                               "day": 8,
                               "year": 1982
                           },
                           "name_day":
                           {
                               "month": null,
                               "day": null
                           },
                           "id_number": "987908",
                           "id_issued_by_country":
                           {
                               "name": "UNITED KINGDOM",
                               "id": "126"
                           },
                           "industry":
                           {
                               "name": "Marketing",
                               "id": "31BC2070C79EAE5455BFAD41599C5190",
                               "code": "MK"
                           }
                       }
                   },
                   "life_cycle_state": "ACTIVE",
                   "number": "177",
                   "name": "Adrew McMillan Premium Account",
                   "id": "4607A5CE055BA55E2E0DDD6527EDA99B"
               },
               "life_cycle_state": "NOT_EFFECTIVE",
               "number": "S60143",
               "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,
                   "udf_string_1": null,
                   "name": "United Kingdom",
                   "udf_string_2": null,
                   "udf_string_3": null,
                   "udf_string_4": null,
                   "udf_string_5": null,
                   "udf_string_6": null,
                   "log_information":
                   {
                       "updated_date": "2015-02-20T16:40:42",
                       "created_by_unit":
                       {
                           "group_name": "Main Group",
                           "name": "Admin Unit",
                           "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                           "description": "r1",
                           "alternative_code": "MG"
                       },
                       "created_date": "2014-06-25T15:44:04",
                       "updated_by_unit":
                       {
                           "group_name": "Main Group",
                           "name": "Admin Unit",
                           "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                           "description": "r1",
                           "alternative_code": "MG"
                       }
                   },
                   "udf_string_7": null,
                   "udf_string_8": null,
                   "id": "1C81FBB1E5D90040F440ECE98D6A368D",
                   "description": "United Kingdom",
                   "alternative_code": "UK"
               },
               "id": "41C6A0AC2C9538DDED4B3CB25E72C6A7"
           },
           "performed_on": "2015-04-29T13:13:18"
       }
    }
Expand
titleExample 2

HTTP Method: POST

Request:

Body:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
	"token": {{token}},
	"subscription_identifier": {
    	"number"  : "S0000000008"
    },
    "action_type_identifier": {
    	"name": "END SHORT TERM ACTIVATION"
    },
    "sub_action_type_identifier": {
    	"name": "END SHORT TERM ACTIVATION"	
    },
    "performed_by_unit_identifier": {
    	"alternative_code": "UC"
    }
}


Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
    "data": {
        "performed_by": null,
        "action_type": {
            "alternative_code": "end_short_term_activation_action",
            "name": "END SHORT TERM ACTIVATION",
            "id": "E3BEA06A9D074764A8A8971E9AFC14EC"
        },
        "transaction_reference_number": null,
        "submitted_by": {
            "person_name": "CRM COM",
            "id": "1",
            "username": "MPAdministrator"
        },
        "executed_on": "2017-09-25T10:58:25",
        "life_cycle_state": "EXECUTED",
        "subscription": {
            "number": "S0000000008",
            "first_activated_date": "2016-02-09T13:15:55",
            "rating_state": "PENDING",
            "accounts_receivable": {
                "number": "ACR0000000009",
                "name": "NOVO CASA FOR PREPAID",
                "id": "67432618BF6B4D8099452E750A239750",
                "life_cycle_state": "ACTIVE",
                "account_owner": {
                    "company_profile": {
                        "tax_reference_number": "av123443556",
                        "registered_in_country": null,
                        "number_of_employees": null,
                        "annual_turnover": null,
                        "profile_year": 2000,
                        "registration_number": "sda21w123123",
                        "vat_registration_number": "2312321321",
                        "industry_sector": null,
                        "industry": null,
                        "established_date": null,
                        "vat_registered_by": null,
                        "vat_registration_date": null
                    },
                    "company_name": "NOVO CASA",
                    "name": "NOVO CASA",
                    "last_name": null,
                    "id": "76F9993673024885966C7B0B4DA20E29",
                    "life_cycle_state": "FINANCIAL",
                    "middle_name": null,
                    "title": null,
                    "type": "COMPANY",
                    "first_name": null,
                    "demographics": null
                }
            },
            "id": "57C9FA9E11DF47EAA6D9B0BD8FDD6280",
            "life_cycle_state": "NOT_EFFECTIVE",
            "type": {
                "alternative_code": "normalsub",
                "name": "Normal",
                "description": null,
                "id": "D1BAE6454A2248189EBCD7ADD3B4B65F"
            }
        },
        "scheduled_date": "2017-09-25T10:58:24",
        "performed_on": null,
        "sub_action_type": {
            "alternative_code": "end_short_term_act_subaction",
            "name": "END SHORT TERM ACTIVATION",
            "id": "59CEF2CF24154A12A060E32595CD74F1"
        },
        "business_classification_code": "END_SHORT_TERM_ACTIVATION",
        "number": "24307",
        "submitted_on": "2017-09-25T10:58:24",
        "id": "ED3519C6A32741DDABAD29AFB1B9418E",
        "job": null,
        "behavior_code": "END_SHORT_TERM_ACTIVATION",
        "performed_by_unit": {
            "alternative_code": "UC",
            "group_name": "Group C",
            "community_name": "Community C",
            "name": "Unit C",
            "description": null,
            "id": "79D99D242650451DBFB5AD5858D405FB"
        }
    },
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}