Download Invoices
Get a URL to download invoices for an entity group as a CSV/JSON file.
Path parameters
entityGroupId
Entity Group ID or Entity Group ForeignID
Headers
Authorization
Bearer authentication of the form Bearer <token>, where token is your auth token.
Query parameters
format
Format of the file to download. Defaults to CSV.
Allowed values:
startDate
Start date filter. Defaults to CREATED_AT unless specified the dateType is specified
endDate
End date filter. Defaults to CREATED_AT unless specified the dateType is specified
dateType
Type of date to filter by if startDate and endDate filters are provided. Defaults to CREATED_AT.
orderBy
Field to order invoices by. Defaults to CREATED_AT.
orderDirection
Direction to order invoices by. Defaults to asc.
Allowed values:
search
Find invoices by vendor name, invoice number, check number, or amount. Partial matches are supported.
metadata
Filter invoices by metadata. Each filter will be applied as an AND condition. Duplicate keys will be ignored.
lineItemMetadata
Filter invoices by line item metadata. Each filter will be applied as an AND condition. Duplicate keys will be ignored.
lineItemGlAccountId
Filter invoices by line item GL account ID. Each filter will be applied as an OR condition. Duplicate keys will be ignored.
payerId
Filter invoices by payer ID or payer foreign ID.
vendorId
Filter invoices by vendor ID or vendor foreign ID.
creatorUserId
Filter invoices by the ID or foreign ID of the user that created the invoice.
approverId
Filter invoices by assigned approver user ID. Only invoices with all upstream policies approved will be returned.
approverAction
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:
invoiceId
Filter invoices by invoice ID or invoice foreign ID.
status
Invoice status to filter on
paymentType
Filter invoices by recurring status
Allowed values:
invoiceTemplateId
Filter invoice by invoice template ID
excludePayables
Return only invoices that are receivable by the entity.
excludeReceivables
Return only invoices that are payable by the entity.
returnPayerMetadata
Whether to return payer metadata in the response
returnVendorMetadata
Whether to return vendor metadata in the response
Response
This endpoint returns an object.
url
mimeType