Invoices: Exports the filtered invoice list as an Excel workbook.

GET /api/invoicing/exports/invoices/excel deprecated

Requires: Invoicing.Invoices, merchant scope.

Returns a downloadable .xlsx file covering every invoice matching the applied filters (biller, biller type, recipient, status, invoice number, currency, issue-date range, due-date range, amount range, and source type), in the requested sort order. Paging members are ignored: an export is not a page. A filtered set of more than 10,000 invoices is rejected rather than truncated; narrow the filter (for example by date range or status) and retry.

Parameters

Name	In	Type	Description
`BillerId` required	query	string (uuid)	Filter by billing entity.
`BillerType` required	query	WinkPGInvoicingInvoicePartyType	Filter by biller type.
`RecipientId` required	query	string (uuid)	Filter by recipient.
`Status` required	query	WinkPGInvoicingInvoiceStatus	Filter by status.
`InvoiceNumber` required	query	string	Filter by invoice number (partial match).
`Currency` required	query	string	Filter by currency.
`MinIssueDate` required	query	string (date-time)	Filter invoices issued on or after this date.
`MaxIssueDate` required	query	string (date-time)	Filter invoices issued on or before this date.
`MinDueDate` required	query	string (date-time)	Filter invoices due on or after this date.
`MaxDueDate` required	query	string (date-time)	Filter invoices due on or before this date.
`MinAmount` required	query	number (double)	Filter by minimum grand total.
`MaxAmount` required	query	number (double)	Filter by maximum grand total.
`SourceType` required	query	WinkPGInvoicingInvoiceSourceType	Filter by source type.
`Ids` required	query	array of string (uuid)	Restrict the result to these specific invoices, AND-combined with every other filter.
`Filter` required	query	string	Gets or sets a general filter string for the result set.
`Name` required	query	string	Gets or sets the name filter for the result set.
`IncludeDeleted` required	query	boolean	Gets or sets a value indicating whether to include deleted entities in the result set.
`IncludeInactive` required	query	boolean	Gets or sets a value indicating whether to include inactive entities in the result set.
`Sorting` required	query	string
`SkipCount` required	query	integer (int32)
`MaxResultCount` required	query	integer (int32)
`ExtraProperties` required	query	object
`suppressNulls` required	query	boolean	If true, omit properties with null values.

Request body

application/json , required

Field	Type	Description

This request body has no documented fields.