Retrieve the list of Invoices for a given filter

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

The invoice number.

string

The id of the customer associated to the invoice.

string

The id of the customer from the platform that is integrating with Adfin.

string

The status of the invoice.

  • DRAFT: The invoice does not contain contact details for the payer or it is not yet distributed.
  • UNPAID: The invoice is not yet paid.
  • OVERDUE: The invoice is not yet paid and it is passed the due date.
  • SCHEDULED: The invoice is scheduled to collect the payment via Direct Debit.
  • SUBMITTED: The remaining due amount on the invoice is covered by submitted (but not yet confirmed) Direct Debit payments.
  • PAID: The invoice payment has been captured.
  • SETTLED: The invoice is paid out.
  • VOID: The invoice was voided.
string

The status reason codes of the invoice.

string

The start date after which the invoices due date should be, including the start date.

string

The end date before which the invoices due date should be, including the end date.

string

The start date after which the invoices issue date should be, including the start date.

string

The end date before which the invoices issue date should be, including the end date.

string

The start time after which the invoice was paid, including the paid start time.

string

The end time after which the invoice was paid, including the paid end time.

string

The start time after which the invoices last updated time should be, including the start time.

string

The end time before which the invoices last updated time should be, including the end time.

string

The start time before which the payment link was seen.

string

The text to search for in the invoices.

string

Whether the response should include details on total count and counts per statuses

string

The credit control status of the invoice.

  • AT_RISK: The invoice is at risk of not being paid.
  • EXPECTED: The invoice is expected to be paid.
  • CONFIRMED: The invoice is paid.
string

The cashflow status of the payment request.

  • UNPAID – not yet paid.
  • PROCESSING – expected to be paid.
  • PAID_OUT – already paid out.
string

Start of the cashflow period (inclusive)

string

End of the cashflow period (inclusive)

string

The direct debit mandate status.

  • NO_MANDATE: invoices linked to customers without a mandate
  • AWAITING_SIGNATURE: invoices linked to customers awaiting signature
  • SIGNED: invoices linked to customers with a signed mandate, but not yet active
  • ACTIVE: invoices linked to customers with an active mandate.
string

The workflow type.

  • AUTO_COLLECT: automatic collection workflow, such as direct debit
  • ON_DEMAND: on demain workflow, such as via open banking and card payments
string
≥ 0

amount greater than or equal to

string
≥ 0

amount less than or equal to

string

The review session ID to filter invoices by

string

List of invoice IDs to filter by

integer
≥ 0
Defaults to 0

Zero-based page index (0..N)

integer
≥ 1
Defaults to 50

The size of the page to be returned

sort
array of strings
Defaults to creationTime,DESC

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

sort
Responses

400

A problem reading or understanding the request. Ensure that the request complies with the required format and includes all necessary parameters.

401

Authentication required - Invalid or missing authorization headers.

422

A request validation error.

500

The server could not process the request.

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json