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

# Estornar as baixas de uma conta a pagar

> Estorna todas as baixas da conta, que volta para a situação em aberto. Quando a conta foi paga em conjunto com outras, retorna 409 com as contas afetadas, e o estorno só é feito com estornarContasRelacionadas; nesse caso retorna 200 com as contas estornadas. Retorna 400 quando a conta não está paga ou parcialmente paga, quando não possui baixas ou quando alguma baixa está em período financeiro fechado.



## OpenAPI

````yaml https://erp.olist.com/public-api/v3/swagger/swagger-mintlify.json post /contas-pagar/{idContaPagar}/estornar
openapi: 3.0.0
info:
  title: Olist ERP API v3
  description: >-
    Documentação completa: <a href="https://api-docs.erp.olist.com"
    target="_blank">https://api-docs.erp.olist.com</a>
  version: '3.1'
servers:
  - url: https://api.tiny.com.br/public-api/v3
security: []
tags:
  - name: Caixa
    description: Caixa
  - name: Categorias
    description: Categorias
  - name: Categorias de receita e despesa
    description: Categorias de receita e despesa
  - name: Contas Bancárias
    description: Contas Bancárias
  - name: Contas Financeiras
    description: Contas Financeiras
  - name: Contas a pagar
    description: Contas a pagar
  - name: Contas a receber
    description: Contas a receber
  - name: Contatos
    description: Contatos
  - name: CRM
    description: CRM
  - name: Dados da empresa
    description: Dados da empresa
  - name: Depósitos
    description: Depósitos
  - name: Estoque
    description: Estoque
  - name: Expedição
    description: Expedição
  - name: Extrato Bancário
    description: Extrato Bancário
  - name: Logistica
    description: Logistica
  - name: Formas de pagamento
    description: Formas de pagamento
  - name: Formas de recebimento
    description: Formas de recebimento
  - name: Grupos de Tags
    description: Grupos de Tags
  - name: Intermediadores
    description: Intermediadores
  - name: Lista de Preços
    description: Lista de Preços
  - name: Marcas
    description: Marcas
  - name: Meios de recebimento
    description: Meios de recebimento
  - name: Notas
    description: Notas
  - name: Orcamentos
    description: Orcamentos
  - name: Ordem de Compra
    description: Ordem de Compra
  - name: Ordem de Serviço
    description: Ordem de Serviço
  - name: Pedidos
    description: Pedidos
  - name: Produtos
    description: Produtos
  - name: Separação
    description: Separação
  - name: Serviços
    description: Serviços
  - name: Tags de Produtos
    description: Tags de Produtos
  - name: Usuarios
    description: Usuarios
  - name: Vendedores
    description: Vendedores
paths:
  /contas-pagar/{idContaPagar}/estornar:
    post:
      tags:
        - Contas a pagar
      summary: Estornar as baixas de uma conta a pagar
      description: >-
        Estorna todas as baixas da conta, que volta para a situação em aberto.
        Quando a conta foi paga em conjunto com outras, retorna 409 com as
        contas afetadas, e o estorno só é feito com estornarContasRelacionadas;
        nesse caso retorna 200 com as contas estornadas. Retorna 400 quando a
        conta não está paga ou parcialmente paga, quando não possui baixas ou
        quando alguma baixa está em período financeiro fechado.
      operationId: EstornarContaPagarAction
      parameters:
        - $ref: >-
            #/components/parameters/post_contas_pagar_idContaPagar_estornar_idContaPagar
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EstornarContaPagarModelRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EstornarContaPagarModelResponse'
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDTO'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '409':
          description: Conta paga em conjunto com outras
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EstornarContaPagarModelResponse'
        '500':
          description: Internal Server Error
        '503':
          description: Service Unavailable
      security:
        - bearerAuth: []
components:
  parameters:
    post_contas_pagar_idContaPagar_estornar_idContaPagar:
      name: idContaPagar
      in: path
      description: Identificador da conta a pagar
      required: true
      schema:
        type: integer
  schemas:
    EstornarContaPagarModelRequest:
      title: ' '
      description: ' '
      properties:
        estornarContasRelacionadas:
          description: >-
            Confirma o estorno da conta paga em conjunto com outras, que também
            voltam a ficar em aberto
          type: boolean
          example: false
      type: object
    EstornarContaPagarModelResponse:
      title: ' '
      description: ' '
      properties:
        mensagem:
          type: string
        contas:
          type: array
          items:
            $ref: '#/components/schemas/ContaPagarEstornoModelResponse'
      type: object
    ErrorDTO:
      title: ' '
      description: ' '
      properties:
        mensagem:
          description: Mensagem de erro geral
          type: string
          example: Ocorreram erros de validação
        detalhes:
          description: Detalhes específicos do erro
          type: array
          items:
            $ref: '#/components/schemas/ErrorDetailDTO'
          example:
            - campo: codigo
              mensagem: O campo código é obrigatório
          nullable: true
      type: object
    ContaPagarEstornoModelResponse:
      title: ' '
      description: ' '
      properties:
        id:
          type: integer
        numeroDocumento:
          type: string
          nullable: true
        nomeContato:
          type: string
          nullable: true
        valor:
          type: number
          format: float
        dataVencimento:
          type: string
          example: '2024-01-31'
      type: object
    ErrorDetailDTO:
      title: ' '
      description: ' '
      properties:
        campo:
          description: Campo que gerou o erro
          type: string
          example: codigo
        mensagem:
          description: Mensagem de erro específica do campo
          type: string
          example: O campo código é obrigatório
      type: object
  securitySchemes:
    bearerAuth:
      type: http
      scheme: Bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.