Page Comparison

...

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

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

(mandatory)

...

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

...

block_services_not_included_in_usage_allowance_limits_settings

(optional)

...

percentage_of_allowed_exceeded_usage_limit

(optional)

...

accumulated_maximum_rated_amount_per_day

(optional)

...

accumulated_maximum_rated_amount_per_month

(optional)

...

accumulated_maximum_rated_amount_per_transaction

(optional)

...

Tip
Available from CRM.COM R13.1.0

Tip
Deprecated from CRM.COM R17.0.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

Resource URL

Parameters

HTTP Method: POST

Request

Body

Code Block

theme	Confluence
language	javascript
linenumbers	true

Response

Code Block

theme	Confluence
language	javascript
linenumbers	true

...

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

block_usage_consumption_when_all_amounts_exceed_credit_limit

(optional)

Boolean

Defines if the usage consumption will be blocked in cases where the billed and un-billed amounts exceed the account's allowed credit limit

Tip
Available from CRM.COM R14.4.0

percentage_of_allowed_exceeded_usage_limit

(optional)

Number

The

accumulated maximum usage

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_

usage

amount_per_month

(optional)

Number

The accumulated maximum

usage

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

accumulated_maximum_rated_

usage

amount_per_transaction

(optional)

Number

The accumulated maximum

usage

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

accumulated_maximum_usage_

services

per_

allowance

day

(optional)

Set of Usage Services Allowance objects

Number

The

usage allowance limits per usage service, service type or service family Include PageV4:Web API - Updating SetsV4: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

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

accumulated_maximum_usage_per_month

(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

...

Restrictions

It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified
It is mandatory to specify one of the semi-optional on conditions parameters, only if one of the semi-optional parameters is specified. There is no limit of how many of those parameters is allowed to specified

Response Data

...

Examples

...

title	Example 1

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

usage_allowance_organisational_units_set

(optional)

Set of Usage Allowance Organisational Units object

The usage allowance organisational units

Tip
Available from CRM.COM R14.4.0

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

Anchor

	accounts_receivable_usage_allowance_limits_modify referred objects
	accounts_receivable_usage_allowance_limits_modify referred objects

Referred Objects Response Data

Include Page

	V4:usage_allowance_limits_parameter
	V4:usage_allowance_limits_parameter

Include Page

	usage_allowance_organisational_parameter
	usage_allowance_organisational_parameter

Restrictions

It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified
It is mandatory to specify one of the semi-optional on conditions parameters, only if one of the semi-optional parameters is specified. There is no limit of how many of those parameters is allowed to specified

Response Data

Include Page

	V4:accounts_receivable_complete
	V4:accounts_receivable_complete

Examples

Expand

title	Example 1

HTTP Method: POST

Request

Body

Code Block

linenumbers

theme	Confluence
language	javascript		true

Response

language

theme	Confluence
javascript	linenumbers	true

Expand

title	Example 3

HTTP Method: POST

Request

Body

Code Block

theme	Confluence
language	javascript
linenumbers	true

Response

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_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

language	javascript
theme	Confluence
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": ""
    }
}

Expand

title	Example 2

HTTP Method: POST

Request

Body

Code Block

language	javascript
theme	Confluence
linenumbers	true

{
  "token": "{{token}}",
 "accounts_receivable_identifier" : {
     "number" : "ACR0000002670"
    },
 "block_usage_consumption_when_all_amounts_exceed_credit_limit":false,
"usage_allowance_organisational_units_set":
	[
		{
		"action":"remove",
		"usage_allowance_organisational_unit_identifier":{"unit_identifier":{"name":"Addidas"}}
		}
		,
		{
		"action":"add",
		"unit_identifier":{"name":"Adidas 2"}
		}
	]
    ,"fields_set":"usage_allowance_limits"
}

Response

Code Block

language	javascript
theme	Confluence
linenumbers	true

{
    "data": {
        "usage_allowance_limits": {
            "percentage_of_allowed_exceeded_usage_limit": null,
            "usage_allowance_organisational_units": [
                {
                    "group": {
                        "alternative_code": "4321",
                        "community_name": "CommunityB",
                        "name": "44444444444444444444444444",
                        "description": null,
                        "id": "BFB82D5BC03C4013860AA671A0A8063B"
                    }
                },
                {
                    "community": {
                        "alternative_code": "C_2",
                        "name": "CommunityB",
                        "description": null,
                        "id": "46D9FC6FD87E45439A1D26400B0DF47C"
                    }
                },
                {
                    "unit": {
                        "alternative_code": "A2",
                        "group_name": "Addidas",
                        "community_name": "Internal",
                        "name": "Adidas 2",
                        "description": null,
                        "id": "7FB4B0192501487D898CE76B239BEA4E"
                    }
                }
            ],
            "accumulated_maximum_rated_amount_per_transaction": null,
            "usage_services_allowance": [
                {
                    "service_family": null,
                    "service_type": null,
                    "maximum_rated_amount_per_day": null,
                    "service": {
                        "code": "Exxon Unleaded",
                        "product_type": {
                            "meter_reading_type": null,
                            "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": "Desc",
                            "id": "ACA2649D85044264AADC31B5DB0BC567",
                            "classification": "SERVICES",
                            "physical_good_type": null
                        },
                        "alternative_code": "EU",
                        "description": "Exxon Unleaded",
                        "id": "3F174D8E87474A2AB115A2BFD2750FBB",
                        "priority_level": null
                    },
                    "maximum_usage_per_transaction": null,
                    "maximum_rated_amount_per_month": null,
                    "maximum_usage_per_day": "50",
                    "maximum_rated_amount_per_transaction": null,
                    "maximum_usage_per_month": null
                },
                {
                    "service_family": null,
                    "service_type": null,
                    "maximum_rated_amount_per_day": "1.86264514923095693E+24",
                    "service": {
                        "code": "Exxon Petrol",
                        "product_type": {
                            "meter_reading_type": null,
                            "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": "Desc",
                            "id": "ACA2649D85044264AADC31B5DB0BC567",
                            "classification": "SERVICES",
                            "physical_good_type": null
                        },
                        "alternative_code": "EP",
                        "description": "Petrol",
                        "id": "E1EB6B2EBFC444A1BEA9A030A5B4D56D",
                        "priority_level": null
                    },
                    "maximum_usage_per_transaction": null,
                    "maximum_rated_amount_per_month": null,
                    "maximum_usage_per_day": null,
                    "maximum_rated_amount_per_transaction": null,
                    "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": null,
            "block_usage_consumption_when_all_amounts_exceed_credit_limit": 0,
            "accumulated_maximum_rated_amount_per_month": "1.86264514923095714E+25",
            "currency": {
                "suffix_symbol": "N/A",
                "prefix_symbol": "£",
                "decimal_part_name": "pence",
                "code": "GBP",
                "integer_part_name": "pound",
                "id": "9",
                "life_cycle_state": "EFFECTIVE"
            },
            "accumulated_maximum_rated_amount_per_day": null,
            "accumulated_maximum_usage_per_transaction": null
        }
    },
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}

Versions Compared

Old Version 14

New Version Current

Key

Resource URL

Parameters

Resource URL

Parameters

Restrictions

Response Data

Examples

Restrictions

Response Data

Examples