TAG LINE
TAG LINE
SMALL TITLE

Frequency / Type

(API Version v8)


This internal entity represents the frequency units used in billing.


What can you do with FrequencyType?


Properties

Property Details
identity
READ-ONLY
"identity": 18
Type: Number
This is the unique numeric identifier for the FrequencyType
name
"name": "Month"
Type: String
The name of the Frequency
sortOrder
"sortOrder": 1
Type: Number
The order in which the frequency appears.


End Points

GETFrequencyType/
Retrieve all of the FrequencyType objects.
Retrieve all of the FrequencyType objects.
GET FrequencyType/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "name": "Month",
            "sortOrder": "1"
        }
    ]
}
GETFrequencyType/Paged
Retrieve all of the FrequencyType 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 FrequencyType objects in a paged fashion.
GET FrequencyType/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": "Month",
                "sortOrder": "1"
            }
        ]
    }
}
GETFrequencyType/{id}
Retrieve an instance of the FrequencyType object by its ID.
{id}Unique identifier for the FrequencyType object.
Retrieve an instance of the FrequencyType object by its ID.
GET FrequencyType/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "name": "Month",
        "sortOrder": "1"
    }
}