> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt
> Use this file to discover all available pages before exploring further.

# Atualizar configurações do Ledger

> Use este endpoint para atualizar parcialmente as configurações de um Ledger específico. Utiliza deep merge — apenas os campos incluídos no corpo da requisição são modificados.



## OpenAPI

````yaml pt/openapi/v3-current/ledger.yaml patch /v1/organizations/{organization_id}/ledgers/{ledger_id}/settings
openapi: 3.1.0
info:
  title: API Midaz Ledger
  description: >-
    Referência completa da API para serviços do Midaz Ledger incluindo
    gerenciamento de organizações, operações de ledger, ativos, segmentos,
    portfolios, contas, tipos de conta, transações, operações, saldos, rotas de
    operação, rotas de transação e índices de metadata.
  version: 3.7.8
servers:
  - url: https://ledger.sandbox.lerian.net
security: []
tags:
  - name: API de Organizações
  - name: API de Ledgers
  - name: API de Ativos
  - name: API de Segmentos
  - name: API de Portfolios
  - name: API de Tipos de Conta
  - name: API de Contas
  - name: API de Saldos
  - name: API de Transações
  - name: API de Operações
  - name: API de Rotas de Operação
  - name: API de Rotas de Transação
  - name: API de Índices de Metadata
  - name: API de Titulares
  - name: API de Instrumentos
  - name: API de Pacotes de Cobrança
  - name: API de Pacotes
  - name: API de Cálculo de Cobrança
  - name: API de Estimativa
  - name: API de Criptografia
  - name: API de Proteção
  - name: API de Taxas de Ativos
paths:
  /v1/organizations/{organization_id}/ledgers/{ledger_id}/settings:
    patch:
      tags:
        - API de Ledgers
      summary: Atualizar configurações do Ledger
      description: >-
        Use este endpoint para atualizar parcialmente as configurações de um
        Ledger específico. Utiliza deep merge — apenas os campos incluídos no
        corpo da requisição são modificados.
      parameters:
        - $ref: '#/components/parameters/OrganizationId'
        - $ref: '#/components/parameters/LedgerId'
        - $ref: '#/components/parameters/ContentType'
        - $ref: '#/components/parameters/XRequestId'
        - $ref: '#/components/parameters/Authorization'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateLedgerSettingsRequest'
            example:
              accounting:
                validateRoutes: true
      responses:
        '200':
          description: >-
            Indica que a requisição foi bem-sucedida e as configurações foram
            atualizadas.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LedgerSettingsResponse'
              example:
                accounting:
                  validateAccountType: false
                  validateRoutes: true
          headers: {}
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorFormat'
              examples:
                Error0147:
                  $ref: '#/components/examples/Error0147'
                Error0148:
                  $ref: '#/components/examples/Error0148'
                Error0149:
                  $ref: '#/components/examples/Error0149'
                Error0143:
                  $ref: '#/components/examples/Error0143'
        '401':
          description: Não autorizado
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorFormat'
              examples:
                Error0041:
                  $ref: '#/components/examples/Error0041'
                Error0042:
                  $ref: '#/components/examples/Error0042'
        '403':
          description: Proibido
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorFormat'
              examples:
                Error0043:
                  $ref: '#/components/examples/Error0043'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorFormat'
              examples:
                Error0007:
                  $ref: '#/components/examples/Error0007'
        '500':
          description: Erro Interno do Servidor
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorFormat'
              examples:
                Error0046:
                  $ref: '#/components/examples/Error0046'
