Page Comparison

...

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

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)

...

accumulated_maximum_rated_amount_per_uot

(optional)

...

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

Tip
Available from CRM.COM R14.2.0

...

rated_amount_uot_value

(mandatory on conditions)

...

The UOT value of the accumulated maximum rated amount per X UOT. Mandatory if accumulated_maximum_rated_amount_per_uot is provided

Tip
Available from CRM.COM R14.2.0

...

rated_amount_uot

(mandatory on conditions)

...

The UOT of the accumulated maximum rated amount per X UOT. Mandatory if accumulated_maximum_rated_amount_per_uot is provided. Available options are:

...

Tip
Available from CRM.COM R13.1.0

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

Resource URL

Parameters

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.

2

4.0

accumulated_maximum

percentage_of_allowed_exceeded_usage_

per_day

limit

(optional)

Number

The

accumulated maximum usage

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

is allowed to use within a day.

accumulated_maximum_rated_

usage

amount_per_

month

day

(optional)

Number

The accumulated maximum

usage

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

month

day.

accumulated_maximum_rated_

usage

amount_per_

transaction

month

(optional)

Number

The accumulated maximum

usage

rated amount that the accounts receivable is allowed to use

per transaction

within a month.

accumulated_maximum_

usage

rated_amount_per_

uot

transaction

(optional)

Number

The accumulated maximum

usage

rated amount that the accounts receivable is allowed to use per

X UOT.

Tip
Available from CRM.COM R14.2.0

usage_uot_value

(mandatory on conditions

transaction.

accumulated_maximum_usage_per_day

(optional)

Number

The

UOT value of the

accumulated maximum usage

per X UOT. Mandatory if

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

accumulated_maximum_usage_per_

uot is provided

Tip
Available from CRM.COM R14.2.0

usage_uot

(mandatory on conditions)

String The UOT of the accumulated maximum usage per X UOT. Mandatory if

month

(optional)

Number

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

accumulated_maximum_usage_per_

uot is provided. Available options are:

DAYS
WEEKS
MONTHS

TipAvailable from CRM.COM R14.2.0

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

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_add referred objects
	accounts_receivable_usage_allowance_limits_add referred objects

Referred Objects Response Data

...

Expand

title	Example 1

HTTP Method: POST

Request

Body

Code Block

language	javascript
theme	Confluence	language	javascript
linenumbers	true

{
  "token": "{{token}}",
 "accounts_receivable_identifier" : {
     "number" : "ACR0000001526"
    },
    "accumulated_maximum_rated_amount_per_day":150.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
        }
    ]
        ,"fields_set":"usage_allowance_limits,name"
}

Response

Code Block

language	javascript
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": "100",
                    "service": {
                        "code": "Exxon Petrol",
                        "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": "EP",
                        "description": "Petrol",
                        "id": "E1EB6B2EBFC444A1BEA9A030A5B4D56D"
                    },
                    "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
                },
                {
                    "service_family": {
                        "code": "CH",
                        "name": "Channels",
                        "description": null,
                        "id": "5432773B865246E3B10A47CD130183C7"
                    },
                    "service_type": null,
                    "maximum_rated_amount_per_day": null,
                    "service": null,
                    "maximum_usage_per_transaction": "2",
                    "maximum_rated_amount_per_month": null,
                    "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": null,
                    "maximum_usage_per_month": null
                },
                {
                    "service_family": null,
                    "service_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
                    },
                    "maximum_rated_amount_per_day": null,
                    "service": null,
                    "maximum_usage_per_transaction": null,
                    "maximum_rated_amount_per_month": null,
                    "maximum_usage_per_day": null,
                    "maximum_rated_amount_per_transaction": "24",
                    "maximum_usage_per_month": null
                },
                {
                    "service_family": null,
                    "service_type": null,
                    "maximum_rated_amount_per_day": null,
                    "service": {
                        "code": "Serendipity",
                        "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": "S_1",
                        "description": "VOD: Serendipity ",
                        "id": "BD3ACEE7D6244DCAA375D0744DA75540"
                    },
                    "maximum_usage_per_transaction": null,
                    "maximum_rated_amount_per_month": "10",
                    "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,
            "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": "150.5",
            "accumulated_maximum_usage_per_transaction": null
        }
    },
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}

...

Versions Compared

Old Version 19

New Version Current

Key

Resource URL

Parameters

Resource URL

Parameters