Page Comparison

Tip
Available from CRM.COM R13.0.0

Excerpt
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.

...

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:

Include Page

	V4:accounts_receivable_identifier_post
	V4:accounts_receivable_identifier_post

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

...

Include Page

	V4:accounts_receivable_remaining_usage_allowance_complete
	V4:accounts_receivable_remaining_usage_allowance_complete

Examples

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{    "token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c3IiOiJNUEFkbWluaXN0cmF0b3IiLCJvcmciOiJwc19yMTNxYSIsIm91biI6IjEiLCJleHAiOiIxNTA4MTY2MzgzIiwiaWF0IjoiMTUwODE1OTE4MyIsImp0aSI6IkExMkRBRTMyNTUzNDRGNEJBM0E2MEMwNDI2MUQxNjNEIn0.vYQ7MSnPT1KxHXHeOyCf58hVPg-O2UUGmhNCApo1MFM",
    "accounts_receivable_identifier":{
        "access_token_identifier":{
            "authentication_code":"test@crm.com.cy"
        }
    }

}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

 {
    "data":
    {
        "remaining_rated_amount_per_day": "501000",
        "remaining_usage_per_day": null,
        "remaining_usage_per_month": null,
        "remaining_usage_allowance_per_service":
        [
            {
                "remaining_rated_amount_per_day": "50100",
                "service_family": null,
                "service_type": null,
                "remaining_usage_per_day": "3",null,
                "service":
                {
                    "code": "SerendipityExxon Petrol",
                    "product_type":
                    {
                        "service_type": "USAGE",
                        "used_for_provisioning": true,false,
                        "alternative_code": "VE2",
                        "udr_type":
                        {
                            "unit_of_measurement":
                            {
                                "alternative_code": "VL",
                                "name": "VODLitre",
                                "description": null,"Littres",
                                "id": "B3CFC986221548279752B1ABC6F4C480A588A14FFA214303BD2182BCF6E9ACCF"
                            },
                            "compositionalternative_methodcode": "FLATT",
                            "name": "Usage Services","Test",
                            "description": null,
                            "descriptionid": "Used for VOD , PPV, TELEPHONE CALLS ETC",C72DCF90AD66467388FA0B7725A24E21"
                        },
                        "composition_method": "FLAT",
                        "name": "Exxon",
                        "description": null,
                        "id": "751C638AA3534B768408AAC4D73CF516ACA2649D85044264AADC31B5DB0BC567",
                        "classification": "SERVICES",
                        "physical_good_type": null
                    },
                    "alternative_code": "S_1EP",
                    "description": "VOD: Serendipity ",Petrol",
                    "id": "BD3ACEE7D6244DCAA375D0744DA75540"E1EB6B2EBFC444A1BEA9A030A5B4D56D",
                    "priority_level": null
                },
                "remaining_usage_per_month": null,
                "remaining_rated_amount_per_transaction": "50100",
                "remaining_rated_amount_per_month": "1501000",
                "remaining_usage_per_transaction": "1" null
            },
           ], {
                "remaining_rated_amount_per_transactionday": null,"1000",
                "remaining_rated_amount_per_monthservice_family": "150",null,
                "service_type": null,
                "remaining_usage_per_transactionday": null "30",
             },   "statusservice":
                {
                    "code": "OKExxon Unleaded",
                    "descriptionproduct_type": "",
               "message": ""   } }

Expand

title	Example 2

HTTP Method: POST

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
  "data": {{
                        "remaining_rated_amount_per_dayservice_type": "50USAGE",
                        "remainingused_usagefor_per_dayprovisioning": "250"false,
      "remaining_usage_per_month                  "alternative_code": "994E2",
                        "remaining_usage_allowance_per_serviceudr_type": [
                        {
                            "remainingunit_rated_amount_per_day": "50",of_measurement":
                            {
                                "servicealternative_familycode": null"L",
          "service_type": {                      "service_typename": "USAGELitre",
          "used_for_provisioning                      "description": false,"Littres",
              "alternative_code                  "id": "USTA",A588A14FFA214303BD2182BCF6E9ACCF"
                            },
              "udr_type": {             "alternative_code": "LT",
                            "name": "LitresTest",
                            "description": null,
                            "id": "B1238270684F4457B6D8EBD4CA00963BC72DCF90AD66467388FA0B7725A24E21"
                        },
                        "composition_method": "FLAT",
                        "name": "Usage Service Type A","Exxon",
                        "description": null,
                        "id": "819661A2C34A4BBF9005E74387CD7A40ACA2649D85044264AADC31B5DB0BC567",
                        "classification": "SERVICES",
                        "physical_good_type": null
                    },
        "remaining_usage_per_day            "alternative_code": "EU",
                    "description": "250Exxon Unleaded",
            "service        "id": "3F174D8E87474A2AB115A2BFD2750FBB",
                    "priority_level": null
                },
                "remaining_usage_per_month": "994"null,
                "remaining_rated_amount_per_transaction": "01000",
                "remaining_rated_amount_per_month": "8971000",
                "remaining_usage_per_transaction": "1030"
            }
        ],
        "remaining_rated_amount_per_transaction": "01000",
        "remaining_rated_amount_per_month": "8971000",
        "remaining_usage_per_transaction": null
 "10"   },
    "status":
    {
        "code": "OK",
        "description": "",
        "message": ""
    }
}

Versions Compared

Old Version 4

New Version 5

Key

Examples