Page Comparison

Tip
Available from CRM.COM R13.1.0

Excerpt
This method adds Usage Allowance Limits to an accounts Receivable but only if the active Accounts Receivable Definition allows it. A single Accounts Receivable is updated by each call

...

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

(mandatory)

Account Receivable Identifier

The identifier of the account receivable to be updated. The allowed account receivable identifier fields are the following:

Include Page

	V4:accounts_receivable_identifier_post
	V4:accounts_receivable_identifier_post

block_services_not_included_in_usage_allowance_limits_settings

(optional)

Boolean

Defines if the account owner can only consume services for which a Usage Allowance Limit is specified

percentage_of_allowed_exceeded_usage_limit

(optional)

Number

The percentage of amount that the limit can be exceeded for the related accounts receivable

accumulated_maximum_rated_amount_per_day

(optional)

Number

The accumulated maximum rated amount that the accounts receivable is allowed to use within a day.

accumulated_maximum_rated_amount_per_month

(optional)

Number

The accumulated maximum rated amount that the accounts receivable is allowed to use within a month.

accumulated_maximum_rated_amount_per_transaction

(optional)

Number

The accumulated maximum rated amount that the accounts receivable is allowed to use per transaction.

accumulated_maximum_usage_per_day

(optional)

Number

The accumulated maximum usage amount that the accounts receivable is allowed to use within a day.

accumulated_maximum_usage_per_month

(optional)

Number

The accumulated maximum usage amount that the accounts receivable is allowed to use within a month.

accumulated_maximum_usage_per_transaction

(optional)

Number

The accumulated maximum usage amount that the accounts receivable is allowed to use per transaction.

usage_services_allowance

(optional)

Set of Usage Services Allowance objects

The usage allowance limits per usage service, service type or service family

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	javascript
linenumbers	true

{
  "token": "{{token}}",
 "accounts_receivable_identifier" : {
     "number" : "ACR0000001526"
    },
    "accumulated_maximum_rated_amount_per_day":50150.5,
    "usage_services_allowance":
    [
        {
        "action":"add",
        "service":{"code":"Serendipity"},
        "maximum_rated_amount_per_month":10
        }
        ,
        {
        "action":"add",
        "service_type":{"name":"Exxon"},
        "maximum_rated_amount_per_transaction":24
        }
            ,
        {
        "action":"add",
        "service_family":{"code":"CH"},
        "maximum_usage_per_transaction":2
        }
    ]
}

Response

Code Block

theme	Confluence
language	javascript
linenumbers	true

{        ,"fields_set":"usage_allowance_limits,name"
}

