Versions Compared

Old Version 42

changes.mady.by.user Joseph Ioannou

Saved on

compared with

New Version 43

changes.mady.by.user p_demou

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

GET usage_detail_records/show

This method returns information related with a usage detail record (UDR).  A single usage detail record is returned by each call

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

(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:

...

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

Expand
titleExample 1

HTTP Method: GET

 

Request:

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
  "data": {
    "tax_amount": null,
    "log_information": {
      "created_by_unit": {
        "alternative_code": "adminunit",
        "group_name": "Main Group",
        "community_name": "Community",
        "name": "Admin Unit",
        "description": "admin unit",
        "id": "1"
      },
      "updated_by_unit": {
        "alternative_code": "adminunit",
        "group_name": "Main Group",
        "community_name": "Community",
        "name": "Admin Unit",
        "description": "admin unit",
        "id": "1"
      },
      "created_date": "2017-01-20T07:26:20",
      "updated_date": "2017-01-20T07:26:25",
      "updated_by_user": {
        "person_name": "MPAdministrator",
        "id": "1",
        "email": "dev@crm.com",
        "username": "MPAdministrator"
      },
      "created_by_user": {
        "person_name": "MPAdministrator",
        "id": "1",
        "email": "dev@crm.com",
        "username": "MPAdministrator"
      }
    },
    "discount_amount": null,
    "destination_id": null,
    "type": {
      "alternative_code": "V",
      "name": "VOD",
      "description": null,
      "id": "B3CFC986221548279752B1ABC6F4C480"
    },
    "number": "1952",
    "unit_of_measurement": {
      "alternative_code": "A",
      "name": "Amount",
      "description": null,
      "id": "0F24D08950AA4B5DB5C5F52FA5A4A7D1"
    },
    "subscription_service": {
      "product": {
        "code": "VOD & PPV Base",
        "product_type": {
          "service_type": "TERMED",
          "used_for_provisioning": false,
          "alternative_code": "V&P",
          "udr_type": null,
          "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-12-15T10:58:00",
      "rating_state": "PENDING",
      "service_bundle": null,
      "rated_up_to_date": null,
      "id": "87D5B4A7443A48939DB5F85F1EC0099B",
      "life_cycle_state": "NOT_EFFECTIVE"
    },
    "id": "BD8CACE5E7C24529B9A4DA3BF3CBCD4A",
    "udf_string_2": null,
    "udf_string_3": null,
    "udf_string_4": null,
    "udf_string_5": null,
    "source_system": null,
    "udf_string_1": null,
    "source_category": null,
    "life_cycle_state": "POSTED",
    "rating_date": "2016-09-13T15:49:59",
    "total_amount": 100,
    "rating_type": "PRE_RATED",
    "udf_string_6": null,
    "subscription_action": {
      "performed_by": null,
      "action_type": null,
      "submitted_by": {
        "person_name": "MPAdministrator",
        "id": "1",
        "email": "dev@crm.com",
        "username": "MPAdministrator"
      },
      "executed_on": "2017-01-20T07:26:23",
      "life_cycle_state": "EXECUTED",
      "subscription": {
        "number": "S0000000790",
        "first_activated_date": "2016-11-30T14:58:47",
        "rating_state": "PENDING",
        "accounts_receivable": {
          "number": "ACR0000000881",
          "name": "ACR0000000881",
          "id": "11D5E9E990D14FC7A0ACE8CF253E6654",
          "life_cycle_state": "ACTIVE",
          "account_owner": {
            "company_profile": null,
            "company_name": null,
            "name": "JMeter QuickPay Subscriber",
            "last_name": "Subscriber",
            "id": "0A98A793044542FAB4BB918252678953",
            "life_cycle_state": "FINANCIAL",
            "middle_name": null,
            "title": null,
            "type": "PERSON",
            "first_name": "JMeter QuickPay",
            "demographics": {
              "name_day": {
                "month": null,
                "day": null
              },
              "id_number": null,
              "gender": null,
              "country_of_residence": {
                "alternative_code": "CYP",
                "three_character_code": "CYP",
                "name": "CYPRUS",
                "id": "181",
                "two_character_code": "CY"
              },
              "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": "A51F1D3CF1D046EEB41F43954AB65A2E",
        "life_cycle_state": "NOT_EFFECTIVE",
        "type": {
          "alternative_code": "normalsub",
          "name": "Normal",
          "description": null,
          "id": "D1BAE6454A2248189EBCD7ADD3B4B65F"
        }
      },
      "scheduled_date": "2017-01-20T07:26:20",
      "performed_on": null,
      "sub_action_type": null,
      "business_classification_code": "ADD_SERVICE_USAGE",
      "number": "4845",
      "submitted_on": "2017-01-20T07:26:20",
      "id": "37F83AF986F44C20ACB5BEBC9CB8A62E",
      "job": null,
      "behavior_code": "ADD_SERVICE_USAGE"
    },
    "device": null,
    "udf_string_7": null,
    "udf_string_8": null,
    "usage_service_catalog": {
      "alternative_code": "USC",
      "name": "Usage Service Catalog",
      "description": null,
      "id": "4B959F05F34F443D866D3C09FE69302C"
    },
    "rating_state": "COMPLETED",
    "subscription": {
      "number": "S0000000790",
      "first_activated_date": "2016-11-30T14:58:47",
      "rating_state": "PENDING",
      "accounts_receivable": {
        "number": "ACR0000000881",
        "name": "ACR0000000881",
        "id": "11D5E9E990D14FC7A0ACE8CF253E6654",
        "life_cycle_state": "ACTIVE",
        "account_owner": {
          "company_profile": null,
          "company_name": null,
          "name": "JMeter QuickPay Subscriber",
          "last_name": "Subscriber",
          "id": "0A98A793044542FAB4BB918252678953",
          "life_cycle_state": "FINANCIAL",
          "middle_name": null,
          "title": null,
          "type": "PERSON",
          "first_name": "JMeter QuickPay",
          "demographics": {
            "name_day": {
              "month": null,
              "day": null
            },
            "id_number": null,
            "gender": null,
            "country_of_residence": {
              "alternative_code": "CYP",
              "three_character_code": "CYP",
              "name": "CYPRUS",
              "id": "181",
              "two_character_code": "CY"
            },
            "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": "A51F1D3CF1D046EEB41F43954AB65A2E",
      "life_cycle_state": "NOT_EFFECTIVE",
      "type": {
        "alternative_code": "normalsub",
        "name": "Normal",
        "description": null,
        "id": "D1BAE6454A2248189EBCD7ADD3B4B65F"
      }
    },
    "udf_date_2": null,
    "udf_date_1": null,
    "udf_date_4": null,
    "udf_date_3": null,
    "udf_float_3": null,
    "udf_float_4": null,
    "to_date": "2016-09-13T15:49:59",
    "vat_amount": 16.67,
    "udf_float_1": null,
    "udf_float_2": null,
    "prerated_discount_amount": null,
    "product": {
      "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"
    },
    "from_date": "2016-09-13T15:49:59",
    "accounts_receivable": {
      "number": "ACR0000000881",
      "name": "ACR0000000881",
      "id": "11D5E9E990D14FC7A0ACE8CF253E6654",
      "life_cycle_state": "ACTIVE",
      "account_owner": {
        "company_profile": null,
        "company_name": null,
        "name": "JMeter QuickPay Subscriber",
        "last_name": "Subscriber",
        "id": "0A98A793044542FAB4BB918252678953",
        "life_cycle_state": "FINANCIAL",
        "middle_name": null,
        "title": null,
        "type": "PERSON",
        "first_name": "JMeter QuickPay",
        "demographics": {
          "name_day": {
            "month": null,
            "day": null
          },
          "id_number": null,
          "gender": null,
          "country_of_residence": {
            "alternative_code": "CYP",
            "three_character_code": "CYP",
            "name": "CYPRUS",
            "id": "181",
            "two_character_code": "CY"
          },
          "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
        }
      }
    },
    "usage_method": null,
    "billing_effective_date": "2017-01-20T00:00:00",
    "source_id": null,
    "usage_amount": 1,
    "additional_discount_amount": null,
    "destination_category": null,
    "billing_directive": "TO_BE_BILLED"
  },
  "status": {
    "code": "OK",
    "description": "",
    "message": ""
  }
}
Expand
titleExample 2

HTTP Method: GET

 

Request:

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
  "data": {
    "usage_service_catalog": {
      "alternative_code": "IUSC",
      "name": "Icareus Usage Service Catalog",
      "description": "Icareus Usage Service Catalog",
      "id": "AE91A25BC50C430691652C258026A8FC"
    },
    "log_information": {
      "created_by_unit": {
        "alternative_code": "adminunit",
        "group_name": "Main Group",
        "community_name": "Community",
        "name": "Admin Unit",
        "description": "admin unit",
        "id": "1"
      },
      "updated_by_unit": {
        "alternative_code": "adminunit",
        "group_name": "Main Group",
        "community_name": "Community",
        "name": "Admin Unit",
        "description": "admin unit",
        "id": "1"
      },
      "created_date": "2016-02-17T15:25:52",
      "updated_date": "2016-02-17T15:26:16",
      "updated_by_user": {
        "person_name": "pdemou",
        "id": "6403BD50DF4A4EA59C406FF686FEAB54",
        "email": "crm.com.tst@gmail.com",
        "username": "pdemou"
      },
      "created_by_user": {
        "person_name": "pdemou",
        "id": "6403BD50DF4A4EA59C406FF686FEAB54",
        "email": "crm.com.tst@gmail.com",
        "username": "pdemou"
      }
    },
    "destination_id": null,
    "rating_state": "COMPLETED",
    "currency_rate_period": {
      "from_date": "0EEE31A81A064D97A9873F5676D2F4D9",
      "to_date": 0.25,
      "rate": 0.25,
      "inverse_rate": 4,
      "currency": {
        "suffix_symbol": null,
        "prefix_symbol": null,
        "decimal_part_name": null,
        "code": "FJD",
        "integer_part_name": null,
        "id": "93"
      },
      "id": "0EEE31A81A064D97A9873F5676D2F4D9"
    },
    "subscription": {
      "number": "S0000000047",
      "first_activated_date": "2016-02-17T15:24:56",
      "rating_state": "PENDING",
      "accounts_receivable": {
        "number": "ACR0000000038",
        "name": "ACR0000000038 Panayiota Demou",
        "id": "461B419C1BE64B0DB8206DD91C5B97DA",
        "life_cycle_state": "ACTIVE",
        "account_owner": {
          "company_profile": null,
          "company_name": null,
          "name": "Panayiota Demou",
          "last_name": "Demou",
          "id": "B7D3E4F8A84C45AD919DB3C3E796BACF",
          "life_cycle_state": "FINANCIAL",
          "middle_name": null,
          "title": null,
          "type": "PERSON",
          "first_name": "Panayiota",
          "demographics": {
            "name_day": {
              "month": 2,
              "day": 1
            },
            "id_number": "3423",
            "gender": "FEMALE",
            "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": 3,
              "year": 1991,
              "day": 29
            },
            "industry_sector": null,
            "passport_number": null,
            "industry": null,
            "social_security_number": null,
            "id_issued_by_country": null,
            "passport_issued_by_country": null
          }
        }
      },
      "id": "E094B7A8285C4743B0C49D53266BA394",
      "life_cycle_state": "NOT_EFFECTIVE"
    },
    "type": {
      "alternative_code": "V",
      "name": "VOD",
      "description": null,
      "id": "B3CFC986221548279752B1ABC6F4C480"
    },
    "udf_date_2": null,
    "udf_date_1": null,
    "udf_date_4": null,
    "udf_date_3": null,
    "number": "6",
    "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": null,
        "id": "F7286EF7D017405E8357FF8614A3EA24"
      },
      "first_activated_date": "2016-02-17T00:00:00",
      "rating_state": "PENDING",
      "service_bundle": null,
      "id": "F3958B3CC39545D59B1EC0C4EE73B9CC",
      "life_cycle_state": "NOT_EFFECTIVE"
    },
    "udf_float_3": null,
    "udf_float_4": null,
    "to_date": null,
    "id": "8888097694064C9EB055B3DFAF36B1A6",
    "udf_float_1": null,
    "udf_float_2": null,
    "udf_string_2": null,
    "udf_string_3": null,
    "product": {
      "code": "CREED",
      "product_type": {
        "service_type": "USAGE",
        "used_for_provisioning": true,
        "alternative_code": "V",
        "composition_method": "FLAT",
        "name": "Usage Services",
        "description": "Used for VOD , PPV, TELEPHONE CALLS ETC",
        "id": "751C638AA3534B768408AAC4D73CF516",
        "classification": "SERVICES",
        "physical_good_type": null
      },
      "alternative_code": "C",
      "description": "VOD: CREED",
      "id": "A465D282F44C46AC834BAE50A81CA2F1"
    },
    "udf_string_4": null,
    "udf_string_5": null,
    "from_date": null,
    "source_system": null,
    "udf_string_1": null,
    "source_category": null,
    "accounts_receivable": {
      "number": "ACR0000000038",
      "name": "ACR0000000038 Panayiota Demou",
      "id": "461B419C1BE64B0DB8206DD91C5B97DA",
      "life_cycle_state": "ACTIVE",
      "account_owner": {
        "company_profile": null,
        "company_name": null,
        "name": "Panayiota Demou",
        "last_name": "Demou",
        "id": "B7D3E4F8A84C45AD919DB3C3E796BACF",
        "life_cycle_state": "FINANCIAL",
        "middle_name": null,
        "title": null,
        "type": "PERSON",
        "first_name": "Panayiota",
        "demographics": {
          "name_day": {
            "month": 2,
            "day": 1
          },
          "id_number": "3423",
          "gender": "FEMALE",
          "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": 3,
            "year": 1991,
            "day": 29
          },
          "industry_sector": null,
          "passport_number": null,
          "industry": null,
          "social_security_number": null,
          "id_issued_by_country": null,
          "passport_issued_by_country": null
        }
      }
    },
    "usage_method": null,
    "life_cycle_state": "POSTED",
    "billing_effective_date": "2016-02-17T00:00:00",
    "source_id": null,
    "usage_amount": 50,
    "udf_string_6": null,
    "subscription_action": {
      "performed_by": null,
      "action_type": null,
      "submitted_by": {
        "person_name": "pdemou",
        "id": "6403BD50DF4A4EA59C406FF686FEAB54",
        "username": "pdemou"
      },
      "executed_on": "2016-02-17T15:26:16",
      "life_cycle_state": "EXECUTED",
      "subscription": {
        "number": "S0000000047",
        "first_activated_date": "2016-02-17T15:24:56",
        "rating_state": "PENDING",
        "accounts_receivable": {
          "number": "ACR0000000038",
          "name": "ACR0000000038 Panayiota Demou",
          "id": "461B419C1BE64B0DB8206DD91C5B97DA",
          "life_cycle_state": "ACTIVE",
          "account_owner": {
            "company_profile": null,
            "company_name": null,
            "name": "Panayiota Demou",
            "last_name": "Demou",
            "id": "B7D3E4F8A84C45AD919DB3C3E796BACF",
            "life_cycle_state": "FINANCIAL",
            "middle_name": null,
            "title": null,
            "type": "PERSON",
            "first_name": "Panayiota",
            "demographics": {
              "name_day": {
                "month": 2,
                "day": 1
              },
              "id_number": "3423",
              "gender": "FEMALE",
              "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": 3,
                "year": 1991,
                "day": 29
              },
              "industry_sector": null,
              "passport_number": null,
              "industry": null,
              "social_security_number": null,
              "id_issued_by_country": null,
              "passport_issued_by_country": null
            }
          }
        },
        "id": "E094B7A8285C4743B0C49D53266BA394",
        "life_cycle_state": "NOT_EFFECTIVE",
        "type": {
          "alternative_code": "normalsub",
          "name": "Normal",
          "description": null,
          "id": "D1BAE6454A2248189EBCD7ADD3B4B65F"
        }
      },
      "scheduled_date": "2016-02-17T15:26:15",
      "performed_on": null,
      "sub_action_type": null,
      "business_classification_code": "ADD_SERVICE_USAGE",
      "number": "223",
      "submitted_on": "2016-02-17T15:26:15",
      "id": "3DA5E83A2608448EBB0E5C17F73BEACA",
      "job": null,
      "behavior_code": "ADD_SERVICE_USAGE"
    },
    "device": null,
    "udf_string_7": null,
    "udf_string_8": null,
    "billing_directive": "TO_BE_BILLED"
  },
  "status": {
    "code": "OK",
    "description": "",
    "message": ""
  }
}

GET usage_detail_records/list

This method returns information related with usage detail records. Multiple usage detail records are returned by each call.

Tip

From CRM.COM R9.1.0 usage detail records returned as results will be sorted based on their creation date in descending order (most recent usage detail record retrieved first

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

(semi-optional)

...

Accounts Receivable identifier  

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

...

(semi-optional)

...

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

...

source_system_identifier

(optional)

...

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

...

type_identifier

(optional)

...

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

...

usage_service_catalog_identifier

(optional)

...

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

...

device_identifier

(optional)

...

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

...

usage_method_identifier

(optional)

...

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

...

source_category_identifier

(optional)

...

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

...

destination_category_identifier

(optional)

...

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

...

product_identifier

(optional)

...

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

...

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

...

from_date

(optional)

...

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)

...

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)

...

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

...

offset

(optional)

...

Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number

Tip

Available from CRM.COM R13.0.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

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

Expand
titleExample 1

HTTP Method: GET

 

Request:

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
    "status":
    {
        "message": "",
        "description": "",
        "code": "OK"
    },
    "data":
    [
        {
            "life_cycle_state": "POSTED",
            "number": "UDR000050",
            "id": "3D24B38BECE94B53AF7A4F7C7CE3F2BF",
            "billing_directive": "TO_BE_BILLED"
        },
        {
            "life_cycle_state": "POSTED",
            "number": "UDR000051",
            "id": "35FD6DB199BA4EA5A9B7CA30AE50B714",
            "billing_directive": "TO_BE_BILLED"
        },
        {
            "life_cycle_state": "POSTED",
            "number": "UDR000052",
            "id": "68881581F77246FDAE15F7C586519D9E",
            "billing_directive": "TO_BE_BILLED"
        },
        {
            "life_cycle_state": "POSTED",
            "number": "UDR000074",
            "id": "BEADDEC1CADD432DA42C81462B6740E6",
            "billing_directive": "TO_BE_BILLED"
        },
        {
            "life_cycle_state": "POSTED",
            "number": "UDR000075",
            "id": "FB15CF9F4D884623AEC8D7B30272B16C",
            "billing_directive": "TO_BE_BILLED"
        },
        {
            "life_cycle_state": "POSTED",
            "number": "UDR000076",
            "id": "EBFFF5289CFA45108C76A922B8E2E8B6",
            "billing_directive": "TO_BE_BILLED"
        },
        {
            "life_cycle_state": "POSTED",
            "number": "UDR000077",
            "id": "F929220D58BE4EBE9E38524B660CCBAF",
            "billing_directive": "TO_BE_BILLED"
        },
        {
            "life_cycle_state": "POSTED",
            "number": "UDR000078",
            "id": "D4E9DF4D55104F41A01B337CF6BD9B1D",
            "billing_directive": "TO_BE_BILLED"
        },
        {
            "life_cycle_state": "POSTED",
            "number": "UDR000079",
            "id": "B644B3BF47F44F8A8B6661E8C86EEDDD",
            "billing_directive": "TO_BE_BILLED"
        },
        {
            "life_cycle_state": "CANCELLED",
            "number": "UDR000080",
            "id": "5ED8B0E9D1534D039D93C3D878879E47",
            "billing_directive": "TO_BE_BILLED"
        },
        {
            "life_cycle_state": "POSTED",
            "number": "UDR000081",
            "id": "C0CEE369AAE34D5EA076A62B7D281E16",
            "billing_directive": "TO_BE_BILLED"
        },
        {
            "life_cycle_state": "POSTED",
            "number": "UDR000082",
            "id": "27B8EE55ED8044D0B329F600A1236E65",
            "billing_directive": "TO_BE_BILLED"
        }
    ]
}
Expand
titleExample 2

