Simular Propostas

POST/proposals/simulate

Esse endpoint permite que um originador autenticado realize uma simulação de proposta antes de criar efetivamente uma proposta.

---

Dados principais

Campo	Tipo	Descrição	Obrigatório
name	string	Nome/Razão Social do Cedente.	Sim
document	string	Documento do cedente (CPF ou CNPJ).	Sim
email	string	E-mail do cedente.	Sim
partnerName	string, null	Nome do sócio solicitante.	Sim para CNPJs
partnerDocument	string, null	Documento do sócio solicitante.	Sim para CNPJs
type	string	Tipo de pessoa: F (Física) ou J (Jurídica).	Sim
cellphone	string	Número de celular do cedente.	Sim
occupation	string	Ocupação/Profissão do cedente.	Sim
bankData.bank	string	Código do banco.	Sim
bankData.account	string	Número da conta bancária.	Sim
bankData.agency	string	Número da agência.	Sim
bankData.keyPix	string	Chave Pix para recebimento.	Não
receivables	array	Array de objetos de recebíveis.	Sim
receivables.externalId	number	Identificador externo do recebível.	Sim
receivables.payerName	string	Nome/Razão Social do pagador/sacado.	Sim
receivables.payerDocument	string	Documento do pagador/sacado (CPF ou CNPJ).	Sim
receivables.value	number	Valor de antecipação do recebível.	Sim
receivables.totalAssetBacking	number	Valor total do recebível.	Sim
receivables.expectedDate	string	Data prevista de pagamento (Formato yyyy-MM-dd).	Sim
receivables.identifier	string	Identificador interno do recebível.	Sim

Exemplo de Body

Física

{
  "name": "John Wick",
  "type": "F",
  "cpf": "12345678901",
  "idNumber": "123456789",
  "issuingAgency": "SSP/SP",
  "tradeName": null,
  "cnpj": null,
  "nationality": "Brasileiro",
  "occupation": "Desenvolvedor",
  "cellphone": "92999998888",
  "email": "wick@zemobank.com",
  "bankData": {
    "bank": "001",
    "account": "123456-7",
    "agency": "0001",
    "keyPix": "email@pix.com"
  },
  "address": {
    "zipCode": "12345678",
    "street": "Rua Empresarial",
    "number": "10",
    "complement": "AP 1802",
    "neighborhood": "Empresarial",
    "city": "São Paulo",
    "state": "SP",
    "country": "Brasil"
  },
  "receivables": [
    {
      "externalId": 101,
      "payerName": "Cliente XPTO",
      "payerDocument": "12345678000199",
      "value": 1000,
      "totalAssetBacking": 1000,
      "expectedDate": "2024-05-15",
      "identifier": "REC001"
    }
  ]
}

Jurídica

{
  "name": "Leon S Kennedy",
  "type": "J",
  "tradeName": "Umbrella Corporation",
  "cnpj": "12111346000190",
  "cpf": "12345678901"
  "idNumber": "123456789",
  "issuingAgency": "SSP/SP",
  "nationality": "Brasileiro",
  "maritalStatus": "solteiro",
  "occupation": "Desenvolvedor",
  "cellphone": "92999998888",
  "email": "leon@zemobank.com",
  "bankData": {
    "bank": "001",
    "account": "123456-7",
    "agency": "0001",
    "keyPix": "email@pix.com"
  },
  "address": {
    "zipCode": "12345678",
    "street": "Rua Empresarial",
    "number": "10",
    "complement": "AP 1802",
    "neighborhood": "Empresarial",
    "city": "São Paulo",
    "state": "SP",
    "country": "Brasil"
  },
  "receivables": [
    {
      "externalId": 101,
      "identifier": "REC001",
      "payerName": "Cliente XPTO",
      "payerDocument": "12345678000199",
      "value": 1000,
      "totalAssetBacking": 1000,
      "expectedDate": "2024-05-15"
    }
  ]
}

Response

200 - Success

{
  "id": "proposal simulate",
  "totalValue": 1000,
  "liquidValue": 743,
  "discountedValue": 104,
  "fixedTac": 150,
  "variableTac": 3,
  "totalTac": 153,
  "averageDaysInAdvance": 39,
  "status": "CREATED",
  "receivables": [
    {
      "id": "receivable 1",
      "proposalId": "proposal simulate",
      "externalId": 101,
      "description": "REC001",
      "dueDate": "2025-05-15T00:00:00.000Z",
      "originalValue": 1000,
      "totalAssetBacking": 1000,
      "liquidTotalValue": 896,
      "discountedValue": 104,
      "defaultTax": 8,
      "variableTac": 3,
      "floatingDays": 2,
      "qtdDaysAdvanced": 39,
      "percentageTotalEffectiveCost": 0,
      "paymentDay": "2025-05-19T12:00:00.000Z",
      "expirationDate": "2025-04-11T23:59:59.999Z",
      "status": "CREATED"
    }
  ]
}

Observação

Este endpoint não cria uma proposta. Serve apenas para simular e retornar os valores. Nenhuma informação será enviada a instituição financeira ou ao cedente.

400 - Bad request

{
  "message": "Validation error",
  "errors": [
    {
      "field": "document",
      "message": "This field is required in body."
    },
    {
      "field": "email",
      "message": "This field is required in body."
    }
  ]
}

401 - Unauthorized

{
    "message": "Invalid credentials"
  
}