> ## 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.

# Obter extrato bancário e suas movimentações



## OpenAPI

````yaml https://erp.olist.com/public-api/v3/swagger/swagger-mintlify.json get /extratos-bancarios/{idExtratoBancario}
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: []
paths:
  /extratos-bancarios/{idExtratoBancario}:
    get:
      tags:
        - Extrato Bancário
      summary: Obter extrato bancário e suas movimentações
      operationId: ObterExtratoBancarioAction
      parameters:
        - $ref: >-
            #/components/parameters/get_extratos_bancarios_idExtratoBancario_idExtratoBancario
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObterExtratoBancarioResponseModel'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDTO'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
        '503':
          description: Service Unavailable
      security:
        - bearerAuth: []
components:
  parameters:
    get_extratos_bancarios_idExtratoBancario_idExtratoBancario:
      name: idExtratoBancario
      in: path
      required: true
      schema:
        type: integer
  schemas:
    ObterExtratoBancarioResponseModel:
      title: ' '
      description: ' '
      properties:
        id:
          type: integer
        arquivo:
          type: string
          example: extrato-01-2024.ofx
        data:
          type: string
          example: '2024-01-01'
        conta:
          $ref: '#/components/schemas/ContaFinanceiraResponseModel'
        movimentacoes:
          type: array
          items:
            $ref: '#/components/schemas/MovimentacaoExtratoBancarioResponseModel'
      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
    ContaFinanceiraResponseModel:
      title: ' '
      description: ' '
      properties:
        id:
          type: integer
        descricao:
          type: string
      type: object
    MovimentacaoExtratoBancarioResponseModel:
      title: ' '
      description: ' '
      properties:
        id:
          type: integer
        data:
          type: string
          example: '2024-01-01'
        historico:
          description: >-
            Histórico da movimentação; quando conciliada, as observações do
            lançamento de caixa prevalecem
          type: string
        valor:
          description: >-
            Valor da movimentação, sempre positivo. O sinal é indicado pelo
            campo tipo
          type: number
          format: float
        tipo:
          description: |-

            - D - Saida
            - C - Entrada
            - S - Saldo
          enum:
            - D
            - C
            - S
          nullable: true
          x-enumDescriptions:
            - D - Saida
            - C - Entrada
            - S - Saldo
        situacao:
          description: |-
            Situação do tratamento da movimentação

            - 0 - Pendente
            - 1 - Ignorado
            - 2 - Adicionado Ao Caixa
            - 3 - Vinculado A Duplicata
          type: integer
          enum:
            - 0
            - 1
            - 2
            - 3
          nullable: true
          x-enumDescriptions:
            - 0 - Pendente
            - 1 - Ignorado
            - 2 - Adicionado Ao Caixa
            - 3 - Vinculado A Duplicata
        categoria:
          $ref: '#/components/schemas/CategoriaReceitaDespesaResponseModel'
        contato:
          $ref: '#/components/schemas/ContatoModelResponse'
        lancamentoCaixa:
          $ref: '#/components/schemas/LancamentoCaixaResponseModel'
      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
    CategoriaReceitaDespesaResponseModel:
      title: ' '
      description: ' '
      properties:
        id:
          type: integer
        descricao:
          type: string
      type: object
    ContatoModelResponse:
      title: ' '
      description: ' '
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseContatoModel'
        - properties:
            id:
              type: integer
          type: object
    LancamentoCaixaResponseModel:
      title: ' '
      description: ' '
      properties:
        id:
          description: Identificador do lançamento de caixa conciliado com a movimentação
          type: integer
      type: object
    BaseContatoModel:
      title: ' '
      description: ' '
      type: object
      allOf:
        - properties:
            nome:
              type: string
              nullable: true
            codigo:
              type: string
              nullable: true
            fantasia:
              type: string
              nullable: true
            tipoPessoa:
              description: |-

                - J - Juridica
                - F - Fisica
                - E - Estrangeiro
                - X - Estrangeiro No Brasil
              type: string
              enum:
                - J
                - F
                - E
                - X
              nullable: true
              x-enumDescriptions:
                - J - Juridica
                - F - Fisica
                - E - Estrangeiro
                - X - Estrangeiro No Brasil
            cpfCnpj:
              type: string
              nullable: true
            inscricaoEstadual:
              type: string
              nullable: true
            rg:
              type: string
              nullable: true
            telefone:
              type: string
              nullable: true
            celular:
              type: string
              nullable: true
            email:
              type: string
              nullable: true
            endereco:
              $ref: '#/components/schemas/EnderecoModel'
          type: object
    EnderecoModel:
      title: ' '
      description: ' '
      type: object
      allOf:
        - properties:
            endereco:
              type: string
              nullable: true
            numero:
              type: string
              nullable: true
            complemento:
              type: string
              nullable: true
            bairro:
              type: string
              nullable: true
            municipio:
              type: string
              nullable: true
            cep:
              type: string
              nullable: true
            uf:
              type: string
              nullable: true
            pais:
              type: string
              nullable: true
          type: object
  securitySchemes:
    bearerAuth:
      type: http
      scheme: Bearer

````