POST

Query Remittance 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 100 remittance invoices, given the provided paging, filtering, and sorting.

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

  • createdDate is sorted in DESC order
  • cursorPaging.limit is 50

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

PropertyFiltersSort
id$eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWithNone
amount.value$eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWithNone
amount.currency$eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWithNone
accountId$eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWithNone
siteId$eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWithNone
cashAdvanceAgreementId$eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWithNone
financialOperationId$eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWithNone
salesStartDate$eq, $ne, $in, $exists, $gt, $gte, $lt, $lteNone
salesEndDate$eq, $ne, $in, $exists, $gt, $gte, $lt, $lteNone
createdDate$eq, $ne, $in, $exists, $gt, $gte, $lt, $lteSort: ASC, DESC
salesDay$eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWithSort: ASC, DESC
Authentication

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

Permission Scopes
Request and view Merchant Cash Advance
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/capital/v1/remittance-invoices/query

Errors

This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?