TAG LINE
SMALL TITLE
Contains a list of historical actions/events that an Invoice passess through during its lifecycle.
identity READ-ONLY | "identity": 21 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": 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": 1 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. |
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:
| GET | api/v3/Invoice/History/ |
| Retrieve all of the InvoiceHistory objects. | |
Retrieve all of the InvoiceHistory objects. GET api/v3/Invoice/History/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"invoiceId": 12,
"invoiceName": "Sample Text Data",
"date": "2021-04-26T15:25:27.587Z",
"action": "rendered",
"userId": 17,
"userName": "Sample Text Data",
"billRunHistoryId": 15,
"billRunHistoryName": "Sample Text Data"
}
]
} | |
| GET | api/v3/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/v3/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": 15,
"invoiceName": "Sample Text Data",
"date": "2021-04-26T15:25:27.587Z",
"action": "rendered",
"userId": 12,
"userName": "Sample Text Data",
"billRunHistoryId": 6,
"billRunHistoryName": "Sample Text Data"
}
]
}
} | |
| GET | api/v3/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/v3/Invoice/History/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"invoiceId": 8,
"invoiceName": "Sample Text Data",
"date": "2021-04-26T15:25:27.587Z",
"action": "rendered",
"userId": 23,
"userName": "Sample Text Data",
"billRunHistoryId": 18,
"billRunHistoryName": "Sample Text Data"
}
} | |