> ## Documentation Index
> Fetch the complete documentation index at: https://bmpdocs.moneyp.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# 25 - Future Entry Query

> <p>Scopes:</p>
<b>api.ext api.lancsfut</b>

Through this endpoint, the partner can view an upcoming transfer or payment release.


## OpenAPI

````yaml get /api/LancamentosFuturos
openapi: 3.0.1
info:
  title: BMPSPBExt
  description: '<p><strong>Build Number: </strong>#0.0</p>'
  version: v1
servers:
  - url: https://api.ext.dbs.moneyp.dev.br/
    description: Localhost
security:
  - Bearer: []
paths:
  /api/LancamentosFuturos:
    get:
      tags:
        - LancamentosFuturos
      summary: >-
        Consulta de agendamento de lançamentos futuros para uma conta bancária
        específica.
      description: "<p>Scopes:</p>\r\n<b>api.ext api.lancsfut</b>"
      parameters:
        - name: BancoNumero
          in: query
          description: Número identificador da Instituição Financeira.
          schema:
            type: string
        - name: ContaDto.Agencia
          in: query
          description: |-
            Número da agência bancária.*

            Observações:
            - O número da agência pode ter no máximo 4 caracteres.
          schema:
            type: string
            description: |-
              Número da agência bancária.*

              Observações:
              - O número da agência pode ter no máximo 4 caracteres.
        - name: ContaDto.AgenciaDigito
          in: query
          description: >-
            Dígito verificador da agência bancária.


            Observações:

            - O dígito verificador da agência bancária pode ter no máximo 1
            caracter.
          schema:
            type: string
            description: >-
              Dígito verificador da agência bancária.


              Observações:

              - O dígito verificador da agência bancária pode ter no máximo 1
              caracter.
        - name: ContaDto.Conta
          in: query
          description: >-
            Número da conta bancária.


            Observações:

            - O número da conta bancária pode ter no máximo 12 caracteres.

            - Para que seja possível localizar a conta, é necessário informar o
            'número da conta com dígito' (```contaPgto```) ou o 'número da
            conta' (```conta```) e o 'dígito verificador' (```contaDigito```).

            - Caso o 'número da conta com dígito' (```contaPgto```) seja
            informado, não é necessário preencher os campos 'número da conta'
            (```conta```) e 'dígito verificador' (```contaDigito```).

            - Caso nenhum dos campos referentes ao número da conta seja
            informado, ocorrerá erro na requisição devido à falta de informação
            vital.
          schema:
            type: string
            description: >-
              Número da conta bancária.


              Observações:

              - O número da conta bancária pode ter no máximo 12 caracteres.

              - Para que seja possível localizar a conta, é necessário informar
              o 'número da conta com dígito' (```contaPgto```) ou o 'número da
              conta' (```conta```) e o 'dígito verificador' (```contaDigito```).

              - Caso o 'número da conta com dígito' (```contaPgto```) seja
              informado, não é necessário preencher os campos 'número da conta'
              (```conta```) e 'dígito verificador' (```contaDigito```).

              - Caso nenhum dos campos referentes ao número da conta seja
              informado, ocorrerá erro na requisição devido à falta de
              informação vital.
        - name: ContaDto.ContaDigito
          in: query
          description: >-
            Dígito verificador do número da conta bancária.


            Observações:

            - O dígito verificador do número da conta bancária pode ter no
            máximo 1 caracter.
          schema:
            type: string
            description: >-
              Dígito verificador do número da conta bancária.


              Observações:

              - O dígito verificador do número da conta bancária pode ter no
              máximo 1 caracter.
        - name: ContaDto.ContaPgto
          in: query
          description: >-
            Número da conta bancária seguido do dígito verificador.


            Observações:

            - O número da conta seguido do dígito verificador pode ter no máximo
            20 caracteres.
          schema:
            type: string
            description: >-
              Número da conta bancária seguido do dígito verificador.


              Observações:

              - O número da conta seguido do dígito verificador pode ter no
              máximo 20 caracteres.
        - name: ContaDto.TipoConta
          in: query
          description: |-
            Tipo da conta.*

            Valores:
            1 - Corrente
            2 - Poupanca
            3 - Pagamento
            4 - Salario
          schema:
            allOf:
              - $ref: '#/components/schemas/BMPSPB.Infra.Enums.TipoConta'
            description: |-
              Tipo da conta.*

              Valores:
              1 - Corrente
              2 - Poupanca
              3 - Pagamento
              4 - Salario
        - name: ContaDto.ModeloConta
          in: query
          description: |-
            Modelo da conta.*

            Valores:
            1 - Movimento
            2 - Escrow
            3 - Vinculada
          schema:
            allOf:
              - $ref: '#/components/schemas/BMPSPB.Infra.Enums.ModeloConta'
            description: |-
              Modelo da conta.*

              Valores:
              1 - Movimento
              2 - Escrow
              3 - Vinculada
        - name: ListarApenasAgendamentosPendentes
          in: query
          description: >-
            Indica se a consulta irá listar apenas agendamentos pendentes de
            execução.
          schema:
            type: boolean
        - name: ListarAutorizacoes
          in: query
          description: >-
            Indica se a consulta incluirá, além das informações dos
            agendamentos, as autorizações relacionadas.
          schema:
            type: boolean
        - name: DataInicioAgendamento
          in: query
          description: >-
            Data de início da consulta dos agendamentos.


            Observações:

            - Pelo menos um dos campos 'data de início da consulta'
            (```dataInicioAgendamento```) ou 'data final da consulta'
            (```dataFimAgendamento```) deve ser informado.

            - Quando ambos os campos forem informados, a 'data de início da
            consulta' (```dataInicioAgendamento```) deverá ser anterior à 'data
            final da consulta' (```dataFimAgendamento```).
          schema:
            type: string
            format: date-time
        - name: DataFimAgendamento
          in: query
          description: >-
            Data final da consulta dos agendamentos.


            Observação:

            - Quando a 'data inicial da consulta' (```dataInicioAgendamento```)
            for informada a 'data final da consulta' (```dataFimAgendamento```)
            deverá ser posterior a ela.
          schema:
            type: string
            format: date-time
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: >-
                    #/components/schemas/BMPSPB.Domain.Messaging.API.Externa.LancamentosFuturos.LancamentosFuturosResponse
        '400':
          description: Erro de negócio
          content:
            application/json:
              schema:
                type: object
                properties:
                  sucesso:
                    type: boolean
                  mensagem:
                    type: string
        '500':
          description: Erro interno do servidor
          content:
            application/json:
              schema:
                type: object
                properties:
                  sucesso:
                    type: boolean
                  mensagem:
                    type: string
