frex v0.1.4 Frex.Client.Invoices

Staff have access to the API calls listed below if the Invoices tab is enabled for staff. Staff users can only access invoices that belong to clients they are assigned to.

Summary

Functions

Return the complete invoice details associated with the given invoice_id

Returns a list of invoice summaries. Results are ordered by descending invoice_id

Functions

get(credentials, invoice_id)

Return the complete invoice details associated with the given invoice_id.

  • You can use the value to provide your customers with a direct link to their invoice.
  • You can use the element to provide your customers with direct links to the invoice for editing, viewing by the client and viewing by an administrator.

Parameters

  • invoice_id (required) — invoice ID
list(credentials, filters \\ %{})

Returns a list of invoice summaries. Results are ordered by descending invoice_id.

Note: This method uses pagination.

The value used for status’ can bedisputed’, draft’,sent’, viewed’,paid’, auto-paid’,retry’, failed’ or the special statusunpaid’ which will retrieve all invoices with a status of disputed’,sent’, viewed’,retry’ or `failed’.