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