Page Comparison

...

Tip
Available from CRM.COM R13.0.0

Tip
Deprecated from CRM.COM R17.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.

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:

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

Restrictions

It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

...

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

language	javascript
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

language	javascript
theme	Confluence	language	javascript
linenumbers	true

{
    "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": ""
    }
}

...

Versions Compared

Old Version 6

New Version Current

Key

Resource URL

Parameters

Restrictions

Examples