You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 6
Next »
This method updates the usage allowance limits of an Accounts Receivable. 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: Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the accounts receivable | number (semi-optional) | String | The number of the accounts receivable | name (semi-optional) | String | The name of the accounts receivable | access_token_identifier (semi-optional) | Access Token Identifier | The identifier of the access token which is related with the accounts receivable. Only effective access tokens can be used to identify an accounts receivable. The allowed access token identifier fields are the following Name | Type | Description |
|---|
authentication_code (semi-optional) | String | The authentication code of the access token | identifier (semi-optional) | String | The identifier of the access token. If the identifier is specified then it will be validated against the specified pass code | pass_code (mandatory on conditions) | String | The pass code of the access token, which is applicable and mandatory if the identifier is specified | one_time_password (semi-optional) | Integer | The one-time password (OTP) of the access token |
|
|
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_date (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 |
Referred Objects Response Data
usage_allowance_limits object parameter data
| | |
|---|
service (semi-optional) | Product Identifier | The product related with the usage allowance limit. The allowed service identifier fields are the following: Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the product | code (semi-optional) | String | The code of the product | alternative_code (semi-optional) | String | The alternative code of the product |
|
service_type (semi-optional) | Product Type Identifier | The product type related with the usage allowance limit. The allowed service type identifier fields are the following: Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the product type | name (semi-optional) | String | The name of the product type | alternative_code (semi-optional) | String | The alternative code of a product type |
|
service_family (semi-optional) | Product Family Identifier | The product family related with the usage allowance limit. The allowed service family identifier fields are the following: Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the product family | name (semi-optional) | String | The name of the product family | code (semi-optional) | String | The code of a product family |
|
maximum_rated_amount_per_day (semi-optional on conditions, applicable only on adding or updating a Usage Allowance Limit) | Number | The maximum rated amount that is allowed to use within a day on the specific usage service, service type or service family. |
maximum_rated_amount_per_month (semi-optional on conditions, applicable only on adding or updating a Usage Allowance Limit) | Number | The maximum rated amount that the accounts receivable is allowed to use within a month on the specific usage service, service type or service family. |
maximum_rated_amount_per_billing_cycle (semi-optional on conditions, applicable only on adding or updating a Usage Allowance Limit) | Number | The maximum rated amount that is allowed to use within a billing cycle on the specific usage service, service type or service family. |
maximum_rated_amount_per_transaction (semi-optional on conditions, applicable only on adding or updating a Usage Allowance Limit)
| Number | The maximum rated amount that is allowed to use per transaction on the specific usage service, service type or service family. |
maximum_usage_per_day (semi-optional on conditions, applicable only on adding or updating a Usage Allowance Limit)
| Number | The maximum usage amount that is allowed to use within a day on the specific usage service, service type or service family. |
maximum_usage_per_month (semi-optional on conditions, applicable only on adding or updating a Usage Allowance Limit) | Number | The maximum usage amount that is allowed to use within a month on the specific usage service, service type or service family. |
maximum_usage_per_billing_cycle (semi-optional on conditions, applicable only on adding or updating a Usage Allowance Limit) | Number | The maximum usage amount that is allowed to use within a billing cycle on the specific usage service, service type or service family. |
maximum_usage_per_transaction (semi-optional on conditions, applicable only on adding or updating a Usage Allowance Limit) | Number | The maximum usage amount that the accounts receivable is allowed to use per transaction on the specific usage service, service type or service family. |
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
Name | Type | Description |
|---|
block_services_not_included_in_usage_allowance_limits_settings | Boolean | Defines if the account owner can only consume services for which a Usage Allowance Limit is specified |
percentage_of_allowed_exceeded_usage_limit | Number | The percentage of amount that the limit can be exceeded for the related accounts receivable |
| accumulated_maximum_rated_amount_per_day | Float | The accumulated maximum rated amount that the accounts receivable is allowed to use within a day. |
| accumulated_maximum_rated_amount_per_month | Float | The accumulated maximum rated amount that the accounts receivable is allowed to use within a month. |
| accumulated_maximum_rated_amount_per_transaction | Float | The accumulated maximum rated amount that the accounts receivable is allowed to use per transaction. |
| accumulated_maximum_usage_per_date | Integer | The accumulated maximum usage amount that the accounts receivable is allowed to use within a day. |
| accumulated_maximum_usage_per_month | Integer | The accumulated maximum usage amount that the accounts receivable is allowed to use within a month. |
| accumulated_maximum_usage_per_transaction | Integer | The accumulated maximum usage amount that the accounts receivable is allowed to use per transaction. |
| currency | Currency object | The accounts receivable's currency |
| usage_services_allowance | Set of Usage Services Allowance objects | The usage allowance limits per usage service, service type or service family |
Referred Objects Response Data
usage_allowance_limit_per_service object response data
Name | Type | Description |
|---|
| maximum_rated_amount_per_transaction | Number | The maximum rated amount that can be used per transaction on the specific usage service, service type or service family. |
| maximum_rated_amount_per_day | Number | The maximum rated amount that can be used within a day on the specific usage service, service type or service family. |
| maximum_rated_amount_per_billing_cycle | Number | The maximum rated amount that can be used within a billing cycle on the specific usage service, service type or service family. |
| maximum_rated_amount_per_month | Number | The maximum rated amount that can be used within a month on the specific usage service, service type or service family. |
| maximum_usage_per_transaction | Number | The maximum usage amount that can be used per transaction on the specific usage service, service type or service family. |
| maximum_usage_per_day | Number | The maximum usage amount that can be used within a day on the specific usage service, service type or service family. |
| maximum_usage_per_billing_cycle | Number | The maximum usage amount that can be used within a billing cycle on the specific usage service, service type or service family. |
| maximum_usage_per_month | Number | The maximum usage amount that can be used within a month on the specific usage service, service type or service family. |
| service | Product object | The product related with the retrieved usage allowance limit. |
| service_type | Product Type object | The product type related with the retrieved usage allowance limit. |
| service_family | Product Family object | The product family related with the retrieved usage allowance limit. |
Referred Objects Response Data
product object response data
| | |
|---|
| Id | String | The ID of the product |
| code | String | The code of product |
alternative_code | String | The alternative code of product |
description | String | The description of product |
| priority_level | Integer | The priority level of the product |
| global_rate | Global Rate Object | The global rate of the retrieved product |
| product_type | Product type object | The type of the product |
Referred Objects Response Data
product_type object data response
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved product type |
| name | String | The Name of the retrieved product type |
| alternative_code | String | The Alternative Code of the retrieved product type |
| description | String | The Description of the retrieved product type |
| classification | String | The Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS |
| service_type | String | The Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE |
| physical_good_type | String | The physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE |
| composition_method | String | The Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE |
| used_for_provisioning | Boolean | The flag shows if the retrieved product type is used for provisioning |
| udr_type | Usage Detail Record Type | The UDR type related with the product type. This is applicable only if the product type is classified as SERVICES and the service type is set to USAGE |
| meter_reading_type | Meter Reading Type | The Meter Reading type related with the product type. This is applicable only for traceable physical goods |
Referred Objects Response Data
usage_detail_record_type object data response
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved usage detail record type |
| name | String | The Name of the retrieved usage detail record type |
| alternative_code | String | The Alternative Code of the retrieved usage detail record type |
| description | String | The Description of the retrieved usage detail record type |
| unit_of_measurement | String | The Unit of measurement of the retrieved usage detail record type |
Referred Objects Response Data
unit_of_measurement object response data
Name | Type | Description |
| id | String | The identifier of the Unit of measurement |
name | String | The name of the Unit of measurement |
description | String | The description of the Unit of measurement |
| alternative_code | String | The alternative code of the Unit of measurement |
meter_reading_type object data response
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved meter reading type |
| name | String | The Name of the retrieved meter reading type |
| alternative_code | String | The Alternative Code of the retrieved meter reading type |
| classification | String | The Classification of the retrieved meter reading type |
| description | String | The Description of the retrieved meter reading type |
| unit_of_measurement | String | The Unit of measurement of the retrieved meter reading type |
Referred Objects Response Data
unit_of_measurement object response data
Name | Type | Description |
| id | String | The identifier of the Unit of measurement |
name | String | The name of the Unit of measurement |
description | String | The description of the Unit of measurement |
| alternative_code | String | The alternative code of the Unit of measurement |
global rate object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved rate |
| rate_model | String | The price plan rate model which can be one of the following: - QUANTITYBASED
- QUANTITYANDPERIODBASED
- BILLABLEPERIODBASED
- DURATIONBASED
- FLATFEEBASED
- USAGEBASED
|
| global_base_amount | Number | The base price of the product in the Global Price Plan |
| base_rate_applied_per | String | The value for 'Base Rate Applied per' Available when the rate model is 'Quantity & Quantity Based' and it is a selection between |
| uot | String | The 'UOT' applicable for the rate
- Seconds
- Minute
- Hour
- Day
- Week
- Month
- Year
Available for one-time services |
| time_period | Time Period Object | The period and unit of time for which the base amount is applicable for. This is available only on termed services rates. |
| uom | String | The 'UOM' applicable for the rate Available when the product type is of Usage Service Classification |
Referred Objects Response Data
period object response data
Name | Type | Description |
|---|
| time_period_value | Number | The time period value |
time_period_uot | String | The time period unit of time. The supported values are the following: MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS |
product_type object data response
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved product type |
| name | String | The Name of the retrieved product type |
| alternative_code | String | The Alternative Code of the retrieved product type |
| description | String | The Description of the retrieved product type |
| classification | String | The Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS |
| service_type | String | The Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE |
| physical_good_type | String | The physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE |
| composition_method | String | The Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE |
| used_for_provisioning | Boolean | The flag shows if the retrieved product type is used for provisioning |
| udr_type | Usage Detail Record Type | The UDR type related with the product type. This is applicable only if the product type is classified as SERVICES and the service type is set to USAGE |
| meter_reading_type | Meter Reading Type | The Meter Reading type related with the product type. This is applicable only for traceable physical goods |
Referred Objects Response Data
usage_detail_record_type object data response
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved usage detail record type |
| name | String | The Name of the retrieved usage detail record type |
| alternative_code | String | The Alternative Code of the retrieved usage detail record type |
| description | String | The Description of the retrieved usage detail record type |
| unit_of_measurement | String | The Unit of measurement of the retrieved usage detail record type |
Referred Objects Response Data
unit_of_measurement object response data
Name | Type | Description |
| id | String | The identifier of the Unit of measurement |
name | String | The name of the Unit of measurement |
description | String | The description of the Unit of measurement |
| alternative_code | String | The alternative code of the Unit of measurement |
meter_reading_type object data response
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved meter reading type |
| name | String | The Name of the retrieved meter reading type |
| alternative_code | String | The Alternative Code of the retrieved meter reading type |
| classification | String | The Classification of the retrieved meter reading type |
| description | String | The Description of the retrieved meter reading type |
| unit_of_measurement | String | The Unit of measurement of the retrieved meter reading type |
Referred Objects Response Data
unit_of_measurement object response data
Name | Type | Description |
| id | String | The identifier of the Unit of measurement |
name | String | The name of the Unit of measurement |
description | String | The description of the Unit of measurement |
| alternative_code | String | The alternative code of the Unit of measurement |
product_family object data response
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved product family |
| name | String | The Name of the retrieved product family |
| code | String | The code of the retrieved product family |
| description | String | The Description of the retrieved product family |
Examples
Example 1
HTTP Method: POST
Request
Body
Response