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

# Paginar Simulações

> Paginação de simulações



## OpenAPI

````yaml GET /v1/proposal/simulation
openapi: 3.1.0
info:
  title: API Credicarro
  description: API para gerenciamento de cobranças e pagamentos usando o Credicarro.
  version: 1.0.0
servers:
  - url: https://api.staging.credicarro.com.br/integration
    description: Servidor para o ambiente de staging
security: []
paths:
  /v1/proposal/simulation:
    get:
      tags:
        - Proposta
      summary: Paginação de simulações
      description: Paginação de simulações
      parameters:
        - name: pagina_inicial
          in: query
          description: Página inicial (mínimo 1)
          schema:
            type: integer
            format: int32
            example: 1
        - name: limite
          in: query
          description: Quantidade de itens por página (1 a 100)
          schema:
            type: integer
            format: int32
            example: 10
      responses:
        '200':
          description: Lista de simulações retornada com sucesso
          content:
            application/json:
              schema:
                type: object
                properties:
                  itens:
                    type: array
                    description: Lista de simulações
                    items:
                      $ref: '#/components/schemas/SimulationResponse'
                  pagina:
                    $ref: '#/components/schemas/Page'
        '400':
          description: Erro na requisição
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      security:
        - bearerAuth: []
components:
  schemas:
    SimulationResponse:
      type: object
      description: Os dados da sua simulação
      properties:
        id_simulacao:
          type: string
          format: uuid
          description: Identificador único da simulação
          example: bea8d060-f93d-48eb-b6c4-45f64483cdd9
        prazo:
          type: integer
          format: int64
          description: Prazo da simulação
          example: 24
        valor_parcela:
          type: number
          format: double
          description: Valor da parcela
          example: 2356
        valor_solicitado:
          type: number
          format: double
          description: Valor solicitado
          example: 37908
        valor_entrada:
          type: number
          format: double
          description: Valor de entrada
          example: 9786
        valor_bem:
          type: number
          format: double
          description: Valor do bem
          example: 47694
        valor_tac:
          type: number
          format: double
          description: Valor da taxa de cadastro
          example: 1500
        taxa_juros_negociada:
          type: number
          format: double
          description: Valor da taxa de juros
          example: 2.79
        valor_registro:
          type: number
          format: double
          description: Valor do registro
          example: 487
        uf:
          type: string
          maxLength: 2
          description: Estado da simulação
          example: SP
        tipo:
          type: string
          description: Tipo da proposta utilizada
          enum:
            - Financing
            - Refinancing
            - AmountSimulation
          example: Refinancing
        transacao:
          $ref: '#/components/schemas/Transaction'
        juros:
          $ref: '#/components/schemas/Interest'
        cet:
          $ref: '#/components/schemas/Cet'
        iof:
          $ref: '#/components/schemas/Iof'
        veiculo:
          $ref: '#/components/schemas/Vehicle'
        cliente:
          $ref: '#/components/schemas/Customer'
        data_criacao:
          type: string
          format: date-time
          example: '2025-10-17T19:05:08.984Z'
          description: Data de criaçao da simulação
      additionalProperties: false
    Page:
      type: object
      properties:
        tem_proximo:
          type: boolean
          description: Identificador se existe uma próxima página
          example: true
        tem_anterior:
          type: boolean
          description: Identificador se existe uma página anterior
          example: false
        numero:
          type: integer
          format: int32
          description: Página atual.
          example: 2
        tamanho:
          type: integer
          format: int32
          description: Quantidade de dados por página
          example: 15
        total:
          type: integer
          format: int64
          description: Total de dados encontrados
          example: 45
      additionalProperties: false
    ProblemDetails:
      type: object
      properties:
        tipo:
          type: string
          description: Tipo de problema encontrado
          example: Partner.AccountIsIncompleted
        titulo:
          type: string
          description: Título do erro
          example: Bad Request
        status:
          type: integer
          format: int32
          description: Status Code do erro
          example: 400
        detalhe:
          type: string
          description: Descrição do erro
          example: Cadastro de conta não finalizado
        erro:
          type: 'null'
      additionalProperties: false
    Transaction:
      type: object
      properties:
        valor_total_credito:
          type: number
          format: double
          description: Valor total do credito
          example: 78495
        valor_total_debito:
          type: number
          format: double
          description: Valor total do debito
          example: 78495
      additionalProperties: false
    Interest:
      type: object
      properties:
        percentual_juros_mensal:
          type: number
          format: double
          description: Percentual de juros mensal
          example: 3.29
        percentual_juros_anual:
          type: number
          format: double
          description: Percentual de juros anual
          example: 39.48
      additionalProperties: false
    Cet:
      type: object
      properties:
        percentual_mensal:
          type: number
          format: double
          description: Percentual mensal
          example: 3.62
        percentual_anual:
          type: number
          format: double
          description: Percentual anual
          example: 43.44
      additionalProperties: false
    Iof:
      type: object
      properties:
        valor:
          type: number
          format: double
          description: Valor de IOF
          example: 872
        percentual:
          type: number
          format: double
          description: Percentual de IOF
          example: 1.92
      additionalProperties: false
    Vehicle:
      type: object
      properties:
        marca:
          type: string
          description: Marca do Veículo
          example: Honda
        modelo:
          type: string
          description: Modelo do Veículo
          example: Civic
        versao:
          type: string
          description: Versão do Veículo
          example: Turing
        ano:
          type: integer
          format: int32
          nullable: true
          description: Ano do Veículo
          example: 2024
        valor:
          type: number
          format: double
          nullable: true
          description: Valor do Veículo
          example: 124654
        placa:
          type: string
          description: Placa do Veículo
          example: MWO-3910
        veiculo_zero_km:
          type: boolean
          nullable: true
          description: Indicador se veículo é 0KM
          example: false
        chassi:
          type: string
          description: Chassi do Veículo
          example: 1Y5Ye4U8kydsr4828
        renavam:
          type: string
          description: Renavam do Veículo
          example: '70502561697'
        cor:
          type: string
          description: Cor do Veículo
          example: Prata
      additionalProperties: false
    Customer:
      type: object
      properties:
        cpf:
          type: string
          description: Documento de identificação do comprador
          example: 123.456.789-01
      additionalProperties: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Cabeçalho de autenticação Bearer no formato `Bearer <token>` onde
        `<token>` é seu TOKEN de autenticação

````