Versions Compared

Key

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

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

This method is setting a draft or a not effective subscription in short-term activation period. The method can be applied on a single subscription only

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:

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)

...

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:

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)

...

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

...

end_short_term_activation_on

(semi-optional)

...

end_short_term_activation_after_specific_days

(semi-optional)

...

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:

Name

Type

Description

id

(semi-optional)

String

The ID of the user

username

(semi-optional)

String

The username of the user

...

performed_on

(optional)

...

billing_effective_date

(optional)

...

billable_period_start_date

(optional)

...

scheduled_date

(optional)

...

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

 

...

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

 

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.

Response Data

...

Examples

...

titleExample 1

HTTP Method: POST

Request:

Body:

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

Response:

...

themeConfluence
languagejavascript
linenumberstrue

...


Excerpt

This method is setting a draft or a not effective subscription in short-term activation period. The method can be applied on a single subscription only

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:

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


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:

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


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


end_short_term_activation_on

(semi-optional)

DateThe date that the short term activation period should end. End short term activation on date is mandatory unless end short term activation after specific days is specified. It is not allowed to specify both information

end_short_term_activation_after_specific_days

(semi-optional)

NumberIt defines the date that the short term activation period should end, based on the date that the subscription will go into short term activation and the specified number of days. End short term activation after specific days is mandatory unless end short term activation on date is specified. It is not allowed to specify both information

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:

Name

Type

Description

id

(semi-optional)

String

The ID of the user

username

(semi-optional)

String

The username of the user


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)

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


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


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.

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": "D10FEF73C8094F4E87B592C142DAC91F",
 "subscription_identifier":{"id":"41C6A0AC2C9538DDED4B3CB25E72C6A7"},
 "end_short_term_activation_after_specific_days":3
}


Response:

