12 - Include Guarantors

cURL

cURL

curl --request POST \
  --url https://api.bmpdigital.moneyp.dev.br/Proposta/IncluirAvalistas \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'IdempotencyKey: <idempotencykey>' \
  --data '
{
  "dto": {
    "codigoProposta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "codigoOperacao": "<string>",
    "numeroProposta": 123
  },
  "avalistas": [
    {
      "nome": "<string>",
      "documentoFederal": "<string>",
      "cep": "<string>",
      "logradouro": "<string>",
      "nroLogradouro": "<string>",
      "bairro": "<string>",
      "complemento": "<string>",
      "cidade": "<string>",
      "uf": "<string>",
      "avalistaPF": {
        "rg": "<string>",
        "rgOrgao": "<string>",
        "rguf": "<string>",
        "rgData": "2023-11-07T05:31:56Z",
        "nomePai": "<string>",
        "nomeMae": "<string>",
        "estadoCivil": 123,
        "sexo": "<string>",
        "nroDependentes": 123,
        "telefoneFixo": "<string>",
        "telefoneCelular": "<string>",
        "dtNasc": "2023-11-07T05:31:56Z",
        "email": "<string>",
        "localTrabalho": "<string>",
        "cnpjTrabalho": "<string>",
        "cargoTrabalho": "<string>",
        "vlrRendimentoTrabalho": 123,
        "vlrOutrosRendimentos": 123,
        "obsOutrosRendimentos": "<string>",
        "cepTrabalho": "<string>",
        "logradouroTrabalho": "<string>",
        "nroLogradouroTrabalho": "<string>",
        "bairroTrabalho": "<string>",
        "complementoTrabalho": "<string>",
        "cidadeTrabalho": "<string>",
        "ufTrabalho": "<string>",
        "telefoneFixoTrabalho": "<string>",
        "telefoneCelularTrabalho": "<string>",
        "emailTrabalho": "<string>",
        "nomeConjuge": "<string>",
        "cpfConjuge": "<string>",
        "rgConjuge": "<string>",
        "rgOrgaoConjuge": "<string>",
        "rgufConjuge": "<string>",
        "rgDataConjuge": "2023-11-07T05:31:56Z",
        "localTrabalhoConjuge": "<string>",
        "vlrRendimentoTrabalhoConjuge": 123,
        "vlrOutrosRendimentosConjuge": 123,
        "obsOutrosRendimentosConjuge": "<string>",
        "refBanco1Nome": "<string>",
        "refBanco1Agencia": "<string>",
        "refBanco1Conta": "<string>",
        "refBanco1DtAbertura": "2023-11-07T05:31:56Z",
        "refBanco1Gerente": "<string>",
        "refBanco1Telefone": "<string>",
        "refBanco2Nome": "<string>",
        "refBanco2Agencia": "<string>",
        "refBanco2Conta": "<string>",
        "refBanco2DtAbertura": "2023-11-07T05:31:56Z",
        "refBanco2Gerente": "<string>",
        "refBanco2Telefone": "<string>",
        "refComercial1Nome": "<string>",
        "refComercial1Parentesco": "<string>",
        "refComercial1Telefone": "<string>",
        "refComercial2Nome": "<string>",
        "refComercial2Parentesco": "<string>",
        "refComercial2Telefone": "<string>",
        "refComercial3Nome": "<string>",
        "refComercial3Parentesco": "<string>",
        "refComercial3Telefone": "<string>",
        "patrimonio1Descricao": "<string>",
        "patrimonio1Valor": 123,
        "patrimonio2Descricao": "<string>",
        "patrimonio2Valor": 123,
        "patrimonio3Descricao": "<string>",
        "patrimonio3Valor": 123,
        "telefoneFixoConjuge": "<string>",
        "telefoneCelularConjuge": "<string>",
        "emailConjuge": "<string>",
        "mostrarConjugeCCB": true,
        "naturalDeCidade": "<string>",
        "naturalDeUF": "<string>",
        "nacionalidade": "<string>"
      },
      "avalistaPJ": {
        "nomeFantasia": "<string>",
        "webSite": "<string>",
        "telefoneFixo": "<string>",
        "telefoneFixoRamal": "<string>",
        "ramoAtividade": "<string>",
        "dtFundacao": "2023-11-07T05:31:56Z",
        "email": "<string>",
        "nomeContatoContador": "<string>",
        "emailContatoContador": "<string>",
        "telefoneContatoContador": "<string>",
        "telefoneRamalContatoContador": "<string>",
        "assistente": "<string>",
        "socio1Nome": "<string>",
        "socio1Documento": "<string>",
        "socio1Percentual": 123,
        "socio1DtEntrada": "2023-11-07T05:31:56Z",
        "socio1RG": "<string>",
        "socio1RGEmissor": "<string>",
        "socio1RGUF": "<string>",
        "socio2Nome": "<string>",
        "socio2Documento": "<string>",
        "socio2Percentual": 123,
        "socio2DtEntrada": "2023-11-07T05:31:56Z",
        "socio2RG": "<string>",
        "socio2RGEmissor": "<string>",
        "socio2RGUF": "<string>",
        "socio3Nome": "<string>",
        "socio3Documento": "<string>",
        "socio3Percentual": 123,
        "socio3DtEntrada": "2023-11-07T05:31:56Z",
        "socio3RG": "<string>",
        "socio3RGEmissor": "<string>",
        "socio3RGUF": "<string>",
        "socio4Nome": "<string>",
        "socio4Documento": "<string>",
        "socio4Percentual": 123,
        "socio4DtEntrada": "2023-11-07T05:31:56Z",
        "socio4RG": "<string>",
        "socio4RGEmissor": "<string>",
        "socio4RGUF": "<string>",
        "socio5Nome": "<string>",
        "socio5Documento": "<string>",
        "socio5Percentual": 123,
        "socio5DtEntrada": "2023-11-07T05:31:56Z",
        "socio5RG": "<string>",
        "socio5RGEmissor": "<string>",
        "socio5RGUF": "<string>",
        "adm1Nome": "<string>",
        "adm1CPF": "<string>",
        "adm1Cargo": "<string>",
        "adm1DtEntrada": "2023-11-07T05:31:56Z",
        "adm1DtTermino": "2023-11-07T05:31:56Z",
        "adm2Nome": "<string>",
        "adm2CPF": "<string>",
        "adm2Cargo": "<string>",
        "adm2DtEntrada": "2023-11-07T05:31:56Z",
        "adm2DtTermino": "2023-11-07T05:31:56Z",
        "adm3Nome": "<string>",
        "adm3CPF": "<string>",
        "adm3Cargo": "<string>",
        "adm3DtEntrada": "2023-11-07T05:31:56Z",
        "adm3DtTermino": "2023-11-07T05:31:56Z",
        "adm4Nome": "<string>",
        "adm4CPF": "<string>",
        "adm4Cargo": "<string>",
        "adm4DtEntrada": "2023-11-07T05:31:56Z",
        "adm4DtTermino": "2023-11-07T05:31:56Z",
        "adm5Nome": "<string>",
        "adm5CPF": "<string>",
        "adm5Cargo": "<string>",
        "adm5DtEntrada": "2023-11-07T05:31:56Z",
        "adm5DtTermino": "2023-11-07T05:31:56Z",
        "colig1Nome": "<string>",
        "colig1CNPJ": "<string>",
        "colig1Percentual": 123,
        "colig1Cidade": "<string>",
        "colig1UF": "<string>",
        "colig1Participante": "<string>",
        "colig2Nome": "<string>",
        "colig2CNPJ": "<string>",
        "colig2Percentual": 123,
        "colig2Cidade": "<string>",
        "colig2UF": "<string>",
        "colig2Participante": "<string>",
        "colig3Nome": "<string>",
        "colig3CNPJ": "<string>",
        "colig3Percentual": 123,
        "colig3Cidade": "<string>",
        "colig3UF": "<string>",
        "colig3Participante": "<string>",
        "colig4Nome": "<string>",
        "colig4CNPJ": "<string>",
        "colig4Percentual": 123,
        "colig4Cidade": "<string>",
        "colig4UF": "<string>",
        "colig4Participante": "<string>",
        "colig5Nome": "<string>",
        "colig5CNPJ": "<string>",
        "colig5Percentual": 123,
        "colig5Cidade": "<string>",
        "colig5UF": "<string>",
        "colig5Participante": "<string>",
        "refBanco1Nome": "<string>",
        "refBanco1Agencia": "<string>",
        "refBanco1Conta": "<string>",
        "refBanco1DtAbertura": "2023-11-07T05:31:56Z",
        "refBanco1Gerente": "<string>",
        "refBanco1Telefone": "<string>",
        "refBanco2Nome": "<string>",
        "refBanco2Agencia": "<string>",
        "refBanco2Conta": "<string>",
        "refBanco2DtAbertura": "2023-11-07T05:31:56Z",
        "refBanco2Gerente": "<string>",
        "refBanco2Telefone": "<string>",
        "refBanco3Nome": "<string>",
        "refBanco3Agencia": "<string>",
        "refBanco3Conta": "<string>",
        "refBanco3DtAbertura": "2023-11-07T05:31:56Z",
        "refBanco3Gerente": "<string>",
        "refBanco3Telefone": "<string>",
        "refCom1Fornecedor": "<string>",
        "refCom1PercentualFornec": 123,
        "refCom1TelefoneFornec": "<string>",
        "refCom1Cliente": "<string>",
        "refCom1PercentualCliente": 123,
        "refCom1TelefoneCliente": "<string>",
        "refCom2Fornecedor": "<string>",
        "refCom2PercentualFornec": 123,
        "refCom2TelefoneFornec": "<string>",
        "refCom2Cliente": "<string>",
        "refCom2PercentualCliente": 123,
        "refCom2TelefoneCliente": "<string>",
        "refCom3Fornecedor": "<string>",
        "refCom3PercentualFornec": 123,
        "refCom3TelefoneFornec": "<string>",
        "refCom3Cliente": "<string>",
        "refCom3PercentualCliente": 123,
        "refCom3TelefoneCliente": "<string>",
        "refCom4Fornecedor": "<string>",
        "refCom4PercentualFornec": 123,
        "refCom4TelefoneFornec": "<string>",
        "refCom4Cliente": "<string>",
        "refCom4PercentualCliente": 123,
        "refCom4TelefoneCliente": "<string>",
        "refNeg1Contrato": "<string>",
        "refNeg1Fornecedor": "<string>",
        "refNeg1Telefone": "<string>",
        "refNeg1ValorNegocio": 123,
        "refNeg1Rentabilidade": 123,
        "refNeg2Contrato": "<string>",
        "refNeg2Fornecedor": "<string>",
        "refNeg2Telefone": "<string>",
        "refNeg2ValorNegocio": 123,
        "refNeg2Rentabilidade": 123,
        "dadosFinanc1ProdServ": "<string>",
        "dadosFinanc1Percentual": 123,
        "dadosFinanc2ProdServ": "<string>",
        "dadosFinanc2Percentual": 123,
        "dadosFinanc3ProdServ": "<string>",
        "dadosFinanc3Percentual": 123,
        "dadosFinanc4ProdServ": "<string>",
        "dadosFinanc4Percentual": 123,
        "dadosFinanc5ProdServ": "<string>",
        "dadosFinanc5Percentual": 123,
        "dadosFinanc6ProdServ": "<string>",
        "dadosFinanc6Percentual": 123,
        "capitalSocial": 123,
        "patrimonioLiq": 123,
        "faturamentoMedio12Meses": 123,
        "comprasMedio12Meses": 123,
        "percExportacao": 123,
        "percImportacao": 123,
        "bens1Qtde": 123,
        "bens1Tipo": "<string>",
        "bens1ValorAtual": 123,
        "bens1OnusCredor": "<string>",
        "bens2Qtde": 123,
        "bens2Tipo": "<string>",
        "bens2ValorAtual": 123,
        "bens2OnusCredor": "<string>",
        "bens3Qtde": 123,
        "bens3Tipo": "<string>",
        "bens3ValorAtual": 123,
        "bens3OnusCredor": "<string>"
      }
    }
  ]
}
'

