Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Tip

Available from CRM.COM R13.1.0

Tip

Deprecated from CRM.COM R17.0.0


Excerpt

This method removes the usage allowance limits from an Accounts Receivable. Usage Allowance Limits can be removed from an Accounts Receivable only if the active Accounts Receivable Definitions allows it. A single Accounts Receivable a Subscription. A single Subscription is updated by each call

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

accountssubscription_receivable_identifier

(mandatory)

Account Receivable IdentifierSubscription Identifier

The identifier of the

account receivable

subscription to be updated. The

allowed account receivable

allowed subscription identifier fields are the following:

Include Page
V4:

accounts_receivable

subscription_identifier

_post

V4:

accounts_receivable

subscription_identifier

_post

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

...

  • It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified

Response Data

Include Page
V4:accounts_receivablesubscription_complete
V4:accountssubscription_receivable_complete

Examples

Expand
titleExample 1

HTTP Method: POST


Request

Body

{ "token": "{{token}}", "accounts_receivable_identifier" : { "number" : "ACR0000001526" } ,"fields_set":"usage_allowance_limits,name" }
Code Block
languagejavascript
themeConfluence
linenumberstrue

Response

 { "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": 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 } ], "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": null, "accumulated_maximum_usage_per_transaction": null } }, "status": { "code": "OK", "description": "", "message": "" } }
Code Block
languagejavascript
themeConfluence
linenumberstrue