Code Block
languagejavascript
themeConfluence
linenumberstrue
     {
       "status":
       {
           "message": null,
           "description": null,
           "code": "OK"
       },
       "data":
       {
           "scheduled_date": "2015-04-29T13:10:53",
           "action_type": null,
           "submitted_on": "2015-04-29T13:10:53",
           "sub_action_type": null,
           "business_classification_code": "SHORT_TERM_SUB_ACTIVATION",
           "number": "977",
           "executed_on": "2015-04-29T13:11:19",
           "life_cycle_state": "EXECUTED",
           "performed_by":
           {
               "person_name": "Marios Lannister",
               "username": "MPAdministrator",
               "id": "1"
           },
           "behavior_code": "SHORT_TERM_SUB_ACTIVATION",
           "submitted_by":
           {
               "person_name": "Marios Lannister",
               "username": "MPAdministrator",
               "id": "1"
           },
           "id": "6E88A0D028EE44908DA5599DFE1B95BB",
           "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
                           },
              "message": null,            "descriptionname_day": null,
           "code": "OK"        },        "data": {
      {            "scheduled_date": "2015-04-29T13:10:53",            "action_typemonth": null,
           "submitted_on": "2015-04-29T13:10:53",            "sub_action_type": null,      "day": null
    "business_classification_code": "SHORT_TERM_SUB_ACTIVATION",            "number": "977",         },
  "executed_on": "2015-04-29T13:11:19",            "life_cycle_state": "EXECUTED",            "performedid_bynumber": "987908",
           {                "person_nameid_issued_by_country":
"Marios Lannister",                "username": "MPAdministrator",         {
      "id": "1"            },            "behavior_codename": "SHORT_TERM_SUB_ACTIVATION",
      UNITED KINGDOM",
    "submitted_by":            {                "person_nameid": "Marios Lannister126",
               "username": "MPAdministrator",           },
    "id": "1"            },
           "idindustry":
"6E88A0D028EE44908DA5599DFE1B95BB",               "subscription":            {
                 "accounts_receivable":              "name": "Marketing",
{                    "account_owner":           "id": "31BC2070C79EAE5455BFAD41599C5190",
       {                        "last_namecode": "McMillanMK",
  
                    "life_cycle_state": "FINANCIAL",      }
                 "middle_name": null,     }
                  "company_profile": null,
    },
                   "titlelife_cycle_state": null,
   "ACTIVE",
                   "typenumber": "PERSON177",
   
                   "first_name": "Adrew", McMillan Premium  Account",
                   "nameid": "Adrew McMillan","4607A5CE055BA55E2E0DDD6527EDA99B"
               },
               "idlife_cycle_state": "403B55EA7311D3C9543C7D3B4D4682ED"SHORT_TERM_EFFECTIVE",
      
                "company_namenumber": null"S60143",
               "type":
       "demographics":        {
               {      "udf_float_1": null,
                     "gender"udf_float_2": "MALE",
       null,
                   "passportudf_issueddate_by_country1": null,
                   "udf_float_3": null,
      {             "udf_date_2": null,
                   "nameudf_float_4": "UNITED KINGDOM"null,
                   "udf_date_3": null,
          "id": "126"        "udf_date_4": null,
                  },
        "udf_string_1": null,
                   "passport_numbername": "943030United Kingdom",
   
                       "socialudf_securitystring_number2": "940321"null,
                           "country_of_residence"udf_string_3": null,
                   "udf_string_4": null,
     {              "udf_string_5": null,
                   "nameudf_string_6": "UNITED KINGDOM"null,
                   "log_information":
           "id": "126"       {
                    },   "updated_date": "2015-02-20T16:40:42",
                       "industrycreated_by_sectorunit":
                           {
 
                             "group_name": "EDUCATIONMain Group",
  
                            "idname": "AF6E0855324153EAB8B582A277147BCEAdmin Unit",
   
                           "alternative_codeid": "148305F8849E3C18B227C5BE3A27BA6DF",
                           }"description": "r1",
                           "datealternative_of_birthcode": "MG"
                       },
  {                     "created_date": "2014-06-25T15:44:04",
          "month": 5,            "updated_by_unit":
                   "day": 8,   {
                           "group_name": "year": 1982Main Group",
                           "name": "Admin }Unit",
                           "name_dayid": "48305F8849E3C18B227C5BE3A27BA6DF",
                          {    "description": "r1",
                           "monthalternative_code": null,"MG"
                       }
       "day": null           },
                },       "udf_string_7": null,
                    "idudf_string_number8": "987908",
      null,
                    "id_issued_by_country":   "1C81FBB1E5D90040F440ECE98D6A368D",
                   "description": "United Kingdom",
  {                 "alternative_code": "UK"
             "name": "UNITED KINGDOM"},
               "id": "41C6A0AC2C9538DDED4B3CB25E72C6A7"
           },
  "id": "126"         "performed_on": "2015-04-29T13:10:47"
       }
    }



Expand
titleExample 2

HTTP Method: POST

Request:

Body:

Code Block
languagejavascript
themeConfluence
linenumberstrue
{
      	"token": {{token}},
	"subscription_identifier": {
    	"number"  : "S0000000008"
    },
       "end_short_term_activation_after_specific_days": 1,
    "industryperformed_by_unit_identifier": {
    	"alternative_code": "UA"
        }
}


Response:

