v1

latestOpenAPI 3.0.12026-07-261451591021.8 KB
Empresas

Consultar informações de uma proposta.

Empresas- Consultar informações de um a proposta enviada<br/>Permite que seja acessado os detalhes específicos de uma proposta individual que foi enviado para uma empresa da plataforma.<br/><br/>Funcionalidades do Endpoint:<br/>- Status da Proposta: O status atual da proposta.<br/><br/>Requisição<br/><table><thead><tr><th>Campo</th><th>Tipo</th><th>Descrição</th><th>Obrigatoriedade</th></tr></thead><tbody><tr><td>cnpj</td><td>Texto</td><td>CNPJ da empresa</td><td>Sim</td></tr><tr><td>client-id</td><td>Texto</td><td>Client ID enviado no Header</td><td>Sim</td></tr></tbody></table><br/><br/>Resposta<br/><table><thead><tr><th>Campo</th><th>Tipo</th><th>Descrição</th></tr></thead><tbody><tr><td>identification</td><td>Texto</td><td>CNPJ da empresa.</td></tr><tr><td>companyName</td><td>Texto</td><td>Nome da empresa.</td></tr><tr><td>client_type</td><td>Texto</td><td>Categoria da proposta.</td></tr><tr><td>flow</td><td>Texto</td><td>Tipo de conta da proposta.</td></tr><tr><td>accounts</td><td>Objeto</td><td>Objeto com contas vinculadas a proposta.</td></tr><tr><td>accountNumber</td><td>Texto</td><td>Número da conta.</td></tr><tr><td>accountName</td><td>Texto</td><td>Nome da conta.</td></tr><tr><td>status</td><td>Texto</td><td>Status atualdo andamento da proposta.</td></tr></tbody></table>

get/api/v1/proposal

Query parameters

cnpjstring required
Example:00.000.000/0001-00

CNPJ da empresa

Headers

client-idstring uuid required
Example:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Client ID enviado no Header

Response

Proposta localizada com sucesso.

messagestring

Example response

{
  "message": "Proposta localizada com sucesso."
}