Versions Compared

Old Version 11

changes.mady.by.user Marina Antoniadou (Unlicensed)

Saved on

compared with

New Version 12

changes.mady.by.user Marina Antoniadou (Unlicensed)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Tip

Available from CRM.COM R13.0.0

Table of Contents
maxLevel2

...

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

...

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

...

Expand
titleExample 1

HTTP Method: POST

 

Request:


ResponseBody:

Code Block
themeConfluence
languagejavascript
linenumberstrue
 {
  "token":"{{token}}",
  "accounts_receivable_identifier":{"number":"ACR0000011921"}
}


Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
 {
  "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": "COMPLETED",
      "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"
    },
    {
      "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": "854BF9FEC6A247EDB117EFA881F84D1C",
      "life_cycle_state": "BLOCKED",
      "expiration_date": "2017-04-30T21:27:57"
    },
    {
      "cancelled_by_user": {
        "person_name": "MPAdministrator",
        "id": "1",
        "email": "dev@crm.com",
        "username": "MPAdministrator"
      },
      "authorisation_date": "2017-03-31T00: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": "65772C04CAF648B78A00175D5BFD6C89",
      "life_cycle_state": "CANCELLED",
      "expiration_date": "2017-04-30T18:44:53",
      "cancellation_date": "2017-03-31T18:46:32"
    },
    {
      "cancelled_by_user": {
        "person_name": "MPAdministrator",
        "id": "1",
        "email": "dev@crm.com",
        "username": "MPAdministrator"
      },
      "authorisation_date": "2017-03-31T00: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": "76344A47C1CD413B9E6668BDF46039B2",
      "life_cycle_state": "CANCELLED",
      "expiration_date": "2017-04-30T18:50:08",
      "cancellation_date": "2017-03-31T18:52:19"
    },
    {
      "authorisation_date": "2017-03-31T00: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": "A5B5C6BAAF7444EBB368605B77EF1023",
      "life_cycle_state": "BLOCKED",
      "expiration_date": "2017-04-30T19:19:04"
    },
    {
      "authorisation_date": "2017-03-31T00: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": "5D7A043EBF904E2B9DA6884687F19AFD",
      "life_cycle_state": "BLOCKED",
      "expiration_date": "2017-04-30T19:22:05"
    }
  ],
  "status": {
    "code": "OK",
    "description": "",
    "message": ""
  }
}

POST usage_authorisations/create

...

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)

FloatThe 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

...

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

...