Versions Compared

Key

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

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)

...

Tip

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

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)

BooleanDefines if the account owner can only consume services for which a Usage Allowance Limit is specified

percentage_of_allowed_exceeded_usage_limit

(optional)

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

accumulated_maximum_rated_amount_per_day

(optional)

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

accumulated_maximum_rated_amount_per_month

(optional)

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

accumulated_maximum_rated_amount_per_transaction

(optional)

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

accumulated_maximum_rated_amount_per_uot

(optional)

Number

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)

Number

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)

String

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

  • DAYS
  • WEEKS
  • MONTHS
Tip

Available from CRM.COM R14.2.0

accumulated_maximum_usage_per_day

(optional)

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

accumulated_maximum_rated_amountusage_per_month

(optional)

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

accumulated_maximum_rated_amountusage_per_transaction

(optional)

NumberThe accumulated maximum rated usage amount that the accounts receivable is allowed to use per transaction.

accumulated_maximum_usage_per_dayuot

(optional)

Number

The accumulated maximum usage

amount

that the accounts receivable is allowed to use

within a day.

per X UOT.

Tip

Available from CRM.COM R14.2.0

usage_uot_value

(mandatory on conditions)

Number

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

(optional)

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

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

(optional)

NumberThe accumulated maximum usage amount that the accounts receivable is allowed to use per transaction.

uot is provided. Available options are:

  • DAYS
  • WEEKS
  • MONTHS
Tip

Available from CRM.COM R14.2.0

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

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

...