Notas de Implementação:
Gerar a impressão do relatório Efetivos para usuário com os filtros informados. Nome Público: AA02436. Grupo: RELEFET.
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
Itens de Menu:
AA02436
Modelo:
| Nome | Descrição | Tipo | Informação Adicional |
|---|---|---|---|
| SubTotalizarDia | boolean |
Opcional |
|
| HistoricoMultilinhas | boolean |
Opcional |
|
| RazaoSocialHistorico | string |
Opcional |
|
| ExibirValor | string |
Opcional |
|
| ExibirValorOriginalColunaValorLancamento | boolean |
Opcional |
|
| Indice | string |
Opcional |
|
| EfetuarDuplaConversao | boolean |
Opcional |
|
| ProjetoInicial | string |
Opcional |
|
| ProjetoFinal | string |
Opcional |
|
| UnidadeNegocioInicial | string |
Opcional |
|
| UnidadeNegocioFinal | string |
Opcional |
|
| DataLiquidacaoInicial | date |
Opcional |
|
| DataLiquidacaoFinal | date |
Opcional |
|
| DataVencimentoInicial | date |
Opcional |
|
| DataVencimentoFinal | date |
Opcional |
|
| DataEmissaoInicial | date |
Opcional |
|
| DataEmissaoFinal | date |
Opcional |
|
| SerieInicial | string |
Opcional |
|
| SerieFinal | string |
Opcional |
|
| SomenteSerieBranca | boolean |
Opcional |
|
| HistoricoInicial | string |
Opcional |
|
| HistoricoFinal | string |
Opcional |
|
| PortadorInicial | string |
Opcional |
|
| PortadorFinal | string |
Opcional |
|
| TgPortador | integer |
Opcional |
|
| EmpresaInicial | string |
Opcional |
|
| EmpresaFinal | string |
Opcional |
|
| RepresentanteInicial | string |
Opcional |
|
| RepresentanteFinal | string |
Opcional |
|
| NomeInicial | string |
Opcional |
|
| NomeFinal | string |
Opcional |
|
| CentralizadoraInicial | string |
Opcional |
|
| CentralizadoraFinal | string |
Opcional |
|
| CobrancaInicial | string |
Opcional |
|
| CobrancaFinal | string |
Opcional |
|
| CategoriaUnicoInicial | string |
Opcional |
|
| CategoriaUnicoFinal | string |
Opcional |
|
| DuplicataInicial | integer |
Opcional |
|
| DuplicataFinal | integer |
Opcional |
|
| ComplementoInicial | string |
Opcional |
|
| ComplementoFinal | string |
Opcional |
|
| NFFinal | integer |
Opcional |
|
| NFInicial | integer |
Opcional |
|
| ContaInicial | string |
Opcional |
|
| ContaFinal | string |
Opcional |
|
| ChequeInicial | integer |
Opcional |
|
| ChequeFinal | integer |
Opcional |
|
| LancamentoInicial | integer |
Opcional |
|
| LancamentoFinal | integer |
Opcional |
|
| Tipo | string |
Opcional |
|
| Situacao | string |
Opcional |
|
| NumeroBloquetoInicial | string |
Opcional |
|
| NumeroBloquetoFinal | string |
Opcional |
|
| Contabilizado | string |
Opcional |
|
| TipoPagamentoInicial | string |
Opcional |
|
| TipoPagamentoFinal | string |
Opcional |
|
| DataInclusaoInicial | date |
Opcional |
|
| DataInclusaoFinal | date |
Opcional |
|
| EspecieDocumentoInicial | string |
Opcional |
|
| EspecieDocumentoFinal | string |
Opcional |
|
| SessaoCaixaInicial | string |
Opcional |
|
| SessaoCaixaFinal | string |
Opcional |
|
| ListarRepresentante | boolean |
Opcional |
|
| TipoRelatorio | string |
Opcional |
|
| NomeRelatorio | string |
Opcional |
Formato de Envio:
application/json, text/json
{
"SubTotalizarDia": true,
"HistoricoMultilinhas": true,
"RazaoSocialHistorico": "string 3",
"ExibirValor": "string 4",
"ExibirValorOriginalColunaValorLancamento": true,
"Indice": "string 6",
"EfetuarDuplaConversao": true,
"ProjetoInicial": "string 8",
"ProjetoFinal": "string 9",
"UnidadeNegocioInicial": "string 10",
"UnidadeNegocioFinal": "string 11",
"DataLiquidacaoInicial": "2026-01-13",
"DataLiquidacaoFinal": "2026-01-13",
"DataVencimentoInicial": "2026-01-13",
"DataVencimentoFinal": "2026-01-13",
"DataEmissaoInicial": "2026-01-13",
"DataEmissaoFinal": "2026-01-13",
"SerieInicial": "string 12",
"SerieFinal": "string 13",
"SomenteSerieBranca": true,
"HistoricoInicial": "string 15",
"HistoricoFinal": "string 16",
"PortadorInicial": "string 17",
"PortadorFinal": "string 18",
"TgPortador": 19,
"EmpresaInicial": "string 20",
"EmpresaFinal": "string 21",
"RepresentanteInicial": "string 22",
"RepresentanteFinal": "string 23",
"NomeInicial": "string 24",
"NomeFinal": "string 25",
"CentralizadoraInicial": "string 26",
"CentralizadoraFinal": "string 27",
"CobrancaInicial": "string 28",
"CobrancaFinal": "string 29",
"CategoriaUnicoInicial": "string 30",
"CategoriaUnicoFinal": "string 31",
"DuplicataInicial": 32,
"DuplicataFinal": 33,
"ComplementoInicial": "string 34",
"ComplementoFinal": "string 35",
"NFFinal": 36,
"NFInicial": 37,
"ContaInicial": "string 38",
"ContaFinal": "string 39",
"ChequeInicial": 40,
"ChequeFinal": 41,
"LancamentoInicial": 42,
"LancamentoFinal": 43,
"Tipo": "string 44",
"Situacao": "string 45",
"NumeroBloquetoInicial": "string 46",
"NumeroBloquetoFinal": "string 47",
"Contabilizado": "string 48",
"TipoPagamentoInicial": "string 49",
"TipoPagamentoFinal": "string 50",
"DataInclusaoInicial": "2026-01-13",
"DataInclusaoFinal": "2026-01-13",
"EspecieDocumentoInicial": "string 51",
"EspecieDocumentoFinal": "string 52",
"SessaoCaixaInicial": "string 53",
"SessaoCaixaFinal": "string 54",
"ListarRepresentante": true,
"TipoRelatorio": "string 56",
"NomeRelatorio": "string 57"
}
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 relatório 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"
}
|