Available from CRM.COM R13.0.0
This method returns information related with an accounts receivable's remaining usage allowance. Information related to a single accounts receivable is returned by each call.
Resource URL
Parameters
Name | Type | Description | ||||||||||||||||||||||||||||||
token | String | The token retrieved from the login method | ||||||||||||||||||||||||||||||
| accounts_receivable_identifier (mandatory) | Accounts receivable identifier | The identifier of the accounts receivable for which its remaining usage allowance should be returned as a result. The allowed accounts receivable identifier fields are the following:
| ||||||||||||||||||||||||||||||
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 |
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
Name | Type | Description |
|---|---|---|
| remaining_rated_amount_per_day | Number | The accumulated remaining rated amount that the accounts receivable is allowed to use within a day |
| remaining_rated_amount_per_month | Number | The accumulated remaining rated amount that the accounts receivable is allowed to use within a month |
| remaining_rated_amount_per_transaction | Number | The accumulated remaining rated amount that the accounts receivable is allowed to use per transaction |
| remaining_usage_per_day | Number | The accumulated remaining usage amount that the accounts receivable is allowed to use within a day |
| remaining_usage_per_month | Number | The accumulated remaining usage amount that the accounts receivable is allowed to use within a month |
| remaining_usage_per_transaction | Number | The accumulated remaining usage amount that the accounts receivable is allowed to use per transaction |
| remaining_amount_until_usage_blocking | Number | The amount that the account owner can still spend until usage consumption is blocked due to exceeded credit limit.The amount depends on the accounts receivable's credit limit minus its balance, as well as on whether non-billed usage is taken into account during blocking. Available from CRM.COM R14.11.0 |
| unbilled_usage_amount | Number | The consumed usage for which the account owner is not billed yet during the current billing cycle Available from CRM.COM R14.11.0 |
| accounts_receivable | Accounts Receivable Object | The accounts receivable for which the remaining usage allowance is returned |
| remaining_usage_allowance_per_service | Set of Accounts Receivable Usage Allowance per Service | The remaining usage allowance per service, service product type and product family |
Referred Objects Response Data
Examples
HTTP Method: POST
Request:
Body:
{ "token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c3IiOiJNUEFkbWluaXN0cmF0b3IiLCJvcmciOiJwc19yMTNxYSIsIm91biI6IjEiLCJleHAiOiIxNTA4MTY2MzgzIiwiaWF0IjoiMTUwODE1OTE4MyIsImp0aSI6IkExMkRBRTMyNTUzNDRGNEJBM0E2MEMwNDI2MUQxNjNEIn0.vYQ7MSnPT1KxHXHeOyCf58hVPg-O2UUGmhNCApo1MFM",
"accounts_receivable_identifier":{
"access_token_identifier":{
"authentication_code":"test@crm.com.cy"
}
}
}
Response:
{
"data":
{
"remaining_rated_amount_per_day": "1000",
"remaining_usage_per_day": null,
"remaining_usage_per_month": null,
"remaining_usage_allowance_per_service":
[
{
"remaining_rated_amount_per_day": "100",
"service_family": null,
"service_type": null,
"remaining_usage_per_day": null,
"service":
{
"code": "Exxon Petrol",
"product_type":
{
"service_type": "USAGE",
"used_for_provisioning": false,
"alternative_code": "E2",
"udr_type":
{
"unit_of_measurement":
{
"alternative_code": "L",
"name": "Litre",
"description": "Littres",
"id": "A588A14FFA214303BD2182BCF6E9ACCF"
},
"alternative_code": "T",
"name": "Test",
"description": null,
"id": "C72DCF90AD66467388FA0B7725A24E21"
},
"composition_method": "FLAT",
"name": "Exxon",
"description": null,
"id": "ACA2649D85044264AADC31B5DB0BC567",
"classification": "SERVICES",
"physical_good_type": null
},
"alternative_code": "EP",
"description": "Petrol",
"id": "E1EB6B2EBFC444A1BEA9A030A5B4D56D",
"priority_level": null
},
"remaining_usage_per_month": null,
"remaining_rated_amount_per_transaction": "100",
"remaining_rated_amount_per_month": "1000",
"remaining_usage_per_transaction": null
},
{
"remaining_rated_amount_per_day": "1000",
"service_family": null,
"service_type": null,
"remaining_usage_per_day": "30",
"service":
{
"code": "Exxon Unleaded",
"product_type":
{
"service_type": "USAGE",
"used_for_provisioning": false,
"alternative_code": "E2",
"udr_type":
{
"unit_of_measurement":
{
"alternative_code": "L",
"name": "Litre",
"description": "Littres",
"id": "A588A14FFA214303BD2182BCF6E9ACCF"
},
"alternative_code": "T",
"name": "Test",
"description": null,
"id": "C72DCF90AD66467388FA0B7725A24E21"
},
"composition_method": "FLAT",
"name": "Exxon",
"description": null,
"id": "ACA2649D85044264AADC31B5DB0BC567",
"classification": "SERVICES",
"physical_good_type": null
},
"alternative_code": "EU",
"description": "Exxon Unleaded",
"id": "3F174D8E87474A2AB115A2BFD2750FBB",
"priority_level": null
},
"remaining_usage_per_month": null,
"remaining_rated_amount_per_transaction": "1000",
"remaining_rated_amount_per_month": "1000",
"remaining_usage_per_transaction": "30"
}
],
"remaining_rated_amount_per_transaction": "1000",
"remaining_rated_amount_per_month": "1000",
"remaining_usage_per_transaction": null
},
"status":
{
"code": "OK",
"description": "",
"message": ""
}
}