POST usage_detail_records/cancel_lot
- Former user (Deleted)
- Joseph Ioannou (Unlicensed)
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 | ||||||||||||
| subscription_action_identifier (mandatory) | Subscription Action identifier | The subscription action identifier that should be used for cancelling the usage detail record lot. The allowed subscription action identifier fields are the following:
| ||||||||||||
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
Available from CRM.COM R13.0.0
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved usage detail record |
| number | String | The number of the retrieved usage detail record |
| life_cycle_state | String | The state of the retrieved usage detail record which can be one of the following: POSTED, CANCELLED |
transaction_reference_number
| String | The unique transaction reference number of the retrieved usage detail record action |
| subscription | Subscription object | The related subscription object |
| subscription_service | Subscription Service object | The related subscription service object, which is classified as a usage service |
| product | Product object | The actual product that was used, which is classified as a usage service |
| unit_of_measurement | Units of Measurement Object | The Unit of measurement of the retrieved usage detail record type |
Referred Objects Response Data
Examples
HTTP Method: POST
Request:
Body:
{
"token": "{{token}}",
"subscription_action_identifier":{"id":"00B8A9381A994A4CABDC9716F866B77C"}
}
Response:
{
"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": ""
}
}