Thanks Jonathan for your reply.
I am looking for an operation which returns last 24 month bills for a given billing account. Can I use "
GET /customerBill?fields=...&{filtering} " operation to filter the billCycles for single billing Account.
The sample response for (GET /customerBill) provided in the user guide is slightly confusing it address multiple billing accounts for given customer or it will return the multiple bills of given billing account.
[
{
"id": "CB-123",
"href": "https://server:port/tmf-api/Customer_Bill_Management/v4/customerBill/CB-123",
"billingAccount": {
"id": "A0815",
"href": "http://host:port/tmf-api/Account_Management/v4/billingAccount/A0815",
"name": "BA Peter Retep",
"@referredType": "billingAccount",
"@type": "billingAccountRef",
"@baseType": "billingAccountRef",
"@schemaLocation": "...some href..."
}
},
{
"id": "CB-456",
"href": "https://server:port/tmf-api/Customer_Bill_Management/v4/customerBill/CB-456",
"billingAccount": {
"id": "A4712",
"href": "http://host:port/tmf-api/Account_Management/v4/billingAccount/A4712",
"name": "BA Claire Erialc",
"@referredType": "billingAccount",
"@type": "billingAccountRef",
"@baseType": "billingAccountRef",
"@schemaLocation": "...some href..."
}
}
]
I am specifically looking for the operation similar to
GET /billCycle?fields=...&{filtering}, Not getting the appropriate way to use the /customerBill entity to achieve this.
Regards,
Veera
------------------------------
veera chopperla
BT Group plc
------------------------------
Original Message:
Sent: Dec 02, 2021 02:07
From: Jonathan Goldberg
Subject: TMF Customer Bill Management API -- Operation for List Bill Cycles
Hi Veera
In general, all the GETs for managed entities in the Open API should support filtering by all top-level attributes, those contained directly in the parent entity (apart from href), unless explicitly specified otherwise in the conformance profile for a given API.
The filter parameters are not generated into the API swagger files, presumably due to complexity, and also to the possible support for JSON Path expressions, whose syntax is not expressible in swagger.
Hope it helps.
------------------------------
Jonathan Goldberg
Amdocs Management Limited
Any opinions and statements made by me on this forum are purely personal, and do not necessarily reflect the position of the TM Forum or my employer.
Original Message:
Sent: Dec 02, 2021 01:30
From: veera chopperla
Subject: TMF Customer Bill Management API -- Operation for List Bill Cycles
Hello,
In the user guide of customer bill management, I could see the API Operation for retrieving the list of bill cycles "GET /billCycle?fields=...&{filtering}". But the same is not showing in the swagger doc or in Conformance Profile. Is the /billCycle a valid API to expose for retrieving the bill cycle??
I have a requirement to provide the last 1 year bill cycle issue date and corresponding bill cycle specifications. Please provide your suggestions.
Document Referred: https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/OpenApiTable/4.0.0/user_guides/TMF678_Customer_Bill_Management_API_User_Guide_v4.0.0.pdf
------------------------------
veera chopperla
BT Group plc
------------------------------