TAG LINE
SMALL TITLE

Invoice / History

(API Version v4)


Contains a list of historical actions/events that an Invoice passess through during its lifecycle.


What can you do with InvoiceHistory?


Properties

Property Details
identity
READ-ONLY
"identity": 25
Type: Number
This is the unique numeric identifier for the InvoiceHistory
invoiceId
"invoiceId": 17
Type: Number
Unique identifier for the associated Invoice object.
invoiceName
"invoiceName": "Sample Name"
Type: String
The name of the object associated with the invoiceId property.
date
"date": "2021-04-26T15:25:27.587Z"
Type: Date
Date Time Stamp for this specific historical event.

Date and time values are specified in the ISO 8601 format.
action
"action": "rendered"
Type: String
The specific action that occured for this invoice. Examples are "rendered", "delivered" etc.
userId
"userId": 13
Type: Number
Unique identifier for the associated User object.
userName
"userName": "Sample Name"
Type: String
The name of the object associated with the userId property.
billRunHistoryId
"billRunHistoryId": 11
Type: Number
The Bill Run that created this invoice event.

Unique identifier for the associated BillRunHistory object.
billRunHistoryName
"billRunHistoryName": "Sample Name"
Type: String
The name of the object associated with the billRunHistoryId property.


End Points

GETapi/v4/Invoice/History/
Retrieve all of the InvoiceHistory objects.
Retrieve all of the InvoiceHistory objects.
GET api/v4/Invoice/History/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "invoiceId": 1,
            "invoiceName": "Sample Text Data",
            "date": "2021-04-26T15:25:27.587Z",
            "action": "rendered",
            "userId": 16,
            "userName": "Sample Text Data",
            "billRunHistoryId": 3,
            "billRunHistoryName": "Sample Text Data"
        }
    ]
}
GETapi/v4/Invoice/History/Paged
Retrieve all of the InvoiceHistory 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 InvoiceHistory objects in a paged fashion.
GET api/v4/Invoice/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,
                "invoiceId": 3,
                "invoiceName": "Sample Text Data",
                "date": "2021-04-26T15:25:27.587Z",
                "action": "rendered",
                "userId": 5,
                "userName": "Sample Text Data",
                "billRunHistoryId": 4,
                "billRunHistoryName": "Sample Text Data"
            }
        ]
    }
}
GETapi/v4/Invoice/History/{id}
Retrieve an instance of the InvoiceHistory object by its ID.
{id}Unique identifier for the InvoiceHistory object.
Retrieve an instance of the InvoiceHistory object by its ID.
GET api/v4/Invoice/History/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "invoiceId": 16,
        "invoiceName": "Sample Text Data",
        "date": "2021-04-26T15:25:27.587Z",
        "action": "rendered",
        "userId": 17,
        "userName": "Sample Text Data",
        "billRunHistoryId": 6,
        "billRunHistoryName": "Sample Text Data"
    }
}
POSTapi/v4/Invoice/History/Search
Retreive a list of InvoiceHistory 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 InvoiceHistory objects based on search criteria.
POST api/v4/Invoice/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,
            "invoiceId": 9,
            "invoiceName": "Sample Text Data",
            "date": "2021-04-26T15:25:27.587Z",
            "action": "rendered",
            "userId": 9,
            "userName": "Sample Text Data",
            "billRunHistoryId": 0,
            "billRunHistoryName": "Sample Text Data"
        }
    ]
}