200

{
  "msg": "<string>",
  "hasError": true,
  "messages": [
    {
      "code": "<string>",
      "context": "<string>",
      "description": "<string>",
      "field": "<string>"
    }
  ],
  "results": [
    {
      "msg": "<string>",
      "hasError": true,
      "messages": [
        {
          "code": "<string>",
          "context": "<string>",
          "description": "<string>",
          "field": "<string>"
        }
      ],
      "codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "numero": 123
    }
  ]
}

Through this endpoint, the partner includes the data of guarantors for a proposal. Guarantors can be individuals or legal entities, and the fields are not mandatory; simply fill out the DTO as needed.

Show Messages

Categoria	Operação	Ação	Código	Código Detalhado	Mensagem
Proposta	IncluirPropostaAvalistas	IncluirAvalistas	C0112	V0001	Proposta não encontrada
Proposta	IncluirPropostaAvalistas	IncluirAvalistas	C0112	V0002	A Proposta não pertence à esta Integração
Proposta	IncluirPropostaAvalistas	IncluirAvalistas	C0057	V0001	Não é possível incluir avalistas na proposta. Proposta encontra-se ” + SituacaoPropostaEnum.GetDescricao(proposta.Situacao)
Proposta	IncluirPropostaAvalistas	IncluirAvalistas	C0057	V0002	Dados do avalista PF devem ser enviados
Proposta	IncluirPropostaAvalistas	IncluirAvalistas	C0057	V0003	Dados do avalista PJ devem ser enviados
Proposta	IncluirPropostaAvalistas	IncluirAvalistas	T0669	D0001	CPF já cadastrado como Avalista.
Proposta	IncluirPropostaAvalistas	IncluirAvalistas	T0669	D0002	Documento deve ser preenchido
Proposta	IncluirPropostaAvalistas	IncluirAvalistas	T0669	D0003	Nome deve ser preenchido
Proposta	IncluirPropostaAvalistas	IncluirAvalistas	T0669	D0004	Proposta não encontrada
Proposta	IncluirPropostaAvalistas	IncluirAvalistas	T0669	D0005	CPF Inválido
Proposta	IncluirPropostaAvalistas	IncluirAvalistas	T0669	D0006	CNPJ Inválido
Proposta	IncluirPropostaAvalistas	IncluirAvalistas	T0670	D0001	Nome do cônjuge deve ser preenchido
Proposta	IncluirPropostaAvalistas	IncluirAvalistas	T0670	D0002	CPF do cônjuge deve ser preenchido
Proposta	IncluirPropostaAvalistas	IncluirAvalistas	T0670	D0003	CPF do cônjuge Inválido
Proposta	IncluirPropostaAvalistas	IncluirAvalistas	T0671	D0001	A data de entrada do sócio não pode ser retroativa a data de abertura da empresa

Authorizations

Authorization · string · header · required

Informe o token

Headers

IdempotencyKey · string · required

Body

application/jsontext/jsonapplication/*+json

dto · object

Show child attributes

avalistas · object[] | null

Show child attributes

Response

200

text/plain

OK

msg · string | null

hasError · boolean

messages · object[] | null

Show child attributes

results · object[] | null

Show child attributes