Page Comparison

Tip
Available from CRM.COM R13.1.0
Tip
Deprecated from CRM.COM R17.0.0

Excerpt
This method removes (deletes) the usage allowance limits from an Accounts Receivable. Usage Allowance Limits can be removed from an Accounts Receivable only if the active Accounts Receivable Definitions allows it. A single Accounts Receivable is updated by each calla Subscription, allowing thus unrestricted usage consumption. A single Subscription is updated by each call

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivablesubscription_identifier

(mandatory)

Account Receivable IdentifierSubscription Identifier

The identifier of the

account receivable

subscription to be updated. The

allowed account receivable

allowed subscription identifier fields are the following:

Include Page

	V4:

accounts

subscription_

receivable_

identifier

_post


	V4:

accounts_receivable

subscription_identifier

_post

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

...

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:accountssubscription_receivable_complete
	V4:accounts_receivablesubscription_complete

Examples

Expand

title	Example 1

HTTP Method: POST

Request

Body

Code Block

language	javascript
theme	Confluence
linenumbers	true

{
  "token": "{{token}}",
 "accountssubscription_receivable_identifier" : {
     "number" : "ACR0000001526S0000009993"}
    }
    ,"fields_set":"usage_allowance_limits,name"
}

Response

Code Block
language	}

Response

Code Block

