TAG LINE
SMALL TITLE

Bill Run / History

(API Version v4)


A list of previously run, or currently running, Bill Run details.


What can you do with BillRunHistory?


Properties

Property Details
identity
READ-ONLY
"identity": 18
Type: Number
This is the unique numeric identifier for the BillRunHistory
ownerId
READ-ONLY
"ownerId": 11
Type: Number
Unique identifier for the associated Owner object.
ownerName
READ-ONLY
"ownerName": "Sample Name"
Type: String
The name of the object associated with the ownerId property.
billRunId
"billRunId": 27
Type: Number
Unique identifier for the associated BillRun object.
billRunName
"billRunName": "Sample Name"
Type: String
The name of the object associated with the billRunId property.
name
"name": "Hello World"
Type: String
complete
READ-ONLY
"complete": true
Type: Boolean
Whether or not this Bill Run has completed.
billRunScheduleId
"billRunScheduleId": 21
Type: Number
Unique identifier for the associated BillRunSchedule object.
billRunScheduleName
"billRunScheduleName": "Sample Name"
Type: String
The name of the object associated with the billRunScheduleId property.
currencyExchangeId
"currencyExchangeId": 10
Type: Number
Unique identifier for the associated CurrencyExchange object.
currencyExchangeName
"currencyExchangeName": "Sample Name"
Type: String
The name of the object associated with the currencyExchangeId property.
parentBillRunHistoryId
"parentBillRunHistoryId": 15
Type: Number
Unique identifier for the associated BillRunHistory object.
parentBillRunHistoryName
"parentBillRunHistoryName": "Sample Name"
Type: String
The name of the object associated with the parentBillRunHistoryId property.


End Points

GETapi/v4/BillRun/History/
Retrieve all of the BillRunHistory objects.
Retrieve all of the BillRunHistory objects.
GET api/v4/BillRun/History/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "ownerId": 16,
            "ownerName": "Sample Text Data",
            "billRunId": 6,
            "billRunName": "Sample Text Data",
            "name": "Sample Text Data",
            "complete": true,
            "billRunScheduleId": 14,
            "billRunScheduleName": "Sample Text Data",
            "currencyExchangeId": 2,
            "currencyExchangeName": "Sample Text Data",
            "parentBillRunHistoryId": 3,
            "parentBillRunHistoryName": "Sample Text Data"
        }
    ]
}
GETapi/v4/BillRun/History/Paged
Retrieve all of the BillRunHistory 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 BillRunHistory objects in a paged fashion.
GET api/v4/BillRun/History/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,
                "ownerId": 1,
                "ownerName": "Sample Text Data",
                "billRunId": 23,
                "billRunName": "Sample Text Data",
                "name": "Sample Text Data",
                "complete": true,
                "billRunScheduleId": 17,
                "billRunScheduleName": "Sample Text Data",
                "currencyExchangeId": 22,
                "currencyExchangeName": "Sample Text Data",
                "parentBillRunHistoryId": 22,
                "parentBillRunHistoryName": "Sample Text Data"
            }
        ]
    }
}
GETapi/v4/BillRun/History/{id}
Retrieve an instance of the BillRunHistory object by its ID.
{id}Unique identifier for the BillRunHistory object.
Retrieve an instance of the BillRunHistory object by its ID.
GET api/v4/BillRun/History/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "ownerId": 6,
        "ownerName": "Sample Text Data",
        "billRunId": 3,
        "billRunName": "Sample Text Data",
        "name": "Sample Text Data",
        "complete": true,
        "billRunScheduleId": 3,
        "billRunScheduleName": "Sample Text Data",
        "currencyExchangeId": 16,
        "currencyExchangeName": "Sample Text Data",
        "parentBillRunHistoryId": 18,
        "parentBillRunHistoryName": "Sample Text Data"
    }
}
GETapi/v4/BillRun/History/{id}/Detail
Retrieve deep detail of the BillRunHistory object by its ID. This endpoint returns additional detailed data related to this object. The specifics on which data is returned will depend on which related objects have been populated in the system.
{id}Unique identifier for the BillRunHistory object.
Retrieve deep detail of the BillRunHistory object by its ID.
GET api/v4/BillRun/History/{id}/Detail
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "ownerId": 2,
        "ownerName": "Sample Text Data",
        "billRunId": 8,
        "billRunName": "Sample Text Data",
        "name": "Sample Text Data",
        "complete": true,
        "billRunScheduleId": 20,
        "billRunScheduleName": "Sample Text Data",
        "currencyExchangeId": 27,
        "currencyExchangeName": "Sample Text Data",
        "parentBillRunHistoryId": 7,
        "parentBillRunHistoryName": "Sample Text Data",
        "details": {
            "sampleSingleObject": {
                "identity": 2,
                "property1": "Sample Text",
                "property2": "2021-04-26T15:25:29.117Z",
                "property3": 2
            },
            "sampleMultipleObjects": {
                "totalCount": 1,
                "items": [
                    {
                        "identity": 2,
                        "property1": "Sample Text",
                        "property2": "2021-04-26T15:25:29.117Z",
                        "property3": 2
                    }
                ]
            }
        }
    }
}
POSTapi/v4/BillRun/History/Search
Retreive a list of BillRunHistory 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 BillRunHistory objects based on search criteria.
POST api/v4/BillRun/History/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,
            "ownerId": 24,
            "ownerName": "Sample Text Data",
            "billRunId": 17,
            "billRunName": "Sample Text Data",
            "name": "Sample Text Data",
            "complete": true,
            "billRunScheduleId": 16,
            "billRunScheduleName": "Sample Text Data",
            "currencyExchangeId": 8,
            "currencyExchangeName": "Sample Text Data",
            "parentBillRunHistoryId": 16,
            "parentBillRunHistoryName": "Sample Text Data"
        }
    ]
}