Search invoices

GET

Search invoices for all entities in the organization

Query parameters

entityIdstringOptional

Filter invoices by the ID or foreign ID of the entity that is the payer or the vendor of the invoice.

startDatedatetimeOptional

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

endDatedatetimeOptional

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

dateTypeenumOptional

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

orderByenumOptional

Field to order invoices by. Defaults to CREATED_AT.

orderDirection"ASC" or "DESC"Optional

Direction to order invoices by. Defaults to asc.

Allowed values: ASCDESC
limitintegerOptional

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

startingAfterstringOptional

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

searchstringOptional

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

metadataobjectOptional

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

lineItemMetadataobjectOptional

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

lineItemGlAccountIdstringOptional

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

payerIdstringOptional

Filter invoices by payer ID or payer foreign ID.

vendorIdstringOptional

Filter invoices by vendor ID or vendor foreign ID.

creatorUserIdstringOptional

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

approverIdstringOptional

Filter invoices by assigned approver user ID.

approverActionenumOptional

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.

Allowed values: NONEAPPROVEREJECT
invoiceIdstringOptional

Filter invoices by invoice ID.

statusenumOptional

Invoice status to filter on

paymentTypelist of "oneTime" or "recurring"Optional

Filter invoices by recurring status

Allowed values: oneTimerecurring
invoiceTemplateIdstringOptional

Filter invoice by invoice template ID

Response

This endpoint returns an object.
countinteger

Total number of notifications for the given start and end date filters. This value is not limited by the limit parameter. It is provided so that you can determine how many pages of results are available.

hasMoreboolean

True if there are more notifications available for the given start and end date filters.

datalist of objects
Create
Built with