Available from CRM.COM R13.1.0
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
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:
| ||||||||||||||||||||||||||||||
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_day (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. | ||||||||||||||||||||||||||||||
(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 |
Referred Objects Response Data
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified
- It is mandatory to specify one of the semi-optional on conditions parameters, only if one of the semi-optional parameters is specified. There is no limit of how many of those parameters is allowed to specified
Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved accounts receivable |
| type | String | The type of the retrieved accounts receivable which can be CUSTOMER or SYSTEM or ORGANISATIONAL ORGANISATIONAL type is available from CRM.COM R15.0.0 |
number | String | The number of the retrieved accounts receivable |
name | String | The name of the retrieved accounts receivable |
| description | String | The description of the retrieved accounts receivable |
| notes | String | The notes of the retrieved accounts receivable |
balance | Float | The aggregated amount of posted debits and credits allocated against the accounts receivable, as of a specific date. This information is calculated dynamically |
| opening_balance | Float | The opening balance of the accounts receivable for the latest and still open Accounting Period. This information is calculated during the latest Accounting Period Closing process. |
| opening_balance_date | Date | The date on which the opening balance of the accounts receivable was last calculated by an Accounting Period Closing process. |
outstanding_amount | Float | The total outstanding amount which is owned by the customer, as of a specific date, which is the aggregated amount of posted debits which are not paid and are past their due date. This information is calculated dynamically |
| credit_limit_status | String | Determines if the outstanding amount of the specific accounts receivable has exceeded the allowed credit limit. The supported values are NOT_EXCEEDED or EXCEEDED |
| credit_limit | Number | Is the maximum amount of credit that can be provided to the specific accounts receivable,or in other words the maximum balance that the accounts receivable can ever reach. |
| credit_period | Number | Credit period is the length of time for which a customer is allowed to settle any given debit |
life_cycle_state | String | The life cycle state of the retrieved accounts receivable which can be ACTIVE, SUSPENDED or TERMINATED |
primary_account | Boolean | Indicates if the accounts receivable is the primary accounts receivable for the specified customer or not |
| partner_account | Boolean | Indicates if the accounts receivable is owned by a partner group or a partner unit, i.e. is a partner account |
| parent_account | Boolean | Indicates if the accounts receivable is a parent account in a group accounts |
| is_tax_exempt | Boolean | Indicates if the account owner is tax exempt or not Available from CRM.COM R17.0.0 |
udf_string_1 | String | User Defined Field of type String |
udf_string_2 | String | User Defined Field of type String |
udf_string_3 | String | User Defined Field of type String |
udf_string_4 | String | User Defined Field of type String |
udf_string_5 | String | User Defined Field of type String |
udf_string_6 | String | User Defined Field of type String |
udf_string_7 | String | User Defined Field of type String |
udf_string_8 | String | User Defined Field of type String |
udf_float_1 | Float | User Defined Field of type Float |
udf_float_2 | Float | User Defined Field of type Float |
udf_float_3 | Float | User Defined Field of type Float |
udf_float_4 | Float | User Defined Field of type Float |
udf_date_1 | Date | User Defined Field of type Date |
udf_date_2 | Date | User Defined Field of type Date |
udf_date_3 | Date | User Defined Field of type Date |
udf_date_4 | Date | User Defined Field of type Date |
Contact Information object | The contact information related with the specified accounts receivable | |
Classification object | The classification of the retrieved accounts receivable | |
Credit Rating object | The credit rating of the retrieved accounts receivable | |
| credit_period | Credit Period object | The credit period of the retrieved accounts receivable |
Address object | The billing address of the retrieved accounts receivable | |
| currency | Currency object | The accounts receivable's currency |
| parent_account | Accounts Receivable Object | The parent accounts receivable. Applicable only if the retrieved Accounts Receivable is a member in a group of accounts. |
| accounting_period | Accounting Period Object | The latest Accounting Period for which the accounts receivable's opening balance was calculated for. |
| owned_by_group | Group Object | The group that is owning the accounts receivable Deprecated from CRM.COM R18.0.0 (replaced with owned_by_business_unit) |
| owned_by_business_unit | Business Unit Object | The business unit that is owning the accounts receivable Available from CRM.COM R18.0.0 |
| privacy_level | Privacy Level Object | The accounts receivable privacy level Deprecated from CRM.COM R18.0.0 |
| usage_allowance_limits | Usage Allowance Limits Object | The accounts receivable Usage Allowance Limits Available from CRM.COM R13.0.0 Deprecated from CRM.COM R17.0.0 |
Log Information Object | The log information related to the retrieved accounts receivable | |
| account_manager | Users Object | The account manager of the retrieved accounts receivable Applicable only if the retrieved account is owned by a COMPANY |
| pricing_agreement | Pricing Agreement Object | The pricing agreement of the retrieved accounts receivable Applicable only for an Accounts Receivable that is owned by a Company and a Price Plan and/or Usage Service Catalog was agreed as part of a special pricing agreement Available from CRM.COM R14.0.0 From CRM.COM R15.0.0, pricing_agreement is available for all CUSTOMER and ORGANISATIONAL accounts, for both persons and companies |
| recurring_payments_preferences | Recurring Payments Preferences Object | The recurring payments preferences associated with the accounts receivable |
| membership_information | Account Membership Information Object | The accounts receivable membership information in terms of funding scope and the services funded by the parent account. Applicable only if the retrieved accounts receivable is a member account of a group. |
| rewards | Rewards Object | The rewards information of the accounts receivable Available from CRM.COM R17.0.0 |
Set of Accounts Receivable Presentment Preferences Objects | The presentment preferences of the retrieved accounts receivable | |
Set of Accounts Receivable Payment Preferences Objects | The payment preferences of the retrieved accounts receivable | |
| access_tokens_set | Set of Access Token objects | The access tokens associated with the accounts receivable |
| member_accounts | Set of Accounts Receivable Objects | The member accounts of the retrieved accounts receivable. Applicable only if the retrieved account is a Parent Account. |
| usage_allowance_organisational_units | Set of Usage Organisational Conditions Objects | The usage organisational conditions (communities, groups, units) that services can be used at |
Referred Objects Response Data
Examples
HTTP Method: POST
Request
Body
{
"token": "{{token}}",
"accounts_receivable_identifier" : {
"number" : "ACR0000001392"
},
"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
{
"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": [
{
"service_family": null,
"service_type": null,
"maximum_rated_amount_per_day": null,
"service": {
"code": "Serendipity",
"product_type": {
"service_type": "USAGE",
"used_for_provisioning": true,
"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_1",
"description": "VOD: Serendipity ",
"id": "BD3ACEE7D6244DCAA375D0744DA75540"
},
"maximum_usage_per_transaction": null,
"maximum_rated_amount_per_month": "10.00",
"maximum_usage_per_day": null,
"maximum_rated_amount_per_transaction": null,
"maximum_usage_per_month": null
},
{
"service_family": null,
"service_type": {
"service_type": "USAGE",
"used_for_provisioning": false,
"alternative_code": "E2",
"composition_method": "FLAT",
"name": "Exxon",
"description": null,
"id": "ACA2649D85044264AADC31B5DB0BC567",
"classification": "SERVICES",
"physical_good_type": null
},
"maximum_rated_amount_per_day": null,
"service": null,
"maximum_usage_per_transaction": null,
"maximum_rated_amount_per_month": null,
"maximum_usage_per_day": null,
"maximum_rated_amount_per_transaction": "24.00",
"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
}
],
"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": ""
}
}