HTTP Method: GET

 

Request:

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
  "data": [
    {
      "number": "7",
      "currency_rate_period": null,
      "id": "1D91EF7FB52B46BDA74EFAC10735819B",
      "life_cycle_state": "POSTED",
      "billing_directive": "TO_BE_BILLED"
    },
    {
      "number": "8",
      "currency_rate_period": null,
      "id": "2E2ED680115B4D84B98785A2DDF245DF",
      "life_cycle_state": "POSTED",
      "billing_directive": "TO_BE_BILLED"
    },
    {
      "number": "6",
      "currency_rate_period": {
        "from_date": "0EEE31A81A064D97A9873F5676D2F4D9",
        "to_date": 0.25,
        "rate": 0.25,
        "inverse_rate": 4,
        "currency": {
          "suffix_symbol": null,
          "prefix_symbol": null,
          "decimal_part_name": null,
          "code": "FJD",
          "integer_part_name": null,
          "id": "93"
        },
        "id": "0EEE31A81A064D97A9873F5676D2F4D9"
      },
      "id": "8888097694064C9EB055B3DFAF36B1A6",
      "life_cycle_state": "POSTED",
      "billing_directive": "TO_BE_BILLED"
    }
  ],
  "status": {
    "code": "OK",
    "description": "",
    "message": ""
  }
}

POST usage_detail_records/cancel

This method cancels an existing usage detail record, which is in posted state. A single usage record can be updated by each call

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

