VTEX Store Configuration API

openapi: 3.2.0
info:
  title: VTex Customer Credit Store Configuration API
  description: 'With Customer Credit your store can enable **credit payments** through the checkout. You can also control **invoices** and the **credit limits** of your clients.


    Learn more about Customer Credit in our [Help Center article](https://help.vtex.com/en/tracks/customer-credit-getting-started--1hCRg21lXYy2seOKgqQ2CC/36grlQ69NK6OCuioeekyCs).


    Additionally, you can find more information on installment payments for an order in the `customData`  field found in the [Get Order](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/oms/pvt/orders/-orderId-) endpoint of the Orders API. This includes the number of installments, amount and due dates.


    All requests need an authorization header. This API allows two kinds of authorization:


    1. Authorization header containing the VTEX ID authentication token.

    2. VTEX Appkey and Apptoken headers.


    Read [Authentication](https://developers.vtex.com/docs/guides/authentication) for more information about authentication options.


    ## Customer Credit API Index


    ### Invoices


    - `GET` [Search all invoices](https://developers.vtex.com/docs/api-reference/customer-credit-api#get-/api/creditcontrol/invoices)

    - `GET` [Retrieve Invoice by Id](https://developers.vtex.com/docs/api-reference/customer-credit-api#get-/api/creditcontrol/accounts/-creditAccountId-/invoices/-invoiceId-)

    - `PUT` [Change Invoice](https://developers.vtex.com/docs/api-reference/customer-credit-api#put-/api/creditcontrol/accounts/-creditAccountId-/invoices/-invoiceId-)

    - `DELETE` [Cancel Invoice](https://developers.vtex.com/docs/api-reference/customer-credit-api#delete-/api/creditcontrol/accounts/-creditAccountId-/invoices/-invoiceId-)

    - `GET` [Retrieve invoice by creditAccountId](https://developers.vtex.com/docs/api-reference/customer-credit-api#get-/api/creditcontrol/accounts/-creditAccountId-/invoices)

    - `POST` [Mark an invoice as Paid](https://developers.vtex.com/docs/api-reference/customer-credit-api#post-/api/creditcontrol/accounts/-creditAccountId-/invoices/-invoiceId-/payments)

    - `PUT` [Postpone an invoice](https://developers.vtex.com/docs/api-reference/customer-credit-api#put-/api/creditcontrol/accounts/-creditAccountId-/invoices/-invoiceId-/postponement)


    ### Account


    - `GET` [Search all accounts](https://developers.vtex.com/docs/api-reference/customer-credit-api#get-/api/creditcontrol/accounts)

    - `POST` [Open an account](https://developers.vtex.com/docs/api-reference/customer-credit-api#post-/api/creditcontrol/accounts)

    - `GET` [Retrieve an account by Id](https://developers.vtex.com/docs/api-reference/customer-credit-api#get-/api/creditcontrol/accounts/-creditAccountId-)

    - `DELETE` [Close an account](https://developers.vtex.com/docs/api-reference/customer-credit-api#delete-/api/creditcontrol/accounts/-creditAccountId-)

    - `PUT` [Update account information](https://developers.vtex.com/docs/api-reference/customer-credit-api#put-/api/creditcontrol/accounts/-creditAccountId-)

    - `GET` [Account statements](https://developers.vtex.com/docs/api-reference/customer-credit-api#get-/api/creditcontrol/accounts/-creditAccountId-/statements)

    - `PUT` [Change credit limit of an account](https://developers.vtex.com/docs/api-reference/customer-credit-api#put-/api/creditcontrol/accounts/-creditAccountId-/creditlimit)

    - `PUT` [Decrease balance of an account](https://developers.vtex.com/docs/api-reference/customer-credit-api#put-/api/creditcontrol/accounts/-creditAccountId-/statements/-statementId-)

    - `PUT` [Create or Update Settlement](https://developers.vtex.com/docs/api-reference/customer-credit-api#put-/api/creditcontrol/accounts/-creditAccountId-/transactions/-transactionId-/settlement)

    - `POST` [Create a Pre-Authorization](https://developers.vtex.com/docs/api-reference/customer-credit-api#post-/api/creditcontrol/accounts/-creditAccountId-/transactions)

    - `PUT` [Update a Pre-Authorization](https://developers.vtex.com/docs/api-reference/customer-credit-api#put-/api/creditcontrol/accounts/-creditAccountId-/transactions/-transactionId-)

    - `DELETE` [Cancel a Pre-Authorization](https://developers.vtex.com/docs/api-reference/customer-credit-api#delete-/api/creditcontrol/accounts/-creditAccountId-/transactions/-transactionId-)

    - `POST` [Add an account Holder](https://developers.vtex.com/docs/api-reference/customer-credit-api#post-/api/creditcontrol/accounts/-creditAccountId-/holders)

    - `DELETE` [Delete an account holder](https://developers.vtex.com/docs/api-reference/customer-credit-api#delete-/api/creditcontrol/accounts/-creditAccountId-/holders/-holderId-)

    - `PUT` [Change tolerance of an account](https://developers.vtex.com/docs/api-reference/customer-credit-api#put-/api/creditcontrol/accounts/-creditAccountId-/tolerance)

    - `POST` [Partial or Total Refund a Settlement](https://developers.vtex.com/docs/api-reference/customer-credit-api#post-/api/creditcontrol/accounts/-creditAccountId-/transactions/-transactionId-/refunds)


    ### Store Configuration


    - `GET` [Retrieve store configuration](https://developers.vtex.com/docs/api-reference/customer-credit-api#get-/api/creditcontrol/storeconfig)

    - `PUT` [Create or change store configuration](https://developers.vtex.com/docs/api-reference/customer-credit-api#put-/api/creditcontrol/storeconfig)

    '
  contact: {}
  version: '1.0'
servers:
- url: https://{accountName}.{environment}.com.br
  description: VTEX server URL.
  variables:
    accountName:
      description: Name of the VTEX account. Used as part of the URL
      default: apiexamples
    environment:
      description: Environment to use. Used as part of the URL.
      enum:
      - vtexcommercestable
      default: vtexcommercestable
security:
- appKey: []
  appToken: []
- VtexIdclientAutCookie: []
tags:
- name: Store Configuration
paths:
  /api/creditcontrol/storeconfig:
    get:
      tags:
      - Store Configuration
      summary: VTex Retrieve store configuration
      description: 'Gets store configuration data related to [customer credit accounts](https://help.vtex.com/en/tracks/customer-credit-getting-started--1hCRg21lXYy2seOKgqQ2CC/7FHLd0cmxqqGeEUuc8uioU).


        ## Permissions


        Any user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) 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 | Store Configuration | **Read Configuration** |


        There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-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](https://developers.vtex.com/docs/guides/authentication).


        >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.'
      operationId: Retrievestoreconfiguration
      parameters:
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/Accept'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                - dailyInterestRate
                - invoicePostponementLimit
                - taxRate
                - maxPostponementDays
                - defaultCreditValue
                - postponementEnabled
                - automaticCheckingAccountCreationEnabled
                - toleranceEnabled
                - myCreditsEnabled
                - maxPreAuthorizationGrowthRate
                type: object
                properties:
                  dailyInterestRate:
                    type: number
                    description: Daily interest rate (percent 0.1 = 10%).
                  invoicePostponementLimit:
                    type: number
                    description: Maximum number of postponements allowed.
                  taxRate:
                    type: number
                    description: Tax rate value (percent 0.1 = 10%).
                  maxPostponementDays:
                    type: number
                    description: Maximum number of days of postponement.
                  defaultCreditValue:
                    type: number
                    description: Default credit amount.
                  postponementEnabled:
                    type: boolean
                    description: Postponement option activated.
                    default: false
                  automaticCheckingAccountCreationEnabled:
                    type: boolean
                    description: Allows users who have not previously received credit to complete an order.
                    default: false
                  toleranceEnabled:
                    type: boolean
                    description: Allows orders to be placed even if they exceed X % of the account's credit limit.
                    default: false
                  myCreditsEnabled:
                    type: boolean
                    description: Show the [My Credits](https://help.vtex.com/en/tutorial/customer-credit-overview--1uIqTjWxIIIEW0COMg4uE0#my-credits) page on storefront.
                    default: false
                  maxPreAuthorizationGrowthRate:
                    type: number
                    description: Pre-authorization growth-rate value (percent 0.1 = 10%).
                  notificationsSettings:
                    type: object
                    description: Notification settings information.
                    properties:
                      daysPrior:
                        type: array
                        description: Notification information sent before invoice payment date.
                        items:
                          required:
                          - days
                          - timeOfDay
                          type: object
                          description: Object with information about the moment when the notification is sent.
                          properties:
                            days:
                              type: integer
                              description: How many days before the invoice payment date is the notification sent.
                            timeOfDay:
                              type: string
                              description: Notification sending time.
                      daysAfter:
                        type: array
                        description: Notification information sent after invoice payment date.
                        items:
                          required:
                          - days
                          - timeOfDay
                          type: object
                          description: Object with information about the moment when the notification is sent.
                          properties:
                            days:
                              type: integer
                              description: How many days after the invoice payment date is the notification sent.
                            timeOfDay:
                              type: string
                              description: Notification sending time.
              example:
                dailyInterestRate: 0
                invoicePostponementLimit: 0
                taxRate: 0
                maxPostponementDays: 0
                defaultCreditValue: 2000
                postponementEnabled: false
                automaticCheckingAccountCreationEnabled: false
                toleranceEnabled: false
                myCreditsEnabled: false
                maxPreAuthorizationGrowthRate: 0
                notificationsSettings:
                  daysPrior:
                  - days: 5
                    timeOfDay: '12:00:00'
                  - days: 1
                    timeOfDay: '12:00:00'
                  - days: 0
                    timeOfDay: '12:00:00'
                  daysAfter:
                  - days: 3
                    timeOfDay: '12:00:00'
      deprecated: false
    put:
      tags:
      - Store Configuration
      summary: VTex Create or change store configuration
      description: 'Creates or changes store configuration data related to [customer credit accounts](https://help.vtex.com/en/tracks/customer-credit-getting-started--1hCRg21lXYy2seOKgqQ2CC/7FHLd0cmxqqGeEUuc8uioU).


        ## Permissions


        Any user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) 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 | Store Configuration | **Edit Configuration** |


        There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-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](https://developers.vtex.com/docs/guides/authentication).


        >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.'
      operationId: Createorchangestoreconfiguration
      parameters:
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/Accept'
      requestBody:
        content:
          application/json:
            schema:
              required:
              - dailyInterestRate
              - invoicePostponementLimit
              - taxRate
              - maxPostponementDays
              - defaultCreditValue
              - maxPreAuthorizationGrowthRate
              - myCreditsEnabled
              - toleranceEnabled
              - automaticCheckingAccountCreationEnabled
              - postponementEnabled
              type: object
              properties:
                dailyInterestRate:
                  type: number
                  description: Daily interest rate (percent 0.1 = 10%).
                  example: 0.01
                invoicePostponementLimit:
                  type: number
                  description: Maximum number of postponements allowed.
                  example: 2
                taxRate:
                  type: number
                  description: Tax rate value (percent 0.1 = 10%).
                  example: 0.4
                maxPostponementDays:
                  type: number
                  description: Maximum number of days of postponement.
                  example: 3
                defaultCreditValue:
                  type: number
                  description: Default credit amount.
                  example: 150
                maxPreAuthorizationGrowthRate:
                  type: number
                  description: Pre-authorization growth rate value (percent 0.1 = 10%).
                  example: 0.1
                myCreditsEnabled:
                  type: boolean
                  description: Show the [My Credits](https://help.vtex.com/en/tutorial/customer-credit-overview--1uIqTjWxIIIEW0COMg4uE0#my-credits) page on storefront.
                  example: true
                toleranceEnabled:
                  type: boolean
                  description: Allows orders to be placed even if they exceed X % of the account's credit limit.
                  example: true
                automaticCheckingAccountCreationEnabled:
                  type: boolean
                  description: Allows users who have not previously received credit to complete an order.
                  example: true
                postponementEnabled:
                  type: boolean
                  description: Postponement option activated.
                  example: true
                notificationsSettings:
                  type: object
                  description: Notification settings information.
                  properties:
                    daysPrior:
                      type: array
                      description: Notification information sent before invoice payment date.
                      items:
                        required:
                        - days
                        - timeOfDay
                        type: object
                        description: Object with information about the moment when the notification is sent.
                        properties:
                          days:
                            type: integer
                            description: How many days before the invoice payment date is the notification sent.
                            example: 1
                          timeOfDay:
                            type: string
                            description: Notification sending time.
                            example: '16:00:00'
                    daysAfter:
                      type: array
                      description: Notification information sent after invoice payment date.
                      items:
                        required:
                        - days
                        - timeOfDay
                        type: object
                        description: Object with information about the moment when the notification is sent.
                        properties:
                          days:
                            type: integer
                            description: How many days after the invoice payment date is the notification sent.
                            example: 0
                          timeOfDay:
                            type: string
                            description: Notification sending time.
                            example: '12:00:00'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                - dailyInterestRate
                - invoicePostponementLimit
                - taxRate
                - maxPostponementDays
                - defaultCreditValue
                - postponementEnabled
                - automaticCheckingAccountCreationEnabled
                - toleranceEnabled
                - myCreditsEnabled
                - maxPreAuthorizationGrowthRate
                type: object
                properties:
                  dailyInterestRate:
                    type: number
                    description: Daily interest rate (percent 0.1 = 10%).
                  invoicePostponementLimit:
                    type: number
                    description: Maximum number of postponements allowed.
                  taxRate:
                    type: number
                    description: Tax rate value (percent 0.1 = 10%).
                  maxPostponementDays:
                    type: number
                    description: Maximum number of days of postponement.
                  defaultCreditValue:
                    type: number
                    description: Default credit amount.
                  postponementEnabled:
                    type: boolean
                    description: Postponement option activated.
                    default: false
                  automaticCheckingAccountCreationEnabled:
                    type: boolean
                    description: Allows users who have not previously received credit to complete an order.
                    default: false
                  toleranceEnabled:
                    type: boolean
                    description: Allows orders to be placed even if they exceed X % of the account's credit limit.
                    default: false
                  myCreditsEnabled:
                    type: boolean
                    description: Show the [My Credits](https://help.vtex.com/en/tutorial/customer-credit-overview--1uIqTjWxIIIEW0COMg4uE0#my-credits) page on storefront.
                    default: false
                  maxPreAuthorizationGrowthRate:
                    type: number
                    description: Pre-authorization growth rate value (percent 0.1 = 10%).
                  notificationsSettings:
                    type: object
                    description: Notification settings information.
                    properties:
                      daysPrior:
                        type: array
                        description: Notification information sent before invoice payment date.
                        items:
                          required:
                          - days
                          - timeOfDay
                          type: object
                          description: Object with information about the moment when the notification is sent.
                          properties:
                            days:
                              type: integer
                              description: How many days before the invoice payment date is the notification sent.
                            timeOfDay:
                              type: string
                              description: Notification sending time.
                      daysAfter:
                        type: array
                        description: Notification information sent after invoice payment date.
                        items:
                          required:
                          - days
                          - timeOfDay
                          type: object
                          description: Object with information about the moment when the notification is sent.
                          properties:
                            days:
                              type: integer
                              description: How many days after the invoice payment date is the notification sent.
                            timeOfDay:
                              type: string
                              description: Notification sending time.
              example:
                dailyInterestRate: 0.01
                invoicePostponementLimit: 2
                taxRate: 0.4
                maxPostponementDays: 3
                defaultCreditValue: 150
                postponementEnabled: false
                automaticCheckingAccountCreationEnabled: false
                toleranceEnabled: false
                myCreditsEnabled: false
                maxPreAuthorizationGrowthRate: 0.1
                notificationsSettings:
                  daysPrior:
                  - days: 5
                    timeOfDay: '12:00:00'
                  - days: 1
                    timeOfDay: '12:00:00'
                  - days: 0
                    timeOfDay: '12:00:00'
                  daysAfter:
                  - days: 3
                    timeOfDay: '12:00:00'
      deprecated: false
components:
  parameters:
    Accept:
      name: Accept
      in: header
      description: HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
      required: true
      style: simple
      schema:
        type: string
        example: application/json
    Content-Type:
      name: Content-Type
      in: header
      description: Type of the content being sent.
      required: true
      style: simple
      schema:
        type: string
        example: application/json
  securitySchemes:
    appKey:
      type: apiKey
      in: header
      name: X-VTEX-API-AppKey
      description: Unique identifier of the [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys).
    appToken:
      type: apiKey
      in: header
      name: X-VTEX-API-AppToken
      description: Secret token of the [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys).
    VtexIdclientAutCookie:
      type: apiKey
      in: header
      name: VtexIdclientAutCookie
      description: '[User token](https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens), valid for 24 hours.'