Create or update settlement
Changed onCreates an invoice or update its value for an order placed in the store that used customer credit as a payment method.
ℹ️ If payment for the order is made in installments, you can create an invoice for each installment. The first invoice will be due in 30 days, and subsequent invoices will be due 30 days after the previous invoice.
.
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 | Statements | Create Statements |
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.
Request
- Base URLhttps://apiexamples.vtexcommercestable.com.br
- URLhttps://apiexamples.vtexcommercestable.com.br/api/creditcontrol/accounts/{creditAccountId}/transactions/{transactionId}/settlement
- Auth
- API key in header X-VTEX-API-AppKey and API key in header X-VTEX-API-AppToken
- or API key in header VtexIdclientAutCookie
Path parameters
Credit account identification.
Pre-authorization identification.
Headers
Type of the content being sent.
HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.
Request body
Example request
{
"value": 49.95
}Response
OK
Changes
- warning
the optional response header
connectionremoved for the status200 - warning
the optional response header
content-lengthremoved for the status200 - warning
the optional response header
content-typeremoved for the status200 - warning
the optional response header
dateremoved for the status200 - warning
the optional response header
serverremoved for the status200 - warning
the optional response header
x-powered-byremoved for the status200 - warning
the optional response header
x-vtex-janus-router-backend-appremoved for the status200
- warning
- breaking
the
request property type changed fromstringtonumber - info
the
request property default value490.0was removed
- breaking