(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:

...

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

...

titleExample 1

HTTP Method: POST

 

Request:

Body:

 

Code Block
languagexml
linenumberstrue
{
            "token":"FF4C550D74714EDBAE01E7674F8E387D",
            "usage_detail_record_identifier":{"number":"UDR000082"}
}

 

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
    "status":
    {
        "message": "",
        "description": "",
        "code": "OK"
    },
    "data":
    {
        "udf_float_1": null,
        "udf_float_2": null,
        "udf_float_3": null,
        "udf_float_4": null,
        "number": "UDR000082",
        "billing_effective_date": "2015-09-24T00:00:00",
        "billing_directive": "TO_BE_BILLED",
        "udf_string_1": null,
        "udf_string_2": null,
        "udf_string_3": null,
        "udf_string_4": null,
        "udf_string_5": null,
        "destination_category":
        {
            "name": "Voip Application",
            "id": "629C2E9E7B044012B0534787974E9D7C",
            "description": "VOIP APPLICATION",
            "code": "VOIP"
        },
        "udf_string_6": null,
        "udf_string_7": null,
        "udf_string_8": null,
        "subscription_service":
        {
            "life_cycle_state": "EFFECTIVE",
            "id": "C7B603C90BA3440BAA5B6528596D5905",
            "service_bundle": null,
            "product":
            {
                "product_type":
                {
                    "service_type": "TERMED",
                    "physical_good_type": null,
                    "used_for_provisioning": true,
                    "classification": "SERVICES",
                    "composition_method": "FLAT",
                    "id": "BC954969D3172372D498D3BB2BA590A0",
                    "name": "Subscription Packages",
                    "description": "Subscription main packages",
                    "alternative_code": "SP"
                },
                "id": "17540C21EAB9C50D0945F12313B79875",
                "description": "Silver Basic Package",
                "code": "Silver",
                "alternative_code": "SBP"
            }
        },
        "source_system":
        {
            "name": "IVR",
            "id": "AE17CDC38DBD35EE7FD045E59657923B",
            "description": "IVR",
            "alternative_code": "IVR"
        },
        "accounts_receivable":
        {
            "account_owner":
            {
                "last_name": "Ioannou97",
                "middle_name": null,
                "life_cycle_state": "FINANCIAL",
                "company_profile": null,
                "title": null,
                "first_name": "Marios",
                "type": "PERSON",
                "id": "82CAA74F74324D26825E444460F4B65C",
                "name": "Ioannou97 Marios",
                "company_name": null,
                "demographics":
                {
                    "gender": null,
                    "passport_issued_by_country": null,
                    "social_security_number": null,
                    "passport_number": null,
                    "industry_sector": null,
                    "country_of_residence":
                    {
                        "three_character_code": "USA",
                        "two_character_code": "US",
                        "id": "127",
                        "name": "UNITED STATES",
                        "alternative_code": null
                    },
                    "name_day":
                    {
                        "month": null,
                        "day": null
                    },
                    "date_of_birth":
                    {
                        "month": null,
                        "day": null,
                        "year": null
                    },
                    "id_number": "435345",
                    "industry": null,
                    "id_issued_by_country": null
                }
            },
            "life_cycle_state": "ACTIVE",
            "number": "ACR000778",
            "id": "917763A6499545B593DFBBC21A3689CB",
            "name": "mar97"
        },
        "device":
        {
            "name": "Tablet",
            "id": "ACDED1DC999A4FB1AC375622CD1C6147",
            "description": "Tablet",
            "alternative_code": "Tablet"
        },
        "subscription_action":
        {
            "scheduled_date": "2015-09-24T12:01:20",
            "submitted_on": "2015-09-24T12:01:20",
            "action_type": null,
            "sub_action_type": null,
            "business_classification_code": "ADD_SERVICE_USAGE",
            "number": "1942",
            "executed_on": "2015-09-24T12:01:22",
            "life_cycle_state": "EXECUTED",
            "performed_by": null,
            "behavior_code": "ADD_SERVICE_USAGE",
            "id": "579282B52E1F46A3845DAB5AED18F792",
            "submitted_by":
            {
                "person_name": "MPAdministrator",
                "username": "MPAdministrator",
                "id": "1"
            },
            "subscription":
            {
                "life_cycle_state": "EFFECTIVE",
                "accounts_receivable":
                {
                    "account_owner":
                    {
                        "last_name": "Ioannou97",
                        "middle_name": null,
                        "life_cycle_state": "FINANCIAL",
                        "company_profile": null,
                        "title": null,
                        "first_name": "Marios",
                        "type": "PERSON",
                        "id": "82CAA74F74324D26825E444460F4B65C",
                        "name": "Ioannou97 Marios",
                        "company_name": null,
                        "demographics":
                        {
                            "gender": null,
                            "passport_issued_by_country": null,
                            "social_security_number": null,
                            "passport_number": null,
                            "industry_sector": null,
                            "country_of_residence":
                            {
                                "three_character_code": "USA",
                                "two_character_code": "US",
                                "id": "127",
                                "name": "UNITED STATES",
                                "alternative_code": null
                            },
                            "name_day":
                            {
                                "month": null,
                                "day": null
                            },
                            "date_of_birth":
                            {
                                "month": null,
                                "day": null,
                                "year": null
                            },
                            "id_number": "435345",
                            "industry": null,
                            "id_issued_by_country": null
                        }
                    },
                    "life_cycle_state": "ACTIVE",
                    "number": "ACR000778",
                    "id": "917763A6499545B593DFBBC21A3689CB",
                    "name": "mar97"
                },
                "number": "S60555",
                "type":
                {
                    "udf_float_1": null,
                    "udf_float_2": null,
                    "udf_date_1": null,
                    "udf_float_3": null,
                    "udf_date_2": null,
                    "udf_float_4": null,
                    "udf_date_3": null,
                    "udf_date_4": null,
                    "name": "London",
                    "udf_string_1": null,
                    "udf_string_2": null,
                    "udf_string_3": null,
                    "udf_string_4": null,
                    "udf_string_5": null,
                    "udf_string_6": null,
                    "udf_string_7": null,
                    "log_information":
                    {
                        "updated_date": "2015-09-15T10:02:30",
                        "created_date": "2014-06-23T14:59:40",
                        "created_by_unit":
                        {
                            "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                            "name": "Admin Unit",
                            "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                            "alternative_code": "MG"
                        },
                        "updated_by_unit":
                        {
                            "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                            "name": "Admin Unit",
                            "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                            "alternative_code": "MG"
                        },
                        "created_by_user":
                        {
                            "person_name": "MPAdministrator",
                            "username": "MPAdministrator",
                            "id": "1"
                        },
                        "updated_by_user":
                        {
                            "person_name": "MPAdministrator",
                            "username": "MPAdministrator",
                            "id": "1"
                        }
                    },
                    "udf_string_8": null,
                    "id": "3100B0D56E7C7EADF073C34BCE1E42AF",
                    "description": null,
                    "alternative_code": "LND"
                },
                "id": "16C09DFDDF444C25A97953191DE653DC"
            },
            "performed_on": null
        },
        "id": "27B8EE55ED8044D0B329F600A1236E65",
        "subscription":
        {
            "life_cycle_state": "EFFECTIVE",
            "accounts_receivable":
            {
                "account_owner":
                {
                    "last_name": "Ioannou97",
                    "middle_name": null,
                    "life_cycle_state": "FINANCIAL",
                    "company_profile": null,
                    "title": null,
                    "first_name": "Marios",
                    "type": "PERSON",
                    "id": "82CAA74F74324D26825E444460F4B65C",
                    "name": "Ioannou97 Marios",
                    "company_name": null,
                    "demographics":
                    {
                        "gender": null,
                        "passport_issued_by_country": null,
                        "social_security_number": null,
                        "passport_number": null,
                        "industry_sector": null,
                        "country_of_residence":
                        {
                            "three_character_code": "USA",
                            "two_character_code": "US",
                            "id": "127",
                            "name": "UNITED STATES",
                            "alternative_code": null
                        },
                        "name_day":
                        {
                            "month": null,
                            "day": null
                        },
                        "date_of_birth":
                        {
                            "month": null,
                            "day": null,
                            "year": null
                        },
                        "id_number": "435345",
                        "industry": null,
                        "id_issued_by_country": null
                    }
                },
                "life_cycle_state": "ACTIVE",
                "number": "ACR000778",
                "id": "917763A6499545B593DFBBC21A3689CB",
                "name": "mar97"
            },
            "number": "S60555",
            "type":
            {
                "udf_float_1": null,
                "udf_float_2": null,
                "udf_date_1": null,
                "udf_float_3": null,
                "udf_date_2": null,
                "udf_float_4": null,
                "udf_date_3": null,
                "udf_date_4": null,
                "name": "London",
                "udf_string_1": null,
                "udf_string_2": null,
                "udf_string_3": null,
                "udf_string_4": null,
                "udf_string_5": null,
                "udf_string_6": null,
                "udf_string_7": null,
                "log_information":
                {
                    "updated_date": "2015-09-15T10:02:30",
                    "created_date": "2014-06-23T14:59:40",
                    "created_by_unit":
                    {
                        "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                        "name": "Admin Unit",
                        "group_name": "Main Group",
                        "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                        "alternative_code": "MG"
                    },
                    "updated_by_unit":
                    {
                        "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                        "name": "Admin Unit",
                        "group_name": "Main Group",
                        "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                        "alternative_code": "MG"
                    },
                    "created_by_user":
                    {
                        "person_name": "MPAdministrator",
                        "username": "MPAdministrator",
                        "id": "1"
                    },
                    "updated_by_user":
                    {
                        "person_name": "MPAdministrator",
                        "username": "MPAdministrator",
                        "id": "1"
                    }
                },
                "udf_string_8": null,
                "id": "3100B0D56E7C7EADF073C34BCE1E42AF",
                "description": null,
                "alternative_code": "LND"
            },
            "id": "16C09DFDDF444C25A97953191DE653DC"
        },
        "source_category":
        {
            "name": "United Kingdom",
            "id": "3107A54E4DD840DA93A452B12CEF2246",
            "description": "United Kingdom",
            "code": "UK"
        },
        "from_date": "2015-09-23T19:07:44",
        "udf_date_1": null,
        "udf_date_2": null,
        "udf_date_3": null,
        "udf_date_4": null,
        "destination_id": null,
        "product":
        {
            "product_type":
            {
                "service_type": "USAGE",
                "physical_good_type": null,
                "used_for_provisioning": true,
                "classification": "SERVICES",
                "composition_method": "FLAT",
                "id": "219FBB8FBAA1433AB0A33446B61637F9",
                "name": "Usage - Flat",
                "description": "Usage - Flat",
                "alternative_code": "U-F"
            },
            "id": "33F396002DE74BB8BA5439CA943E7FEF",
            "description": "Movie 2",
            "code": "Movie 2",
            "alternative_code": "MOV_2"
        },
        "log_information":
        {
            "updated_date": "2015-09-24T14:05:43",
            "created_date": "2015-09-24T12:01:11",
            "created_by_unit":
            {
                "community_name": "Internal Community",
                "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                "name": "Admin Unit",
                "group_name": "Main Group",
                "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                "alternative_code": "MG"
            },
            "updated_by_unit":
            {
                "community_name": "Internal Community",
                "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                "name": "Admin Unit",
                "group_name": "Main Group",
                "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                "alternative_code": "MG"
            },
            "created_by_user":
            {
                "person_name": "MPAdministrator",
                "username": "MPAdministrator",
                "id": "1",
                "email": "sakkascy1986@hotmail.com"
            },
            "updated_by_user":
            {
                "person_name": "Marios Lannister",
                "username": "MPAdministrator",
                "id": "1"
            }
        },
        "usage_service_catalog":
        {
            "id": "BA2F98BF66494A3584ABE9DA1747BA16",
            "name": "Catalog Story board 5",
            "description": null,
            "alternative_code": "Catalog_SB_5"
        },
        "to_date": "2015-09-30T19:07:44",
        "life_cycle_state": "CANCELLED",
        "usage_amount": 20,
        "type":
        {
            "name": "Discounted",
            "id": "1B812BBE898578C6D26397884B83851A",
            "description": "Discounted",
            "alternative_code": "D"
        },
        "source_id": null,
        "usage_method":
        {
            "name": "Download",
            "id": "665FCE1AF41F44CB87A74CD9E769C488",
            "description": "Download",
            "alternative_code": "Download"
        }
    }
}

...

titleExample 2

HTTP Method: POST

 

Request:

Body:

 

Code Block
languagexml
linenumberstrue
{
    "token":"{{token}}",
      "usage_detail_record_identifier":{"number":"9"}
}

 

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
  "data": {
    "usage_service_catalog": {
      "alternative_code": "IUSC",
      "name": "Icareus Usage Service Catalog",
      "description": "Icareus Usage Service Catalog",
      "id": "AE91A25BC50C430691652C258026A8FC"
    },
    "log_information": {
      "created_by_unit": {
        "alternative_code": "adminunit",
        "group_name": "Main Group",
        "community_name": "Community",
        "name": "Admin Unit",
        "description": "admin unit",
        "id": "1"
      },
      "updated_by_unit": {
        "alternative_code": "adminunit",
        "group_name": "Main Group",
        "community_name": "Community",
        "name": "Admin Unit",
        "description": "admin unit",
        "id": "1"
      },
      "created_date": "2016-03-01T14:36:50",
      "updated_date": "2016-07-19T07:37:56",
      "updated_by_user": {
        "person_name": "CRM COM",
        "id": "1",
        "username": "MPAdministrator"
      },
      "created_by_user": {
        "person_name": "p_xenopoulou",
        "id": "6D7E8CA9F3254F23A5511E20C1D92DB8",
        "email": "p_xenopoulou@crm.com",
        "username": "p_xenopoulou"
      }
    },
    "destination_id": null,
    "rating_state": "COMPLETED",
    "currency_rate_period": {
      "from_date": "0EEE31A81A064D97A9873F5676D2F4D9",
      "to_date": 0.25,
      "rate": 0.25,
      "inverse_rate": 4,
      "currency": {
        "suffix_symbol": null,
        "prefix_symbol": null,
        "decimal_part_name": null,
        "code": "FJD",
        "integer_part_name": null,
        "id": "93"
      },
      "id": "0EEE31A81A064D97A9873F5676D2F4D9"
    },
    "subscription": {
      "number": "S0000000023",
      "first_activated_date": "2016-02-11T16:12:22",
      "rating_state": "PENDING",
      "accounts_receivable": {
        "number": "ACR0000000032",
        "name": "ACR0000000032 1 2",
        "id": "12F1B77F210B4F6390D54562004B8C6C",
        "life_cycle_state": "ACTIVE",
        "account_owner": {
          "company_profile": null,
          "company_name": null,
          "name": "1 2",
          "last_name": "2",
          "id": "F25DE1EAE093426EA8DC83F41D387CB3",
          "life_cycle_state": "FINANCIAL",
          "middle_name": null,
          "title": null,
          "type": "PERSON",
          "first_name": "1",
          "demographics": {
            "name_day": {
              "month": null,
              "day": null
            },
            "id_number": null,
            "gender": null,
            "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": "450D629398554E469990A55187443E56",
      "life_cycle_state": "NOT_EFFECTIVE"
    },
    "type": {
      "alternative_code": "V",
      "name": "VOD",
      "description": null,
      "id": "B3CFC986221548279752B1ABC6F4C480"
    },
    "udf_date_2": null,
    "udf_date_1": null,
    "udf_date_4": null,
    "udf_date_3": null,
    "number": "9",
    "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": null,
        "id": "F7286EF7D017405E8357FF8614A3EA24"
      },
      "first_activated_date": "2016-03-01T00:00:00",
      "rating_state": "PENDING",
      "service_bundle": null,
      "id": "4EE608F776454F8FB41FFBC8C905F52E",
      "life_cycle_state": "NOT_EFFECTIVE"
    },
    "udf_float_3": null,
    "udf_float_4": null,
    "to_date": null,
    "id": "D26E0991D24E4FEBAB37C8775F35E739",
    "udf_float_1": null,
    "udf_float_2": null,
    "udf_string_2": null,
    "udf_string_3": null,
    "product": {
      "code": "CREED",
      "product_type": {
        "service_type": "USAGE",
        "used_for_provisioning": true,
        "alternative_code": "V",
        "composition_method": "FLAT",
        "name": "Usage Services",
        "description": "Used for VOD , PPV, TELEPHONE CALLS ETC",
        "id": "751C638AA3534B768408AAC4D73CF516",
        "classification": "SERVICES",
        "physical_good_type": null
      },
      "alternative_code": "C",
      "description": "VOD: CREED",
      "id": "A465D282F44C46AC834BAE50A81CA2F1"
    },
    "udf_string_4": null,
    "udf_string_5": null,
    "from_date": null,
    "source_system": null,
    "udf_string_1": null,
    "source_category": null,
    "accounts_receivable": {
      "number": "ACR0000000032",
      "name": "ACR0000000032 1 2",
      "id": "12F1B77F210B4F6390D54562004B8C6C",
      "life_cycle_state": "ACTIVE",
      "account_owner": {
        "company_profile": null,
        "company_name": null,
        "name": "1 2",
        "last_name": "2",
        "id": "F25DE1EAE093426EA8DC83F41D387CB3",
        "life_cycle_state": "FINANCIAL",
        "middle_name": null,
        "title": null,
        "type": "PERSON",
        "first_name": "1",
        "demographics": {
          "name_day": {
            "month": null,
            "day": null
          },
          "id_number": null,
          "gender": null,
          "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
        }
      }
    },
    "usage_method": null,
    "life_cycle_state": "CANCELLED",
    "billing_effective_date": "2016-03-01T00:00:00",
    "source_id": null,
    "usage_amount": 1,
    "udf_string_6": null,
    "subscription_action": {
      "performed_by": null,
      "action_type": null,
      "submitted_by": {
        "person_name": "p_xenopoulou",
        "id": "6D7E8CA9F3254F23A5511E20C1D92DB8",
        "username": "p_xenopoulou"
      },
      "executed_on": "2016-03-01T14:37:15",
      "life_cycle_state": "EXECUTED",
      "subscription": {
        "number": "S0000000023",
        "first_activated_date": "2016-02-11T16:12:22",
        "rating_state": "PENDING",
        "accounts_receivable": {
          "number": "ACR0000000032",
          "name": "ACR0000000032 1 2",
          "id": "12F1B77F210B4F6390D54562004B8C6C",
          "life_cycle_state": "ACTIVE",
          "account_owner": {
            "company_profile": null,
            "company_name": null,
            "name": "1 2",
            "last_name": "2",
            "id": "F25DE1EAE093426EA8DC83F41D387CB3",
            "life_cycle_state": "FINANCIAL",
            "middle_name": null,
            "title": null,
            "type": "PERSON",
            "first_name": "1",
            "demographics": {
              "name_day": {
                "month": null,
                "day": null
              },
              "id_number": null,
              "gender": null,
              "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": "450D629398554E469990A55187443E56",
        "life_cycle_state": "NOT_EFFECTIVE",
        "type": {
          "alternative_code": "normalsub",
          "name": "Normal",
          "description": null,
          "id": "D1BAE6454A2248189EBCD7ADD3B4B65F"
        }
      },
      "scheduled_date": "2016-03-01T14:37:14",
      "performed_on": null,
      "sub_action_type": null,
      "business_classification_code": "ADD_SERVICE_USAGE",
      "number": "316",
      "submitted_on": "2016-03-01T14:37:14",
      "id": "F9008B93023B490283AF4FCE5EBDE4EB",
      "job": null,
      "behavior_code": "ADD_SERVICE_USAGE"
    },
    "device": null,
    "udf_string_7": null,
    "udf_string_8": null,
    "billing_directive": "TO_BE_BILLED"
  },
  "status": {
    "code": "OK",
    "description": "",
    "message": ""
  }
}

POST usage_detail_records/cancel_lot

Tip

Available from CRM.COM R13.0.0

 

This method cancels multiple existing usage detail records, which are in Posted state. Multiple usage records can be updated by each call.

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

(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:

...

fields_set

(optional)

...

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

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

This method adjusts an existing usage detail record, which is in posted state. A single usage record can be adjusted by each call

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

(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:

...

product_identifier

(optional)

...

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

...

source_system_identifier

(optional)

...

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

...

from_date

(optional)

...

to_date

(optional)

...

usage_amount

(optional)

...

total_amount

(optional and applicable on conditions)

...

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)

...

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)

...

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)

...

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)

...

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)

