Versions Compared

Old Version 40

changes.mady.by.user Joseph Ioannou (Unlicensed)

Saved on

compared with

New Version 41

changes.mady.by.user Sevia Kyriacou (Deactivated)

Saved on

Key

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

Available from CRM.COM R7.0.0

Table of Contents
maxLevel2

...

Name

Type

Description

token

String

The token retrieved from the login method

usage_detail_record_identifier

(mandatory)

Usage Detail Record identifier  

The identifier of the usage detail record that should be returned as a result. The allowed usage detail record identifier fields are the following:

Include Page
V4:usage_detail_record_identifier
V4:usage_detail_record_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

(semi-optional)

Accounts Receivable identifier  

The identifier of the related accounts receivable. The allowed accounts receivable identifier fields are the following:

Include Page
V4:accounts_receivable_identifier
V4:accounts_receivable_identifier

subscription_identifier

(semi-optional)

Subscription identifier

The identifier of the related subscription. The allowed subscription identifier fields are the following:

Include Page
V4:subscription_identifier
V4:subscription_identifier

source_system_identifier

(optional)

Usage Detail Record Source System identifier

The identifier of the related usage detail record source system. The allowed usage detail record source system identifier fields are the following:

Include Page
V4:usage_detail_record_source_system_identifier
V4:usage_detail_record_source_system_identifier

type_identifier

(optional)

Usage Detail Record Type identifier

The identifier of the related usage detail record type. The allowed usage detail record type identifier fields are the following:

Include Page
V4:usage_detail_record_type_identifier
V4:usage_detail_record_type_identifier

usage_service_catalog_identifier

(optional)

Usage Service Catalog identifier

The identifier of the related usage service catalog. The allowed usage service catalog identifier fields are the following:

Include Page
V4:usage_service_catalog_identifier
V4:usage_service_catalog_identifier

device_identifier

(optional)

Usage Detail Record Device identifier

The identifier of the related usage detail record device. The allowed usage detail record device identifier fields are the following:

Include Page
V4:usage_detail_record_device_identifier
V4:usage_detail_record_device_identifier

usage_method_identifier

(optional)

Usage Detail Record Usage Method identifier

The identifier of the related usage detail record usage method. The allowed usage detail record usage method identifier fields are the following:

Include Page
V4:usage_detail_record_usage_method_identifier
V4:usage_detail_record_usage_method_identifier

source_category_identifier

(optional)

Usage Detail Record Source Category identifier

The identifier of the related usage detail record source category. The allowed usage detail record source category identifier fields are the following:

Include Page
V4:usage_detail_record_source_category_identifier
V4:usage_detail_record_source_category_identifier

destination_category_identifier

(optional)

Usage Detail Record Destination Category identifier

The identifier of the related usage detail record destination category. The allowed usage detail record destination category identifier fields are the following:

Include Page
V4:usage_detail_record_destination_category_identifier
V4:usage_detail_record_destination_category_identifier

product_identifier

(optional)

Product Identifier

The identifier of the actual product that was used. The allowed product identifier fields are the following:

Include Page
V4:product_identifier
V4:product_identifier

Only products classified as usage services can be specified in this parameter

from_date

(optional)

Date

The date from which the usage detail record that should be returned as a result was created (inclusive).

Tip

Available from CRM.COM R9.1.0

to_date

(optional)

Date

The date until which the usage detail record that should be returned as a result was created (exclusive).

Tip

Available from CRM.COM R9.1.0

number_of_results

(optional)

Number

The required number of usage detail records that should be returned as a result. If not specified, then all usage detail records that meet the rest of the criteria will be returned. If specified, then the most recent usage detail records will be retrieved.

Tip

Available from CRM.COM R9.1.0

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_detail_record_identifier

(mandatory)

Usage Detail Record identifier  

The identifier of the usage detail record that should be cancelled. The allowed usage detail record identifier fields are the following:

Include Page
V4:usage_detail_record_identifier
V4:usage_detail_record_identifier

...

Name

Type

Description

token

String