language	javascript
theme	Confluence
linenumbers	true

 {
    "data": {
        "namelog_information": "ACR0000001526{
 John CN UAL",         "usagecreated_allowanceby_limitsunit": {
                "percentage_of_allowed_exceeded_usage_limitalternative_code": null,"adminunit",
                "accumulated_maximum_rated_amount_per_transaction": nullgroup_name": "Main Group",
            "usage_services_allowance    "community_name": ["CommunityA",
                {
   "name": "Admin Unit",
                "service_familydescription": "admin nullunit",
                "id": "1"
   "service_type": null,        },
            "maximumupdated_rated_amount_per_dayby_unit": "100",
{
                   "service"alternative_code": {"adminunit",
                        "code": "Exxon Petrol"group_name": "Main Group",
                "community_name": "CommunityA",
      "product_type": {          "name": "Admin Unit",
                "service_typedescription": "USAGEadmin unit",
                "id": "1"
           "used_for_provisioning": false },
            "created_date": "2019-08-30T08:40:33",
              "alternative_code"updated_date": "E22019-09-03T08:17:52",
            "updated_by_user": {
                "udrperson_typename": {
          "CRM COM",
                     "unit_of_measurement"id": {"1",
                "email": "dev@crm.com",
                  "alternative_codeusername": "LMPAdministrator",
            },
                       "name"created_by_user": "Litre",{
                "person_name": "CRM  COM",
                "descriptionid": "Littres1",
                  "email": "dev@crm.com",
                 "idusername": "A588A14FFA214303BD2182BCF6E9ACCFMPAdministrator"
            }
        },
        "subscription_address": {
},            "country": {
                   "alternative_code": "TCYP",
                "three_character_code": "CYP",
                "name": "TestCYPRUS",
                "id": "181",
                "descriptiontwo_character_code": null,"CY"
                   },
            "idapartment_number": "C72DCF90AD66467388FA0B7725A24E21"null,
            "care_of": null,
              }"is_primary": true,
               "municipality": null,
            "composition_methodtype": "FLATBUSINESS",
            "udf_date_2": null,
              "name"udf_date_1": "Exxon"null,
            "udf_date_4": null,
              "descriptionstreet_name": null"Test",
            "udf_date_3": null,
              "id"udf_float_3": "ACA2649D85044264AADC31B5DB0BC567"null,
            "udf_float_4": null,
              "classification"udf_string_15": "SERVICES"null,
            "po_box_postal_code": null,
              "physicaludf_goodstring_type16": null,
            "udf_string_13": null,
             }"udf_string_14": null,
            "udf_string_11": null,
            "alternativeudf_string_code12": "EP"null,
            "id": "26FB447FD675451AA970EE4B5E5608E9",
            "descriptionudf_string_10": "Petrol"null,
            "udf_float_1": null,
            "idfloor": "E1EB6B2EBFC444A1BEA9A030A5B4D56D"null,
            "udf_float_2": null,
      },        "udf_string_2": null,
            "maximum_usage_per_transactionarea": null,
     
              "maximumudf_rated_amount_per_monthstring_3": null,
      
             "maximumudf_usagestring_per_day4": null,
    
               "maximumudf_rated_amount_per_transactionstring_5": null,
              "udf_string_1": null,
            "maximum_usage_per_monthpo_box": null,
            "town_city": null,
  },          "district": null,
     {       "street_number": "5",
            "servicepostal_familycode": null,
   
                "service_type"udf_string_6": null,
       
            "maximumudf_rated_amount_per_daystring_7": null,
            "udf_string_8": null,
      "service": {     "udf_string_9": null
         },
        "codeowned_by_group": {
"Exxon Unleaded",           "alternative_code": "MG",
            "product_typename": { "Main Group",
            "description": "Main Group ",
            "service_typeid": "USAGE1",
            "unified_code": "MG"
        },
      "used_for_provisioning  "custom_field_set": false[],
        "rating_state": "PENDING",
        "expiration_date": null,
        "alternativeudf_date_code2": "E2"null,
            "type": {
               "udr_type"udf_string_2": {null,
            "udf_string_3": null,
                  "unit_of_measurement"udf_string_4": {null,
                     "udf_string_5": null,
              "alternative_code": "Lnormalsub",
            "log_information": {
                "created_by_unit": {
    "name": "Litre",               "alternative_code": "adminunit",
                    "descriptiongroup_name": "LittresMain Group",
                    "community_name": "CommunityA",
              "id": "A588A14FFA214303BD2182BCF6E9ACCF"     "name": "Admin Unit",
                    "description": "admin unit",
  },                  "id": "1"
               "alternative_code": "T", },
                "updated_by_unit": {
                    "namealternative_code": "Testadminunit",
                    "group_name": "Main Group",
         "description": null,           "community_name": "CommunityA",
                    "idname": "C72DCF90AD66467388FA0B7725A24E21Admin Unit",
                            }"description": "admin unit",
                        "id": "1"
   "composition_method": "FLAT",            },
                "namecreated_date": "Exxon2016-01-28T19:07:27",
                "updated_date": "2019-05-16T09:05:25",
          "description": null,     "updated_by_user": {
                      "idperson_name": "ACA2649D85044264AADC31B5DB0BC567CRM COM",
       
                    "classificationid": "SERVICES1",
                    "email": "dev@crm.com",
      "physical_good_type": null             "username": "MPAdministrator"
          },        },
                "alternativecreated_by_codeuser": "EU",
{
                       "description"person_name": "ExxonCRM UnleadedCOM",
                        "id": "3F174D8E87474A2AB115A2BFD2750FBB1",
                     }"email": "dev@crm.com",
                    "maximum_usage_per_transactionusername": null,"MPAdministrator"
                }
   "maximum_rated_amount_per_month": null,        },
            "maximumudf_usagestring_per_day1": "30",
     null,
              "maximum_rated_amount_per_transaction"description": null,
      
             "maximumudf_usagedate_per_month2": null,
            "udf_date_1": null,
  }             ]"udf_date_4": null,
            "blockudf_services_not_included_in_usage_allowance_limits_settingsdate_3": 1null,
            "accumulatedudf_maximum_usage_per_dayfloat_3": null,
            "accumulatedudf_maximum_usage_per_monthfloat_4": null,
            "accumulated_maximum_rated_amount_per_monthname": "1000Normal",
            "currencyid": {
   "D1BAE6454A2248189EBCD7ADD3B4B65F",
            "suffixudf_string_symbol6": "N/A",null,
                 "prefix_symbol"udf_float_1": "€",
   null,
            "decimaludf_partstring_name7": "cents",
   null,
            "codeudf_float_2": "EUR"null,

               "integerudf_partstring_name8": null
"euro",        },
        "idudf_date_1": "2"null,
        "udf_date_4": null,
  },      "udf_date_3": null,
        "accumulatedinstalled_maximum_rated_amount_per_dayitems_set": [],
        "number": "S0000009993",
        "rated_up_to": null,
        "udf_float_3": null,
        "accumulatedudf_maximum_usage_per_transactionfloat_4": null,
        "installed_items_distribution_set": [],
        "first_activated_date": null,
        "termed_services_distribution_set": [
            {
                "subscription_service": {
                    "udf_float_13 ": null,
                    "udf_date_8 ": null,
                    "udf_date_4 ": null,
                    "udf_string_16 ": null,
                    "udf_float_2 ": null,
                    "udf_string_12 ": null,
                    "udf_float_6 ": null,
                    "udf_string_4 ": null,
                    "udf_string_8 ": null,
                    "first_activated_date": null,
                    "udf_date_12 ": null,
                    "id": "A8951180FDDF4D79A1D18BA788336C5A",
                    "udf_date_16 ": null,
                    "udf_float_14 ": null,
                    "udf_date_9 ": null,
                    "udf_string_15 ": null,
                    "udf_float_1 ": null,
                    "udf_float_10 ": null,
                    "udf_date_5 ": null,
                    "udf_string_11 ": null,
                    "udf_float_5 ": null,
                    "udf_date_1 ": null,
                    "rated_up_to_date": null,
                    "life_cycle_state": "DRAFT",
                    "udf_string_1 ": null,
                    "udf_float_9 ": null,
                    "udf_string_5 ": null,
                    "udf_string_9 ": null,
                    "udf_date_13 ": null,
                    "udf_float_15 ": null,
                    "udf_date_6 ": null,
                    "udf_string_14 ": null,
                    "udf_float_11 ": null,
                    "udf_date_2 ": null,
                    "rating_state": "PENDING",
                    "udf_string_10 ": null,
                    "udf_float_4 ": null,
                    "udf_string_2 ": null,
                    "mandatory": false,
                    "udf_float_8 ": null,
                    "udf_string_6 ": null,
                    "udf_date_10 ": null,
                    "service_bundle": null,
                    "udf_date_14 ": null,
                    "free": false,
                    "product": {
                        "code": "Bronze",
                        "product_type": {
                            "meter_reading_type": null,
                            "service_type": "TERMED",
                            "allowed_metadata_attribute_set": [],
                            "used_for_provisioning": true,
                            "alternative_code": "Main Packages",
                            "udr_type": null,
                            "composition_method": "FLAT",
                            "name": "Main Packages",
                            "description": null,
                            "id": "E186E293AAAB49EE86A729540A4287FE",
                            "classification": "SERVICES",
                            "physical_good_type": null
                        },
                        "alternative_code": "B",
                        "description": "Bronze",
                        "id": "F50CC52934BD4F119B6E18E215A4FC55",
                        "priority_level": null
                    },
                    "udf_float_16 ": null,
                    "udf_date_7 ": null,
                    "udf_float_3 ": null,
                    "udf_float_12 ": null,
                    "udf_date_3 ": null,
                    "udf_string_13 ": null,
                    "udf_float_7 ": null,
                    "udf_string_3 ": null,
                    "udf_string_7 ": null,
                    "udf_date_11 ": null,
                    "udf_date_15 ": null
                },
                "provisioning_distributor": {
                    "alternative_code": "I",
                    "name": "Irdeto",
                    "id": "EFD7B1E488C14614A12D1988F5211924"
                },
                "provisioning_distributor_labels": null,
                "id": "010EAF1F458A4814A6896436DF7305BE"
            }
        ],
        "id": "DEAEFCBC74B04DE9A0365F4E7784B9D7",
        "free": false,
        "udf_float_1": null,
        "billing_terms": {
            "payment_preference": null,
            "billing_term_scheme": {
                "billing_method": "PERIOD",
                "code": "Normal Billing Scheme",
                "name": "Normal Billing Scheme",
                "billing_type": "NORMAL",
                "id": "2CCA4F1A694E4BFFBBD2152AB33C3D35",
                "life_cycle_state": "EFFECTIVE",
                "classification": "SUBSCRIPTIONS"
            },
            "is_auto_renewed": true,
            "next_renewal_date": null,
            "expires_on": null,
            "expiration_date": null,
            "billing_frequency": {
                "code": "MONTHLY",
                "name": "Monthly"
            },
            "concurrent_usage_based_pricing": {
                "maximum_capacity": null,
                "concurrent_usage_billing_method": "BASED_ON_NUMBER_OF_INSTALLED_ITEMS"
            },
            "billing_cycle_day": 1,
            "agreement_date": "2019-08-01T00:00:00",
            "effective_date": "2019-08-30T00:00:00",
            "price_plan": null,
            "id": "F38CD070CE9F46ABAF0F55AC0EAA0354",
            "binding_information": {
                "end_date": "2020-08-30T00:00:00",
                "binding_period": {
                    "code": "ANNUAL",
                    "name": "Annual"
                },
                "state": "IN_BINDING",
                "start_date": "2019-08-30T00:00:00"
            }
        },
        "udf_float_2": null,
        "udf_string_2": null,
        "udf_string_3": null,
        "udf_string_4": null,
        "udf_string_5": null,
        "privacy_level": null,
        "udf_string_1": null,
        "termed_services_set": [
            {
                "udf_float_13 ": null,
                "udf_date_8 ": null,
                "udf_date_4 ": null,
                "udf_string_16 ": null,
                "udf_float_2 ": null,
                "udf_string_12 ": null,
                "udf_float_6 ": null,
                "udf_string_4 ": null,
                "udf_string_8 ": null,
                "first_activated_date": null,
                "udf_date_12 ": null,
                "id": "A8951180FDDF4D79A1D18BA788336C5A",
                "udf_date_16 ": null,
                "udf_float_14 ": null,
                "udf_date_9 ": null,
                "udf_string_15 ": null,
                "udf_float_1 ": null,
                "udf_float_10 ": null,
                "udf_date_5 ": null,
                "udf_string_11 ": null,
                "udf_float_5 ": null,
                "udf_date_1 ": null,
                "rated_up_to_date": null,
                "life_cycle_state": "DRAFT",
                "udf_string_1 ": null,
                "udf_float_9 ": null,
                "udf_string_5 ": null,
                "udf_string_9 ": null,
                "udf_date_13 ": null,
                "udf_float_15 ": null,
                "udf_date_6 ": null,
                "udf_string_14 ": null,
                "udf_float_11 ": null,
                "udf_date_2 ": null,
                "rating_state": "PENDING",
                "udf_string_10 ": null,
                "udf_float_4 ": null,
                "udf_string_2 ": null,
                "mandatory": false,
                "udf_float_8 ": null,
                "udf_string_6 ": null,
                "udf_date_10 ": null,
                "service_bundle": null,
                "udf_date_14 ": null,
                "free": false,
                "product": {
                    "code": "Bronze",
                    "product_type": {
                        "meter_reading_type": null,
                        "service_type": "TERMED",
                        "allowed_metadata_attribute_set": [],
                        "used_for_provisioning": true,
                        "alternative_code": "Main Packages",
                        "udr_type": null,
                        "composition_method": "FLAT",
                        "name": "Main Packages",
                        "description": null,
                        "id": "E186E293AAAB49EE86A729540A4287FE",
                        "classification": "SERVICES",
                        "physical_good_type": null
                    },
                    "alternative_code": "B",
                    "description": "Bronze",
                    "id": "F50CC52934BD4F119B6E18E215A4FC55",
                    "priority_level": null
                },
                "udf_float_16 ": null,
                "udf_date_7 ": null,
                "udf_float_3 ": null,
                "udf_float_12 ": null,
                "udf_date_3 ": null,
                "udf_string_13 ": null,
                "udf_float_7 ": null,
                "udf_string_3 ": null,
                "udf_string_7 ": null,
                "udf_date_11 ": null,
                "udf_date_15 ": null
            }
        ],
        "accounts_receivable": {
            "number": "ACR0000014201",
            "name": "ACR0000014201 Test  30082019_01",
            "id": "1B13777B4D4544F990615F4971F34A24",
            "life_cycle_state": "ACTIVE",
            "account_owner": {
                "company_profile": null,
                "company_name": null,
                "name": "Test  30082019_01",
                "last_name": "30082019_01",
                "id": "17DBA78EF932418F89FF9C241B5F0C28",
                "life_cycle_state": "FINANCIAL",
                "middle_name": null,
                "title": null,
                "type": "PERSON",
                "first_name": "Test",
                "demographics": {
                    "name_day": {
                        "month": null,
                        "day": null
                    },
                    "id_number": "30082019_01",
                    "passport_number_expiration_date": 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
                    },
                    "id_number_expiration_date": null,
                    "passport_number": null,
                    "social_security_number": null,
                    "id_issued_by_country": null,
                    "passport_issued_by_country": null
                }
            }
        },
        "life_cycle_state": "DRAFT",
        "expense_services_set": [],
        "udf_string_6": null,
        "udf_string_7": null,
        "udf_string_8": null
    },
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}

...

Versions Compared

Old Version 1

New Version Current

Key

Resource URL

Parameters

Response Data

Examples