...

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

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

...

titleExample 1

HTTP Method: POST

 

Request:

Body:

 

Code Block
languagexml
linenumberstrue
{
"token":"{{token}}",
"usage_detail_record_identifier":{"number":"1"},
"product_identifier":{"code":"CREED"},
"from_date": "2015-09-25T19:07:44",
"to_date": "2015-10-10T19:07:44",
"usage_amount":"25"
   
} 

 

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
  "data": {
    "usage_service_catalog": {
      "alternative_code": "IUSC",
      "name": "Icareus Usage Service Catalog",
      "description": "Icareus Usage Service Catalog",
      "id": "AE91A25BC50C430691652C258026A8FC"
    },
    "log_information": {
      "created_by_unit": {
        "alternative_code": "adminunit",
        "group_name": "Main Group",
        "community_name": "Community",
        "name": "Admin Unit",
        "description": "admin unit",
        "id": "1"
      },
      "updated_by_unit": {
        "alternative_code": "adminunit",
        "group_name": "Main Group",
        "community_name": "Community",
        "name": "Admin Unit",
        "description": "admin unit",
        "id": "1"
      },
      "created_date": "2016-02-17T12:31:17",
      "updated_date": "2016-07-28T14:49:55",
      "updated_by_user": {
        "person_name": "CRM COM",
        "id": "1",
        "username": "MPAdministrator"
      },
      "created_by_user": {
        "person_name": "p_xenopoulou",
        "id": "6D7E8CA9F3254F23A5511E20C1D92DB8",
        "email": "p_xenopoulou@crm.com",
        "username": "p_xenopoulou"
      }
    },
    "destination_id": null,
    "rating_state": "PENDING",
    "subscription": {
      "number": "S0000000041",
      "first_activated_date": "2016-02-16T15:35:01",
      "rating_state": "PENDING",
      "accounts_receivable": {
        "number": "ACR0000000044",
        "name": "ACR0000000044 Matt Black",
        "id": "794EBF31990C4A22B17D1B23EB7ABF55",
        "life_cycle_state": "ACTIVE",
        "account_owner": {
          "company_profile": null,
          "company_name": null,
          "name": "Matt Black",
          "last_name": "Black",
          "id": "76E0E43E7CD74157979230819FD41B8E",
          "life_cycle_state": "FINANCIAL",
          "middle_name": "Y",
          "title": null,
          "type": "PERSON",
          "first_name": "Matt",
          "demographics": {
            "name_day": {
              "month": null,
              "day": null
            },
            "id_number": "1212128596",
            "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": "999999998",
            "id_issued_by_country": null,
            "passport_issued_by_country": null
          }
        }
      },
      "id": "D809554919DD473F959B25C2FA700216",
      "life_cycle_state": "NOT_EFFECTIVE"
    },
    "type": {
      "alternative_code": "V",
      "name": "VOD",
      "description": null,
      "id": "B3CFC986221548279752B1ABC6F4C480"
    },
    "udf_date_2": null,
    "udf_date_1": null,
    "udf_date_4": null,
    "udf_date_3": null,
    "number": "1",
    "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": null,
        "id": "F7286EF7D017405E8357FF8614A3EA24"
      },
      "first_activated_date": "2016-02-17T00:00:00",
      "rating_state": "PENDING",
      "service_bundle": null,
      "id": "89D2B810A52E46179FD076D163812CD4",
      "life_cycle_state": "NOT_EFFECTIVE"
    },
    "udf_float_3": null,
    "udf_float_4": null,
    "to_date": "2015-10-10T19:07:44",
    "id": "CAB30766DA4A405DB2A3C71B57705817",
    "udf_float_1": null,
    "udf_float_2": null,
    "udf_string_2": null,
    "udf_string_3": null,
    "product": {
      "code": "CREED",
      "product_type": {
        "service_type": "USAGE",
        "used_for_provisioning": true,
        "alternative_code": "V",
        "composition_method": "FLAT",
        "name": "Usage Services",
        "description": "Used for VOD , PPV, TELEPHONE CALLS ETC",
        "id": "751C638AA3534B768408AAC4D73CF516",
        "classification": "SERVICES",
        "physical_good_type": null
      },
      "alternative_code": "C",
      "description": "VOD: CREED",
      "id": "A465D282F44C46AC834BAE50A81CA2F1"
    },
    "udf_string_4": null,
    "udf_string_5": null,
    "from_date": "2015-09-25T19:07:44",
    "source_system": null,
    "udf_string_1": "udf1",
    "source_category": null,
    "accounts_receivable": {
      "number": "ACR0000000044",
      "name": "ACR0000000044 Matt Black",
      "id": "794EBF31990C4A22B17D1B23EB7ABF55",
      "life_cycle_state": "ACTIVE",
      "account_owner": {
        "company_profile": null,
        "company_name": null,
        "name": "Matt Black",
        "last_name": "Black",
        "id": "76E0E43E7CD74157979230819FD41B8E",
        "life_cycle_state": "FINANCIAL",
        "middle_name": "Y",
        "title": null,
        "type": "PERSON",
        "first_name": "Matt",
        "demographics": {
          "name_day": {
            "month": null,
            "day": null
          },
          "id_number": "1212128596",
          "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": "999999998",
          "id_issued_by_country": null,
          "passport_issued_by_country": null
        }
      }
    },
    "usage_method": null,
    "life_cycle_state": "POSTED",
    "billing_effective_date": "2016-02-17T00:00:00",
    "source_id": null,
    "usage_amount": 25,
    "udf_string_6": null,
    "subscription_action": {
      "performed_by": null,
      "action_type": null,
      "submitted_by": {
        "person_name": "p_xenopoulou",
        "id": "6D7E8CA9F3254F23A5511E20C1D92DB8",
        "username": "p_xenopoulou"
      },
      "executed_on": "2016-02-17T12:32:50",
      "life_cycle_state": "EXECUTED",
      "subscription": {
        "number": "S0000000041",
        "first_activated_date": "2016-02-16T15:35:01",
        "rating_state": "PENDING",
        "accounts_receivable": {
          "number": "ACR0000000044",
          "name": "ACR0000000044 Matt Black",
          "id": "794EBF31990C4A22B17D1B23EB7ABF55",
          "life_cycle_state": "ACTIVE",
          "account_owner": {
            "company_profile": null,
            "company_name": null,
            "name": "Matt Black",
            "last_name": "Black",
            "id": "76E0E43E7CD74157979230819FD41B8E",
            "life_cycle_state": "FINANCIAL",
            "middle_name": "Y",
            "title": null,
            "type": "PERSON",
            "first_name": "Matt",
            "demographics": {
              "name_day": {
                "month": null,
                "day": null
              },
              "id_number": "1212128596",
              "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": "999999998",
              "id_issued_by_country": null,
              "passport_issued_by_country": null
            }
          }
        },
        "id": "D809554919DD473F959B25C2FA700216",
        "life_cycle_state": "NOT_EFFECTIVE",
        "type": {
          "alternative_code": "normalsub",
          "name": "Normal",
          "description": null,
          "id": "D1BAE6454A2248189EBCD7ADD3B4B65F"
        }
      },
      "scheduled_date": "2016-02-17T12:32:49",
      "performed_on": null,
      "sub_action_type": null,
      "business_classification_code": "ADD_SERVICE_USAGE",
      "number": "214",
      "submitted_on": "2016-02-17T12:32:49",
      "id": "D4E26FB3D5AE4E84BEFAE9A4886C20FD",
      "job": null,
      "behavior_code": "ADD_SERVICE_USAGE"
    },
    "device": null,
    "udf_string_7": null,
    "udf_string_8": null,
    "billing_directive": "TO_BE_BILLED"
  },
  "status": {
    "code": "OK",
    "description": "",
    "message": ""
  }
}

 

POST usage_detail_records/set_not_billable

This method sets the billing directive of an existing usage detail record to not billable. This method is applicable only on usage detail records which are not already not billable. A single usage record can be updated by each call

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

