Get invoices for an entity with the given filters.
Path parameters
entityIdstringRequired
Query parameters
excludePayablesbooleanOptional
Return only invoices that are receivable by the entity.
excludeReceivablesbooleanOptional
Return only invoices that are payable by the entity.
startDatedatetimeOptional
Start date for invoice created on date filter.
endDatedatetimeOptional
End date for invoice created date filter.
orderByenumOptional
Field to order invoices by. Defaults to CREATED_AT.
orderDirectionenumOptional
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.
metadataobjectOptional
Filter invoices by metadata. Each filter will be applied as an AND condition. Duplicate keys will be ignored.
searchstringOptional
Find invoices by vendor name, invoice number, or amount. Partial matches are supported.
payerIdstringOptional
Filter invoices by payer ID.
vendorIdstringOptional
Filter invoices by vendor ID.
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.
includeFeesbooleanOptional
Deprecated
DEPRECATED. Fees are now included by default in the response.
Response
This endpoint returns an object
count
integer
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.
hasMore
boolean
True if there are more notifications available for the given start and end date filters.