CoworkerInvoices
Search CoworkerInvoices
Search and list CoworkerInvoice records with filtering, sorting, and pagination.
GET
A CoworkerInvoice represents an invoice document issued to a customer. Invoices track amounts owed, payment status, billing details, and integration state with external accounting systems.
Invoices can be in draft or final state. A draft invoice (“Draft
true) can still be modified before being finalised. Once finalised, an invoice number is assigned and the invoice can be sent to the customer.
An invoice may also be a credit note (CreditNote` true`), which references the original invoice via OriginalInvoiceGuid“ and represents a reversal or adjustment.
Payment status is tracked via Paid, PaidAmount, and PaidOn. Partial payments are possible — compare PaidAmount against TotalAmount to determine outstanding balance. Refunds are tracked separately via Refunded, RefundedOn, and RefundedAmount.
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 CoworkerInvoice-List role.Enums
eStorecoveInvoiceStatus — StorecoveInvoiceStatus values
eStorecoveInvoiceStatus — StorecoveInvoiceStatus values
| Value | Name |
|---|---|
| 1 | None |
| 2 | TransferFailed |
| 3 | Processing |
| 4 | ProcessingFailed |
| 5 | Processed |
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 Id.
Filter by full name of the invoiced customer.
Filter by Coworker Regular Payment Contract Number.
Filter by Coworker Regular Payment Provider.
Filter by Coworker Card Number.
Filter by Coworker Go Cardless Contract Number.
Filter by Coworker Enable Go Cardless Payments.
Filter by billing email address of the customer.
Filter by Coworker Notify On New Invoice.
Filter by Coworker Notify On New Payment.
Filter by Coworker Notify On Failed Payment.
Filter by Coworker Do Not Process Invoices Automatically.
Filter by company name of the invoiced customer.
Filter by team names the invoiced customer belongs to.
Filter by Business Id.
Filter by name of the location that issued the invoice.
Filter by unique invoice number assigned when the invoice is finalised.
Filter by reference code used to match payments to this invoice.
Filter by name of the person or company being billed.
Filter by billing address on the invoice.
Filter by billing city on the invoice.
Filter by billing post code on the invoice.
Filter by billing phone number on the invoice.
Filter by billing fax number on the invoice.
Filter by billing state or region on the invoice.
Filter by Bill To Country Id.
Filter by name of the billing country on the invoice.
Filter by Bill To Country Two Digits Code.
Filter by bank account number on the invoice for payment.
Filter by tax identification number of the billed party.
Filter by customer purchase order number for this invoice.
Filter by free-text description or notes for the invoice.
Filter by discount amount applied to the invoice total.
Filter by date by which payment is due.
Filter by start date of the billing period covered by this invoice.
Filter by end date of the billing period covered by this invoice.
Filter by total invoice amount including tax.
Filter by total amount paid against this invoice so far.
Filter by Transaction Total Amount.
Filter by Transaction Currency Id.
Filter by Transaction Currency Code.
Filter by Transaction Exchange Rate.
Filter by Currency Id.
Filter by iSO currency code (e.g. USD, EUR, GBP).
Filter by total tax amount on the invoice.
Filter by whether the invoice is still a draft. Draft invoices can be modified before finalisation.
Filter by whether the invoice has been voided (cancelled without a credit note).
Filter by whether the invoice is queued for invoice number assignment.
Filter by whether the invoice has been fully paid.
Filter by whether the invoice has been emailed to the customer.
Filter by date the invoice was emailed to the customer.
Filter by date the invoice was marked as fully paid.
Filter by whether a refund has been issued for this invoice.
Filter by whether the invoice has been transferred to Xero.
Filter by whether the payment has been transferred to Xero.
Filter by whether the invoice has been transferred to QuickBooks.
Filter by whether the payment has been transferred to QuickBooks.
Filter by whether the invoice has been transferred to Moloni.
Filter by whether the payment has been transferred to Moloni.
Filter by status of e-invoicing transfer via Storecove.
Filter by whether the invoice is automatically sent to Storecove for e-invoicing.
Filter by Storecove Unique Id.
Filter by date the refund was issued.
Filter by whether this document is a credit note rather than an invoice.
Filter by gUID of the original invoice this credit note reverses.
Filter by gUID of the contract that generated this invoice.
Filter by arbitrary custom data stored with the invoice.
Filter by goCardless payment reference for direct debit collection.
Filter by Spreedly Token.
Filter by Last Payment Attempt.
Filter by Billed.
Filter by whether to skip automatic application of available credit to this invoice.
Filter by Created On Local.
Filter by Due Date Local.
Filter by Invoice From Date Local.
Filter by Invoice To Date Local.
Filter by Paid On Local.
Filter by Refunded On Local.
Filter by Last Payment Attempt Local.
Filter by total amount received via direct payments.
Filter by amount paid via credit notes or account credit.
Filter by total amount refunded on this invoice.
Filter by transaction ID from NexKiosk point-of-sale payment.
Filter by whether the invoice is automatically transferred to Xero or QuickBooks.
Range Filters
Filter by discount amount applied to the invoice total greater than or equal to this value.
Filter by discount amount applied to the invoice total less than or equal to this value.
Filter by date by which payment is due greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by date by which payment is due less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by start date of the billing period covered by this invoice greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by start date of the billing period covered by this invoice less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by end date of the billing period covered by this invoice greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by end date of the billing period covered by this invoice less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by total invoice amount including tax greater than or equal to this value.
Filter by total invoice amount including tax less than or equal to this value.
Filter by total amount paid against this invoice so far greater than or equal to this value.
Filter by total amount paid against this invoice so far less than or equal to this value.
Filter by transaction total amount greater than or equal to this value.
Filter by transaction total amount less than or equal to this value.
Filter by transaction exchange rate greater than or equal to this value.
Filter by transaction exchange rate less than or equal to this value.
Filter by total tax amount on the invoice greater than or equal to this value.
Filter by total tax amount on the invoice less than or equal to this value.
Filter by date the invoice was emailed to the customer greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by date the invoice was emailed to the customer less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by date the invoice was marked as fully paid greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by date the invoice was marked as fully paid less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by date the refund was issued greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by date the refund was issued less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by last payment attempt greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by last payment attempt less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by created on local greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by created on local less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by due date local greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by due date local less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by invoice from date local greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by invoice from date local less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by invoice to date local greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by invoice to date local less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by paid on local greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by paid on local less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by refunded on local greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by refunded on local less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by last payment attempt local greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by last payment attempt local less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by total amount received via direct payments greater than or equal to this value.
Filter by total amount received via direct payments less than or equal to this value.
Filter by amount paid via credit notes or account credit greater than or equal to this value.
Filter by amount paid via credit notes or account credit less than or equal to this value.
Filter by total amount refunded on this invoice greater than or equal to this value.
Filter by total amount refunded on this invoice less than or equal to this value.
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 InvoiceNumber
Range filters
Response
200
The list of CoworkerInvoice records matching the query. See the Get one CoworkerInvoice 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