(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:

...

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

...

titleExample 1

HTTP Method: GET

 

Request:

Body:

 

Code Block
languagexml
linenumberstrue
{
            "token":"FF4C550D74714EDBAE01E7674F8E387D",
            "usage_detail_record_identifier":{"number":"UDR000081"}
} 

 

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
    "status":
    {
        "message": "",
        "description": "",
        "code": "OK"
    },
    "data":
    {
        "udf_float_1": null,
        "udf_float_2": null,
        "udf_float_3": null,
        "udf_float_4": null,
        "number": "UDR000081",
        "billing_effective_date": "2015-09-24T00:00:00",
        "billing_directive": "NOT_TO_BE_BILLED",
        "udf_string_1": null,
        "udf_string_2": null,
        "udf_string_3": null,
        "udf_string_4": null,
        "udf_string_5": null,
        "destination_category":
        {
            "name": "Voip Application",
            "id": "629C2E9E7B044012B0534787974E9D7C",
            "description": "VOIP APPLICATION",
            "code": "VOIP"
        },
        "udf_string_6": null,
        "udf_string_7": null,
        "udf_string_8": null,
        "subscription_service":
        {
            "life_cycle_state": "EFFECTIVE",
            "id": "C7B603C90BA3440BAA5B6528596D5905",
            "service_bundle": null,
            "product":
            {
                "product_type":
                {
                    "service_type": "TERMED",
                    "physical_good_type": null,
                    "used_for_provisioning": true,
                    "classification": "SERVICES",
                    "composition_method": "FLAT",
                    "id": "BC954969D3172372D498D3BB2BA590A0",
                    "name": "Subscription Packages",
                    "description": "Subscription main packages",
                    "alternative_code": "SP"
                },
                "id": "17540C21EAB9C50D0945F12313B79875",
                "description": "Silver Basic Package",
                "code": "Silver",
                "alternative_code": "SBP"
            }
        },
        "source_system":
        {
            "name": "IVR",
            "id": "AE17CDC38DBD35EE7FD045E59657923B",
            "description": "IVR",
            "alternative_code": "IVR"
        },
        "accounts_receivable":
        {
            "account_owner":
            {
                "last_name": "Ioannou97",
                "middle_name": null,
                "life_cycle_state": "FINANCIAL",
                "company_profile": null,
                "title": null,
                "first_name": "Marios",
                "type": "PERSON",
                "id": "82CAA74F74324D26825E444460F4B65C",
                "name": "Ioannou97 Marios",
                "company_name": null,
                "demographics":
                {
                    "gender": null,
                    "passport_issued_by_country": null,
                    "social_security_number": null,
                    "passport_number": null,
                    "industry_sector": null,
                    "country_of_residence":
                    {
                        "three_character_code": "USA",
                        "two_character_code": "US",
                        "id": "127",
                        "name": "UNITED STATES",
                        "alternative_code": null
                    },
                    "name_day":
                    {
                        "month": null,
                        "day": null
                    },
                    "date_of_birth":
                    {
                        "month": null,
                        "day": null,
                        "year": null
                    },
                    "id_number": "435345",
                    "industry": null,
                    "id_issued_by_country": null
                }
            },
            "life_cycle_state": "ACTIVE",
            "number": "ACR000778",
            "id": "917763A6499545B593DFBBC21A3689CB",
            "name": "mar97"
        },
        "device":
        {
            "name": "Tablet",
            "id": "ACDED1DC999A4FB1AC375622CD1C6147",
            "description": "Tablet",
            "alternative_code": "Tablet"
        },
        "subscription_action":
        {
            "scheduled_date": "2015-09-24T12:00:05",
            "submitted_on": "2015-09-24T12:00:05",
            "action_type": null,
            "sub_action_type": null,
            "business_classification_code": "ADD_SERVICE_USAGE",
            "number": "1941",
            "executed_on": "2015-09-24T12:00:07",
            "life_cycle_state": "EXECUTED",
            "performed_by": null,
            "behavior_code": "ADD_SERVICE_USAGE",
            "id": "D362FB71D17C43069BA28ACFEA4FFFE3",
            "submitted_by":
            {
                "person_name": "MPAdministrator",
                "username": "MPAdministrator",
                "id": "1"
            },
            "subscription":
            {
                "life_cycle_state": "EFFECTIVE",
                "accounts_receivable":
                {
                    "account_owner":
                    {
                        "last_name": "Ioannou97",
                        "middle_name": null,
                        "life_cycle_state": "FINANCIAL",
                        "company_profile": null,
                        "title": null,
                        "first_name": "Marios",
                        "type": "PERSON",
                        "id": "82CAA74F74324D26825E444460F4B65C",
                        "name": "Ioannou97 Marios",
                        "company_name": null,
                        "demographics":
                        {
                            "gender": null,
                            "passport_issued_by_country": null,
                            "social_security_number": null,
                            "passport_number": null,
                            "industry_sector": null,
                            "country_of_residence":
                            {
                                "three_character_code": "USA",
                                "two_character_code": "US",
                                "id": "127",
                                "name": "UNITED STATES",
                                "alternative_code": null
                            },
                            "name_day":
                            {
                                "month": null,
                                "day": null
                            },
                            "date_of_birth":
                            {
                                "month": null,
                                "day": null,
                                "year": null
                            },
                            "id_number": "435345",
                            "industry": null,
                            "id_issued_by_country": null
                        }
                    },
                    "life_cycle_state": "ACTIVE",
                    "number": "ACR000778",
                    "id": "917763A6499545B593DFBBC21A3689CB",
                    "name": "mar97"
                },
                "number": "S60555",
                "type":
                {
                    "udf_float_1": null,
                    "udf_float_2": null,
                    "udf_date_1": null,
                    "udf_float_3": null,
                    "udf_date_2": null,
                    "udf_float_4": null,
                    "udf_date_3": null,
                    "udf_date_4": null,
                    "name": "London",
                    "udf_string_1": null,
                    "udf_string_2": null,
                    "udf_string_3": null,
                    "udf_string_4": null,
                    "udf_string_5": null,
                    "udf_string_6": null,
                    "udf_string_7": null,
                    "log_information":
                    {
                        "updated_date": "2015-09-15T10:02:30",
                        "created_date": "2014-06-23T14:59:40",
                        "created_by_unit":
                        {
                            "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                            "name": "Admin Unit",
                            "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                            "alternative_code": "MG"
                        },
                        "updated_by_unit":
                        {
                            "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                            "name": "Admin Unit",
                            "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                            "alternative_code": "MG"
                        },
                        "created_by_user":
                        {
                            "person_name": "MPAdministrator",
                            "username": "MPAdministrator",
                            "id": "1"
                        },
                        "updated_by_user":
                        {
                            "person_name": "MPAdministrator",
                            "username": "MPAdministrator",
                            "id": "1"
                        }
                    },
                    "udf_string_8": null,
                    "id": "3100B0D56E7C7EADF073C34BCE1E42AF",
                    "description": null,
                    "alternative_code": "LND"
                },
                "id": "16C09DFDDF444C25A97953191DE653DC"
            },
            "performed_on": null
        },
        "id": "C0CEE369AAE34D5EA076A62B7D281E16",
        "subscription":
        {
            "life_cycle_state": "EFFECTIVE",
            "accounts_receivable":
            {
                "account_owner":
                {
                    "last_name": "Ioannou97",
                    "middle_name": null,
                    "life_cycle_state": "FINANCIAL",
                    "company_profile": null,
                    "title": null,
                    "first_name": "Marios",
                    "type": "PERSON",
                    "id": "82CAA74F74324D26825E444460F4B65C",
                    "name": "Ioannou97 Marios",
                    "company_name": null,
                    "demographics":
                    {
                        "gender": null,
                        "passport_issued_by_country": null,
                        "social_security_number": null,
                        "passport_number": null,
                        "industry_sector": null,
                        "country_of_residence":
                        {
                            "three_character_code": "USA",
                            "two_character_code": "US",
                            "id": "127",
                            "name": "UNITED STATES",
                            "alternative_code": null
                        },
                        "name_day":
                        {
                            "month": null,
                            "day": null
                        },
                        "date_of_birth":
                        {
                            "month": null,
                            "day": null,
                            "year": null
                        },
                        "id_number": "435345",
                        "industry": null,
                        "id_issued_by_country": null
                    }
                },
                "life_cycle_state": "ACTIVE",
                "number": "ACR000778",
                "id": "917763A6499545B593DFBBC21A3689CB",
                "name": "mar97"
            },
            "number": "S60555",
            "type":
            {
                "udf_float_1": null,
                "udf_float_2": null,
                "udf_date_1": null,
                "udf_float_3": null,
                "udf_date_2": null,
                "udf_float_4": null,
                "udf_date_3": null,
                "udf_date_4": null,
                "name": "London",
                "udf_string_1": null,
                "udf_string_2": null,
                "udf_string_3": null,
                "udf_string_4": null,
                "udf_string_5": null,
                "udf_string_6": null,
                "udf_string_7": null,
                "log_information":
                {
                    "updated_date": "2015-09-15T10:02:30",
                    "created_date": "2014-06-23T14:59:40",
                    "created_by_unit":
                    {
                        "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                        "name": "Admin Unit",
                        "group_name": "Main Group",
                        "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                        "alternative_code": "MG"
                    },
                    "updated_by_unit":
                    {
                        "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                        "name": "Admin Unit",
                        "group_name": "Main Group",
                        "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                        "alternative_code": "MG"
                    },
                    "created_by_user":
                    {
                        "person_name": "MPAdministrator",
                        "username": "MPAdministrator",
                        "id": "1"
                    },
                    "updated_by_user":
                    {
                        "person_name": "MPAdministrator",
                        "username": "MPAdministrator",
                        "id": "1"
                    }
                },
                "udf_string_8": null,
                "id": "3100B0D56E7C7EADF073C34BCE1E42AF",
                "description": null,
                "alternative_code": "LND"
            },
            "id": "16C09DFDDF444C25A97953191DE653DC"
        },
        "source_category":
        {
            "name": "United Kingdom",
            "id": "3107A54E4DD840DA93A452B12CEF2246",
            "description": "United Kingdom",
            "code": "UK"
        },
        "from_date": "2015-09-25T19:07:44",
        "udf_date_1": null,
        "udf_date_2": null,
        "udf_date_3": null,
        "udf_date_4": null,
        "destination_id": null,
        "product":
        {
            "product_type":
            {
                "service_type": "USAGE",
                "physical_good_type": null,
                "used_for_provisioning": true,
                "classification": "SERVICES",
                "composition_method": "FLAT",
                "id": "219FBB8FBAA1433AB0A33446B61637F9",
                "name": "Usage - Flat",
                "description": "Usage - Flat",
                "alternative_code": "U-F"
            },
            "id": "5F60B19CFD634F7D9B9EC401C74ACB16",
            "description": "Movie 1",
            "code": "Movie 1",
            "alternative_code": "MOV_1"
        },
        "log_information":
        {
            "updated_date": "2015-09-24T14:15:24",
            "created_date": "2015-09-24T12:00:04",
            "created_by_unit":
            {
                "community_name": "Internal Community",
                "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                "name": "Admin Unit",
                "group_name": "Main Group",
                "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                "alternative_code": "MG"
            },
            "updated_by_unit":
            {
                "community_name": "Internal Community",
                "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                "name": "Admin Unit",
                "group_name": "Main Group",
                "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                "alternative_code": "MG"
            },
            "created_by_user":
            {
                "person_name": "MPAdministrator",
                "username": "MPAdministrator",
                "id": "1",
                "email": "sakkascy1986@hotmail.com"
            },
            "updated_by_user":
            {
                "person_name": "Marios Lannister",
                "username": "MPAdministrator",
                "id": "1"
            }
        },
        "usage_service_catalog":
        {
            "id": "BA2F98BF66494A3584ABE9DA1747BA16",
            "name": "Catalog Story board 5",
            "description": null,
            "alternative_code": "Catalog_SB_5"
        },
        "to_date": "2015-10-10T19:07:44",
        "life_cycle_state": "POSTED",
        "usage_amount": 25,
        "type":
        {
            "name": "Discounted",
            "id": "1B812BBE898578C6D26397884B83851A",
            "description": "Discounted",
            "alternative_code": "D"
        },
        "source_id": null,
        "usage_method":
        {
            "name": "Download",
            "id": "665FCE1AF41F44CB87A74CD9E769C488",
            "description": "Download",
            "alternative_code": "Download"
        }
    }
}

...

titleExample 2

HTTP Method: GET

 

Request:

Body:

 

Code Block
languagexml
linenumberstrue
{
            "token":"FF4C550D74714EDBAE01E7674F8E387D",
            "usage_detail_record_identifier":{"number":"6"}
} 

 

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
  "data": {
    "usage_service_catalog": {
      "alternative_code": "IUSC",
      "name": "Icareus Usage Service Catalog",
      "description": "Icareus Usage Service Catalog",
      "id": "AE91A25BC50C430691652C258026A8FC"
    },
    "log_information": {
      "created_by_unit": {
        "alternative_code": "adminunit",
        "group_name": "Main Group",
        "community_name": "Community",
        "name": "Admin Unit",
        "description": "admin unit",
        "id": "1"
      },
      "updated_by_unit": {
        "alternative_code": "adminunit",
        "group_name": "Main Group",
        "community_name": "Community",
        "name": "Admin Unit",
        "description": "admin unit",
        "id": "1"
      },
      "created_date": "2016-02-17T15:25:52",
      "updated_date": "2016-07-19T08:09:07",
      "updated_by_user": {
        "person_name": "CRM COM",
        "id": "1",
        "username": "MPAdministrator"
      },
      "created_by_user": {
        "person_name": "pdemou",
        "id": "6403BD50DF4A4EA59C406FF686FEAB54",
        "email": "crm.com.tst@gmail.com",
        "username": "pdemou"
      }
    },
    "destination_id": null,
    "rating_state": "PENDING",
    "currency_rate_period": {
      "from_date": "0EEE31A81A064D97A9873F5676D2F4D9",
      "to_date": 0.25,
      "rate": 0.25,
      "inverse_rate": 4,
      "currency": {
        "suffix_symbol": null,
        "prefix_symbol": null,
        "decimal_part_name": null,
        "code": "FJD",
        "integer_part_name": null,
        "id": "93"
      },
      "id": "0EEE31A81A064D97A9873F5676D2F4D9"
    },
    "subscription": {
      "number": "S0000000047",
      "first_activated_date": "2016-02-17T15:24:56",
      "rating_state": "PENDING",
      "accounts_receivable": {
        "number": "ACR0000000038",
        "name": "ACR0000000038 Panayiota Demou",
        "id": "461B419C1BE64B0DB8206DD91C5B97DA",
        "life_cycle_state": "ACTIVE",
        "account_owner": {
          "company_profile": null,
          "company_name": null,
          "name": "Panayiota Demou",
          "last_name": "Demou",
          "id": "B7D3E4F8A84C45AD919DB3C3E796BACF",
          "life_cycle_state": "FINANCIAL",
          "middle_name": null,
          "title": null,
          "type": "PERSON",
          "first_name": "Panayiota",
          "demographics": {
            "name_day": {
              "month": 2,
              "day": 1
            },
            "id_number": "3423",
            "gender": "FEMALE",
            "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": 3,
              "year": 1991,
              "day": 29
            },
            "industry_sector": null,
            "passport_number": null,
            "industry": null,
            "social_security_number": null,
            "id_issued_by_country": null,
            "passport_issued_by_country": null
          }
        }
      },
      "id": "E094B7A8285C4743B0C49D53266BA394",
      "life_cycle_state": "NOT_EFFECTIVE"
    },
    "type": {
      "alternative_code": "V",
      "name": "VOD",
      "description": null,
      "id": "B3CFC986221548279752B1ABC6F4C480"
    },
    "udf_date_2": null,
    "udf_date_1": null,
    "udf_date_4": null,
    "udf_date_3": null,
    "number": "6",
    "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": null,
        "id": "F7286EF7D017405E8357FF8614A3EA24"
      },
      "first_activated_date": "2016-02-17T00:00:00",
      "rating_state": "PENDING",
      "service_bundle": null,
      "id": "F3958B3CC39545D59B1EC0C4EE73B9CC",
      "life_cycle_state": "NOT_EFFECTIVE"
    },
    "udf_float_3": null,
    "udf_float_4": null,
    "to_date": "2015-10-10T19:07:44",
    "id": "8888097694064C9EB055B3DFAF36B1A6",
    "udf_float_1": null,
    "udf_float_2": null,
    "udf_string_2": null,
    "udf_string_3": null,
    "product": {
      "code": "Serendipity",
      "product_type": {
        "service_type": "USAGE",
        "used_for_provisioning": true,
        "alternative_code": "V",
        "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"
    },
    "udf_string_4": null,
    "udf_string_5": null,
    "from_date": "2015-09-25T19:07:44",
    "source_system": null,
    "udf_string_1": null,
    "source_category": null,
    "accounts_receivable": {
      "number": "ACR0000000038",
      "name": "ACR0000000038 Panayiota Demou",
      "id": "461B419C1BE64B0DB8206DD91C5B97DA",
      "life_cycle_state": "ACTIVE",
      "account_owner": {
        "company_profile": null,
        "company_name": null,
        "name": "Panayiota Demou",
        "last_name": "Demou",
        "id": "B7D3E4F8A84C45AD919DB3C3E796BACF",
        "life_cycle_state": "FINANCIAL",
        "middle_name": null,
        "title": null,
        "type": "PERSON",
        "first_name": "Panayiota",
        "demographics": {
          "name_day": {
            "month": 2,
            "day": 1
          },
          "id_number": "3423",
          "gender": "FEMALE",
          "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": 3,
            "year": 1991,
            "day": 29
          },
          "industry_sector": null,
          "passport_number": null,
          "industry": null,
          "social_security_number": null,
          "id_issued_by_country": null,
          "passport_issued_by_country": null
        }
      }
    },
    "usage_method": null,
    "life_cycle_state": "POSTED",
    "billing_effective_date": "2016-02-17T00:00:00",
    "source_id": null,
    "usage_amount": 25,
    "udf_string_6": null,
    "subscription_action": {
      "performed_by": null,
      "action_type": null,
      "submitted_by": {
        "person_name": "pdemou",
        "id": "6403BD50DF4A4EA59C406FF686FEAB54",
        "username": "pdemou"
      },
      "executed_on": "2016-02-17T15:26:16",
      "life_cycle_state": "EXECUTED",
      "subscription": {
        "number": "S0000000047",
        "first_activated_date": "2016-02-17T15:24:56",
        "rating_state": "PENDING",
        "accounts_receivable": {
          "number": "ACR0000000038",
          "name": "ACR0000000038 Panayiota Demou",
          "id": "461B419C1BE64B0DB8206DD91C5B97DA",
          "life_cycle_state": "ACTIVE",
          "account_owner": {
            "company_profile": null,
            "company_name": null,
            "name": "Panayiota Demou",
            "last_name": "Demou",
            "id": "B7D3E4F8A84C45AD919DB3C3E796BACF",
            "life_cycle_state": "FINANCIAL",
            "middle_name": null,
            "title": null,
            "type": "PERSON",
            "first_name": "Panayiota",
            "demographics": {
              "name_day": {
                "month": 2,
                "day": 1
              },
              "id_number": "3423",
              "gender": "FEMALE",
              "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": 3,
                "year": 1991,
                "day": 29
              },
              "industry_sector": null,
              "passport_number": null,
              "industry": null,
              "social_security_number": null,
              "id_issued_by_country": null,
              "passport_issued_by_country": null
            }
          }
        },
        "id": "E094B7A8285C4743B0C49D53266BA394",
        "life_cycle_state": "NOT_EFFECTIVE",
        "type": {
          "alternative_code": "normalsub",
          "name": "Normal",
          "description": null,
          "id": "D1BAE6454A2248189EBCD7ADD3B4B65F"
        }
      },
      "scheduled_date": "2016-02-17T15:26:15",
      "performed_on": null,
      "sub_action_type": null,
      "business_classification_code": "ADD_SERVICE_USAGE",
      "number": "223",
      "submitted_on": "2016-02-17T15:26:15",
      "id": "3DA5E83A2608448EBB0E5C17F73BEACA",
      "job": null,
      "behavior_code": "ADD_SERVICE_USAGE"
    },
    "device": null,
    "udf_string_7": null,
    "udf_string_8": null,
    "billing_directive": "NOT_TO_BE_BILLED"
  },
  "status": {
    "code": "OK",
    "description": "",
    "message": ""
  }
}

