API ReferenceInvoice

Search invoices

Search invoices for all entities in the organization

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

entityIdstringOptional
Filter invoices by the ID or foreign ID of the entity that is the payer or the vendor of the invoice.
entityGroupIdstringOptional
Filter invoices by the ID or foreign ID of the entity group that the entity belongs to.
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.

orderDirectionenumOptional
Direction to order invoices by. Defaults to asc.
Allowed values:
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, check 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. Only invoices with all upstream policies approved will be returned.
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:
invoiceIdstringOptional
Filter invoices by invoice ID or invoice foreign ID.
statusenumOptional
Invoice status to filter on
paymentTypelist of enumsOptional
Filter invoices by recurring status
Allowed values:
invoiceTemplateIdstringOptional
Filter invoice by invoice template ID
returnPayerMetadatabooleanOptional
Whether to return payer metadata in the response
returnVendorMetadatabooleanOptional
Whether to return vendor metadata in the response
returnPaymentTimingbooleanOptional
Whether to return payment timing in the response

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

Errors