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

...

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_usage_per_day

(optional)

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

accumulated_maximum_usage_per_month

(optional)

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

accumulated_maximum_usage_per_transaction

(optional)

NumberThe 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

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

...

Expand
titleExample 1

HTTP Method: POST

 

Request

Body

Code Block
themeConfluence
languagejavascript
linenumberstrue
 {
  "token": "{{token}}",
 "accounts_receivable_identifier" : {
     "number" : "ACR0000001392ACR0000001526"
    },
 "block_services_not_included_in_usage_allowance_limits_settings":true,
 "percentage_of_allowed_exceeded_usage_limit":30,
 "accumulated_maximum_rated_amount_per_day":100,
 "accumulated_maximum_rated_amount_per_month":1000,
"accumulated_maximum_usage_per_date":10,
"accumulated_maximum_usage_per_month":25,
"accumulated_maximum_usage_per_transaction":5,
"usage_services_allowance":
    [
        {
        "action":"add",
        "service":{"code":"CREED"},
        "maximum_rated_amount_per_month":5
        }
        ,
        {
        "action":"update",
        "service_type":{"namealternative_code":"ExxonEU"},
        "maximum_rated_amount_per_transaction":23
        }
            ,
        {
        "action":"remove",
        "service":{"code":"MADExxon MAXPetrol"}
        }
    ]    ,
        {
        "action":"remove",
        "service_type":{"name":"Usage Services"}
        }
        ,
        {
        "action":"remove",
        "service":{"code":"Exxon Super"}
        }
        
    ]
}

Response

Code Block
themeConfluence
languagejavascript
linenumberstrue
 {
    "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-10T17:55:34",
            "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": [
                {
                    "service_family": null,
                    "service_type": {
                        "service_type": "USAGE",
                        "used_for_provisioning": false,
                        "alternative_code": "E2",
                        "composition_method": "FLAT",
              "fields_set":"usage_allowance_limits,name"
}

Response

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
    "data": {
         "name": "ExxonACR0000001526 John CN UAL",
           "usage_allowance_limits": {
            "descriptionpercentage_of_allowed_exceeded_usage_limit": null30,
                        "id"accumulated_maximum_rated_amount_per_transaction": "ACA2649D85044264AADC31B5DB0BC567"null,
            "usage_services_allowance": [
           "classification": "SERVICES",    {
                    "physicalservice_good_typefamily": null,
                    } "service_type": null,
                    "maximum_rated_amount_per_day": null,
                    "service": null,
                    "maximum_usage_per_transaction": null,{
                        "maximum_rated_amount_per_monthcode": null"CREED",
                        "maximum_usage_per_day": null,product_type": {
                            "maximum_rated_amount_per_transactionservice_type": "23.00USAGE",
                            "maximumused_usagefor_per_monthprovisioning": null
    true,
           },                 {
"alternative_code": "V",
                   "service_family": null,         "udr_type": {
          "service_type": null,                     "maximumunit_rated_amount_per_dayof_measurement": null,
                    "service": {           "alternative_code": "V",
            "code": "Serendipity",                     "name": "VOD",
  "product_type": {                             "service_typedescription": "USAGE"null,
                             "used_for_provisioning   "id": true,"B3CFC986221548279752B1ABC6F4C480"
                            "alternative_code": "V"},
                            "composition_method": "FLAT",
                            "name": "Usage Services",
                            "description": "Used for VOD , PPV, TELEPHONE CALLS ETC",
                            "id": "751C638AA3534B768408AAC4D73CF516",
                            "classification": "SERVICES",
                            "physical_good_type": null
                        },
                        "alternative_code": "S_1C",
                        "description": "VOD: Serendipity CREED",
                        "id": "BD3ACEE7D6244DCAA375D0744DA75540A465D282F44C46AC834BAE50A81CA2F1"
                    },
                    "maximum_usage_per_transaction": null,
                    "maximum_rated_amount_per_month": "105.00",
                    "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": "CREEDExxon Unleaded",
                        "product_type": {
                            "service_type": "USAGE",
                            "used_for_provisioning": truefalse,
                            "alternative_code": "VE2",
                            "udr_type": {
          "composition_method": "FLAT",                       "unit_of_measurement": {
     "name": "Usage Services",                             "descriptionalternative_code": "L"Used,
 for VOD , PPV, TELEPHONE CALLS ETC",                             "idname": "751C638AA3534B768408AAC4D73CF516Litre",
                                    "classificationdescription": "SERVICESLittres",

                           "physical_good_type": null         "id": "A588A14FFA214303BD2182BCF6E9ACCF"
              },                  },
      "alternative_code": "C",                         "descriptionalternative_code": "VOD: CREEDT",
                        "id": "A465D282F44C46AC834BAE50A81CA2F1"       "name": "Test",
            },                     "maximum_usage_per_transaction"description": null,
        
           "maximum_rated_amount_per_month": "5.00",                     "maximum_usage_per_dayid": null, "C72DCF90AD66467388FA0B7725A24E21"
                           "maximum_rated_amount_per_transaction": null, },
                            "maximum_usage_per_month": nullcomposition_method": "FLAT",
                    },        "name": "Exxon",
       {                     "service_family": {description": null,
                            "codeid": "CHACA2649D85044264AADC31B5DB0BC567",
                            "nameclassification": "ChannelsSERVICES",
                         "description   "physical_good_type": null,
                        },
   "id": "5432773B865246E3B10A47CD130183C7"                     },"alternative_code": "EU",
                        "service_typedescription": "Exxon nullUnleaded",
                       "maximum_rated_amount_per_day": null,
 "id": "3F174D8E87474A2AB115A2BFD2750FBB"
                   "service": null},
                    "maximum_usage_per_transaction": "2"null,
                    "maximum_rated_amount_per_month": null,
                    "maximum_usage_per_day": null"30",
                    "maximum_rated_amount_per_transaction": null"23",
                    "maximum_usage_per_month": null
                }
            ],
            "block_services_not_included_in_usage_allowance_limits_settings": null1,
            "accumulated_maximum_usage_per_day": "10.00"null,
            "accumulated_maximum_usage_per_month": "25.00",
            "accumulated_maximum_rated_amount_per_month": "1000.00",
            "currency": null,
         {
  "accumulated_maximum_rated_amount_per_day": "100.00",             "accumulated_maximum_usage_per_transactionsuffix_symbol": "5.00"N/A",
        },         "creditprefix_limit_statussymbol": null,
    "€",
   "credit_rating": {             "codedecimal_part_name": "AAAcents",
                "namecode": "key_aaa_-_subject_to_minimal_credit_risk"EUR",
        },         "integer_part_name": "ACR0000001392 Κατερίνα Τζιηρτζιηπήeuro",
  
     "outstanding_amount": null,           "udf_string_6id": null, "2"
           "udf_string_7": null, },
          "accounting_period  "accumulated_maximum_rated_amount_per_day": null"100",
          "access_tokens_set  "accumulated_maximum_usage_per_transaction": [],"5"
        "udf_string_8": null}
    },
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}