Notas de Implementação:
Gera um ou mais boletos bancários e envia NF-e por e-mail.
Informações de Envio:
Cabeçalhos de Envio:
| Parâmetro | Valor | Descrição | Tipo de parâmetro | Tipo de dados |
|---|---|---|---|---|
| Authorization | Bearer | Hash gerado no login | Header | String |
Acesse o método de login para mais informações: api/genericos/ge/Login/Autenticar
Direitos:
MNGFROTOPE
Itens de Menu:
CG00098
Modelo:
Dados do boleto em formato json
| Nome | Descrição | Tipo | Informação Adicional |
|---|---|---|---|
| CodigoLancamento | string |
Opcional |
|
| CodigoUnidadeNegocio | string |
Opcional |
|
| CodigoEmpresa | string |
Opcional |
|
| CodigoPortador | string |
Opcional |
|
| BloquetoImpresso | boolean |
Opcional |
|
| GerarBoleto | boolean |
Opcional |
|
| GerarNFe | boolean |
Opcional |
Formato de Envio:
application/json, text/json
Exemplo:
{
"CodigoLancamento": [
"string 1"
],
"CodigoUnidadeNegocio": "string 1",
"CodigoEmpresa": "string 2",
"CodigoPortador": "string 3",
"BloquetoImpresso": true,
"GerarBoleto": true,
"GerarNFe": true
}
Informações de Retorno:
Cabeçalhos Adicionais:
| Nome | Descrição | Valor |
|---|---|---|
| cigam-api-version | Versão do build/compilação dessa versão da API | 2.1.8565.21067 |
Modelo:
| Nome | Descrição | Tipo | Informação Adicional |
|---|---|---|---|
| success | boolean |
Opcional |
|
| hash | string |
Opcional |
|
| messages | string |
Opcional |
|
| data | Object |
Opcional |
|
| tipoLogin | string |
Opcional |
Formato de Resposta:
Retorna o boleto gerado
| Código de status HTTP | Descrição | Modelo de resposta |
|---|---|---|
| 200 | OK |
application/json, text/json
Exemplo:
{
"success": true,
"hash": "string 2",
"messages": [
"string 1"
],
"data": {},
"tipoLogin": "string 4"
}
|
| 400 | Requisição inválida |
application/json, text/json
Exemplo:
{
"success": false,
"hash": "string 2",
"messages": [
"string 1"
],
"data": {},
"tipoLogin": "string 4"
}
|
| 401 | Não autorizado |
application/json, text/json
Exemplo:
{
"success": false,
"hash": "string 2",
"messages": [
"string 1"
],
"data": {},
"tipoLogin": "string 4"
}
|
| 500 | Requisição falhou |
application/json, text/json
Exemplo:
{
"success": false,
"hash": "string 2",
"messages": [
"string 1"
],
"data": {},
"tipoLogin": "string 4"
}
|
| 502 | Falha de comunicação |
application/json, text/json
Exemplo:
{
"success": false,
"hash": "string 2",
"messages": [
"string 1"
],
"data": {},
"tipoLogin": "string 4"
}
|