TAG LINE
TAG LINE
SMALL TITLE
The Bill Run Status Type are internal statuses for a Bill Run showing their current status in the billing pipeline. Such as "Completed", "Failed" etc.
identity READ-ONLY | "identity": 24 Type: Number This is the unique numeric identifier for the BillRunStatusType |
name READ-ONLY | "name": "Completed" Type: String The defined name for this Status Type. |
sortOrder READ-ONLY | "sortOrder": 16 Type: Number Unused. |
GET | BillRun/StatusType/ |
Retrieve all of the BillRunStatusType objects. | |
Retrieve all of the BillRunStatusType objects. GET BillRun/StatusType/ HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "totalCount": 1, "items": [ { "identity": 1, "name": "Completed", "sortOrder": 5 } ] } |
GET | BillRun/StatusType/Paged |
Retrieve all of the BillRunStatusType 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 BillRunStatusType objects in a paged fashion. GET BillRun/StatusType/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": "Completed", "sortOrder": 24 } ] } } |
GET | BillRun/StatusType/{id} |
Retrieve an instance of the BillRunStatusType object by its ID. | |
{id} | Unique identifier for the BillRunStatusType object. |
Retrieve an instance of the BillRunStatusType object by its ID. GET BillRun/StatusType/{id} HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "instance": { "identity": 1, "name": "Completed", "sortOrder": 0 } } |