TAG LINE
SMALL TITLE

Bill Run / Status Type

(API Version v4)


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.


What can you do with BillRunStatusType?


Properties

Property Details
identity
READ-ONLY
"identity": 23
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": 26
Type: Number
Unused.


End Points

GETapi/v4/BillRun/StatusType/
Retrieve all of the BillRunStatusType objects.
Retrieve all of the BillRunStatusType objects.
GET api/v4/BillRun/StatusType/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "name": "Completed",
            "sortOrder": 8
        }
    ]
}
GETapi/v4/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 api/v4/BillRun/StatusType/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": "Completed",
                "sortOrder": 16
            }
        ]
    }
}
GETapi/v4/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 api/v4/BillRun/StatusType/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "name": "Completed",
        "sortOrder": 7
    }
}
POSTapi/v4/BillRun/StatusType/Search
Retreive a list of BillRunStatusType objects based on search criteria. Search end points allow for retrieving results based on search criteria. Search criteria is sent as the payload of the POST.
Retreive a list of BillRunStatusType objects based on search criteria.
POST api/v4/BillRun/StatusType/Search

{
    "query": {
        "top": 20,
        "search": [
            {
                "name": "MyFieldName",
                "operator": "startsWith",
                "value": "a"
            }
        ]
    }
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "itemCount": 1,
    "items": [
        {
            "identity": 1,
            "name": "Completed",
            "sortOrder": 8
        }
    ]
}