Page Comparison

Tip
Available from CRM.COM R13.1.0

Excerpt
This method updates the Usage Allowance Limits of 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

Include Page

	V4:Web API - Updating Sets
	V4:Web API - Updating Sets

Note that the "action" : "update" cannot change the service, service type or service family, but only its usage allowance

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"
    },
 "block_services_not_included_in_usage_allowance_limits_settings":true,
 "percentage_of_allowed_exceeded_usage_limit":30,
 "accumulated_maximum_rated_amount_per_day":100,
 "accumulated_maximum_rated_amount_per_month":1000,
"accumulated_maximum_usage_per_date":10,
"accumulated_maximum_usage_per_month":25,
"accumulated_maximum_usage_per_transaction":5,
"usage_services_allowance":
    [
        {
        "action":"add",
        "service":{"code":"CREED"},
        "maximum_rated_amount_per_month":5
        }
        ,
        {
        "action":"update",
        "service":{"alternative_code":"EU"},
        "maximum_rated_amount_per_transaction":23
        }
            ,
        {
        "action":"remove",
        "service":{"code":"Exxon Petrol"}
        }
    ]    ,"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": 30,
            "accumulated_maximum_rated_amount_per_transaction": null,
            "usage_services_allowance": [
                {
                    "service_family": null,
                    "service_type": null,
                    "maximum_rated_amount_per_day": null,
                    "service": {
                        "code": "CREED",
                        "product_type": {
                            "service_type": "USAGE",
                            "used_for_provisioning": true,
                            "alternative_code": "V",
                            "udr_type": {
                                "unit_of_measurement": null,
                                "alternative_code": "V",
                                "name": "VOD",
                                "description": null,
                                "id": "B3CFC986221548279752B1ABC6F4C480"
                            },
                            "composition_method": "FLAT",
                            "name": "Usage Services",
                            "description": "Used for VOD , PPV, TELEPHONE CALLS ETC",
                            "id": "751C638AA3534B768408AAC4D73CF516",
                            "classification": "SERVICES",
                            "physical_good_type": null
                        },
                        "alternative_code": "C",
                        "description": "VOD: CREED",
                        "id": "A465D282F44C46AC834BAE50A81CA2F1"
                    },
                    "maximum_usage_per_transaction": null,
                    "maximum_rated_amount_per_month": "5.00",
                    "maximum_usage_per_day": null,
                    "maximum_rated_amount_per_transaction": null,
                    "maximum_usage_per_month": null
                },
                {
                    "service_family": null,
                    "service_type": null,
                    "maximum_rated_amount_per_day": null,
                    "service": {
                        "code": "Exxon Unleaded",
                        "product_type": {
                            "service_type": "USAGE",
                            "used_for_provisioning": false,
                            "alternative_code": "E2",
                            "udr_type": {
                                "unit_of_measurement": {
                                    "alternative_code": "L",
                                    "name": "Litre",
                                    "description": "Littres",
                                    "id": "A588A14FFA214303BD2182BCF6E9ACCF"
                                },
                                "alternative_code": "T",
                                "name": "Test",
                                "description": null,
                                "id": "C72DCF90AD66467388FA0B7725A24E21"
                            },
                            "composition_method": "FLAT",
                            "name": "Exxon",
                            "description": null,
                            "id": "ACA2649D85044264AADC31B5DB0BC567",
                            "classification": "SERVICES",
                            "physical_good_type": null
                        },
                        "alternative_code": "EU",
                        "description": "Exxon Unleaded",
                        "id": "3F174D8E87474A2AB115A2BFD2750FBB"
                    },
                    "maximum_usage_per_transaction": null,
                    "maximum_rated_amount_per_month": null,
                    "maximum_usage_per_day": "30",
                    "maximum_rated_amount_per_transaction": "23",
                    "maximum_usage_per_month": null
                }
            ],
            "block_services_not_included_in_usage_allowance_limits_settings": 1,
            "accumulated_maximum_usage_per_day": null,
            "accumulated_maximum_usage_per_month": "25",
            "accumulated_maximum_rated_amount_per_month": "1000",
            "currency": {
                "suffix_symbol": "N/A",
                "prefix_symbol": "€",
                "decimal_part_name": "cents",
                "code": "EUR",
                "integer_part_name": "euro",
                "id": "2"
            },
            "accumulated_maximum_rated_amount_per_day": "100",
            "accumulated_maximum_usage_per_transaction": "5"
        }
    },
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}

Versions Compared

Old Version 17

New Version 18

Key