Antes de fazer qualquer ação no produto, é necessário fazer o cadastro do cedente (Emissor da cobrança). Isso pode ser feito através da GuiWeb, via API ou via OCX.
O Cedente é cadastrado na base de dados da API e o cadastro deve acontecer individualmente, sendo assim, para cadastrar dois cedentes é necessário fazer a operação duas vezes.
O cadastro do cedente se resume em preenchermos um modelo de integração (TX2) com os dados do cedente e enviarmos para o nosso servidor.
POST
Homologação:
http://homologacao.plugboleto.com.br/api/v1/cedentes
Produção:
https://plugboleto.com.br/api/v1/cedentes
Headers
| Nome | Descrição | Exemplo |
| Content-Type | Indica o tipo de arquivo | application/json |
| cnpj-sh | CNPJ ou CPF da Software House | 01001001000113 |
| token-sh | Token da Software House | f22b97c0c9a3d41ac0a3875aba69e5aa |
Body
| Campo | Tipo | Descrição | Tamanho |
| CedenteRazaoSocial | string | Razão Social do Cedente | 1 - 200 |
| CedenteNomeFantasia | string | Nome Fantasia do Cedente | 1 - 200 |
| CedenteCPFCNPJ | string | CPF ou CNPJ do Cedente | 11 (CPF) ou 14 (CNPJ) |
| CedenteEnderecoLogradouro | string | Endereço do Cedente | 1 - 200 |
| CedenteEnderecoNumero | string | Número do logradouro do endereço | 1 - 10 |
| CedenteEnderecoComplemento | string | Complemento do endereço | 1 - 100 |
| CedenteEnderecoBairro | string | Nome do bairro | 1 - 100 |
| CedenteEnderecoCEP | string | CEP do Cedente | 8 |
| CedenteEnderecoCidadeIBGE | string | Código IBGE da cidade do Cedente | 7 (clique aqui para consultar o código de sua cidade) |
| CedenteTelefone | string | Número do telefone do Cedente | 11 |
| CedenteEmail | string | E-mail do Cedente | 1 - 150 |
Exemplo:
{
"CedenteRazaoSocial": "Empresa Ltda",
"CedenteNomeFantasia": "Empresa",
"CedenteCPFCNPJ": "14868336000185",
"CedenteEnderecoLogradouro": "Av. Analista Jucá de Souza",
"CedenteEnderecoNumero": "123",
"CedenteEnderecoComplemento": "sala 987",
"CedenteEnderecoBairro": "Centro",
"CedenteEnderecoCEP": "87012345",
"CedenteEnderecoCidadeIBGE": "4115200",
"CedenteTelefone": "(44) 3033-1234",
"CedenteEmail": "cobranca@boleto.com.br"
}
Retorno
Exemplo de retorno:
{
"_status": "sucesso",
"_dados": {
"id": 728,
"razaosocial": "Empresa Ltda",
"nomefantasia": "Empresa",
"cpf_cnpj": "20841251000106",
"logradouro": "Av. Analista Jucá de Souza",
"numero": "123",
"complemento": "sala 987",
"bairro": "Centro",
"cep": "87012345",
"id_cidade": 2136,
"telefone": "4430331234",
"email": "cobranca@boleto.com.br",
"criado": "2018-05-16T19:13:30Z",
"atualizado": "2018-05-16T19:13:30Z",
"token_cedente": "9d03331b377ab63d5f070206059686ae",
"token_esales": "0",
"situacao": "ATIVO",
"id_software_house": 23,
"config_email": null,
"config_notificacao": null,
"motivo_inativacao": null,
"data_ativacao": "2018-05-16T19:13:30Z",
"data_inativacao": null,
"certificado": null,
"dtvencimentocertificado": null,
"uf": "PR",
"contas": [],
"cidadeibge": 4115200,
"cidade": "Maringá"
}
}
Obs.: É importantíssimo persistir em seu banco de dados o ID do Cedente retornado na resposta da requisição. Ele será usado para fazer alterações no cadastro do cliente.
Exemplo de retorno com erro:
{
"_status": "erro",
"_mensagem": "Erro de validação.",
"_dados": [
{
"_campo": "cedentecpfcnpj",
"_erro": "CPF / CNPJ 14868336000185 já está sendo utilizado pela software house."
}
]
}
Comentários
0 comentário
Por favor, entre para comentar.