v50

latestOpenAPI 3.0.0raw.githubusercontent.com2025-08-28250234.8 KB

Invoices

Change invoice

Updates invoice's status, observation and paymentLink attributes.

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	Create 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.

put/api/creditcontrol/accounts/{creditAccountId}/invoices/{invoiceId}

Path parameters

creditAccountIdstring required

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

Credit account identification.

invoiceIdstring required

Example:A424887D0F2D45028FE5C96E9B0E1A2D-01

Invoice identification.

Query parameters

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.

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.

Request body

status'Opened' | 'Paid' | 'Cancelled' required

Invoice status.

observationstring nullable

Observation notes about the invoice.

paymentLinkstring nullable

Link (URL) created to direct the customer to an invoice payment environment (optional).

Example request

{
  "status": "Paid",
  "observation": "BF 2023 customer invoice.",
  "paymentLink": "https://paymentlink.com"
}

Response

OK. This endpoint does not return any data in the response body.