A alteração dos dados cadastrais do cedente pode ser realizada pela GuiWeb, via API ou via OCX.
A Alteração de um Cedente se resume em preenchermos um modelo de integração (JSON) com os dados do Cedente a serem alterados e enviarmos para o nosso servidor. Dessa forma, todos os dados solicitados para alteração, serão alterados instantaneamente em nossa base de dados.
PUT
Homologação:
https://homologacao.plugboleto.com.br/api/v1/cedentes/:id
Produção:
https://plugboleto.com.br/api/v1/cedentes/:id
*Deve ser informado o id do cedente na URL da requisição. É o mesmo ID retornado na rotina de cadastro do cedente
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 |
cnpj-cedente | CNPJ ou CPF do cedente | 01001001000113 |
Body
Campo | Tipo | Descrição |
CedenteRazaoSocial | string | Razão Social do Cedente |
CedenteNomeFantasia | string | Nome Fantasia do Cedente |
CedenteEnderecoLogradouro | string | Endereço do Cedente |
CedenteEnderecoNumero | string | Número do logradouro do endereço |
CedenteEnderecoComplemento | string | Complemento do endereço |
CedenteEnderecoBairro | string | Nome do bairro |
CedenteEnderecoCEP | string | CEP do Cedente |
CedenteEnderecoCidadeIBGE | string | Código IBGE da cidade do Cedente |
CedenteTelefone | string | Número do telefone do Cedente |
CedenteEmail | string | E-mail do Cedente |
Exemplo:
{
"CedenteRazaoSocial": "Empresa Ltda",
"CedenteNomeFantasia": "Empresa",
"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á"
}
}
Exemplo de retorno com erro:
{
"_status": "erro",
"_mensagem": "Acesso negado.",
"_dados": [
{
"_erro": "Conta do Cedente não encontrada"
}
]
}
Comentários
0 comentário
Por favor, entre para comentar.