Pular para o conteúdo principal

Estrutura de Dados de Proposta (Proposal)

Este documento fornece uma explicação detalhada de todos os campos presentes na estrutura Proposal e suas entidades associadas. A proposta representa uma solicitação financeira com dados pessoais, informações bancárias, detalhes contratuais e log de operações.

Campos do Objeto Proposal​

  • id (string): Identificador único da proposta.
  • shortHash (string | null): Hash curto usado para identificar a proposta.
  • externalId (string | null): ID externo para a proposta, se aplicável.
  • status (string): Status atual da proposta (ex.: PENDING, APPROVED).
  • anticipatedYears (number | null): Número de anos antecipados para o empréstimo.
  • annualCET (number | null): Custo Efetivo Total (CET) anual da proposta.
  • monthlyCET (number | null): CET mensal da proposta.
  • operationDate (string | null): Data da operação, no formato ISO.
  • disbursementDate (string | null): Data de liberação do valor.

Relacionamentos de Proposal​

  • sellerId (string): Identificador do vendedor responsável pela proposta.
  • Seller (User): Dados completos do vendedor.
  • processorId (string): Identificador do processador de pagamento associado.
  • Processor (Processor | null): Dados completos do processador.
  • corbanId (number): ID do Corban responsável.
  • balanceSolicitationId (string): ID da solicitação de saldo associada.
  • BalanceSolicitation (BalanceSolicitation | null): Dados da solicitação de saldo.
  • naturalPersonId (string | null): ID da pessoa física associada à proposta.
  • NaturalPerson (NaturalPerson | null): Dados completos da pessoa física.
  • chosenFinancialInfoId (string | null): ID das informações financeiras escolhidas pelo cliente.
  • chosenFinancialInfo (FinancialInfo | null): Dados completos da opção financeira escolhida.
  • optionsFinancialInfo (FinancialInfo[]): Lista de opções financeiras disponíveis para o cliente.
  • BankDetail (BankDetail | null): Detalhes bancários para pagamento.
  • Contract (Contract | null): Detalhes do contrato da proposta.
  • UnicoData (UnicoData | null): Dados de biometria e verificação únicos.
  • OperationLog (OperationLog[]): Log de operações realizadas na proposta.
  • createdAt (string): Data de criação da proposta, no formato ISO.

Campos do Objeto NaturalPerson​

  • id (string): Identificador único da pessoa física.
  • name (string | null): Nome da pessoa física.
  • motherName (string | null): Nome da mãe.
  • birthDate (string | null): Data de nascimento, no formato ISO.
  • document (string): Número do documento (CPF).
  • documentType (string): Tipo de documento (ex.: CPF).
  • address (Address | null): Endereço completo da pessoa.
  • addressId (string | null): Identificador do endereço.
  • phoneNumber (string | null): Número de telefone.
  • email (string | null): Endereço de e-mail.
  • nationality (string | null): Nacionalidade.
  • occupation (string | null): Ocupação profissional.
  • civilStatus (string): Estado civil.
  • createdAt (string): Data de criação da pessoa física, no formato ISO.
  • Proposal (Proposal[] | null): Lista de propostas associadas a esta pessoa.

Campos do Objeto Address​

  • addressName (string): Nome da rua ou logradouro.
  • zipCode (string): Código postal (CEP).
  • city (string): Cidade.
  • uf (string): Estado (ex.: SP, RJ).
  • number (string): Número da residência ou prédio.
  • district (string | null): Bairro.
  • complement (string | null): Complemento do endereço (ex.: Apto 101).

