Search invoices

Filter invoices by the ID or foreign ID of the entity that created the invoice.

Start date filter. Defaults to CREATED_AT unless specified the dateType is specified

End date filter. Defaults to CREATED_AT unless specified the dateType is specified

Type of date to filter by if startDate and endDate filters are provided. Defaults to CREATED_AT.

Field to order invoices by. Defaults to CREATED_AT.

Direction to order invoices by. Defaults to asc.

Number of invoices to return. Limit can range between 1 and 100, and the default is 10.

The ID of the invoice to start after. If not provided, the first page of invoices will be returned.

Find invoices by vendor name, invoice number, or amount. Partial matches are supported.

Filter invoices by metadata. Each filter will be applied as an AND condition. Duplicate keys will be ignored.

Filter invoices by line item metadata. Each filter will be applied as an AND condition. Duplicate keys will be ignored.

Filter invoices by line item GL account ID. Each filter will be applied as an OR condition. Duplicate keys will be ignored.

Filter invoices by payer ID or payer foreign ID.

Filter invoices by vendor ID or vendor foreign ID.

Filter invoices by assigned approver user ID.

Filter invoices by approver action. Needs to be used with approverId. For example, if you want to find all invoices that have been approved by a specific user, you would use approverId and approverAction=APPROVE.

Filter invoices by invoice ID.

Invoice status to filter on

Filter invoices by recurring status

Filter invoice by invoice template ID