Sign in

v1

latestOpenAPI 3.1.02026-08-0670151364.9 KB
Invoices

Retrieve a list of invoices by filter

get/invoices

Query parameters

invoiceNostring

The invoice number.

The invoice number.

customerIdstring

The id of the customer associated to the invoice.

The id of the customer associated to the invoice.

externalCustomerIdstring

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

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

statusesstring[]

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.

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.
statusReasonsstring[]

The status reason codes of the invoice.

The status reason codes of the invoice.

dueStartDatestring date-time

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

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

dueEndDatestring date-time

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

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

issueStartDatestring date-time

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

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

issueEndDatestring date-time

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

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

paidStartTimestring date-time

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

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

paidEndTimestring date-time

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

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

lastUpdatedStartTimestring date-time

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

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

lastUpdatedEndTimestring date-time

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

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

paymentLinkLastSeenTimestring date-time

The start time before which the payment link was seen.

The start time before which the payment link was seen.

searchTextstring

The text to search for in the invoices.

The text to search for in the invoices.

includeCountboolean

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

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

creditControlStatusesstring[]

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.

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.
cashflowStatusesstring[]

The cashflow status of the payment request.

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

The cashflow status of the payment request.

  • UNPAID – not yet paid.
  • PROCESSING – expected to be paid.
  • PAID_OUT – already paid out.
cashflowPeriodStartDatestring date-time

Start of the cashflow period (inclusive)

Start of the cashflow period (inclusive)

cashflowPeriodEndDatestring date-time

End of the cashflow period (inclusive)

End of the cashflow period (inclusive)

directDebitMandateStatusesstring[]

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.
  • MIGRATING: invoices linked to customers with an active mandate which is being migrated to a different payment service provider.

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.
  • MIGRATING: invoices linked to customers with an active mandate which is being migrated to a different payment service provider.
workflowTypesstring[]

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

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
minAmountnumber

amount greater than or equal to

amount greater than or equal to

maxAmountnumber

amount less than or equal to

amount less than or equal to

reviewSessionIdstring

The review session ID to filter invoices by

The review session ID to filter invoices by

invoiceIdsstring[]

List of invoice IDs to filter by

List of invoice IDs to filter by

scheduleIdstring

The id of the schedule associated to the invoice.

The id of the schedule associated to the invoice.

fieldValueIdsstring[]

List of field value IDs to filter invoices by their associated field mappings.

List of field value IDs to filter invoices by their associated field mappings.

pageinteger

Zero-based page index (0..N)

sizeinteger

The size of the page to be returned

sortstring[]

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

Response

The list of invoices for the specified filter.

idstring

The internal id of the invoice

invoiceNostring

The number of the invoice. Can be empty when creating the invoice without an invoice number,but it will be automatically generated when the invoice is pushed to an accounting software. Once set, serves as a unique value that can be used as an idempotency key.

descriptionstring

Short description of the invoice

totalAmountstring

The invoice total amount. Includes tax amount, amount paid or reduced with credit notes)

taxAmountstring

The invoice tax amount.

dueAmountstring

The invoice amount due (remaining to be paid).

creditNotesAmountstring

The total amount that is credited.

dueDatestring date-time

The due date of the invoice

issueDatestring date-time

The issue date date of the invoice

creationTimestring date-time

The date the invoice was created

lastUpdatedTimestring date-time

The date the invoice was last updated

paidTimestring date-time

The date the invoice was paid

status'DRAFT' | 'UNPAID' | 'OVERDUE' | 'SCHEDULED' | 'SUBMITTED' | 'PAID' | 'VOID' | 'SETTLED'

The invoice status

statusReasonCode'MISSING_PAYER_CONTACT_DETAILS' | 'PENDING_ACTIVATION' | 'PENDING_DD_MANDATE' | 'PENDING_DD_CAPABILITY' | 'MARKED_AS_PAID' | 'WORKFLOW_COMPLETED' | 'NOTIFICATION_DELIVERY_FAILED' | 'BULK_PRUNE' | 'STALE_DRAFT_CLEANUP' | 'OTHER' | 'DIRECT_DEBIT_MANDATE_BANK_ACCOUNT_CHANGED'

The reason as predefined code why the invoice is in a certain status

statusReasonstring

Custom details on why the invoice is in a certain status

invoiceSource'FILE_UPLOAD' | 'MANUAL' | 'PR' | 'EXTERNAL' | 'SCHEDULE' | 'PLATFORM'

The source of the invoice

itemsTaxType'EXCLUSIVE' | 'INCLUSIVE' | 'NONE'

How tax is applied to line items from the invoice

fileSource'NONE' | 'FILE_UPLOAD' | 'EXTERNAL' | 'ADFIN' | 'PENDING_ADFIN'

The file source of invoice

creditControlStatus'AT_RISK' | 'EXPECTED' | 'CONFIRMED'

The credit control status of the invoice

workflowType'AUTO_COLLECT' | 'ON_DEMAND' | 'NONE'

The workflow type of the invoice