POST usage_detail_records/set_billable

This method sets the billing directive of an existing usage detail record to billable. This method is applicable only on usage detail records which are not already billable. A single usage record can be updated by each call

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

(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:

...

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

Expand
titleExample 1

HTTP Method: POST

Request:

Body:

Code Block
languagejs
linenumberstrue
{
            "token":"FF4C550D74714EDBAE01E7674F8E387D",
            "usage_detail_record_identifier":{"number":"UDR000081"}
} 

 

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
    "status":
    {
        "message": "",
        "description": "",
        "code": "OK"
    },
    "data":
    {
        "udf_float_1": null,
        "udf_float_2": null,
        "udf_float_3": null,
        "udf_float_4": null,
        "number": "UDR000081",
        "billing_effective_date": "2015-09-24T00:00:00",
        "billing_directive": "TO_BE_BILLED",
        "udf_string_1": null,
        "udf_string_2": null,
        "udf_string_3": null,
        "udf_string_4": null,
        "udf_string_5": null,
        "destination_category":
        {
            "name": "Voip Application",
            "id": "629C2E9E7B044012B0534787974E9D7C",
            "description": "VOIP APPLICATION",
            "code": "VOIP"
        },
        "udf_string_6": null,
        "udf_string_7": null,
        "udf_string_8": null,
        "subscription_service":
        {
            "life_cycle_state": "EFFECTIVE",
            "id": "C7B603C90BA3440BAA5B6528596D5905",
            "service_bundle": null,
            "product":
            {
                "product_type":
                {
                    "service_type": "TERMED",
                    "physical_good_type": null,
                    "used_for_provisioning": true,
                    "classification": "SERVICES",
                    "composition_method": "FLAT",
                    "id": "BC954969D3172372D498D3BB2BA590A0",
                    "name": "Subscription Packages",
                    "description": "Subscription main packages",
                    "alternative_code": "SP"
                },
                "id": "17540C21EAB9C50D0945F12313B79875",
                "description": "Silver Basic Package",
                "code": "Silver",
                "alternative_code": "SBP"
            }
        },
        "source_system":
        {
            "name": "IVR",
            "id": "AE17CDC38DBD35EE7FD045E59657923B",
            "description": "IVR",
            "alternative_code": "IVR"
        },
        "accounts_receivable":
        {
            "account_owner":
            {
                "last_name": "Ioannou97",
                "middle_name": null,
                "life_cycle_state": "FINANCIAL",
                "company_profile": null,
                "title": null,
                "first_name": "Marios",
                "type": "PERSON",
                "id": "82CAA74F74324D26825E444460F4B65C",
                "name": "Ioannou97 Marios",
                "company_name": null,
                "demographics":
                {
                    "gender": null,
                    "passport_issued_by_country": null,
                    "social_security_number": null,
                    "passport_number": null,
                    "industry_sector": null,
                    "country_of_residence":
                    {
                        "three_character_code": "USA",
                        "two_character_code": "US",
                        "id": "127",
                        "name": "UNITED STATES",
                        "alternative_code": null
                    },
                    "name_day":
                    {
                        "month": null,
                        "day": null
                    },
                    "date_of_birth":
                    {
                        "month": null,
                        "day": null,
                        "year": null
                    },
                    "id_number": "435345",
                    "industry": null,
                    "id_issued_by_country": null
                }
            },
            "life_cycle_state": "ACTIVE",
            "number": "ACR000778",
            "id": "917763A6499545B593DFBBC21A3689CB",
            "name": "mar97"
        },
        "device":
        {
            "name": "Tablet",
            "id": "ACDED1DC999A4FB1AC375622CD1C6147",
            "description": "Tablet",
            "alternative_code": "Tablet"
        },
        "subscription_action":
        {
            "scheduled_date": "2015-09-24T12:00:05",
            "submitted_on": "2015-09-24T12:00:05",
            "action_type": null,
            "sub_action_type": null,
            "business_classification_code": "ADD_SERVICE_USAGE",
            "number": "1941",
            "executed_on": "2015-09-24T12:00:07",
            "life_cycle_state": "EXECUTED",
            "performed_by": null,
            "behavior_code": "ADD_SERVICE_USAGE",
            "id": "D362FB71D17C43069BA28ACFEA4FFFE3",
            "submitted_by":
            {
                "person_name": "MPAdministrator",
                "username": "MPAdministrator",
                "id": "1"
            },
            "subscription":
            {
                "life_cycle_state": "EFFECTIVE",
                "accounts_receivable":
                {
                    "account_owner":
                    {
                        "last_name": "Ioannou97",
                        "middle_name": null,
                        "life_cycle_state": "FINANCIAL",
                        "company_profile": null,
                        "title": null,
                        "first_name": "Marios",
                        "type": "PERSON",
                        "id": "82CAA74F74324D26825E444460F4B65C",
                        "name": "Ioannou97 Marios",
                        "company_name": null,
                        "demographics":
                        {
                            "gender": null,
                            "passport_issued_by_country": null,
                            "social_security_number": null,
                            "passport_number": null,
                            "industry_sector": null,
                            "country_of_residence":
                            {
                                "three_character_code": "USA",
                                "two_character_code": "US",
                                "id": "127",
                                "name": "UNITED STATES",
                                "alternative_code": null
                            },
                            "name_day":
                            {
                                "month": null,
                                "day": null
                            },
                            "date_of_birth":
                            {
                                "month": null,
                                "day": null,
                                "year": null
                            },
                            "id_number": "435345",
                            "industry": null,
                            "id_issued_by_country": null
                        }
                    },
                    "life_cycle_state": "ACTIVE",
                    "number": "ACR000778",
                    "id": "917763A6499545B593DFBBC21A3689CB",
                    "name": "mar97"
                },
                "number": "S60555",
                "type":
                {
                    "udf_float_1": null,
                    "udf_float_2": null,
                    "udf_date_1": null,
                    "udf_float_3": null,
                    "udf_date_2": null,
                    "udf_float_4": null,
                    "udf_date_3": null,
                    "udf_date_4": null,
                    "name": "London",
                    "udf_string_1": null,
                    "udf_string_2": null,
                    "udf_string_3": null,
                    "udf_string_4": null,
                    "udf_string_5": null,
                    "udf_string_6": null,
                    "udf_string_7": null,
                    "log_information":
                    {
                        "updated_date": "2015-09-15T10:02:30",
                        "created_date": "2014-06-23T14:59:40",
                        "created_by_unit":
                        {
                            "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                            "name": "Admin Unit",
                            "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                            "alternative_code": "MG"
                        },
                        "updated_by_unit":
                        {
                            "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                            "name": "Admin Unit",
                            "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                            "alternative_code": "MG"
                        },
                        "created_by_user":
                        {
                            "person_name": "MPAdministrator",
                            "username": "MPAdministrator",
                            "id": "1"
                        },
                        "updated_by_user":
                        {
                            "person_name": "MPAdministrator",
                            "username": "MPAdministrator",
                            "id": "1"
                        }
                    },
                    "udf_string_8": null,
                    "id": "3100B0D56E7C7EADF073C34BCE1E42AF",
                    "description": null,
                    "alternative_code": "LND"
                },
                "id": "16C09DFDDF444C25A97953191DE653DC"
            },
            "performed_on": null
        },
        "id": "C0CEE369AAE34D5EA076A62B7D281E16",
        "subscription":
        {
            "life_cycle_state": "EFFECTIVE",
            "accounts_receivable":
            {
                "account_owner":
                {
                    "last_name": "Ioannou97",
                    "middle_name": null,
                    "life_cycle_state": "FINANCIAL",
                    "company_profile": null,
                    "title": null,
                    "first_name": "Marios",
                    "type": "PERSON",
                    "id": "82CAA74F74324D26825E444460F4B65C",
                    "name": "Ioannou97 Marios",
                    "company_name": null,
                    "demographics":
                    {
                        "gender": null,
                        "passport_issued_by_country": null,
                        "social_security_number": null,
                        "passport_number": null,
                        "industry_sector": null,
                        "country_of_residence":
                        {
                            "three_character_code": "USA",
                            "two_character_code": "US",
                            "id": "127",
                            "name": "UNITED STATES",
                            "alternative_code": null
                        },
                        "name_day":
                        {
                            "month": null,
                            "day": null
                        },
                        "date_of_birth":
                        {
                            "month": null,
                            "day": null,
                            "year": null
                        },
                        "id_number": "435345",
                        "industry": null,
                        "id_issued_by_country": null
                    }
                },
                "life_cycle_state": "ACTIVE",
                "number": "ACR000778",
                "id": "917763A6499545B593DFBBC21A3689CB",
                "name": "mar97"
            },
            "number": "S60555",
            "type":
            {
                "udf_float_1": null,
                "udf_float_2": null,
                "udf_date_1": null,
                "udf_float_3": null,
                "udf_date_2": null,
                "udf_float_4": null,
                "udf_date_3": null,
                "udf_date_4": null,
                "name": "London",
                "udf_string_1": null,
                "udf_string_2": null,
                "udf_string_3": null,
                "udf_string_4": null,
                "udf_string_5": null,
                "udf_string_6": null,
                "udf_string_7": null,
                "log_information":
                {
                    "updated_date": "2015-09-15T10:02:30",
                    "created_date": "2014-06-23T14:59:40",
                    "created_by_unit":
                    {
                        "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                        "name": "Admin Unit",
                        "group_name": "Main Group",
                        "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                        "alternative_code": "MG"
                    },
                    "updated_by_unit":
                    {
                        "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                        "name": "Admin Unit",
                        "group_name": "Main Group",
                        "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                        "alternative_code": "MG"
                    },
                    "created_by_user":
                    {
                        "person_name": "MPAdministrator",
                        "username": "MPAdministrator",
                        "id": "1"
                    },
                    "updated_by_user":
                    {
                        "person_name": "MPAdministrator",
                        "username": "MPAdministrator",
                        "id": "1"
                    }
                },
                "udf_string_8": null,
                "id": "3100B0D56E7C7EADF073C34BCE1E42AF",
                "description": null,
                "alternative_code": "LND"
            },
            "id": "16C09DFDDF444C25A97953191DE653DC"
        },
        "source_category":
        {
            "name": "United Kingdom",
            "id": "3107A54E4DD840DA93A452B12CEF2246",
            "description": "United Kingdom",
            "code": "UK"
        },
        "from_date": "2015-09-25T19:07:44",
        "udf_date_1": null,
        "udf_date_2": null,
        "udf_date_3": null,
        "udf_date_4": null,
        "destination_id": null,
        "product":
        {
            "product_type":
            {
                "service_type": "USAGE",
                "physical_good_type": null,
                "used_for_provisioning": true,
                "classification": "SERVICES",
                "composition_method": "FLAT",
                "id": "219FBB8FBAA1433AB0A33446B61637F9",
                "name": "Usage - Flat",
                "description": "Usage - Flat",
                "alternative_code": "U-F"
            },
            "id": "5F60B19CFD634F7D9B9EC401C74ACB16",
            "description": "Movie 1",
            "code": "Movie 1",
            "alternative_code": "MOV_1"
        },
        "log_information":
        {
            "updated_date": "2015-09-24T14:18:07",
            "created_date": "2015-09-24T12:00:04",
            "created_by_unit":
            {
                "community_name": "Internal Community",
                "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                "name": "Admin Unit",
                "group_name": "Main Group",
                "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                "alternative_code": "MG"
            },
            "updated_by_unit":
            {
                "community_name": "Internal Community",
                "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                "name": "Admin Unit",
                "group_name": "Main Group",
                "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                "alternative_code": "MG"
            },
            "created_by_user":
            {
                "person_name": "MPAdministrator",
                "username": "MPAdministrator",
                "id": "1",
                "email": "sakkascy1986@hotmail.com"
            },
            "updated_by_user":
            {
                "person_name": "Marios Lannister",
                "username": "MPAdministrator",
                "id": "1"
            }
        },
        "usage_service_catalog":
        {
            "id": "BA2F98BF66494A3584ABE9DA1747BA16",
            "name": "Catalog Story board 5",
            "description": null,
            "alternative_code": "Catalog_SB_5"
        },
        "to_date": "2015-10-10T19:07:44",
        "life_cycle_state": "POSTED",
        "usage_amount": 25,
        "type":
        {
            "name": "Discounted",
            "id": "1B812BBE898578C6D26397884B83851A",
            "description": "Discounted",
            "alternative_code": "D"
        },
        "source_id": null,
        "usage_method":
        {
            "name": "Download",
            "id": "665FCE1AF41F44CB87A74CD9E769C488",
            "description": "Download",
            "alternative_code": "Download"
        }
    }
}
Expand
titleExample 2

