TAG LINE
SMALL TITLE

Bill Run / Status Type

(API Version v2)


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": 25
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": 12
Type: Number
Unused.


Update Request Filters

Update Request Filters are no longer required starting with v4 of the LogiSense Billing API.

When updating an object you use the update request header with the list of properties to update. Then you need only supply the new values in the body of your request. Please note, this header can only be used with PUT or PATCH requests.

Field List:

  • name

End Points

GETapi/v2/BillRun/StatusType/
Retrieve all of the BillRunStatusType objects.
Retrieve all of the BillRunStatusType objects.
GET api/v2/BillRun/StatusType/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "name": "Completed",
            "sortOrder": 18
        }
    ]
}
GETapi/v2/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/v2/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": 20
            }
        ]
    }
}
GETapi/v2/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/v2/BillRun/StatusType/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "name": "Completed",
        "sortOrder": 2
    }
}