The token retrieved from the login method

subscription_action_identifier

(mandatory)

Subscription Action identifier  


The subscription action identifier that should be used for cancelling the usage detail record lot. The allowed subscription action identifier fields are the following:

Include Page
V4:subscription_action_identifier
V4:subscription_action_identifier

fields_set

(optional)

List of Strings, comma separatedA 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:

 

Body:

Code Block
languagexml
linenumberstrue
 {
    "token": "{{token}}",
    "subscription_action_identifier":{"id":"00B8A9381A994A4CABDC9716F866B77C"}
}

 

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
 {
  "data": [
    {
      "number": "214",
      "subscription_service": {
        "product": {
          "code": "VOD & PPV Base",
          "product_type": {
            "service_type": "TERMED",
            "used_for_provisioning": false,
            "alternative_code": "V&P",
            "composition_method": "FLAT",
            "name": "VOD & PPV",
            "description": "To be used for termed non provisioning services as a base for ordering VOD and PPV",
            "id": "CE2024C589D34244A1D29CDDE3B88127",
            "classification": "SERVICES",
            "physical_good_type": null
          },
          "alternative_code": "V&PB",
          "description": "VOD & PPV Base",
          "id": "F7286EF7D017405E8357FF8614A3EA24"
        },
        "first_activated_date": "2016-10-21T14:00:38",
        "rating_state": "PENDING",
        "service_bundle": null,
        "rated_up_to_date": null,
        "id": "D3C50E4E5B924B798FF436B7C25DB570",
        "life_cycle_state": "EFFECTIVE"
      },
      "product": {
        "code": "Serendipity",
        "product_type": {
          "service_type": "USAGE",
          "used_for_provisioning": true,
          "alternative_code": "V",
          "udr_type": {
            "unit_of_measurement": {
              "alternative_code": "A",
              "name": "Amount",
              "description": null,
              "id": "0F24D08950AA4B5DB5C5F52FA5A4A7D1"
            },
            "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"
      },
      "unit_of_measurement": {
        "alternative_code": "A",
        "name": "Amount",
        "description": null,
        "id": "0F24D08950AA4B5DB5C5F52FA5A4A7D1"
      },
      "transaction_reference_number": null,
      "id": "93CA2251A0C94A33A66F70D62DC9EE3F",
      "life_cycle_state": "CANCELLED",
      "subscription": {
        "number": "S0000000278",
        "first_activated_date": "2016-10-21T14:00:38",
        "rating_state": "PENDING",
        "accounts_receivable": {
          "number": "ACR0000000132",
          "name": "ACR0000000132 Melissa Ioannou",
          "id": "4653431C51AD4A28A4A8D2286E9146E7",
          "life_cycle_state": "ACTIVE",
          "account_owner": {
            "company_profile": null,
            "company_name": null,
            "name": "Melissa Ioannou",
            "last_name": "Ioannou",
            "id": "D36C847F516B417D98242B55ECBF67D0",
            "life_cycle_state": "FINANCIAL",
            "middle_name": null,
            "title": null,
            "type": "PERSON",
            "first_name": "Melissa",
            "demographics": {
              "name_day": {
                "month": null,
                "day": null
              },
              "id_number": "336655",
              "gender": "MALE",
              "country_of_residence": {
                "alternative_code": "IRN",
                "three_character_code": null,
                "name": "IRAN (ISLAMIC REPUBLIC OF)",
                "id": "231",
                "two_character_code": 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": "A120C3C6949D414EB0F1D5A70FCDD9C0",
        "life_cycle_state": "EFFECTIVE",
        "type": {
          "alternative_code": "normalsub",
          "name": "Normal",
          "description": null,
          "id": "D1BAE6454A2248189EBCD7ADD3B4B65F"
        }
      }
    }
  ],
  "status": {
    "code": "OK",
    "description": "",
    "message": ""
  }
}

 

POST usage_detail_records/adjust

...

Name

Type

Description

token

String

The token retrieved from the login method

usage_detail_record_identifier

(mandatory)

Usage Detail Record identifier  

The identifier of the usage detail record that should be cancelled. The allowed usage detail record identifier fields are the following:

Include Page
V4:usage_detail_record_identifier
V4:usage_detail_record_identifier

product_identifier

(optional)

Product identifier

The identifier of the product that was actually used. The allowed product identifier fields are the following:

Include Page
V4:product_identifier
V4:product_identifier

source_system_identifier

(optional)


Usage Detail Record Source System identifier

The identifier of the usage detail record source system. The allowed usage detail record source system identifier fields are the following:

Include Page
V4:usage_data_record_source_system_identifier
V4:usage_data_record_source_system_identifier

from_date

(optional)

DateThe date that the usage of the service started

to_date

(optional)

NumberThe date that the usage of the service stopped

usage_amount

(optional)

NumberThe usage detail record total usage amount

total_amount

(optional and applicable on conditions)

Number

The total amount that the usage detail record will be rated for. This information can be adjusted only if the usage detail record is defined as pre-rated through the related usage service catalog

Tip

Available from CRM.COM R12.0.0

vat_amount

(optional and applicable on conditions)

Number

The VAT amount that will be applied on the usage detail record. This information can be adjusted only if the usage detail record is defined as pre-rated through the related usage service catalog

Tip

Available from CRM.COM R12.0.0

tax_amount

(optional and applicable on conditions)

Number

The total Tax amount that will be applied on the usage detail record. This information can be adjusted only if the usage detail record is defined as pre-rated through the related usage service catalog

Tip

Available from CRM.COM R12.0.0


discount_amount

(optional and applicable on conditions)

Number

The discount amount that will be applied on the usage detail record. This information can be adjusted only if the usage detail record is defined as pre-rated through the related usage service catalog

Tip

Available from CRM.COM R12.0.0

rating_date

(optional and applicable on conditions)

Date

The date that the rating was applied on the usage detail record. This information can be adjusted only if the usage detail record is defined as pre-rated through the related usage service catalog

Tip

Available from CRM.COM R12.0.0

udf_string_1

(optional)

String

User Defined Field of type String

udf_string_2

(optional)

String

User Defined Field of type String

udf_string_3

(optional)

String

User Defined Field of type String

udf_string_4

(optional)

String

User Defined Field of type String

udf_string_5

(optional)

String

User Defined Field of type String

udf_string_6

(optional)

String

User Defined Field of type String

udf_string_7

(optional)

String

User Defined Field of type String

udf_string_8

(optional)

String

User Defined Field of type String

udf_float_1

(optional)

Float

User Defined Field of type Float

udf_float_2

(optional)

Float

User Defined Field of type Float

udf_float_3

(optional)

Float

User Defined Field of type Float

udf_float_4

(optional)

Float

User Defined Field of type Float

udf_date_1

(optional)

Date

User Defined Field of type Date

udf_date_2

(optional)

Date

User Defined Field of type Date

udf_date_3

(optional)

Date

User Defined Field of type Date

udf_date_4

(optional)

Date

User Defined Field of type Date

...

Name

Type

Description

token

String

The token retrieved from the login method

usage_detail_record_identifier

(mandatory)

Usage Detail Record identifier  

The identifier of the usage detail record that should be updated. The allowed usage detail record identifier fields are the following:

Include Page
V4:usage_detail_record_identifier
V4:usage_detail_record_identifier

...

Name

Type

Description

token

String

The token retrieved from the login method

usage_detail_record_identifier

(mandatory)

Usage Detail Record identifier  

The identifier of the usage detail record that should be updated. The allowed usage detail record identifier fields are the following:

Include Page
V4:usage_detail_record_identifier
V4:usage_detail_record_identifier

...

Name

Type

Description

token

String

The token retrieved from the login method

usage_detail_record_identifier

(mandatory)

Usage Detail Record identifier  

The identifier of the usage detail record that should be cancelled. The allowed usage detail record identifier fields are the following:

Include Page
V4:usage_detail_record_identifier
V4:usage_detail_record_identifier

...