Search all invoices
Returns a list of invoices related to payment orders created through customer credit accounts.
ℹ️ Query parameters can be used individually or combined to filter invoice results.
Queries to filter results
- By the location of the invoices in the list (quantity of invoices): ?from={int}&to={int}
- By creation date: ?createdDateFrom={dateISO8601}&createDateTo={dateISO8601}. The dates should be in ISO8601 format.
- By due date: ?dueDateFrom={dateISO8601}&dueDateTo={dateISO8601}. The dates should be in ISO8601 format.
- By value: ?value={decimal}
- By status: ?status={string}
- By Id: ?friendlyId={string}
- By observation: ?observation={string}
- By creditAccountId: ?creditAccountId={creditAcountId}
Combining filters
You can use the op query parameter to specify if filters will be evaluated as AND or OR for the query. The default behavior when there is more than one query parameter is AND.
Example:
For the query ?value=100&status=Paid, the criteria will build value = 100 AND status = Paid.
For the same query, adding the op parameter (?value=100&status=Paid&op=or), the criteria will build value = 100 OR status = Paid.
Permissions
Any user or API key must have at least one of the appropriate License Manager resources to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint:
| Product | Category | Resource |
|---|---|---|
| Credit Control | Main | Main Access |
| Credit Control | Invoices | Read Invoices |
There are no applicable predefined roles for this resource list. You must create a custom role and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see Authentication overview.
❗ To prevent integrations from having excessive permissions, consider the best practices for managing API keys when assigning License Manager roles to integrations.
Query parameters
Indicates the starting position of the invoice to be searched in the invoice list. For example, the value 1 indicates that the first invoice in the list will be returned.
Indicates the final position of the invoice to be searched in the invoice list. For example, if the value of from is equal to 1 and to is 300, information from 300 invoices will be displayed in the response body of the request.
Indicates the initial creation date of invoices that should be searched in the invoice list based on their creation date. The dates should be in ISO8601 format.
Indicates the final creation date of invoices that should be searched in the invoice list based on their creation date. The dates should be in ISO8601 format.
Indicates the initial due date of invoices that should be searched in the invoice list based on their creation date. The dates should be in ISO8601 format.
Indicates the final due date of invoices that should be searched in the invoice list based on their creation date. The dates should be in ISO8601 format.
Indicates the value of the invoices to be searched for. It must be completed with a decimal value.
Indicates the status of the invoices to be searched for.
Simplified identification of an invoice. This code is created automatically, always associated with an existing invoice. It consists of an 8-digit random ID (of numbers and letters) and the installment.
Observation notes about the invoice.
Credit account identification.
Headers
Type of the content being sent.
HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.
Response
OK