Get All

GET

Get invoices for an entity group with the given filters.

Path parameters

entityGroupIdstringRequired

Entity Group ID or Entity Group ForeignID

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.

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.

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 or payer foreign ID.

vendorIdstringOptional

Filter invoices by vendor ID or vendor foreign 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.

paymentTypelist of "oneTime" or "recurring"Optional

Filter invoices by recurring status

Allowed values: oneTimerecurring

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