Customer Invoices

GET /customerInvoices

Returns a list of invoices. The list can be filtered by customer, job, invoice number, and due dates.

Request

Base URL
https://api.fergus.com
Auth
- OAuth 2
  Authorization codehttps://auth.fergus.com/oauth2/authorize
  Token URLhttps://auth.fergus.com/oauth2/token
- or HTTP bearer
TypeScript
https://skmtc.dev/fergus/apis/fergus-api/docs/customerInvoices/get.ts
A function with typed inputs. Its response is checked against the schema.

pageSizeinteger

'asc'

'desc'

pageCursorstring

'id'

'createdAt'

'dueDate'

customerIdnumber

Filter by customer ID

jobIdnumber

Filter by job ID

invoiceNumberstring

Search by invoiceNumber

dueBeforestring date-time

Filter invoices due before this datetime

dueAfterstring date-time

Filter invoices due after this datetime

'processing'

'succeeded'

'failed'

Filter by direct debit status

Successful Response

resultstring required

No recorded changes to this operation across all 18 revisions of this API.