HTTP Method: POST

Request:

Body:

Code Block
languagexml
linenumberstrue
{
            "token":"FF4C550D74714EDBAE01E7674F8E387D",
            "usage_detail_record_identifier":{"number":"6"}
} 

 

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
  "data": {
    "usage_service_catalog": {
      "alternative_code": "IUSC",
      "name": "Icareus Usage Service Catalog",
      "description": "Icareus Usage Service Catalog",
      "id": "AE91A25BC50C430691652C258026A8FC"
    },
    "log_information": {
      "created_by_unit": {
        "alternative_code": "adminunit",
        "group_name": "Main Group",
        "community_name": "Community",
        "name": "Admin Unit",
        "description": "admin unit",
        "id": "1"
      },
      "updated_by_unit": {
        "alternative_code": "adminunit",
        "group_name": "Main Group",
        "community_name": "Community",
        "name": "Admin Unit",
        "description": "admin unit",
        "id": "1"
      },
      "created_date": "2016-02-17T15:25:52",
      "updated_date": "2016-07-19T08:08:20",
      "updated_by_user": {
        "person_name": "CRM COM",
        "id": "1",
        "username": "MPAdministrator"
      },
      "created_by_user": {
        "person_name": "pdemou",
        "id": "6403BD50DF4A4EA59C406FF686FEAB54",
        "email": "crm.com.tst@gmail.com",
        "username": "pdemou"
      }
    },
    "destination_id": null,
    "rating_state": "PENDING",
    "currency_rate_period": {
      "from_date": "0EEE31A81A064D97A9873F5676D2F4D9",
      "to_date": 0.25,
      "rate": 0.25,
      "inverse_rate": 4,
      "currency": {
        "suffix_symbol": null,
        "prefix_symbol": null,
        "decimal_part_name": null,
        "code": "FJD",
        "integer_part_name": null,
        "id": "93"
      },
      "id": "0EEE31A81A064D97A9873F5676D2F4D9"
    },
    "subscription": {
      "number": "S0000000047",
      "first_activated_date": "2016-02-17T15:24:56",
      "rating_state": "PENDING",
      "accounts_receivable": {
        "number": "ACR0000000038",
        "name": "ACR0000000038 Panayiota Demou",
        "id": "461B419C1BE64B0DB8206DD91C5B97DA",
        "life_cycle_state": "ACTIVE",
        "account_owner": {
          "company_profile": null,
          "company_name": null,
          "name": "Panayiota Demou",
          "last_name": "Demou",
          "id": "B7D3E4F8A84C45AD919DB3C3E796BACF",
          "life_cycle_state": "FINANCIAL",
          "middle_name": null,
          "title": null,
          "type": "PERSON",
          "first_name": "Panayiota",
          "demographics": {
            "name_day": {
              "month": 2,
              "day": 1
            },
            "id_number": "3423",
            "gender": "FEMALE",
            "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": 3,
              "year": 1991,
              "day": 29
            },
            "industry_sector": null,
            "passport_number": null,
            "industry": null,
            "social_security_number": null,
            "id_issued_by_country": null,
            "passport_issued_by_country": null
          }
        }
      },
      "id": "E094B7A8285C4743B0C49D53266BA394",
      "life_cycle_state": "NOT_EFFECTIVE"
    },
    "type": {
      "alternative_code": "V",
      "name": "VOD",
      "description": null,
      "id": "B3CFC986221548279752B1ABC6F4C480"
    },
    "udf_date_2": null,
    "udf_date_1": null,
    "udf_date_4": null,
    "udf_date_3": null,
    "number": "6",
    "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": null,
        "id": "F7286EF7D017405E8357FF8614A3EA24"
      },
      "first_activated_date": "2016-02-17T00:00:00",
      "rating_state": "PENDING",
      "service_bundle": null,
      "id": "F3958B3CC39545D59B1EC0C4EE73B9CC",
      "life_cycle_state": "NOT_EFFECTIVE"
    },
    "udf_float_3": null,
    "udf_float_4": null,
    "to_date": "2015-10-10T19:07:44",
    "id": "8888097694064C9EB055B3DFAF36B1A6",
    "udf_float_1": null,
    "udf_float_2": null,
    "udf_string_2": null,
    "udf_string_3": null,
    "product": {
      "code": "Serendipity",
      "product_type": {
        "service_type": "USAGE",
        "used_for_provisioning": true,
        "alternative_code": "V",
        "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"
    },
    "udf_string_4": null,
    "udf_string_5": null,
    "from_date": "2015-09-25T19:07:44",
    "source_system": null,
    "udf_string_1": null,
    "source_category": null,
    "accounts_receivable": {
      "number": "ACR0000000038",
      "name": "ACR0000000038 Panayiota Demou",
      "id": "461B419C1BE64B0DB8206DD91C5B97DA",
      "life_cycle_state": "ACTIVE",
      "account_owner": {
        "company_profile": null,
        "company_name": null,
        "name": "Panayiota Demou",
        "last_name": "Demou",
        "id": "B7D3E4F8A84C45AD919DB3C3E796BACF",
        "life_cycle_state": "FINANCIAL",
        "middle_name": null,
        "title": null,
        "type": "PERSON",
        "first_name": "Panayiota",
        "demographics": {
          "name_day": {
            "month": 2,
            "day": 1
          },
          "id_number": "3423",
          "gender": "FEMALE",
          "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": 3,
            "year": 1991,
            "day": 29
          },
          "industry_sector": null,
          "passport_number": null,
          "industry": null,
          "social_security_number": null,
          "id_issued_by_country": null,
          "passport_issued_by_country": null
        }
      }
    },
    "usage_method": null,
    "life_cycle_state": "POSTED",
    "billing_effective_date": "2016-02-17T00:00:00",
    "source_id": null,
    "usage_amount": 25,
    "udf_string_6": null,
    "subscription_action": {
      "performed_by": null,
      "action_type": null,
      "submitted_by": {
        "person_name": "pdemou",
        "id": "6403BD50DF4A4EA59C406FF686FEAB54",
        "username": "pdemou"
      },
      "executed_on": "2016-02-17T15:26:16",
      "life_cycle_state": "EXECUTED",
      "subscription": {
        "number": "S0000000047",
        "first_activated_date": "2016-02-17T15:24:56",
        "rating_state": "PENDING",
        "accounts_receivable": {
          "number": "ACR0000000038",
          "name": "ACR0000000038 Panayiota Demou",
          "id": "461B419C1BE64B0DB8206DD91C5B97DA",
          "life_cycle_state": "ACTIVE",
          "account_owner": {
            "company_profile": null,
            "company_name": null,
            "name": "Panayiota Demou",
            "last_name": "Demou",
            "id": "B7D3E4F8A84C45AD919DB3C3E796BACF",
            "life_cycle_state": "FINANCIAL",
            "middle_name": null,
            "title": null,
            "type": "PERSON",
            "first_name": "Panayiota",
            "demographics": {
              "name_day": {
                "month": 2,
                "day": 1
              },
              "id_number": "3423",
              "gender": "FEMALE",
              "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": 3,
                "year": 1991,
                "day": 29
              },
              "industry_sector": null,
              "passport_number": null,
              "industry": null,
              "social_security_number": null,
              "id_issued_by_country": null,
              "passport_issued_by_country": null
            }
          }
        },
        "id": "E094B7A8285C4743B0C49D53266BA394",
        "life_cycle_state": "NOT_EFFECTIVE",
        "type": {
          "alternative_code": "normalsub",
          "name": "Normal",
          "description": null,
          "id": "D1BAE6454A2248189EBCD7ADD3B4B65F"
        }
      },
      "scheduled_date": "2016-02-17T15:26:15",
      "performed_on": null,
      "sub_action_type": null,
      "business_classification_code": "ADD_SERVICE_USAGE",
      "number": "223",
      "submitted_on": "2016-02-17T15:26:15",
      "id": "3DA5E83A2608448EBB0E5C17F73BEACA",
      "job": null,
      "behavior_code": "ADD_SERVICE_USAGE"
    },
    "device": null,
    "udf_string_7": null,
    "udf_string_8": null,
    "billing_directive": "TO_BE_BILLED"
  },
  "status": {
    "code": "OK",
    "description": "",
    "message": ""
  }
}

POST usage_detail_records/set_creditable

This method sets the billing directive of an existing usage detail record to creditable. This method is applicable only on usage detail records which are not already creditable. A single usage record can be updated by each call

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

