Retrieve invoice by creditAccountId

Returns associated invoices by specified creditAccountId, the param that identifies a client in VTEX's system.

Paging params

  • By page numbers:?from={int}&to={int}

Date params

You can refine the API response using the two date params that will always be used in ISO8601 format.

  • By creation date: ?createdDateFrom={dateISO8601}&createDateTo={dateISO8601}
  • By due date: ?dueDateFrom={dateISO8601}&dueDateTo={dateISO8601}

Other filters

For proper responses, you can use the filters below:

  • By value: ?value={decimal}
  • By status: ?status={string}
  • By Id: ?Id={string}
  • By observation: ?observation={string}
  • By creditAccountId: ?creditAccountId={creditAcountId}

Combine filters

You can use the query parameter op to specify if filters will be evaluated as AND or OR for the query. In this case, the default is AND.

Let's see how it works?

For example, if we take the query string ?value=100&status=Paid, the criteria will build value=100 AND status=Paid.

Now, if we take the same query string and add the op parameter, the result will be ?value=100&status=Paid&op=or and the criteria will build value=100 OR status=Paid

Click Try It! to start a request and see the response here!