Criar Propostas

POST/proposals

Esse endpoint permite que um originador autenticado crie uma proposta de antecipação de recebíveis.

Dados principais

Atenção!

Para o cedente pessoa jurídica (type: "J"), os dados pessoais deverão ser preenchidos com as informações do sócio solicitante, e os dados referentes ao endereço deverão ser preenchidos com as informações da Empresa.

Campo	Tipo	Descrição	Obrigatório
name	string	Nome completo do cedente ou sócio solicitante.	Sim
type	string	Tipo de pessoa: F (Física) ou J (Jurídica).	Sim
tradeName	string, null	Razão social da empresa.	Sim
cnpj	string, null	CNPJ da empresa.	Sim
cpf	string	CPF do cedente ou sócio solicitante.	Sim
idNumber	string	RG - Identidade do cedente ou sócio solicitante.	Sim
issuingAgency	string	Órgão Expedidor do RG do cedente ou sócio solicitante.	Sim
nationality	string	Nacionalidade do cedente ou sócio solicitante.	Sim
maritalStatus	string	Estado civil. Opções disponíveis: "solteiro", "casado", "divorciado", "viúvo" e "separado".	Sim
occupation	string	Profissão do cedente ou sócio solicitante.	Sim
cellphone	string	Número de celular do cedente ou sócio solicitante.	Sim
email	string	E-mail do cedente ou sócio solicitante.	Sim
bank.code	string	Código do banco.	Sim
bank.type	string	Tipo de conta bancária. Opções disponíveis: "CC", "CP" e "SA".	Sim
bank.account	string	Número da conta bancária.	Sim
bank.agency	string	Número da agência.	Sim
bank.keyPix	string	Chave Pix para recebimento.	Não
adress.zipCode	string	CEP.	Sim
adress.street	string	Logradouro.	Sim
adress.number	string	Número.	Sim
adress.complement	string	Complemento.	Não
adress.neighborhood	string	Bairro.	Sim
adress.city	string	Cidade.	Sim
adress.state	string	Estado.	Sim
adress.country	string	País.	Sim
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 da NF/recebível, caso o (receivables.value) seja uma parcela de um pagamento maior.	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",
  "tradeName": null,
  "cnpj": null,
  "cpf": "12345678909",
  "idNumber": "123456789",
  "issuingAgency": "SSP/SP",
  "nationality": "Brasileiro",
  "maritalStatus": "solteiro",
  "occupation": "Desenvolvedor",
  "cellphone": "92999998888",
  "email": "wick@mail.com",
  "bank": {
    "code": "001",
    "account": "1234567",
    "type": "CC",
    "agency": "0001",
    "keyPix": "wick@mail.com"
  },
  "address": {
    "zipCode": "09961050",
    "street": "Rua Jovelim",
    "number": "987",
    "complement": "AP 47",
    "neighborhood": "Jardim Casão",
    "city": "São Paulo",
    "state": "SP",
    "country": "Brasil"
  },
  "receivables": [
    {
      "externalId": 101,
      "identifier": "REC001",
      "payerName": "Cliente XPTO",
      "payerDocument": "12345678000199",
      "value": 1000,
      "totalAssetBacking": 1000,
      "expectedDate": "2025-08-15"
    }
  ]
}

Jurídica

{
  "name": "John Wick",
  "type": "J",
  "tradeName": "Umbrella Corporation",
  "cnpj": "12345678910111",
  "cpf": "12345678909",
  "idNumber": "123456789",
  "issuingAgency": "SSP/SP",
  "nationality": "Brasileiro",
  "maritalStatus": "solteiro",
  "occupation": "Desenvolvedor",
  "cellphone": "92999998888",
  "email": "wick@mail.com",
  "bank": {
    "code": "001",
    "account": "1234567",
    "type": "CC",
    "agency": "0001",
    "keyPix": "wick@mail.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": "2025-10-15"
    }
  ]
}

Response

201 - Created

Status Code: 201

{
  "id": "0196cf7b-aeec-703f-b349-5be378ca69bc",
  "totalValue": 1000,
  "liquidValue": 588.33,
  "discountedValue": 258.67,
  "overwriteId": null,
  "fixedTac": 150,
  "variableTac": 3,
  "totalTac": 153,
  "status": "CREATED",
  "averageDaysInAdvance": 97,
  "receivables": [
    {
      "id": "0196cf7b-aeec-703f-b349-5fc9189041c4",
      "proposalId": "0196cf7b-aeec-703f-b349-5be378ca69bc",
      "status": "CREATED",
      "externalId": 101,
      "description": "REC001",
      "dueDate": "2025-08-15T15:00:00.000Z",
      "paymentDay": "2025-08-18T12:00:00.000Z",
      "expirationDate": "2025-05-14T23:59:59.999Z",
      "totalAssetBacking": 1000,
      "originalValue": 1000,
      "discountedValue": 258.67,
      "liquidTotalValue": 741.33,
      "defaultTax": 8,
      "variableTac": 3,
      "floatingDays": 2,
      "qtdDaysAdvanced": 97,
      "percentageTotalEffectiveCost": 0
    }
  ]
}

400 - Bad Request

Status Code: 400

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

401 - Unauthorized

Status Code: 401

{
  "message": "Invalid credentials"
}