VTvtex
Invoices

Mark an invoice as paid

Changed on

Records the payment of an invoice.

This operation causes a balance restore with the invoice value to the checking account.

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 ControlInvoicesPay Invoice

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.

post/api/creditcontrol/accounts/{creditAccountId}/invoices/{invoiceId}/payments

Request

  • Base URL
    https://apiexamples.vtexcommercestable.com.br
  • URL
    https://apiexamples.vtexcommercestable.com.br/api/creditcontrol/accounts/{creditAccountId}/invoices/{invoiceId}/payments
  • 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

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

Credit account identification.

invoiceIdstring required
Example:A424887D0F2D45028FE5C96E9B0E1A2D-01

Invoice 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

idstring required

Invoice identification.

friendlyIdstring required

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.

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

Invoice status.

valuenumber required

Invoice value.

accountIdstring required

Account identification. It is the same checkingAccountId parameter used in other Customer Credit API endpoints.

creditValuenumber required

Credit value.

createdAtstring required

Invoice creation date.

updatedAtstring required

Date of the last update made to the invoice.

originalDueDatestring required

Original invoice expiration date.

dueDatestring required

Modified invoice expiration date.

installmentnumber required

Identification of installment number.

orderIdstring required

Identification of the order that generated the invoice.

transactionIdstring required

Identification of the invoice transaction. This is the same number as the id field, removing the last three characters.

numberOfInstallmentsnumber required

Number of installments.

creditAccountIdstring required

Credit account identification. It is the same accountId parameter used in other Customer Credit API endpoints.

Changes

  • 28dfe2555ec4Revision changes
    • warning

      added the new Opened enum value to the response property for the response status

    • info

      removed the Open enum value from the response property for the response status

  • 0cfe5b381175Revision changes
    • warning

      the optional response header Access-Control-Allow-Origin removed for the status 200

    • warning

      the optional response header Connection removed for the status 200

    • warning

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

    • warning

      the optional response header Date removed for the status 200

    • warning

      the optional response header Server removed for the status 200

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

      the optional response header X-Translate-BackEnd removed for the status 200

    • warning

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