Code Block
languagejavascript
themeConfluence
linenumberstrue
{
    "data": {
     {   "performed_by": null,
              "action_type": {
            "namealternative_code": "Marketingshort_term_activation_action",
            "name": "SHORT     TERM ACTIVATION",
            "id": "31BC2070C79EAE5455BFAD41599C51905E9403290A5B4EDA9C1247F09C2B6ADE",
                },
              "code": "MK"
        "transaction_reference_number": null,
        "submitted_by": {
        }    "person_name": "CRM COM",
            "id": "1",
   }           "username": "MPAdministrator"
        },
        "executed_on": "2017-09-25T10:33:25",
         "life_cycle_state": "ACTIVEEXECUTED",
        "subscription": {
            "number": "177S0000000008",
                   "name"first_activated_date": "Adrew McMillan Premium Account",
      2016-02-09T13:15:55",
            "idrating_state": "4607A5CE055BA55E2E0DDD6527EDA99BPENDING",
               },"accounts_receivable": {
                "life_cycle_statenumber": "SHORT_TERM_EFFECTIVEACR0000000009",
                "numbername": "S60143NOVO CASA FOR PREPAID",
                "typeid": "67432618BF6B4D8099452E750A239750",
              {  "life_cycle_state": "ACTIVE",
                "udfaccount_float_1owner": {
null,                    "udfcompany_float_2": null,profile": {
                        "udftax_datereference_1number": null,"av123443556",
                        "udfregistered_floatin_3country": null,
                        "udfnumber_dateof_2employees": null,
                        "udfannual_float_4turnover": null,
                        "udfprofile_date_3year": null2000,
                        "udfregistration_date_4number": null,"sda21w123123",
                        "udfvat_string_1": null,registration_number": "2312321321",
                        "nameindustry_sector": "United Kingdom", null,
                        "udf_string_2industry": null,
                        "udfestablished_string_3date": null,
                        "udfvat_stringregistered_4by": null,
                        "udfvat_stringregistration_5date": null,
                   "udf_string_6": null },
                    "logcompany_informationname": "NOVO CASA",
                  {  "name": "NOVO CASA",
                    "updatedlast_datename": "2015-02-20T16:40:42",
  null,
                    "created_by_unitid": "76F9993673024885966C7B0B4DA20E29",
                      {
      "life_cycle_state": "FINANCIAL",
                    "groupmiddle_name": "Main Group",
      null,
                    "nametitle": "Admin Unit",
      null,
                    "idtype": "48305F8849E3C18B227C5BE3A27BA6DFCOMPANY",
  
                        "description"first_name": "r1"null,
                    "demographics": null
     "alternative_code": "MG"           }
            },
            "id": "57C9FA9E11DF47EAA6D9B0BD8FDD6280",
            "createdlife_cycle_datestate": "2014-06-25T15:44:04",SHORT_TERM_EFFECTIVE",
            "type": {
                "updatedalternative_by_unitcode": "normalsub",
                "name": "Normal",
     {           "description": null,
                "group_nameid": "D1BAE6454A2248189EBCD7ADD3B4B65F"Main
  Group",          }
        },
        "namescheduled_date": "Admin Unit2017-09-25T10:33:25",
        "performed_on": null,
        "sub_action_type": {
            "idalternative_code": "48305F8849E3C18B227C5BE3A27BA6DFshort_term_activation_subaction",
            "name": "SHORT TERM ACTIVATION",
            "descriptionid": "r1094F08F32D1B4B2CA5A75D40875603FF",
         },
                 "alternative"business_classification_code": "MGSHORT_TERM_ACTIVATION",
        "number": "24305",
        "submitted_on": "2017-09-25T10:33:25",
   }     "id": "54C41D6ED5264A318BF54933CBC5E3FA",
             }"job": null,
        "behavior_code": "SHORT_TERM_ACTIVATION",
         "udfperformed_stringby_7unit": null,{
            "alternative_code": "UA",
     "udf_string_8": null,      "group_name": "GroupA",
            "idcommunity_name": "1C81FBB1E5D90040F440ECE98D6A368DCommunityA",
            "name": "Unit A",
    "description": "United Kingdom",      "description": null,
            "alternative_codeid": "UK72CD6EBE88E541CA879BBA9ECBA11E68"
          }
    },
    "status":  {
        "idcode": "41C6A0AC2C9538DDED4B3CB25E72C6A7OK",
           }"description": "",
           "performed_on"message": "2015-04-29T13:10:47"
       }
   
}