components:
  parameters:
    OrganizationId:
      name: organization_id
      in: path
      description: O identificador único da Organização associada ao Ledger.
      required: true
      example: 019c96a0-0a98-7287-9a31-786e0809c769
      schema:
        type: string
        format: uuid
    LedgerId:
      name: ledger_id
      in: path
      description: O identificador único do Ledger associado.
      required: true
      example: 019c96a0-0ac0-7de9-9f53-9cf842a2ee5a
      schema:
        type: string
        format: uuid
    ContentType:
      name: Content-Type
      in: header
      description: O tipo de mídia do recurso. O valor recomendado é `application/json`.
      required: false
      example: application/json
      schema:
        type: string
    XRequestId:
      name: X-Request-Id
      in: header
      description: >-
        Um identificador único utilizado para rastrear e acompanhar cada
        requisição.
      required: false
      example: 019c96a0-0a98-7287-9a31-786e0809c769
      schema:
        type: string
        format: uuid
    Authorization:
      name: Authorization
      in: header
      required: false
      schema:
        type: string
      description: >
        Token JWT bearer para autenticação.

        Obrigatório quando `PLUGIN_AUTH_ENABLED=true` (exigido em implantações
        multi-tenant).

        Opcional no modo OSS single-tenant padrão.

        Formato: `Bearer <token>`
  schemas:
    UpdateLedgerSettingsRequest:
      type: object
      description: >-
        Atualização parcial das configurações do Ledger. Utiliza deep merge —
        apenas os campos que você incluir são modificados.
      properties:
        accounting:
          type: object
          description: Configurações relacionadas à contabilidade do Ledger.
          properties:
            validateAccountType:
              type: boolean
              description: >-
                Habilitar ou desabilitar a validação de tipo de conta para
                transações.
            validateRoutes:
              type: boolean
              description: Habilitar ou desabilitar a validação de rotas para transações.
    LedgerSettingsResponse:
      type: object
      description: As configurações atuais de um Ledger.
      properties:
        accounting:
          type: object
          description: Configurações relacionadas à contabilidade do Ledger.
          properties:
            validateAccountType:
              type: boolean
              description: >-
                Quando habilitado, valida que os tipos de conta correspondam às
                regras definidas nas rotas de operação durante o processamento
                de transações.
            validateRoutes:
              type: boolean
              description: >-
                Quando habilitado, cada transação neste Ledger deve ter uma rota
                de transação associada. As operações também são validadas contra
                as regras de suas rotas de operação.
    ErrorFormat:
      type: object
      description: A mensagem de erro da resposta.
      required:
        - code
        - title
        - message
      properties:
        code:
          type: string
          description: Um identificador único e estável para o erro.
        title:
          type: string
          description: Um breve resumo do problema.
        message:
          type: string
          description: Orientação detalhada para resolver o erro.
        entityType:
          type: string
          description: >-
            O tipo de entidade ao qual o erro se refere (por exemplo,
            organization, ledger, account, transaction). Opcional.
        fields:
          type: object
          additionalProperties: true
          description: Informações adicionais sobre os campos que causaram o erro.
  examples:
    Error0147:
      summary: Unknown Settings Field
      value:
        code: '0147'
        title: Unknown Settings Field
        message: >-
          The provided field is not recognized in the settings configuration.
          Only known fields are accepted.
    Error0148:
      summary: Invalid Settings Field Type
      value:
        code: '0148'
        title: Invalid Settings Field Type
        message: >-
          The provided value has an incompatible type for the specified field
          (e.g., a string was provided for a boolean field).
    Error0149:
      summary: Settings Field at Root Level
      value:
        code: '0149'
        title: Settings Field at Root Level
        message: >-
          The field must be nested under the correct parent object (e.g., use
          accounting.validateRoutes instead of validateRoutes at the root
          level).
    Error0143:
      summary: Payload Too Large
      value:
        code: '0143'
        title: Payload Too Large
        message: The request body exceeds the 64 KB limit.
    Error0041:
      summary: Token Missing
      value:
        code: '0041'
        title: Token Missing
        message: >-
          A valid token must be provided in the request header. Please include a
          token and try again.
    Error0042:
      summary: Invalid Token
      value:
        code: '0042'
        title: Invalid Token
        message: >-
          The provided token is expired, invalid or malformed. Please provide a
          valid token and try again.
    Error0043:
      summary: Insufficient Privileges
      value:
        code: '0043'
        title: Insufficient Privileges
        message: >-
          You do not have the necessary permissions to perform this action.
          Please contact your administrator if you believe this is an error.
    Error0007:
      value:
        code: '0007'
        title: Entity Not Found
        message: >-
          No entity was found for the given ID. Please make sure to use the
          correct ID for the entity you are trying to manage.
      summary: Entity Not Found
    Error0046:
      summary: Internal Server Error
      value:
        code: '0046'
        title: Internal Server Error
        message: >-
          The server encountered an unexpected error. Please try again later or
          contact support.

````