Invoice / History

(API Version v10)

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

What can you do with InvoiceHistory?

GET Invoice/History/
Retrieve all of the InvoiceHistory objects.
GET Invoice/History/Paged
Retrieve all of the InvoiceHistory objects in a paged fashion.
GET Invoice/History/{id}
Retrieve an instance of the InvoiceHistory object by its ID.

Properties

Property Details

identity READ-ONLY	"identity": 15 Type: Number This is the unique numeric identifier for the InvoiceHistory
invoiceId	"invoiceId": 3 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": 6 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": 24 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

Retrieve all of the InvoiceHistory objects.

GET Invoice/History/

View Sample Response

HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "invoiceId": 23,
            "invoiceName": "Sample Text Data",
            "date": "2021-04-26T15:25:27.587Z",
            "action": "rendered",
            "userId": 7,
            "userName": "Sample Text Data",
            "billRunHistoryId": 11,
            "billRunHistoryName": "Sample Text Data"
        }
    ]
}

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 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": 26,
                "invoiceName": "Sample Text Data",
                "date": "2021-04-26T15:25:27.587Z",
                "action": "rendered",
                "userId": 22,
                "userName": "Sample Text Data",
                "billRunHistoryId": 20,
                "billRunHistoryName": "Sample Text Data"
            }
        ]
    }
}

GET	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 Invoice/History/{id} View Sample Response HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "instance": { "identity": 1, "invoiceId": 17, "invoiceName": "Sample Text Data", "date": "2021-04-26T15:25:27.587Z", "action": "rendered", "userId": 26, "userName": "Sample Text Data", "billRunHistoryId": 25, "billRunHistoryName": "Sample Text Data" } }