POST

Query Invoices

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves a list of up to 1,000 invoices, given the provided paging, filtering, and sorting.

Query Invoices runs with these defaults, which you can override:

createdDate is sorted in DESC order
paging.limit is 50
paging.offset is 0

To learn about working with Query methods, see API Query Language, Sorting and Paging, and Field Projection.

Property	Filters	Sort
`id`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`, `$startsWith`	Sort: `ASC`, `DESC`
`createdDate`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`	Sort: `ASC`, `DESC`
`updatedDate`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`	Sort: `ASC`, `DESC`
`status`	`$eq`, `$ne`, `$in`, `$exists`	Sort: `ASC`, `DESC`
`statusQualifiers`		Sort: `ASC`, `DESC`
`sourceReference.appId`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`, `$startsWith`	Sort: `ASC`, `DESC`
`sourceReference.externalReferenceId`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`, `$startsWith`	Sort: `ASC`, `DESC`
`reference.referenceType`	`$eq`, `$ne`, `$in`, `$exists`	Sort: `ASC`, `DESC`
`reference.standaloneReference.orderId`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`, `$startsWith`	Sort: `ASC`, `DESC`
`reference.orderReference.orderId`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`, `$startsWith`	Sort: `ASC`, `DESC`
`reference.migratedReference.orderId`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`, `$startsWith`	Sort: `ASC`, `DESC`
`numbering.prefix`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`, `$startsWith`	Sort: `ASC`, `DESC`
`numbering.number`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`	Sort: `ASC`, `DESC`
`numbering.suffix`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`, `$startsWith`	Sort: `ASC`, `DESC`
`numbering.displayNumber`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`, `$startsWith`	Sort: `ASC`, `DESC`
`issueDate`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`	Sort: `ASC`, `DESC`
`dueDate`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`	Sort: `ASC`, `DESC`
`customerInfo.contactId`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`, `$startsWith`	Sort: `ASC`, `DESC`
`archived`	`$eq`, `$ne`, `$in`, `$exists`	Sort: `ASC`, `DESC`
`hasSubscriptions`	`$eq`, `$ne`, `$in`, `$exists`	Sort: `ASC`, `DESC`
`lineItems.customItem.subscriptionInfo.billingSubscriptionId`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`, `$startsWith`	Sort: `ASC`, `DESC`
`lineItems.catalogItem.subscriptionInfo.billingSubscriptionId`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`, `$startsWith`	Sort: `ASC`, `DESC`
`tags.publicTags.tagIds`	`$hasSome`, `$hasAll`, `$exists`, `$isEmpty`	Sort: `ASC`, `DESC`
`tags.privateTags.tagIds`	`$hasSome`, `$hasAll`, `$exists`, `$isEmpty`	Sort: `ASC`, `DESC`

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions

Learn more about app permissions.

Endpoint

POST

https://www.wixapis.com/invoices/v4/invoices/query

Errors

500Internal

There is 1 error with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?