Versions Compared

Old Version 16

changes.mady.by.user Joseph Ioannou

Saved on

compared with

New Version 17

changes.mady.by.user Ekaterini Tzirtzipi

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
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)

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

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"
    },
    "accumulated_maximum_rated_amount_per_day":50.5,
    "usage_services_allowance":
    [
        {
        "action":"add",
        "service":{"code":"Serendipity"},
        "maximum_rated_amount_per_month":10
        }
        ,
        {
        "action":"add",
        "service_type":{"name":"Exxon"},
        "maximum_rated_amount_per_transaction":24
        }
            ,
        {
        "action":"add",
        "service_family":{"code":"CH"},
        "maximum_usage_per_transaction":2
        }
    ]
}

Response

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
    "data": {
        "notesname": null"ACR0000001526 John CN UAL",
        "logusage_allowance_informationlimits": {
            "createdpercentage_of_by_unitallowed_exceeded_usage_limit": {null,
                "alternative_code"accumulated_maximum_rated_amount_per_transaction": "adminunit"null,
                "group_name"usage_services_allowance": "Main Group",[
                {
  "community_name": "Community",                 "nameservice_family": "Admin Unit",null,
                    "descriptionservice_type": "admin unit",null,
                 "id   "maximum_rated_amount_per_day": "1" null,
               },     "service": {
      "updated_by_unit": {                 "alternative_code": "adminunitSerendipity",
                "group_name": "Main Group",        "product_type": {
          "community_name": "Community",                 "nameservice_type": "Admin UnitUSAGE",
                "description": "admin unit",                 "id": "1""used_for_provisioning": true,
               },             "createdalternative_datecode": "2017-07-28T12:26:08V",
            "updated_date": "2017-08-08T16:46:36",                "updatedcomposition_by_usermethod": {"FLAT",
                "person_name": "MPAdministrator",                 "id"name": "1Usage Services",
                "email": null,            "description": "Used for VOD , PPV, TELEPHONE CALLS "username": "MPAdministrator"ETC",
               },             "created_by_userid": {"751C638AA3534B768408AAC4D73CF516",
                "person_name": "MPAdministrator",
                "idclassification": "1SERVICES",
                "email": null,           "physical_good_type": null
    "username": "MPAdministrator"
            }         },
 
      "payment_preferences_set": [],         "owned_by_group": {             "alternative_code": "MGS_1",
            "community_name": "Community",             "namedescription": "MainVOD: Serendipity Group",
  
         "description": "Main Group",             "id": "1BD3ACEE7D6244DCAA375D0744DA75540"
        },         "description": null,  },
      "contact_information": {             "company_profilemaximum_usage_per_transaction": null,
            "company_name": null,       "maximum_rated_amount_per_month": "10.00",
    "name": null,                "last_namemaximum_usage_per_day": "Τζιηρτζιηπή"null,

           "id": "7B7A165FD2804DA59BFE70F353F79579",        "maximum_rated_amount_per_transaction": null,
      "life_cycle_state": "FINANCIAL",             "middle_namemaximum_usage_per_month": "νΊΚοΥ",null
            "title": null,   },
         "type": "PERSON",      {
      "first_name": "Κατερίνα",             "demographicsservice_family": null,
   {                 "nameservice_daytype": {
                    "month    "service_type": null"USAGE",
                    "day": null   "used_for_provisioning": false,
            },                 "idalternative_numbercode": null"E2",
                "gender": null,       "udr_type": {
        "date_of_birth": {                     "month"unit_of_measurement": null,{
                    "year": null,                     "day": null"alternative_code": "L",
                 },                 "industry_sectorname": null"Litre",
                "passport_number": null,                 "industrydescription": null"Littres",
                "social_security_number": null,
                "id_issued_by_country": null,"A588A14FFA214303BD2182BCF6E9ACCF"
                "passport_issued_by_country": null           },
 }         },         "billing_address": null,         "primaryalternative_accountcode": true"T",
        "type": "CUSTOMER",         "udf_date_2": null,         "udf_date_1name": null"Test",
        "udf_date_4": null,         "udf_date_3": null,         "numberdescription": "ACR0000001392"null,
        "udf_float_3": null,         "udf_float_4": null,         "balanceid": null, "C72DCF90AD66467388FA0B7725A24E21"
             "credit_period_operator": "PLUS",         "credit_period": 0 },
        "currency": {                "suffixcomposition_symbolmethod": "N/AFLAT",
            "prefix_symbol": "€",
            "decimal_part_name": "centsExxon",
            "code": "EUR",             "integer_part_name"description": "euro",null,
                        "id": "2ACA2649D85044264AADC31B5DB0BC567",
        },                "idclassification": "76FBE26DE50D424987AC4CC69619A9C5SERVICES",
        "opening_balance": 0,                "udfphysical_floatgood_1type": null,
         "udf_float_2": null,         "udf_string_2": null },
        "opening_balance_date": null,            "udf_string_3maximum_rated_amount_per_day": null,
         "udf_string_4": null,           "udf_string_5service": null,
        "privacy_level": {             "number"maximum_usage_per_transaction": "14"null,
            "name": "PL Group A_Share_Low",
            "id"maximum_rated_amount_per_month": "9DCEFDA9D56145978C265085CD146810",
       null,
    "hierarchy_level": 1         },         "presentment_preferences_set"maximum_usage_per_day": []null,
          "udf_string_1": null,         "life_cycle_statemaximum_rated_amount_per_transaction": "ACTIVE24.00",
        "classification": {             "alternative_code": "E",maximum_usage_per_month": null
               "name": "Employee", },
                {
"id": "E093533DA53A4167C69762073D1B13A8"           },         "usageservice_allowance_limitsfamily": {null,
                    "percentage_of_allowed_exceeded_usage_limitservice_type": null,
                    "accumulated_maximum_rated_amount_per_transactionday": null,
              "usage_services_allowance      "service": [{
                {        "code": "Exxon Unleaded",
          "service_family": null,             "product_type": {
      "service_type": null,                     "maximum_rated_amount_per_dayservice_type": null"USAGE",
                    "service": {       "used_for_provisioning": false,
                "code": "Serendipity",                         "product_type"alternative_code": {"E2",
                            "serviceudr_type": "USAGE",{
                                "usedunit_forof_provisioningmeasurement": true,{
                                    "alternative_code": "VL",
                                 "composition_method   "name": "FLATLitre",
                                    "namedescription": "Usage ServicesLittres",
                            "description        "id": "UsedA588A14FFA214303BD2182BCF6E9ACCF"
for VOD , PPV, TELEPHONE CALLS ETC",                          },
  "id": "751C638AA3534B768408AAC4D73CF516",                             "classificationalternative_code": "SERVICEST",
                            "physical_good_type    "name": null"Test",
                          },      "description": null,
                 "alternative_code": "S_1",              "id": "C72DCF90AD66467388FA0B7725A24E21"
         "description": "VOD: Serendipity ",                },
        "id": "BD3ACEE7D6244DCAA375D0744DA75540"                     }"composition_method": "FLAT",
                    "maximum_usage_per_transaction": null,       "name": "Exxon",
            "maximum_rated_amount_per_month": "10.00",
                    "maximum_usage_per_daydescription": null,
                    "maximum_rated_amount_per_transaction": null,        "id": "ACA2649D85044264AADC31B5DB0BC567",
             "maximum_usage_per_month": null                 }"classification": "SERVICES",
                {
                    "service_family"physical_good_type": null,
                       "service_type": { },
                        "servicealternative_typecode": "USAGEEU",
                        "used_for_provisioningdescription": false"Exxon Unleaded",
                        "alternative_codeid": "E23F174D8E87474A2AB115A2BFD2750FBB",
                        "composition_method": "FLAT"},
                        "name"maximum_usage_per_transaction": "Exxon"null,
 
                      "description"maximum_rated_amount_per_month": null,

                       "id"maximum_usage_per_day": "ACA2649D85044264AADC31B5DB0BC56730",
 
                      "classification": "SERVICES""maximum_rated_amount_per_transaction": null,
                        "physical_good_type"maximum_usage_per_month": null
 
                  },
                {
   "maximum_rated_amount_per_day": null,                     "service_family": null,
                    "maximum_usage_per_transactionservice_type": null,
                    "maximum_rated_amount_per_monthday": null"100",
                    "maximum_usage_per_dayservice": null, {
                        "maximum_rated_amount_per_transaction": "24.00","code": "Exxon Petrol",
                        "maximum_usage_per_monthproduct_type": null{
                },            "service_type": "USAGE",
   {                         "serviceused_for_familyprovisioning": {false,
                            "alternative_code": "CHE2",
                        "name    "udr_type": "Channels",{
                        "description": null,       "unit_of_measurement": {
                "id": "5432773B865246E3B10A47CD130183C7"                     }"alternative_code": "L",
                    "service_type": null,
                    "maximum_rated_amount_per_day"name": null"Litre",
                    "service": null,                     "maximum_usage_per_transaction"description": "2.00Littres",
                     "maximum_rated_amount_per_month": null,               "id": "A588A14FFA214303BD2182BCF6E9ACCF"
                    "maximum_usage_per_day": null,           },
         "maximum_rated_amount_per_transaction": null,                       "maximum_usage_per_month": nullalternative_code": "T",
                    }             ]"name": "Test",
            "block_services_not_included_in_usage_allowance_limits_settings": null,                    "accumulated_maximum_usage_per_daydescription": null,
            "accumulated_maximum_usage_per_month": null,                    "accumulated_maximum_rated_amount_per_monthid": "C72DCF90AD66467388FA0B7725A24E21"
null,             "currency": null,             "accumulated_maximum_rated_amount_per_day": "50.50",
  },
          "accumulated_maximum_usage_per_transaction": null         },         "creditcomposition_limit_statusmethod": null"FLAT",
        "credit_rating": {                    "codename": "AAAExxon",
                            "name": "key_aaa_-_subject_to_minimal_credit_risk"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": {
                        "code": "CH",
                        "name": "Channels",
                        "description": null,
                        "id": "5432773B865246E3B10A47CD130183C7"
                    },
                    "service_type": null,
                    "maximum_rated_amount_per_day": null,
                    "service": null,
                    "maximum_usage_per_transaction": "2.00",
                    "maximum_rated_amount_per_month": null,
                    "maximum_usage_per_day": null,
                    "maximum_rated_amount_per_transaction": null,
                    "maximum_usage_per_month": null
                }
            ],
           "name": "ACR0000001392 Κατερίνα Τζιηρτζιηπή", "block_services_not_included_in_usage_allowance_limits_settings": 1,
            "outstanding_amount": null,accumulated_maximum_usage_per_day": null,
            "udf_string_6accumulated_maximum_usage_per_month": null,
            "udf_string_7accumulated_maximum_rated_amount_per_month": null,
        "accounting_period    "currency": null,
          "access_tokens_set  "accumulated_maximum_rated_amount_per_day": []"150.50",
        "udf_string_8    "accumulated_maximum_usage_per_transaction": null
        }
    },
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}