CoworkerInvoiceHistories
Search CoworkerInvoiceHistories
Search and list CoworkerInvoiceHistory records with filtering, sorting, and pagination.
GET
A CoworkerInvoiceHistory records a history entry for a customer invoice. Each entry captures an activity or event that occurred on that invoice, such as the invoice being sent, an e-invoicing action, a payment receipt, or a payment error.
Use
IsProblem to flag entries that represent errors or issues (e.g. a failed payment attempt). Set Notify to trigger a notification when the history entry is created.
Authentication
This endpoint requires OAuth2 authentication. Include a valid bearer token in the
Authorization header.
The authenticated user must be a full unrestricted administrator or have the CoworkerInvoiceHistory-List role.Query Parameters
Pagination & Sorting
The page number to retrieve.
The number of records per page.
The property name to sort results by (e.g.
Name, CreatedOn).Sort direction.
1 for ascending, -1 for descending.Filters
Filter by Coworker Invoice Id.
Filter by Coworker Invoice Coworker Id.
Filter by Coworker Invoice Business Id.
Filter by Coworker Invoice Business Currency Code.
Filter by full name of the customer who owns the invoice.
Filter by total amount of the related customer invoice.
Filter by invoice number of the related customer invoice.
Filter by Coworker Invoice Bill To Name.
Filter by whether the related customer invoice has been fully paid.
Filter by Coworker Invoice Paid On.
Filter by Coworker Invoice Refunded.
Filter by Coworker Invoice Refunded On.
Filter by Coworker Invoice Due Date.
Filter by whether the related customer invoice is still in draft.
Filter by short title of the history entry (e.g. ‘Invoice sent’, ‘Payment received’).
Filter by detailed description of the activity or event recorded by this history entry.
Filter by flags this history entry as an error or issue (e.g. a failed payment attempt or e-invoicing error).
Filter by whether to send a notification when this history entry is created.
Range Filters
Filter by coworker invoice coworker id greater than or equal to this value.
Filter by coworker invoice coworker id less than or equal to this value.
Filter by coworker invoice business id greater than or equal to this value.
Filter by coworker invoice business id less than or equal to this value.
Filter by coworker invoice paid on greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by coworker invoice paid on less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by coworker invoice refunded on greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by coworker invoice refunded on less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by coworker invoice due date greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by coworker invoice due date less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter records created on or after this date. Format:
YYYY-MM-DDTHH:mm.Filter records created on or before this date. Format:
YYYY-MM-DDTHH:mm.Filter records updated on or after this date. Format:
YYYY-MM-DDTHH:mm.Filter records updated on or before this date. Format:
YYYY-MM-DDTHH:mm.Code Examples
Simple listing
Filtering by Name
Range filters
Response
200
The list of CoworkerInvoiceHistory records matching the query. See the Get one CoworkerInvoiceHistory endpoint for the full list of properties returned for each record.
Current page number.
Number of records per page.
The field used for sorting.
The sort direction (
1 = ascending, -1 = descending).Index of the first item on the current page.
Index of the last item on the current page.
Total number of matching records across all pages.
Total number of pages.
Whether there is a next page of results.
Whether there is a previous page of results.
Example Response