...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
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)
...
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
...
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 |
---|
HTTP Method: POST
Request
Body
...
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:
| ||||||
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
| ||||||
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 |
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
...
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. | ||
(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
| ||
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 | ||||
---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
|
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 | ||||
---|---|---|---|---|
|
Examples
Expand | |||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||
HTTP Method: POST Request Body
Response
Response
|
...