Sign in
Invoice

Gets list of Invoices

TransactionStatusCode values are: "Draft", "Sent", "Late", "Paid", "Partial", "Void"

get/api/Invoice

Query parameters

UpdatedAfterstring date-time

Only return invoices updated after this date-time.

pageSizeinteger

Number of items per page (max 1000)

pageNumberinteger

Page to display. Starts from 1.

TransactionStatusCodestring

Filter by invoice status. Values: Draft, Sent, Late, Paid, Partial, Void.

IssueDateFromstring date-time

Filter invoices issued on or after this date (ISO 8601).

IssueDateTostring date-time

Filter invoices issued before this date (ISO 8601).

DueDateFromstring date-time

Filter invoices due on or after this date (ISO 8601).

DueDateTostring date-time

Filter invoices due before this date (ISO 8601).

Sortstring

Sort results by: DateUpdated, DateCreated (append ' desc' for descending).

CompanyIDFKinteger

Filter invoices to a specific customer company by Company ID.

IncludeSourceLinksboolean

When true, each line item also lists the IDs of the timesheets, expenses and fixed amounts linked to it (TimesheetEntryIDs / ExpenseIDs / FixedAmountIDs). Defaults to false to keep large list responses small.

Response

Returns a paginated list of invoices with line items.

TotalCountinteger

Total number of records matching the query across all pages.

PageNumberinteger

The current page number (1-based).

PageSizeinteger

The number of records per page.

Changes