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

...

(mandatory)

...

Usage Authorisation Identifier

The identifier of the usage authorisation. The allowed alert 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

...

Examples

...

title	Example 1

HTTP Method: POST

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
  "data": {
    "authorisation_date": "2017-04-04T00:00:00",
    "usage_authorisation_services": [
      {
        "service_family": null,
        "maximum_usage": 64,
        "service_type": null,
        "service": {
          "code": "Usage Service 3",
          "product_type": {
            "service_type": "USAGE",
            "used_for_provisioning": false,
            "alternative_code": "USTB",
            "udr_type": {
              "alternative_code": "L",
              "name": "Litres",
              "description": null,
              "id": "B1238270684F4457B6D8EBD4CA00963B"
            },
            "composition_method": "FLAT",
            "name": "Usage Service Type B",
            "description": null,
            "id": "8FEC7EEE39254E55ABA2C3382C432D2D",
            "classification": "SERVICES",
            "physical_good_type": null
          },
          "alternative_code": "US3",
          "description": "Usage Service 3",
          "id": "6444E6324BCE4A34A99DD795E55C016D"
        },
        "maximum_amount": "10",
        "id": "A2FFC6A9B83C4091BBA57DB37D590787"
      },
      {
        "service_family": null,
        "maximum_usage": 10,
        "service_type": {
          "service_type": "USAGE",
          "used_for_provisioning": false,
          "alternative_code": "USTA",
          "udr_type": {
            "alternative_code": "L",
            "name": "Litres",
            "description": null,
            "id": "B1238270684F4457B6D8EBD4CA00963B"
          },
          "composition_method": "FLAT",
          "name": "Usage Service Type A",
          "description": null,
          "id": "819661A2C34A4BBF9005E74387CD7A40",
          "classification": "SERVICES",
          "physical_good_type": null
        },
        "service": null,
        "maximum_amount": "82",
        "id": "50059BED5D2D4E87980607FDEBF00B8F"
      },
      {
        "service_family": null,
        "maximum_usage": 1,
        "service_type": null,
        "service": {
          "code": "Serendipity",
          "product_type": {
            "service_type": "USAGE",
            "used_for_provisioning": true,
            "alternative_code": "V",
            "udr_type": {
              "alternative_code": "V",
              "name": "VOD",
              "description": null,
              "id": "B3CFC986221548279752B1ABC6F4C480"
            },
            "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_amount": "82",
        "id": "863CBFA6A43848B481752601CC267883"
      }
    ],
    "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": "E66D25BECAA348A2999F7B3D68F3B791",
    "life_cycle_state": "BLOCKED",
    "expiration_date": "2017-05-04T18:58:25"
  },
  "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

...

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:

...

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

...

Examples

...

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
  "token":"{{token}}",
  "accounts_receivable_identifier":{"number":"ACR0000011923"}
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
  "data": [
    {
      "authorisation_date": "2017-04-05T00:00:00",
      "usage_authorisation_services": [
        {
          "service_family": null,
          "maximum_usage": 1,
          "service_type": null,
          "service": {
            "code": "Serendipity",
            "product_type": {
              "service_type": "USAGE",
              "used_for_provisioning": true,
              "alternative_code": "V",
              "udr_type": {
                "alternative_code": "V",
                "name": "VOD",
                "description": null,
                "id": "B3CFC986221548279752B1ABC6F4C480"
              },
              "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_amount": "100",
          "id": "45FA61F72CB6415898CB1DD896F52D8B"
        }
      ],
      "authorisation_amount": "30",
      "accounts_receivable": {
        "number": "ACR0000011923",
        "name": "ACR0000011923",
        "id": "FBD27E8726074FB7B1F1B1FCCF53BBBA",
        "life_cycle_state": "ACTIVE",
        "account_owner": {
          "company_profile": null,
          "company_name": null,
          "name": null,
          "last_name": "Allowance_4",
          "id": "67F46A57D0F446F88CCD995A9E4777D4",
          "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": "0B97452F87E147BF88F0DD5F4329F475",
      "life_cycle_state": "BLOCKED",
      "expiration_date": "2017-05-05T11:20:22"
    },
    {
      "authorisation_date": "2017-04-05T00:00:00",
      "usage_authorisation_services": [
        {
          "service_family": null,
          "maximum_usage": 1,
          "service_type": null,
          "service": {
            "code": "Serendipity",
            "product_type": {
              "service_type": "USAGE",
              "used_for_provisioning": true,
              "alternative_code": "V",
              "udr_type": {
                "alternative_code": "V",
                "name": "VOD",
                "description": null,
                "id": "B3CFC986221548279752B1ABC6F4C480"
              },
              "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_amount": "70",
          "id": "B0DE40F93E804F49B732B2A3BA5C3266"
        }
      ],
      "authorisation_amount": "20",
      "accounts_receivable": {
        "number": "ACR0000011923",
        "name": "ACR0000011923",
        "id": "FBD27E8726074FB7B1F1B1FCCF53BBBA",
        "life_cycle_state": "ACTIVE",
        "account_owner": {
          "company_profile": null,
          "company_name": null,
          "name": null,
          "last_name": "Allowance_4",
          "id": "67F46A57D0F446F88CCD995A9E4777D4",
          "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": "EA931F5406FE45309C8658B55FA63671",
      "life_cycle_state": "BLOCKED",
      "expiration_date": "2017-05-05T11:22:20"
    }
  ],
  "status": {
    "code": "OK",
    "description": "",
    "message": ""
  }
}

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

...

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

...

authorisation_amount

(mandatory)

...

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

...

Examples

...

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
  "token":"{{token}}",
  "accounts_receivable_identifier":{"number":"ACR0000011921"},
  "authorisation_amount":50
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

 {
  "data": {
    "authorisation_date": "2017-04-04T00:00:00",
    "usage_authorisation_services": [
      {
        "service_family": null,
        "maximum_usage": 64,
        "service_type": null,
        "service": {
          "code": "Usage Service 3",
          "product_type": {
            "service_type": "USAGE",
            "used_for_provisioning": false,
            "alternative_code": "USTB",
            "udr_type": {
              "alternative_code": "L",
              "name": "Litres",
              "description": null,
              "id": "B1238270684F4457B6D8EBD4CA00963B"
            },
            "composition_method": "FLAT",
            "name": "Usage Service Type B",
            "description": null,
            "id": "8FEC7EEE39254E55ABA2C3382C432D2D",
            "classification": "SERVICES",
            "physical_good_type": null
          },
          "alternative_code": "US3",
          "description": "Usage Service 3",
          "id": "6444E6324BCE4A34A99DD795E55C016D"
        },
        "maximum_amount": "0",
        "id": "0CFA05C5E5924EEE9D5B19AC3FEE0068"
      },
      {
        "service_family": null,
        "maximum_usage": 1,
        "service_type": null,
        "service": {
          "code": "Serendipity",
          "product_type": {
            "service_type": "USAGE",
            "used_for_provisioning": true,
            "alternative_code": "V",
            "udr_type": {
              "alternative_code": "V",
              "name": "VOD",
              "description": null,
              "id": "B3CFC986221548279752B1ABC6F4C480"
            },
            "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_amount": "0",
        "id": "0C02283A665444C3A6C74FD262364057"
      },
      {
        "service_family": null,
        "maximum_usage": 10,
        "service_type": {
          "service_type": "USAGE",
          "used_for_provisioning": false,
          "alternative_code": "USTA",
          "udr_type": {
            "alternative_code": "L",
            "name": "Litres",
            "description": null,
            "id": "B1238270684F4457B6D8EBD4CA00963B"
          },
          "composition_method": "FLAT",
          "name": "Usage Service Type A",
          "description": null,
          "id": "819661A2C34A4BBF9005E74387CD7A40",
          "classification": "SERVICES",
          "physical_good_type": null
        },
        "service": null,
        "maximum_amount": "0",
        "id": "EFD35C8D331C46E3A2F7BF6F09D69ABC"
      }
    ],
    "authorisation_amount": "50.00",
    "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": "DEDC131D808742A2A380C0C8D64F5B84",
    "life_cycle_state": "BLOCKED",
    "expiration_date": "2017-05-04T19:09:00"
  },
  "status": {
    "code": "OK",
    "description": "",
    "message": ""
  }
}

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

...

(mandatory)

...

String

The identifier of the usage authorisation to be cancelled. The allowed usage authorisation 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

...

Examples

HTTP Method: POST

Request:

Body:

Expand

title	Example 1

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
  "token":"{{token}}",
  "usage_authorisation_identifier":{"authorisation_id":"8129B3C28FD540639C3EE4689638B8C7"}
 }

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{ "data": { "cancelled_by_user": { "person_name": "MPAdministrator", "id": "1", "email": "dev@crm.com", "username": "MPAdministrator" }, "authorisation_date": "2017-04-04T00:00:00", "usage_authorisation_services": [ { "service_family": null, "maximum_usage": 64, "service_type": null, "service": { "code": "Usage Service 3", "product_type": { "service_type": "USAGE", "used_for_provisioning": false, "alternative_code": "USTB", "udr_type": { "alternative_code": "L", "name": "Litres", "description": null, "id": "B1238270684F4457B6D8EBD4CA00963B" }, "composition_method": "FLAT", "name": "Usage Service Type B", "description": null, "id": "8FEC7EEE39254E55ABA2C3382C432D2D", "classification": "SERVICES", "physical_good_type": null }, "alternative_code": "US3", "description": "Usage Service 3", "id": "6444E6324BCE4A34A99DD795E55C016D" }, "maximum_amount": "10", "id": "A2FFC6A9B83C4091BBA57DB37D590787" }, { "service_family": null, "maximum_usage": 1, "service_type": null, "service": { "code": "Serendipity", "product_type": { "service_type": "USAGE", "used_for_provisioning": true, "alternative_code": "V", "udr_type": { "alternative_code": "V", "name": "VOD", "description": null, "id": "B3CFC986221548279752B1ABC6F4C480" }, "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_amount": "82", "id": "863CBFA6A43848B481752601CC267883" }, { "service_family": null, "maximum_usage": 10, "service_type": { "service_type": "USAGE", "used_for_provisioning": false, "alternative_code": "USTA", "udr_type": { "alternative_code": "L", "name": "Litres", "description": null, "id": "B1238270684F4457B6D8EBD4CA00963B" }, "composition_method": "FLAT", "name": "Usage Service Type A", "description": null, "id": "819661A2C34A4BBF9005E74387CD7A40", "classification": "SERVICES", "physical_good_type": null }, "service": null, "maximum_amount": "82", "id": "50059BED5D2D4E87980607FDEBF00B8F" } ], "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": "E66D25BECAA348A2999F7B3D68F3B791", "life_cycle_state": "CANCELLED", "expiration_date": "2017-05-04T18:58:25", "cancellation_date": "2017-04-05T11:29:51" }, "status": { "code": "OK", "description": "", "message": "" } } Panel

name	blue

Child pages (Children Display)

excerpt	true

Versions Compared

Old Version 17

New Version 18

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

Response Data

Examples

Page Comparison

Versions Compared

Old Version 17

New Version 18

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

Response Data

Examples