Page Comparison

Tip
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

...

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

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

...

Expand

title	Example 1

HTTP Method: POST

Request

Body

Code Block

theme	Confluence
language	javascript
linenumbers	true

 {
  "token": "{{token}}",
 "accounts_receivable_identifier" : {
     "number" : "ACR0000001392"
    },
    "accumulated_maximum_rated_amount_per_day":50.5
}

Response

Code Block

theme	Confluence
language	javascript
linenumbers	true

 {
    "data": {
        "notes": null,
        "log_information": {
            "created_by_unit": {
                "alternative_code": "adminunit",
                "group_name": "Main Group",
                "community_name": "Community",
                "name": "Admin Unit",
                "description": "admin unit",
                "id": "1"
            },
            "updated_by_unit": {
                "alternative_code": "adminunit",
                "group_name": "Main Group",
                "community_name": "Community",
                "name": "Admin Unit",
                "description": "admin unit",
                "id": "1"
            },
            "created_date": "2017-07-28T12:26:08",
            "updated_date": "2017-08-08T16:46:36",
            "updated_by_user": {
                "person_name": "MPAdministrator",
                "id": "1",
                "email": null,
                "username": "MPAdministrator"
            },
            "created_by_user": {
                "person_name": "MPAdministrator",
                "id": "1",
                "email": null,
                "username": "MPAdministrator"
            }
        },
        "payment_preferences_set": [],
        "owned_by_group": {
            "alternative_code": "MG",
            "community_name": "Community",
            "name": "Main Group",
            "description": "Main Group",
            "id": "1"
        },
        "description": null,
        "contact_information": {
            "company_profile": null,
            "company_name": null,
            "name": null,
            "last_name": "Τζιηρτζιηπή",
            "id": "7B7A165FD2804DA59BFE70F353F79579",
            "life_cycle_state": "FINANCIAL",
            "middle_name": "νΊΚοΥ",
            "title": null,
            "type": "PERSON",
            "first_name": "Κατερίνα",
            "demographics": {
                "name_day": {
                    "month": null,
                    "day": null
                },
                "id_number": null,
                "gender": null,
                "date_of_birth": {
                    "month": null,
                    "year": null,
                    "day": null
                },
                "industry_sector": null,
                "passport_number": null,
                "industry": null,
                "social_security_number": null,
                "id_issued_by_country": null,
                "passport_issued_by_country": null
            }
        },
        "billing_address": null,
        "primary_account": true,
        "type": "CUSTOMER",
        "udf_date_2": null,
        "udf_date_1": null,
        "udf_date_4": null,
        "udf_date_3": null,
        "number": "ACR0000001392",
        "udf_float_3": null,
        "udf_float_4": null,
        "balance": null,
        "credit_period_operator": "PLUS",
        "credit_period": 0,
        "currency": {
            "suffix_symbol": "N/A",
            "prefix_symbol": "€",
            "decimal_part_name": "cents",
            "code": "EUR",
            "integer_part_name": "euro",
            "id": "2"
        },
        "id": "76FBE26DE50D424987AC4CC69619A9C5",
        "opening_balance": 0,
        "udf_float_1": null,
        "udf_float_2": null,
        "udf_string_2": null,
        "opening_balance_date": null,
        "udf_string_3": null,
        "udf_string_4": null,
        "udf_string_5": null,
        "privacy_level": {
            "number": "14",
            "name": "PL Group A_Share_Low",
            "id": "9DCEFDA9D56145978C265085CD146810",
            "hierarchy_level": 1
        },
        "presentment_preferences_set": [],
        "udf_string_1": null,
        "life_cycle_state": "ACTIVE",
        "classification": {
            "alternative_code": "E",
            "name": "Employee",
            "id": "E093533DA53A4167C69762073D1B13A8"
        },
        "usage_allowance_limits": {
            "percentage_of_allowed_exceeded_usage_limit": null,
            "accumulated_maximum_rated_amount_per_transaction": null,
            "usage_services_allowance": [],
            "block_services_not_included_in_usage_allowance_limits_settings": null,
            "accumulated_maximum_usage_per_day": null,
            "accumulated_maximum_usage_per_month": null,
            "accumulated_maximum_rated_amount_per_month": null,
            "currency": null,
            "accumulated_maximum_rated_amount_per_day": "50.50",
            "accumulated_maximum_usage_per_transaction": null
        },
        "credit_limit_status": null,
        "credit_rating": {
            "code": "AAA",
            "name": "key_aaa_-_subject_to_minimal_credit_risk"
        },
        "name": "ACR0000001392 Κατερίνα Τζιηρτζιηπή",
        "outstanding_amount": null,
        "udf_string_6": null,
        "udf_string_7": null,
        "accounting_period": null,
        "access_tokens_set": [],
        "udf_string_8": null
    },
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}

Versions Compared

Old Version 13

New Version 14

Key