Tip
Available from CRM.COM R13.0.0

Table of Contents

maxLevel	2

GET usage_

...

authorisations/show

This method returns information related with a usage authorisation request. A single Usage Authorisation is returned by each call

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

usage_authorisation_identifier

(mandatory)

Usage Authorisation Identifier

The identifier of the usage authorisation. The allowed alert Identifier fields are the following:

Include Page

	V4:usage_authorisation_identifier
	V4:usage_authorisation_identifier

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

Include Page

	V4:usage_authorisation_complete
	V4:usage_authorisation_complete

Examples

Expand

title	Example 1

HTTP Method: POST

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

 {
  "data": {
    "authorisation_date": "2017-03-30T00:00:00",
    "usage_authorisation_services": [],
    "authorisation_amount": "50",
    "accounts_receivable": {
      "number": "ACR0000008125",
      "name": "ACR0000008125",
      "id": "A99AC83A26B9488089DFD9EFAB40BED8",
      "life_cycle_state": "ACTIVE",
      "account_owner": {
        "company_profile": null,
        "company_name": null,
        "name": null,
        "last_name": "Allowance_1",
        "id": "932C4BC5D2374AA5AEA2DB3EDC4426D2",
        "life_cycle_state": "FINANCIAL",
        "middle_name": null,
        "title": null,
        "type": "PERSON",
        "first_name": "AC",
        "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
        }
      }
    },
    "id": "79890340CF9B4896A366C95B6042C970",
    "life_cycle_state": "BLOCKED",
    "expiration_date": "2017-04-30T20:12:54"
  },
  "status": {
    "code": "OK",
    "description": "",
    "message": ""
  }
}

Expand

title	Example 2

HTTP Method: POST

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
  "data": {
    "authorisation_date": "2017-03-30T00:00:00",
    "usage_authorisation_services": [],
    "authorisation_amount": "50",
    "accounts_receivable": {
      "number": "ACR0000011921",
      "name": "ACR0000011921",
      "id": "20956A4C18C94A19BE75249D567DBA00",
      "life_cycle_state": "ACTIVE",
      "account_owner": {
        "company_profile": null,
        "company_name": null,
        "name": null,
        "last_name": "Allowance_2",
        "id": "198E7882488E4B5B936441EE0CE811C0",
        "life_cycle_state": "FINANCIAL",
        "middle_name": null,
        "title": null,
        "type": "PERSON",
        "first_name": "AC",
        "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
        }
      }
    },
    "id": "D5FD16BDA3AA4F79B9304F58646D4F2F",
    "life_cycle_state": "BLOCKED",
    "subscription": {
      "number": "S0000008518",
      "first_activated_date": "2017-03-30T20:02:28",
      "rating_state": "PENDING",
      "accounts_receivable": {
        "number": "ACR0000011921",
        "name": "ACR0000011921",
        "id": "20956A4C18C94A19BE75249D567DBA00",
        "life_cycle_state": "ACTIVE"
      },
      "id": "5094D412B5A6495E8BAF6DD4A9E45FD9",
      "life_cycle_state": "EFFECTIVE",
      "type": {
        "alternative_code": "normalsub",
        "name": "Normal",
        "description": null,
        "id": "D1BAE6454A2248189EBCD7ADD3B4B65F"
      }
    },
    "expiration_date": "2017-04-30T20:13:10",
    "completed_by_action": {
      "business_classification_code": "ADD_SERVICE_USAGE",
      "number": "21882",
      "submitted_on": "2017-03-30T21:01:04",
      "action_type": null,
      "executed_on": "2017-03-30T21:01:09",
      "id": "B04DCEAE62534B3CA0C5F63D2F0B370F",
      "life_cycle_state": "EXECUTED",
      "performed_on": null,
      "sub_action_type": null,
      "behavior_code": "ADD_SERVICE_USAGE"
    },
    "completed_date": "2017-03-30T21:01:09"
  },
  "status": {
    "code": "OK",
    "description": "",
    "message": ""
  }
}

POST usage_

...

authorisations/list

This method returns information related with usage authorisation requests that were submitted against a specific account receivable. Multiple usage authorisations are 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 related with the usage authorisations that 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.

Response Data

Include Page

	V4:usage_authorisation_complete
	V4:usage_authorisation_complete

Examples

Expand

title	Example 1

HTTP Method: POST

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

POST usage_authorisations/create

This method creates a usage authorisation. A single usage authorisation can be created by each call.

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier
(mandatory)

Subscription Identifier

The identifier of the accounts receivable related with the usage authorisation to be created. The allowed accounts receivable identifier fields are the following:

Include Page

	V4:accounts_receivable_identifier_post
	V4:accounts_receivable_identifier_post

authorisation_amount

(mandatory)

Float

The amount of money the subscriber requests to be authorised

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

Include Page

	V4:usage_authorisation_complete
	V4:usage_authorisation_complete

Examples

Expand

title	Example 1

HTTP Method: POST

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

POST usage_authorisations/cancel

This method cancels an existing usage authorisation. This method can be used only if the specified usage authorisation's life cycle state is set to Blocked. A single usage authorisation can be cancelled by each call.

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

usage_authorisation_identifier

(mandatory)

String

The identifier of the usage authorisation to be cancelled. The allowed usage authorisation Identifier fields are the following:

Include Page

	V4:usage_authorisation_identifier
	V4:usage_authorisation_identifier

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.

Anchor
accounts_receivable_add_members referred objects parameters
accounts_receivable_add_members referred objects parameters
Referred Objects Response Data

Response Data

Include Page

	V4:usage_authorisation_complete
	V4:usage_authorisation_complete

Examples

Expand

title	Example 1

HTTP Method: POST

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

Versions Compared

Old Version 10

New Version 11

Key

GET usage_

authorisations/show

Resource URL

Parameters

Restrictions

Response Data

Examples

POST usage_

authorisations/list

Resource URL

Parameters

Restrictions

Response Data

Examples

POST usage_authorisations/create

Resource URL

Parameters

Restrictions

Response Data

Examples

POST usage_authorisations/cancel

Resource URL

Parameters

Restrictions

Anchor
accounts_receivable_add_members referred objects parameters
accounts_receivable_add_members referred objects parameters
Referred Objects Response Data

Response Data

Examples

Page Comparison

Versions Compared

Old Version 10

New Version 11

Key

GET usage_

authorisations/show

Resource URL

Parameters

Restrictions

Response Data

Examples

POST usage_

authorisations/list

Resource URL

Parameters

Restrictions

Response Data

Examples

POST usage_authorisations/create

Resource URL

Parameters

Restrictions

Response Data

Examples

POST usage_authorisations/cancel

Resource URL

Parameters

Restrictions

Anchoraccounts_receivable_add_members referred objects parametersaccounts_receivable_add_members referred objects parametersReferred Objects Response Data

Response Data

Examples

Anchor
accounts_receivable_add_members referred objects parameters
accounts_receivable_add_members referred objects parameters
Referred Objects Response Data