Sign in
Invoices

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:

ProductCategoryResource
Credit ControlMainMain Access
Credit ControlInvoicesRead 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.

get/api/creditcontrol/invoices

Query parameters

fromstring
Example:1

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.

tostring
Example:300

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.

createdDateFromstring
Example:2023-01-20

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.

createdDateTostring
Example:2023-01-25

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.

dueDateFromstring
Example:2023-01-20

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.

dueDateTostring
Example:2023-01-25

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.

valuenumber
Example:101.22

Indicates the value of the invoices to be searched for. It must be completed with a decimal value.

status'Opened' | 'Paid' | 'Cancelled'
Example:Paid

Indicates the status of the invoices to be searched for.

friendlyIdstring
Example:u8KFsGDk-1

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.

observationstring
Example:Some observation about the invoice

Observation notes about the invoice.

creditAccountIdstring required
Example:01bce461-9g03-12ds-8217-b3d39271e15b

Credit account identification.

Headers

Content-Typestring required
Example:application/json

Type of the content being sent.

Acceptstring required
Example:application/json

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Response

OK

Changes

Changed in 11 of the 51 revisions of this API.221323

  • 28dfe2555ec411See the full diff
    • ▲

      removed the enum value Open from the query request parameter status

      request-parameter-enum-value-removed

    • ○

      added the new enum value Opened to the query request parameter status

      request-parameter-enum-value-added

  • 0cfe5b3811759See the full diff
    • ●

      the optional response header Connection removed for the status 200

      optional-response-header-removed

    • ●

      the optional response header Content-Encoding removed for the status 200

      optional-response-header-removed

    • ●

      the optional response header Date removed for the status 200

      optional-response-header-removed

    • ●

      the optional response header Server removed for the status 200

      optional-response-header-removed

    • ●

      the optional response header Vary removed for the status 200

      optional-response-header-removed

    • ●

      the optional response header X-CDNIgnore removed for the status 200

      optional-response-header-removed

    • ●

      the optional response header X-Powered-by-VTEX-Janus-Edge removed for the status 200

      optional-response-header-removed

    • ●

      the optional response header X-Track removed for the status 200

      optional-response-header-removed

    • ●

      the optional response header X-VTEX-Janus-Router-Backend-App removed for the status 200

      optional-response-header-removed

  • c2a7893f998b2See the full diff
    • ▲

      the summary/totalCancelled response's property type/format changed from integer/ to number/ for status 200

      response-property-type-changed

    • ▲

      the summary/totalPaid response's property type/format changed from integer/ to number/ for status 200

      response-property-type-changed

  • c812a194b17d11See the full diff
    • ●

      added the new Opened enum value to the data/items/status response property for the response status 200

      response-property-enum-value-added

    • ○

      removed the Open enum value from the data/items/status response property for the response status 200

      response-property-enum-value-removed

  • 7dfddf64951f1See the full diff
    • ▲

      the data/items/orderId response's property type/format changed from number/ to string/ for status 200

      response-property-type-changed

  • 25c08deef7923See the full diff
    • ●

      added the new Cancelled enum value to the data/items/status response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new Open enum value to the data/items/status response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new Paid enum value to the data/items/status response property for the response status 200

      response-property-enum-value-added

  • 1a0ba22582f0612See the full diff
    • ▲

      the query request parameter creditAccountId became required

      request-parameter-became-required

    • ▲

      the response property data/items/observation became optional for the status 200

      response-property-became-optional

    • ▲

      the response property data/items/paymentLink became optional for the status 200

      response-property-became-optional

    • ▲

      the summary/count response's property type/format changed from integer/int32 to integer/ for status 200

      response-property-type-changed

    • ▲

      removed the required property data/items/checkingAccountId from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property data/items/description from the response with the 200 status

      response-required-property-removed

    • ○

      media type application/json; charset=utf-8 was changed to application/json for the response status 200

      response-media-type-name-changed

    • ○

      added the optional property data/items/resolvedAt to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property summary/totalCancelled to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property summary/totalPaid to the response with the 200 status

      response-optional-property-added

    • ○

      added the required property data/items/accountId to the response with the 200 status

      response-required-property-added

    • ○

      added the required property data/items/creditAccountId to the response with the 200 status

      response-required-property-added

    • ○

      added the required property data/items/creditValue to the response with the 200 status

      response-required-property-added

    • ○

      added the required property data/items/friendlyId to the response with the 200 status

      response-required-property-added

    • ○

      added the required property data/items/installment to the response with the 200 status

      response-required-property-added

    • ○

      added the required property data/items/numberOfInstallments to the response with the 200 status

      response-required-property-added

    • ○

      added the required property data/items/orderId to the response with the 200 status

      response-required-property-added

    • ○

      added the required property data/items/transactionId to the response with the 200 status

      response-required-property-added

  • cc3bac5e3fcd13See the full diff
    • ▲

      the query request parameter status was restricted to a list of enum values

      request-parameter-became-enum

    • ○

      added the new enum value Cancelled to the query request parameter status

      request-parameter-enum-value-added

    • ○

      added the new enum value Open to the query request parameter status

      request-parameter-enum-value-added

    • ○

      added the new enum value Paid to the query request parameter status

      request-parameter-enum-value-added

  • 2884a17b89294See the full diff
    • ▲

      for the query request parameter from, default value 1 was removed

      request-parameter-default-value-removed

    • ▲

      removed the enum value Cancelled from the query request parameter status

      request-parameter-enum-value-removed

    • ▲

      removed the enum value Open from the query request parameter status

      request-parameter-enum-value-removed

    • ▲

      removed the enum value Paid from the query request parameter status

      request-parameter-enum-value-removed

  • cd34d575bdcb13See the full diff
    • ▲

      the query request parameter status was restricted to a list of enum values

      request-parameter-became-enum

    • ○

      added the new enum value Cancelled to the query request parameter status

      request-parameter-enum-value-added

    • ○

      added the new enum value Open to the query request parameter status

      request-parameter-enum-value-added

    • ○

      added the new enum value Paid to the query request parameter status

      request-parameter-enum-value-added