Notas de Implementação:
Gerar a impressão do relatório Efetivos Por Conta com os filtros informados. Nome Público: AA02469. Grupo: 2469.
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
Modelo:
| Nome | Descrição | Tipo | Informação Adicional |
|---|---|---|---|
| DataInicial | date |
Opcional |
|
| DataFinal | date |
Opcional |
|
| VencimentoInicial | date |
Opcional |
|
| VencimentoFinal | date |
Opcional |
|
| EmpresaInicial | string |
Opcional |
|
| EmpresaFinal | string |
Opcional |
|
| NomeInicial | string |
Opcional |
|
| NomeFinal | string |
Opcional |
|
| CentralizadoraInicial | string |
Opcional |
|
| CentralizadoraFinal | string |
Opcional |
|
| CobrancaInicial | string |
Opcional |
|
| CobrancaFinal | string |
Opcional |
|
| ContaInicial | string |
Opcional |
|
| ContaFinal | string |
Opcional |
|
| UnidadeNegocioInicial | string |
Opcional |
|
| UnidadeNegocioFinal | string |
Opcional |
|
| TgUnidadeNegocio | integer |
Opcional |
|
| TgPortador | integer |
Opcional |
|
| BancoInicial | string |
Opcional |
|
| BancoFinal | string |
Opcional |
|
| TipoPagamentoInicial | string |
Opcional |
|
| TipoPagamentoFinal | string |
Opcional |
|
| ProjetoInicial | string |
Opcional |
|
| ProjetoFinal | string |
Opcional |
|
| ChequeLoteInicial | integer |
Opcional |
|
| ChequeLoteFinal | integer |
Opcional |
|
| CategoriaInicial | string |
Opcional |
|
| CategoriaFinal | string |
Opcional |
|
| CategoriaUnidadeNegocioInicial | string |
Opcional |
|
| CategoriaUnidadeNegocioFinal | string |
Opcional |
|
| TipoRelatorio | string |
Opcional |
|
| Listar | string |
Opcional |
|
| ModoImpressao | string |
Opcional |
|
| SubtotalizarContaPorData | boolean |
Opcional |
|
| HistoricoMultilinhas | boolean |
Opcional |
|
| NomeRelatorio | string |
Opcional |
Formato de Envio:
application/json, text/json
Exemplo:
{
"DataInicial": "2026-01-13",
"DataFinal": "2026-01-13",
"VencimentoInicial": "2026-01-13",
"VencimentoFinal": "2026-01-13",
"EmpresaInicial": "string 1",
"EmpresaFinal": "string 2",
"NomeInicial": "string 3",
"NomeFinal": "string 4",
"CentralizadoraInicial": "string 5",
"CentralizadoraFinal": "string 6",
"CobrancaInicial": "string 7",
"CobrancaFinal": "string 8",
"ContaInicial": "string 9",
"ContaFinal": "string 10",
"UnidadeNegocioInicial": "string 11",
"UnidadeNegocioFinal": "string 12",
"TgUnidadeNegocio": 13,
"TgPortador": 14,
"BancoInicial": "string 15",
"BancoFinal": "string 16",
"TipoPagamentoInicial": "string 17",
"TipoPagamentoFinal": "string 18",
"ProjetoInicial": "string 19",
"ProjetoFinal": "string 20",
"ChequeLoteInicial": 21,
"ChequeLoteFinal": 22,
"CategoriaInicial": "string 23",
"CategoriaFinal": "string 24",
"CategoriaUnidadeNegocioInicial": "string 25",
"CategoriaUnidadeNegocioFinal": "string 26",
"TipoRelatorio": "string 27",
"Listar": "string 28",
"ModoImpressao": "string 29",
"SubtotalizarContaPorData": true,
"HistoricoMultilinhas": true,
"NomeRelatorio": "string 32"
}
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:
| 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"
}
|