Response

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
    "data": {
        "name": "ACR0000001526 John CN UAL",
        "usage_allowance_limits": {
            "percentage_of_allowed_exceeded_usage_limit": null,
            "accumulated_maximum_rated_amount_per_transaction": null,
            "usage_services_allowance": [
                {
                    "service_family": null,
                    "service_type": null,
                    "maximum_rated_amount_per_day": null"100",
                    "service": {
                        "code": "SerendipityExxon Petrol",
                        "product_type": {
                            "service_type": "USAGE",
                            "used_for_provisioning": truefalse,
                            "alternative_code": "VE2",
                            "compositionudr_methodtype": "FLAT",{
                                "nameunit_of_measurement": "Usage{
Services",                             "description": "Used for VOD , PPV, TELEPHONE CALLS ETC "alternative_code": "L",
                            "id        "name": "751C638AA3534B768408AAC4D73CF516Litre",
                            "classification        "description": "SERVICESLittres",
                            "physical_good_type": null         "id": "A588A14FFA214303BD2182BCF6E9ACCF"
              },                  },
      "alternative_code": "S_1",                         "descriptionalternative_code": "VOD: Serendipity T",
                        "id": "BD3ACEE7D6244DCAA375D0744DA75540"        "name": "Test",
             },                     "maximum_usage_per_transaction"description": null,
                    "maximum_rated_amount_per_month": "10.00",            "id": "C72DCF90AD66467388FA0B7725A24E21"
             "maximum_usage_per_day": null,              },
      "maximum_rated_amount_per_transaction": null,                     "maximum_usage_per_monthcomposition_method": "FLAT",
null                 },           "name": "Exxon",
    {                        "service_familydescription": null,
                    "service_type": {        "id": "ACA2649D85044264AADC31B5DB0BC567",
                            "service_typeclassification": "USAGESERVICES",
                            "usedphysical_forgood_provisioningtype": false,null
                        "alternative_code": "E2"},
                        "udralternative_typecode": {"EP",
                            "unit_of_measurement"description": {"Petrol",
                        "id": "E1EB6B2EBFC444A1BEA9A030A5B4D56D"
       "alternative_code": "L",            },
                    "namemaximum_usage_per_transaction": "Litre"null,
                    "maximum_rated_amount_per_month": null,
          "description": "Littres",         "maximum_usage_per_day": null,
                      "id"maximum_rated_amount_per_transaction": "A588A14FFA214303BD2182BCF6E9ACCF"null,
                    "maximum_usage_per_month": null
      },          },
                  "alternative_code": "T",
       {
                    "nameservice_family": "Test",{
                            "descriptioncode": null"CH",
                            "idname": "C72DCF90AD66467388FA0B7725A24E21Channels",
                        }"description": null,
                        "composition_methodid": "FLAT5432773B865246E3B10A47CD130183C7",
                        "name": "Exxon",
 },
                      "descriptionservice_type": null,
                        "id"maximum_rated_amount_per_day": "ACA2649D85044264AADC31B5DB0BC567",
   null,
                    "classificationservice": "SERVICES"null,
                        "physical_good_type"maximum_usage_per_transaction": null"2",
                    },
 "maximum_rated_amount_per_month": null,
                    "maximum_rated_amountusage_per_day": null,
                    "servicemaximum_rated_amount_per_transaction": null,
                    "maximum_usage_per_transactionmonth": null,
                },
               "maximum_rated_amount_per_month": null, {
                    "maximum_usage_per_dayservice_family": null,
                    "maximum_rated_amount_per_transactionservice_type": "24.00"null,
                    "maximum_usagerated_amount_per_monthday": null,
                },    "service": {
           {             "code": "Exxon Unleaded",
     "service_family": null,                     "serviceproduct_type": null,{
                            "maximum_rated_amount_per_dayservice_type": null"USAGE",
                    "service        "used_for_provisioning": {false,
                            "alternative_code": "Exxon UnleadedE2",
                            "productudr_type": {
                            "service_type": "USAGE",    "unit_of_measurement": {
                                    "usedalternative_for_provisioningcode": false,"L",
                                    "alternative_codename": "E2Litre",
                                    "udr_typedescription": {"Littres",
                                    "unit_of_measurementid": "A588A14FFA214303BD2182BCF6E9ACCF"
{                                },
                                "alternative_code": "LT",
                                    "name": "LitreTest",
  
                                 "description": "Littres",
  null,
                                 "id": "A588A14FFA214303BD2182BCF6E9ACCFC72DCF90AD66467388FA0B7725A24E21"
   
                            },
   
                            "alternativecomposition_codemethod": "TFLAT",
                                "name": "TestExxon",
                                "description": null,
                                "id": "C72DCF90AD66467388FA0B7725A24E21ACA2649D85044264AADC31B5DB0BC567",
                            },"classification": "SERVICES",
                            "compositionphysical_good_methodtype": "FLAT",null
                            "name": "Exxon"},
                            "description"alternative_code": null,
   "EU",
                        "iddescription": "ACA2649D85044264AADC31B5DB0BC567Exxon Unleaded",
  
                         "classificationid": "SERVICES3F174D8E87474A2AB115A2BFD2750FBB",
                    },
       "physical_good_type": null            "maximum_usage_per_transaction": null,
           },         "maximum_rated_amount_per_month": null,
               "alternative_code     "maximum_usage_per_day": "EU30",
                        "description"maximum_rated_amount_per_transaction": "Exxon Unleaded",
   null,
                    "idmaximum_usage_per_month": "3F174D8E87474A2AB115A2BFD2750FBB"
  null
                 },
                {
   "maximum_usage_per_transaction": null,                     "maximum_rated_amount_per_month"service_family": null,
                    "maximum_usage_per_dayservice_type": "30",{
                        "maximum_rated_amount_per_transactionservice_type": null"USAGE",
                        "maximumused_usagefor_per_monthprovisioning": nullfalse,
                },        "alternative_code": "E2",
       {                     "serviceudr_familytype": {
null,                     "service_type       "unit_of_measurement": null,{
                    "maximum_rated_amount_per_day": "100",             "alternative_code": "L",
       "service": {                         "codename": "Exxon PetrolLitre",
                          "product_type      "description": {"Littres",
                                "service_typeid": "USAGEA588A14FFA214303BD2182BCF6E9ACCF",
                            "used_for_provisioning": false},
                            "alternative_code": "E2T",
                            "udr_typename": {"Test",
                                "unit_of_measurement"description": {null,
                                    "alternative_code"id": "LC72DCF90AD66467388FA0B7725A24E21",
                        },
           "name": "Litre",            "composition_method": "FLAT",
                        "descriptionname": "LittresExxon",
                        "description": null,
          "id": "A588A14FFA214303BD2182BCF6E9ACCF"             "id": "ACA2649D85044264AADC31B5DB0BC567",
                  },      "classification": "SERVICES",
                         "alternativephysical_good_codetype": "T",null
                    },
           "name": "Test",            "maximum_rated_amount_per_day": null,
                    "descriptionservice": null,
                                "id"maximum_usage_per_transaction": "C72DCF90AD66467388FA0B7725A24E21"null,
                     "maximum_rated_amount_per_month": null,
       },             "maximum_usage_per_day": null,
                    "composition_methodmaximum_rated_amount_per_transaction": "FLAT24",
                    "maximum_usage_per_month": null
        "name": "Exxon",       },
                {
    "description": null,               "service_family": null,
            "id": "ACA2649D85044264AADC31B5DB0BC567",       "service_type": null,
                    "classificationmaximum_rated_amount_per_day": "SERVICES"null,
                            "physical_good_type"service": null{
                        }"code": "Serendipity",
                        "alternativeproduct_codetype": "EP",{
                            "descriptionservice_type": "PetrolUSAGE",
                        "id": "E1EB6B2EBFC444A1BEA9A030A5B4D56D"            "used_for_provisioning": true,
        },                     "maximum_usage_per_transactionalternative_code": null"V",
                    "maximum_rated_amount_per_month": null,       "udr_type": {
            "maximum_usage_per_day": null,                     "maximumunit_rated_amount_per_transactionof_measurement": null,
                    "maximum_usage_per_month": null             "alternative_code": "V",
   },                 {            "name": "VOD",
       "service_family": {                         "codedescription": "CH"null,
                        "name        "id": "ChannelsB3CFC986221548279752B1ABC6F4C480",
                           "description": null},
                            "idcomposition_method": "5432773B865246E3B10A47CD130183C7FLAT",
                    },        "name": "Usage Services",
          "service_type": null,                 "description": "Used for VOD , PPV, TELEPHONE CALLS ETC",
                            "id": "751C638AA3534B768408AAC4D73CF516",
                            "classification": "SERVICES",
                            "physical_good_type": null
                        },
                        "alternative_code": "S_1",
                        "description": "VOD: Serendipity ",
                        "id": "BD3ACEE7D6244DCAA375D0744DA75540"
                    },
                    "maximum_usage_per_transaction": null,
                    "maximum_rated_amount_per_month": "10",
                    "maximum_ratedusage_amount_per_day": null,
                    "servicemaximum_rated_amount_per_transaction": null,
                    "maximum_usage_per_transactionmonth": "2.00",null
                }
           "maximum_rated_amount_per_month": null ],
            "block_services_not_included_in_usage_allowance_limits_settings": 1,
               "accumulated_maximum_usage_per_day": null,
     
              "accumulated_maximum_ratedusage_amount_per_transactionmonth": null,

                   "maximum_usage"accumulated_maximum_rated_amount_per_month": "1000",
null            "currency": {
   }              ]"suffix_symbol": "N/A",
                "block_services_not_included_in_usage_allowance_limits_settingsprefix_symbol": 1"€",
                "accumulateddecimal_maximum_usage_per_daypart_name": null"cents",
            "accumulated_maximum_usage_per_month    "code": null,"EUR",
                "accumulatedinteger_maximum_rated_amount_per_monthpart_name": null"euro",
                "currencyid": null "2"
            },
            "accumulated_maximum_rated_amount_per_day": "150.505",
            "accumulated_maximum_usage_per_transaction": null
        }
    },
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}

Versions Compared

Old Version 17

New Version 18

Key