VTvtex
Invoices

Postpone an invoice

Changed on

Postpones an invoice by the amount of time defined on the dueDays field (number of days for the invoice to be postponed by).

This operation updates the invoice field dueDate.

⚠️ Before making this request, access the endpoint Retrieve store configuration to check whether the option to postpone invoice is enabled in the store (invoicePostponementLimit: value greater than 0 and postponementEnabled: true).

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 ControlInvoicesCreate 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}/postponement

Request

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

Request body

dueDaysnumber required

Number of days to postpone the invoice.

Example request

{
  "dueDays": 10
}

Response

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

Changes

  • 1a0ba22582f0Revision changes
    • breaking

      the request property type changed from string to number

    • breaking

      removed the media type text/plain for the response with the status

    • 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