TAG LINE
TAG LINE
SMALL TITLE
This internal entity represents the frequency units used in billing.
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. |
GET | FrequencyType/ |
Retrieve all of the FrequencyType objects. | |
Retrieve all of the FrequencyType objects. GET FrequencyType/ HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "totalCount": 1, "items": [ { "identity": 1, "name": "Month", "sortOrder": "1" } ] } |
GET | FrequencyType/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 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" } ] } } |
GET | FrequencyType/{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} HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "instance": { "identity": 1, "name": "Month", "sortOrder": "1" } } |