TAG LINE
TAG LINE
SMALL TITLE

Bill Cancel Option Type

(API Version v10)


This entity allows you to query the system to find out the different final bill charging options.


What can you do with BillCancelOptionType?


Properties

Property Details
identity
READ-ONLY
"identity": 19
Type: Number
This is the unique numeric identifier for the BillCancelOptionType
name
"name": "Prorate Final Period Charge"
Type: String
The name of the final bill charging option.
sortOrder
"sortOrder": 20
Type: Number
The order location the object appears in the list of objects.


End Points

GETBillCancelOptionType/
Retrieve all of the BillCancelOptionType objects.
Retrieve all of the BillCancelOptionType objects.
GET BillCancelOptionType/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "name": "Prorate Final Period Charge",
            "sortOrder": 11
        }
    ]
}
GETBillCancelOptionType/Paged
Retrieve all of the BillCancelOptionType objects in a paged fashion. This endpoint implements pagination for its results. Individual pages can be requested to return a particular paged set in the list of results. To learn more, see details on working with paginated endpoints.
Retrieve all of the BillCancelOptionType objects in a paged fashion.
GET BillCancelOptionType/Paged
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "pagination": {
        "pageNumber": 1,
        "pageSize": 20,
        "excludeTotalCount": false
    },
    "pagedResults": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "name": "Prorate Final Period Charge",
                "sortOrder": 27
            }
        ]
    }
}
GETBillCancelOptionType/{id}
Retrieve an instance of the BillCancelOptionType object by its ID.
{id}Unique identifier for the BillCancelOptionType object.
Retrieve an instance of the BillCancelOptionType object by its ID.
GET BillCancelOptionType/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "name": "Prorate Final Period Charge",
        "sortOrder": 24
    }
}