TAG LINE
TAG LINE
SMALL TITLE
Contains a list of historical actions/events that an Invoice passess through during its lifecycle.
identity READ-ONLY | "identity": 15 Type: Number This is the unique numeric identifier for the InvoiceHistory |
invoiceId | "invoiceId": 21 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": 1 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": 7 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. |
GET | Invoice/History/ |
Retrieve all of the InvoiceHistory objects. | |
Retrieve all of the InvoiceHistory objects. GET Invoice/History/ HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "totalCount": 1, "items": [ { "identity": 1, "invoiceId": 3, "invoiceName": "Sample Text Data", "date": "2021-04-26T15:25:27.587Z", "action": "rendered", "userId": 27, "userName": "Sample Text Data", "billRunHistoryId": 9, "billRunHistoryName": "Sample Text Data" } ] } |
GET | 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 Invoice/History/Paged 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": 24, "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" } ] } } |
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} HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "instance": { "identity": 1, "invoiceId": 19, "invoiceName": "Sample Text Data", "date": "2021-04-26T15:25:27.587Z", "action": "rendered", "userId": 7, "userName": "Sample Text Data", "billRunHistoryId": 13, "billRunHistoryName": "Sample Text Data" } } |