Invoices

Lists invoice headers.

Requires ViewInvoices. Cursor-paginated: pass the last invoice's syncId as after. Also available as CSV (Accept: text/csv or ?format=csv); paging cursor in X-Next-Cursor.

get/api/v1/invoices

Request

  • Base URL: https://app.flexonthejob.com
  • URL: https://app.flexonthejob.com/api/v1/invoices
  • Auth: HTTP bearer

Query parameters

status'Draft' | 'Sent' | 'Viewed' | 'PartiallyPaid' | 'Paid' | 'Overdue' | 'Cancelled' | 'Outstanding' | 'Consolidated'

Only invoices in this status (name such as Sent or numeric value).

jobIdinteger

Only invoices billing this job.

customerIdinteger

Only invoices billed to this customer.

updatedSincestring date-time

Only invoices created or modified at/after this UTC instant.

afterstring

SyncId of the last invoice of the previous page.

limitinteger

Page size, 1..200 (default 50).

format'csv'

Alternative to the Accept header: csv returns text/csv.

Response

One page of invoice headers.

nextCursorstring nullable

SyncId of the last item; pass it back as ?after= to fetch the next page. null when this is the last page.

Changes

No recorded changes to this operation across all 1 revision of this API.