Notas de Implementação:
Gerar a impressão do relatório Relação Retenções com os filtros informados. Nome Público: AA02464. Grupo: 2464.
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 |
|---|---|---|---|
| TipoRelatorio | string |
Opcional |
|
| Imposto | string |
Opcional |
|
| CodigoDarf | integer |
Opcional |
|
| RegimeDePagamento | string |
Opcional |
|
| BuscarResiduosCompetencia | boolean |
Opcional |
|
| ExibirLancamentoSemRetencoes | boolean |
Opcional |
|
| ListarRetencoesJaPagas | string |
Opcional |
|
| CompetenciaGps | date |
Opcional |
|
| DataInicial | date |
Opcional |
|
| DataFinal | date |
Opcional |
|
| EmissaoInicial | date |
Opcional |
|
| EmissaoFinal | date |
Opcional |
|
| VencimentoInicial | date |
Opcional |
|
| VencimentoFinal | date |
Opcional |
|
| EmpresaInicial | string |
Opcional |
|
| EmpresaFinal | string |
Opcional |
|
| DivisaoInicial | string |
Opcional |
|
| DivisaoFinal | string |
Opcional |
|
| PortadorInicial | string |
Opcional |
|
| PortadorFinal | string |
Opcional |
|
| UnidadeNegocioInicial | string |
Opcional |
|
| UnidadeNegocioFinal | string |
Opcional |
|
| Situacao | string |
Opcional |
|
| ModoImpressao | string |
Opcional |
|
| ImprimirEmissao | boolean |
Opcional |
|
| SepararPorFornecedor | boolean |
Opcional |
|
| PeriodoApuracao | date |
Opcional |
|
| NomeRelatorio | string |
Opcional |
Formato de Envio:
application/json, text/json
Exemplo:
{
"TipoRelatorio": "string 1",
"Imposto": "string 2",
"CodigoDarf": 3,
"RegimeDePagamento": "string 4",
"BuscarResiduosCompetencia": true,
"ExibirLancamentoSemRetencoes": true,
"ListarRetencoesJaPagas": "string 7",
"CompetenciaGps": "2026-01-13",
"DataInicial": "2026-01-13",
"DataFinal": "2026-01-13",
"EmissaoInicial": "2026-01-13",
"EmissaoFinal": "2026-01-13",
"VencimentoInicial": "2026-01-13",
"VencimentoFinal": "2026-01-13",
"EmpresaInicial": "string 8",
"EmpresaFinal": "string 9",
"DivisaoInicial": "string 10",
"DivisaoFinal": "string 11",
"PortadorInicial": "string 12",
"PortadorFinal": "string 13",
"UnidadeNegocioInicial": "string 14",
"UnidadeNegocioFinal": "string 15",
"Situacao": "string 16",
"ModoImpressao": "string 17",
"ImprimirEmissao": true,
"SepararPorFornecedor": true,
"PeriodoApuracao": "2026-01-13",
"NomeRelatorio": "string 20"
}
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"
}
|