Campos do Objeto FinancialInfo​

  • id (string): Identificador único das informações financeiras.
  • commission (number | null): Comissão associada.
  • balance (number | null): Saldo total.
  • desiredAmount (number | null): Valor desejado pelo cliente.
  • issueAmount (number | null): Valor emitido na proposta.
  • releasedAmount (number | null): Valor liberado na proposta.
  • insuranceAmount (number | null): Valor do seguro associado.
  • withoutTacAmount (number | null): Valor sem custos administrativos (TAC).
  • tacInput (number | null): TAC de entrada.
  • agioInput (number | null): Ágio de entrada.
  • tacOutput (number | null): TAC de saída.
  • agioOutput (number | null): Ágio de saída.
  • monthlyRate (number | null): Taxa de juros mensal.
  • annualRate (number | null): Taxa de juros anual.
  • iof (number | null): Valor do IOF.
  • paymentDate (string | null): Data de pagamento.
  • externalProductId (string | null): ID do produto externo.
  • productId (string): Identificador do produto financeiro.
  • Product (Product | null): Dados completos do produto financeiro.
  • Installments (Installment[] | null): Lista de parcelas associadas.
  • proposalId (string | null): ID da proposta associada.
  • Proposal (Proposal | null): Proposta associada a estas informações financeiras.
  • ChosenProposal (Proposal | null): Proposta escolhida, se aplicável.
  • createdAt (string): Data de criação das informações financeiras, no formato ISO.

Campos do Objeto BankDetail​

  • id (string): Identificador único dos detalhes bancários.
  • pixKeyType (string): Tipo de chave PIX (ex.: CPF).
  • pixKey (string | null): Chave PIX.
  • account (number | null): Número da conta bancária.
  • agency (string | null): Número da agência bancária.
  • bankCode (string | null): Código do banco.
  • accountDigit (string | null): Dígito da conta bancária.
  • proposalId (string): ID da proposta associada.
  • Proposal (Proposal | null): Proposta associada aos detalhes bancários.
  • createdAt (string): Data de criação dos detalhes bancários, no formato ISO.

Campos do Objeto Contract​

  • id (string): Identificador único do contrato.
  • ccbId (string): ID do Contrato de Crédito Bancário.
  • contractUrl (string): URL do contrato original.
  • signedContractUrl (string): URL do contrato assinado.
  • proposalId (string): ID da proposta associada.
  • Proposal (Proposal | null): Proposta associada ao contrato.
  • createdAt (string): Data de criação do contrato, no formato ISO.

Campos do Objeto UnicoData​

  • id (string): Identificador único dos dados biométricos.
  • unicoId (string): Identificador da biometria Unico.
  • unicoScore (number): Pontuação Unico.
  • unicoStatus (string): Status da verificação Unico.
  • unicoFingerprint (string): Impressão digital da Unico.
  • frontDocument (string): Documento frontal da verificação.
  • backDocument (string): Documento traseiro da verificação.
  • frontTyping (string): Reconhecimento de texto frontal.
  • faceMatch (string): Status do reconhecimento facial.
  • lastFormalizationDate (string): Data da última formalização.
  • proposalId (string): ID da proposta associada.
  • Proposal (Proposal | null): Proposta associada aos dados biométricos.
  • createdAt (string): Data de criação dos dados Unico, no formato ISO.

Campos do Objeto Installment​

  • id (string): Identificador único da parcela.
  • dueDate (string): Data de vencimento da parcela, no formato ISO.
  • principalAmount (number): Valor principal da parcela.
  • amortization (number): Valor da amortização.
  • releasedAmount (number): Valor liberado na parcela.
  • issueAmount (number): Valor emitido na parcela.
  • interest (number): Juros da parcela.
  • financeTax (number): Taxa financeira aplicada.
  • payment (number): Valor total do pagamento da parcela.
  • addedFixedCosts (number | null): Custos fixos adicionais, se aplicável.
  • financialInfoId (string | null): ID das informações financeiras associadas.
  • FinancialInfo (FinancialInfo | null): Informações financeiras relacionadas a esta parcela.
  • createdAt (string): Data de criação da parcela, no formato ISO.

Este guia detalha todos os campos disponíveis no objeto `Proposal

` e suas entidades associadas, com descrições de cada atributo e seus relacionamentos para ajudar a entender a estrutura de uma proposta completa.