components:
  schemas:
    BMPSPB.Infra.Enums.TipoConta:
      enum:
        - 1
        - 2
        - 3
        - 4
      type: integer
      description: ''
      format: int32
    BMPSPB.Infra.Enums.ModeloConta:
      enum:
        - 1
        - 2
        - 3
      type: integer
      description: ''
      format: int32
    BMPSPB.Domain.Messaging.API.Externa.LancamentosFuturos.LancamentosFuturosResponse:
      type: object
      properties:
        codigoConta:
          type: string
          description: Código UUID identificador da Conta Bancária de destino.
          format: uuid
        codigoTicket:
          type: string
          format: uuid
        codigo:
          type: string
          description: Código UUID identificador do registro de Agendamento.
          format: uuid
        parceiro:
          type: string
          description: Nome do Parceiro.
          nullable: true
        contaPgto:
          type: string
          description: >-
            Combinação de número da Conta Bancária de Origem + Número da Agência
            de Origem. Sem espaços ou caracteres especiais.
          nullable: true
        descricao:
          type: string
          description: Descrição/Nome da Conta Bancária de Origem.
          nullable: true
        dtInclusao:
          type: string
          description: Data de inclusão do registro.
          format: date-time
        origemTransacao:
          allOf:
            - $ref: '#/components/schemas/BMPSPB.Infra.Enums.OrigemTransacao'
        dtAgendamento:
          type: string
          description: Data e hora da efetivação do Agendamento da Transação Financeira.
          format: date-time
        valor:
          type: number
          description: Valor total da Transação agendada.
          format: double
        nome:
          type: string
          description: Nome completo do Agendador.
          nullable: true
        documentoFederal:
          type: string
          description: CPF ou CNPJ do Agendador, à depender da natureza do mesmo.
          nullable: true
        numeroBanco:
          type: string
          description: Código da Instituição Financeira de destino.
          nullable: true
        descricaoBanco:
          type: string
          description: Nome da Instituição Financeira de destino.
          nullable: true
        agencia:
          type: string
          description: Número da Agência de destino.
          nullable: true
        agenciaDigito:
          type: string
          description: Dígito verificador da Agência de destino.
          nullable: true
        contaDestino:
          type: string
          description: Númmero da Conta Bancária de destino.
          nullable: true
        contaDigitoDestino:
          type: string
          description: Dígito verificador da Conta Bancária de destino.
          nullable: true
        contaPgtoDestino:
          type: string
          description: >-
            Combinação de número da Conta Bancária de destino + Número da
            Agência de destino. Sem espaços ou caracteres especiais.
          nullable: true
        chavePix:
          type: string
          description: >-
            Chave PIX da transferência. Presente somente em registros cujo a
            Origem da Transação seja Envio de Pix.
          nullable: true
        codigoBarras:
          type: string
          description: >-
            Código de Barras do Boleto. Presente somente em registros cujo a
            Origem da Transação seja Pagamento de Boleto.
          nullable: true
        linhaDigitavel:
          type: string
          description: >-
            Linha Digitável do Boleto. Presente somente em registros cujo a
            Origem da Transação seja Pagamento de Boleto.
          nullable: true
        situacao:
          allOf:
            - $ref: '#/components/schemas/BMPSPB.Infra.Enums.SituacaoTicketEnvio'
        autorizacoes:
          type: array
          items:
            $ref: >-
              #/components/schemas/BMPSPB.Domain.Messaging.API.Externa.LancamentosFuturos.Autorizacao
          description: Lista de Autorizações da Transação associadas ao Agendamento.
          nullable: true
      additionalProperties: false
    BMPSPB.Infra.Enums.OrigemTransacao:
      enum:
        - 0
        - 1
        - 2
        - 3
        - 4
        - 5
        - 6
        - 7
        - 8
        - 9
        - 10
        - 501
        - 502
        - 503
        - 504
        - 505
        - 506
        - 507
        - 1001
        - 1002
        - 1003
        - 1004
        - 1005
        - 1006
        - 1007
        - 1008
        - 1009
        - 1010
        - 1011
        - 1012
        - 1013
        - 1014
        - 1200
        - 1501
        - 1502
        - 1503
        - 1601
        - 1701
        - 2001
        - 2002
        - 2003
        - 2004
        - 2010
        - 2012
        - 2501
        - 3001
        - 3002
        - 4001
        - 4501
        - 5001
        - 5002
        - 5003
        - 5004
      type: integer
      description: ''
      format: int32
    BMPSPB.Infra.Enums.SituacaoTicketEnvio:
      enum:
        - 10
        - 11
        - 12
        - 21
        - 22
        - 23
        - 24
        - 31
        - 32
        - 33
        - 34
        - 35
        - 41
        - 42
        - 50
        - 51
      type: integer
      description: ''
      format: int32
    BMPSPB.Domain.Messaging.API.Externa.LancamentosFuturos.Autorizacao:
      type: object
      properties:
        nomeAutorizador:
          type: string
          nullable: true
        situacaoAprovacao:
          allOf:
            - $ref: '#/components/schemas/BMPSPB.Infra.Enums.SituacaoAprovacao'
        dtAprovacao:
          type: string
          format: date-time
      additionalProperties: false
    BMPSPB.Infra.Enums.SituacaoAprovacao:
      enum:
        - 0
        - 1
        - 2
        - 3
      type: integer
      description: ''
      format: int32
  securitySchemes:
    Bearer:
      type: apiKey
      description: Copie 'Bearer ' + token
      name: Authorization
      in: header

````