(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:

...

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

Expand
titleExample 1

HTTP Method: POST

 

Request:

Body:

Code Block
languagexml
linenumberstrue
{
            "token":"FF4C550D74714EDBAE01E7674F8E387D",
            "usage_detail_record_identifier":{"number":"UDR000081"}
} 

 

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
    "status":
    {
        "message": "",
        "description": "",
        "code": "OK"
    },
    "data":
    {
        "udf_float_1": null,
        "udf_float_2": null,
        "udf_float_3": null,
        "udf_float_4": null,
        "number": "UDR000081",
        "billing_effective_date": "2015-09-24T00:00:00",
        "billing_directive": "TO_BE_CREDITED",
        "udf_string_1": null,
        "udf_string_2": null,
        "udf_string_3": null,
        "udf_string_4": null,
        "udf_string_5": null,
        "destination_category":
        {
            "name": "Voip Application",
            "id": "629C2E9E7B044012B0534787974E9D7C",
            "description": "VOIP APPLICATION",
            "code": "VOIP"
        },
        "udf_string_6": null,
        "udf_string_7": null,
        "udf_string_8": null,
        "subscription_service":
        {
            "life_cycle_state": "EFFECTIVE",
            "id": "C7B603C90BA3440BAA5B6528596D5905",
            "service_bundle": null,
            "product":
            {
                "product_type":
                {
                    "service_type": "TERMED",
                    "physical_good_type": null,
                    "used_for_provisioning": true,
                    "classification": "SERVICES",
                    "composition_method": "FLAT",
                    "id": "BC954969D3172372D498D3BB2BA590A0",
                    "name": "Subscription Packages",
                    "description": "Subscription main packages",
                    "alternative_code": "SP"
                },
                "id": "17540C21EAB9C50D0945F12313B79875",
                "description": "Silver Basic Package",
                "code": "Silver",
                "alternative_code": "SBP"
            }
        },
        "source_system":
        {
            "name": "IVR",
            "id": "AE17CDC38DBD35EE7FD045E59657923B",
            "description": "IVR",
            "alternative_code": "IVR"
        },
        "accounts_receivable":
        {
            "account_owner":
            {
                "last_name": "Ioannou97",
                "middle_name": null,
                "life_cycle_state": "FINANCIAL",
                "company_profile": null,
                "title": null,
                "first_name": "Marios",
                "type": "PERSON",
                "id": "82CAA74F74324D26825E444460F4B65C",
                "name": "Ioannou97 Marios",
                "company_name": null,
                "demographics":
                {
                    "gender": null,
                    "passport_issued_by_country": null,
                    "social_security_number": null,
                    "passport_number": null,
                    "industry_sector": null,
                    "country_of_residence":
                    {
                        "three_character_code": "USA",
                        "two_character_code": "US",
                        "id": "127",
                        "name": "UNITED STATES",
                        "alternative_code": null
                    },
                    "name_day":
                    {
                        "month": null,
                        "day": null
                    },
                    "date_of_birth":
                    {
                        "month": null,
                        "day": null,
                        "year": null
                    },
                    "id_number": "435345",
                    "industry": null,
                    "id_issued_by_country": null
                }
            },
            "life_cycle_state": "ACTIVE",
            "number": "ACR000778",
            "id": "917763A6499545B593DFBBC21A3689CB",
            "name": "mar97"
        },
        "device":
        {
            "name": "Tablet",
            "id": "ACDED1DC999A4FB1AC375622CD1C6147",
            "description": "Tablet",
            "alternative_code": "Tablet"
        },
        "subscription_action":
        {
            "scheduled_date": "2015-09-24T12:00:05",
            "submitted_on": "2015-09-24T12:00:05",
            "action_type": null,
            "sub_action_type": null,
            "business_classification_code": "ADD_SERVICE_USAGE",
            "number": "1941",
            "executed_on": "2015-09-24T12:00:07",
            "life_cycle_state": "EXECUTED",
            "performed_by": null,
            "behavior_code": "ADD_SERVICE_USAGE",
            "id": "D362FB71D17C43069BA28ACFEA4FFFE3",
            "submitted_by":
            {
                "person_name": "MPAdministrator",
                "username": "MPAdministrator",
                "id": "1"
            },
            "subscription":
            {
                "life_cycle_state": "EFFECTIVE",
                "accounts_receivable":
                {
                    "account_owner":
                    {
                        "last_name": "Ioannou97",
                        "middle_name": null,
                        "life_cycle_state": "FINANCIAL",
                        "company_profile": null,
                        "title": null,
                        "first_name": "Marios",
                        "type": "PERSON",
                        "id": "82CAA74F74324D26825E444460F4B65C",
                        "name": "Ioannou97 Marios",
                        "company_name": null,
                        "demographics":
                        {
                            "gender": null,
                            "passport_issued_by_country": null,
                            "social_security_number": null,
                            "passport_number": null,
                            "industry_sector": null,
                            "country_of_residence":
                            {
                                "three_character_code": "USA",
                                "two_character_code": "US",
                                "id": "127",
                                "name": "UNITED STATES",
                                "alternative_code": null
                            },
                            "name_day":
                            {
                                "month": null,
                                "day": null
                            },
                            "date_of_birth":
                            {
                                "month": null,
                                "day": null,
                                "year": null
                            },
                            "id_number": "435345",
                            "industry": null,
                            "id_issued_by_country": null
                        }
                    },
                    "life_cycle_state": "ACTIVE",
                    "number": "ACR000778",
                    "id": "917763A6499545B593DFBBC21A3689CB",
                    "name": "mar97"
                },
                "number": "S60555",
                "type":
                {
                    "udf_float_1": null,
                    "udf_float_2": null,
                    "udf_date_1": null,
                    "udf_float_3": null,
                    "udf_date_2": null,
                    "udf_float_4": null,
                    "udf_date_3": null,
                    "udf_date_4": null,
                    "name": "London",
                    "udf_string_1": null,
                    "udf_string_2": null,
                    "udf_string_3": null,
                    "udf_string_4": null,
                    "udf_string_5": null,
                    "udf_string_6": null,
                    "udf_string_7": null,
                    "log_information":
                    {
                        "updated_date": "2015-09-15T10:02:30",
                        "created_date": "2014-06-23T14:59:40",
                        "created_by_unit":
                        {
                            "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                            "name": "Admin Unit",
                            "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                            "alternative_code": "MG"
                        },
                        "updated_by_unit":
                        {
                            "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                            "name": "Admin Unit",
                            "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                            "alternative_code": "MG"
                        },
                        "created_by_user":
                        {
                            "person_name": "MPAdministrator",
                            "username": "MPAdministrator",
                            "id": "1"
                        },
                        "updated_by_user":
                        {
                            "person_name": "MPAdministrator",
                            "username": "MPAdministrator",
                            "id": "1"
                        }
                    },
                    "udf_string_8": null,
                    "id": "3100B0D56E7C7EADF073C34BCE1E42AF",
                    "description": null,
                    "alternative_code": "LND"
                },
                "id": "16C09DFDDF444C25A97953191DE653DC"
            },
            "performed_on": null
        },
        "id": "C0CEE369AAE34D5EA076A62B7D281E16",
        "subscription":
        {
            "life_cycle_state": "EFFECTIVE",
            "accounts_receivable":
            {
                "account_owner":
                {
                    "last_name": "Ioannou97",
                    "middle_name": null,
                    "life_cycle_state": "FINANCIAL",
                    "company_profile": null,
                    "title": null,
                    "first_name": "Marios",
                    "type": "PERSON",
                    "id": "82CAA74F74324D26825E444460F4B65C",
                    "name": "Ioannou97 Marios",
                    "company_name": null,
                    "demographics":
                    {
                        "gender": null,
                        "passport_issued_by_country": null,
                        "social_security_number": null,
                        "passport_number": null,
                        "industry_sector": null,
                        "country_of_residence":
                        {
                            "three_character_code": "USA",
                            "two_character_code": "US",
                            "id": "127",
                            "name": "UNITED STATES",
                            "alternative_code": null
                        },
                        "name_day":
                        {
                            "month": null,
                            "day": null
                        },
                        "date_of_birth":
                        {
                            "month": null,
                            "day": null,
                            "year": null
                        },
                        "id_number": "435345",
                        "industry": null,
                        "id_issued_by_country": null
                    }
                },
                "life_cycle_state": "ACTIVE",
                "number": "ACR000778",
                "id": "917763A6499545B593DFBBC21A3689CB",
                "name": "mar97"
            },
            "number": "S60555",
            "type":
            {
                "udf_float_1": null,
                "udf_float_2": null,
                "udf_date_1": null,
                "udf_float_3": null,
                "udf_date_2": null,
                "udf_float_4": null,
                "udf_date_3": null,
                "udf_date_4": null,
                "name": "London",
                "udf_string_1": null,
                "udf_string_2": null,
                "udf_string_3": null,
                "udf_string_4": null,
                "udf_string_5": null,
                "udf_string_6": null,
                "udf_string_7": null,
                "log_information":
                {
                    "updated_date": "2015-09-15T10:02:30",
                    "created_date": "2014-06-23T14:59:40",
                    "created_by_unit":
                    {
                        "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                        "name": "Admin Unit",
                        "group_name": "Main Group",
                        "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                        "alternative_code": "MG"
                    },
                    "updated_by_unit":
                    {
                        "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                        "name": "Admin Unit",
                        "group_name": "Main Group",
                        "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                        "alternative_code": "MG"
                    },
                    "created_by_user":
                    {
                        "person_name": "MPAdministrator",
                        "username": "MPAdministrator",
                        "id": "1"
                    },
                    "updated_by_user":
                    {
                        "person_name": "MPAdministrator",
                        "username": "MPAdministrator",
                        "id": "1"
                    }
                },
                "udf_string_8": null,
                "id": "3100B0D56E7C7EADF073C34BCE1E42AF",
                "description": null,
                "alternative_code": "LND"
            },
            "id": "16C09DFDDF444C25A97953191DE653DC"
        },
        "source_category":
        {
            "name": "United Kingdom",
            "id": "3107A54E4DD840DA93A452B12CEF2246",
            "description": "United Kingdom",
            "code": "UK"
        },
        "from_date": "2015-09-25T19:07:44",
        "udf_date_1": null,
        "udf_date_2": null,
        "udf_date_3": null,
        "udf_date_4": null,
        "destination_id": null,
        "product":
        {
            "product_type":
            {
                "service_type": "USAGE",
                "physical_good_type": null,
                "used_for_provisioning": true,
                "classification": "SERVICES",
                "composition_method": "FLAT",
                "id": "219FBB8FBAA1433AB0A33446B61637F9",
                "name": "Usage - Flat",
                "description": "Usage - Flat",
                "alternative_code": "U-F"
            },
            "id": "5F60B19CFD634F7D9B9EC401C74ACB16",
            "description": "Movie 1",
            "code": "Movie 1",
            "alternative_code": "MOV_1"
        },
        "log_information":
        {
            "updated_date": "2015-09-24T14:20:39",
            "created_date": "2015-09-24T12:00:04",
            "created_by_unit":
            {
                "community_name": "Internal Community",
                "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                "name": "Admin Unit",
                "group_name": "Main Group",
                "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                "alternative_code": "MG"
            },
            "updated_by_unit":
            {
                "community_name": "Internal Community",
                "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                "name": "Admin Unit",
                "group_name": "Main Group",
                "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                "alternative_code": "MG"
            },
            "created_by_user":
            {
                "person_name": "MPAdministrator",
                "username": "MPAdministrator",
                "id": "1",
                "email": "sakkascy1986@hotmail.com"
            },
            "updated_by_user":
            {
                "person_name": "Marios Lannister",
                "username": "MPAdministrator",
                "id": "1"
            }
        },
        "usage_service_catalog":
        {
            "id": "BA2F98BF66494A3584ABE9DA1747BA16",
            "name": "Catalog Story board 5",
            "description": null,
            "alternative_code": "Catalog_SB_5"
        },
        "to_date": "2015-10-10T19:07:44",
        "life_cycle_state": "POSTED",
        "usage_amount": 25,
        "type":
        {
            "name": "Discounted",
            "id": "1B812BBE898578C6D26397884B83851A",
            "description": "Discounted",
            "alternative_code": "D"
        },
        "source_id": null,
        "usage_method":
        {
            "name": "Download",
            "id": "665FCE1AF41F44CB87A74CD9E769C488",
            "description": "Download",
            "alternative_code": "Download"
        }
    }
}

HTTP Method: POST

 

Request:

Body:

Expand
titleExample 2
Code Block
languagexml
linenumberstrue
{
            "token":"FF4C550D74714EDBAE01E7674F8E387D",
            "usage_detail_record_identifier":{"number":"6"}
} 

 

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
 { "data": { "usage_service_catalog": { "alternative_code": "IUSC", "name": "Icareus Usage Service Catalog", "description": "Icareus Usage Service Catalog", "id": "AE91A25BC50C430691652C258026A8FC" }, "log_information": { "created_by_unit": { "alternative_code": "adminunit", "group_name": "Main Group", "community_name": "Community", "name": "Admin Unit", "description": "admin unit", "id": "1" }, "updated_by_unit": { "alternative_code": "adminunit", "group_name": "Main Group", "community_name": "Community", "name": "Admin Unit", "description": "admin unit", "id": "1" }, "created_date": "2016-02-17T15:25:52", "updated_date": "2016-07-19T08:10:19", "updated_by_user": { "person_name": "CRM COM", "id": "1", "username": "MPAdministrator" }, "created_by_user": { "person_name": "pdemou", "id": "6403BD50DF4A4EA59C406FF686FEAB54", "email": "crm.com.tst@gmail.com", "username": "pdemou" } }, "destination_id": null, "rating_state": "PENDING", "currency_rate_period": { "from_date": "0EEE31A81A064D97A9873F5676D2F4D9", "to_date": 0.25, "rate": 0.25, "inverse_rate": 4, "currency": { "suffix_symbol": null, "prefix_symbol": null, "decimal_part_name": null, "code": "FJD", "integer_part_name": null, "id": "93" }, "id": "0EEE31A81A064D97A9873F5676D2F4D9" }, "subscription": { "number": "S0000000047", "first_activated_date": "2016-02-17T15:24:56", "rating_state": "PENDING", "accounts_receivable": { "number": "ACR0000000038", "name": "ACR0000000038 Panayiota Demou", "id": "461B419C1BE64B0DB8206DD91C5B97DA", "life_cycle_state": "ACTIVE", "account_owner": { "company_profile": null, "company_name": null, "name": "Panayiota Demou", "last_name": "Demou", "id": "B7D3E4F8A84C45AD919DB3C3E796BACF", "life_cycle_state": "FINANCIAL", "middle_name": null, "title": null, "type": "PERSON", "first_name": "Panayiota", "demographics": { "name_day": { "month": 2, "day": 1 }, "id_number": "3423", "gender": "FEMALE", "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": 3, "year": 1991, "day": 29 }, "industry_sector": null, "passport_number": null, "industry": null, "social_security_number": null, "id_issued_by_country": null, "passport_issued_by_country": null } } }, "id": "E094B7A8285C4743B0C49D53266BA394", "life_cycle_state": "NOT_EFFECTIVE" }, "type": { "alternative_code": "V", "name": "VOD", "description": null, "id": "B3CFC986221548279752B1ABC6F4C480" }, "udf_date_2": null, "udf_date_1": null, "udf_date_4": null, "udf_date_3": null, "number": "6", "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": null, "id": "F7286EF7D017405E8357FF8614A3EA24" }, "first_activated_date": "2016-02-17T00:00:00", "rating_state": "PENDING", "service_bundle": null, "id": "F3958B3CC39545D59B1EC0C4EE73B9CC", "life_cycle_state": "NOT_EFFECTIVE" }, "udf_float_3": null, "udf_float_4": null, "to_date": "2015-10-10T19:07:44", "id": "8888097694064C9EB055B3DFAF36B1A6", "udf_float_1": null, "udf_float_2": null, "udf_string_2": null, "udf_string_3": null, "product": { "code": "Serendipity", "product_type": { "service_type": "USAGE", "used_for_provisioning": true, "alternative_code": "V", "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" }, "udf_string_4": null, "udf_string_5": null, "from_date": "2015-09-25T19:07:44", "source_system": null, "udf_string_1": null, "source_category": null, "accounts_receivable": { "number": "ACR0000000038", "name": "ACR0000000038 Panayiota Demou", "id": "461B419C1BE64B0DB8206DD91C5B97DA", "life_cycle_state": "ACTIVE", "account_owner": { "company_profile": null, "company_name": null, "name": "Panayiota Demou", "last_name": "Demou", "id": "B7D3E4F8A84C45AD919DB3C3E796BACF", "life_cycle_state": "FINANCIAL", "middle_name": null, "title": null, "type": "PERSON", "first_name": "Panayiota", "demographics": { "name_day": { "month": 2, "day": 1 }, "id_number": "3423", "gender": "FEMALE", "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": 3, "year": 1991, "day": 29 }, "industry_sector": null, "passport_number": null, "industry": null, "social_security_number": null, "id_issued_by_country": null, "passport_issued_by_country": null } } }, "usage_method": null, "life_cycle_state": "POSTED", "billing_effective_date": "2016-02-17T00:00:00", "source_id": null, "usage_amount": 25, "udf_string_6": null, "subscription_action": { "performed_by": null, "action_type": null, "submitted_by": { "person_name": "pdemou", "id": "6403BD50DF4A4EA59C406FF686FEAB54", "username": "pdemou" }, "executed_on": "2016-02-17T15:26:16", "life_cycle_state": "EXECUTED", "subscription": { "number": "S0000000047", "first_activated_date": "2016-02-17T15:24:56", "rating_state": "PENDING", "accounts_receivable": { "number": "ACR0000000038", "name": "ACR0000000038 Panayiota Demou", "id": "461B419C1BE64B0DB8206DD91C5B97DA", "life_cycle_state": "ACTIVE", "account_owner": { "company_profile": null, "company_name": null, "name": "Panayiota Demou", "last_name": "Demou", "id": "B7D3E4F8A84C45AD919DB3C3E796BACF", "life_cycle_state": "FINANCIAL", "middle_name": null, "title": null, "type": "PERSON", "first_name": "Panayiota", "demographics": { "name_day": { "month": 2, "day": 1 }, "id_number": "3423", "gender": "FEMALE", "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": 3, "year": 1991, "day": 29 }, "industry_sector": null, "passport_number": null, "industry": null, "social_security_number": null, "id_issued_by_country": null, "passport_issued_by_country": null } } }, "id": "E094B7A8285C4743B0C49D53266BA394", "life_cycle_state": "NOT_EFFECTIVE", "type": { "alternative_code": "normalsub", "name": "Normal", "description": null, "id": "D1BAE6454A2248189EBCD7ADD3B4B65F" } }, "scheduled_date": "2016-02-17T15:26:15", "performed_on": null, "sub_action_type": null, "business_classification_code": "ADD_SERVICE_USAGE", "number": "223", "submitted_on": "2016-02-17T15:26:15", "id": "3DA5E83A2608448EBB0E5C17F73BEACA", "job": null, "behavior_code": "ADD_SERVICE_USAGE" }, "device": null, "udf_string_7": null, "udf_string_8": null, "billing_directive": "TO_BE_CREDITED" }, "status": { "code": "OK", "description": "", "message": "" } } Panel
nameblue