Invoicing

List Invoices

Retrieve a list of invoices for the merchant with optional filtering and cursor-based pagination.

To look up a single invoice, use Get Invoice.

get/v5/invoices

Request

  • Base URL
    https://sandbox.nmi.com/api
  • URL
    https://sandbox.nmi.com/api/v5/invoices
  • Auth
    API key in header Authorization

Query parameters

status'open' | 'partially_paid' | 'paid' | 'closed' | 'overdue'

Filter by status.

customer_idstring

Filter by customer ID (exact match).

date_fromstring date

Filter results created on or after this date. Must be a valid calendar date in YYYY-MM-DD format.

date_tostring date

Filter results created on or before this date. Must be a valid calendar date in YYYY-MM-DD format.

cursorstring

Cursor for pagination, returned as next_cursor on the previous page. Omit for the first page.

per_pageinteger

Number of results to return per page (default: 10, max: 100).

Response

Success

per_pageinteger
next_cursorstring nullable

Cursor for the next page. Pass it as the cursor parameter on the next request. Omitted when there are no more results.

has_moreboolean

Whether there are more results beyond this page.

Changes

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