TAG LINE
SMALL TITLE

Usage / Rate / Calculation Type

(API Version v2)


What can you do with UsageRateCalculationType?


Properties

Property Details
identity
READ-ONLY
"identity": 13
Type: Number
This is the unique numeric identifier for the UsageRateCalculationType
name
"name": "Hello World"
Type: String
description
"description": "Hello World"
Type: String
sortOrder
"sortOrder": 9
Type: Number
visible
"visible": true
Type: Boolean


Update Request Filters

Update Request Filters are no longer required starting with v4 of the LogiSense Billing API.

When updating an object you use the update request header with the list of properties to update. Then you need only supply the new values in the body of your request. Please note, this header can only be used with PUT or PATCH requests.

Field List:

  • name
  • description
  • sortOrder
  • visible

End Points

GETapi/v2/Usage/Rate/CalculationType/
Retrieve all of the UsageRateCalculationType objects.
Retrieve all of the UsageRateCalculationType objects.
GET api/v2/Usage/Rate/CalculationType/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "name": "Sample Text Data",
            "description": "Sample Text Data",
            "sortOrder": 24,
            "visible": true
        }
    ]
}
GETapi/v2/Usage/Rate/CalculationType/Paged
Retrieve all of the UsageRateCalculationType 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 UsageRateCalculationType objects in a paged fashion.
GET api/v2/Usage/Rate/CalculationType/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": "Sample Text Data",
                "description": "Sample Text Data",
                "sortOrder": 0,
                "visible": true
            }
        ]
    }
}
GETapi/v2/Usage/Rate/CalculationType/{id}
Retrieve an instance of the UsageRateCalculationType object by its ID.
{id}Unique identifier for the UsageRateCalculationType object.
Retrieve an instance of the UsageRateCalculationType object by its ID.
GET api/v2/Usage/Rate/CalculationType/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "name": "Sample Text Data",
        "description": "Sample Text Data",
        "sortOrder": 0,
        "visible": true
    }
}