Invoices

List invoices you’ve sent (money in). Filter server-side rather than paging and filtering client-side.

get/invoices

Query parameters

limitstring

Page size, 1–100 (default 25).

Page size, 1–100 (default 25).

cursorstring

Opaque cursor from a prior response nextCursor.

Opaque cursor from a prior response nextCursor.

fromstring

Inclusive lower bound, YYYY-MM-DD.

Inclusive lower bound, YYYY-MM-DD.

tostring

Inclusive upper bound, YYYY-MM-DD.

Inclusive upper bound, YYYY-MM-DD.

recipientstring

Case-insensitive substring match on the recipient name.

Case-insensitive substring match on the recipient name.

dueFromstring

Inclusive lower bound on the due date, YYYY-MM-DD.

Inclusive lower bound on the due date, YYYY-MM-DD.

dueTostring

Inclusive upper bound on the due date, YYYY-MM-DD.

Inclusive upper bound on the due date, YYYY-MM-DD.

overdueboolean

Set to true to keep only invoices due strictly before today (UTC). Invoices carry no payment status, so this is a due-date test only.

Set to true to keep only invoices due strictly before today (UTC). Invoices carry no payment status, so this is a due-date test only.

numberstring

Case-insensitive exact match on the invoice number.

Case-insensitive exact match on the invoice number.

Response

A page of invoices.

nextCursorstring nullable required

Pass back as ?cursor for the next page; null on the last page.

Changes

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