Notas de Implementação:
Gerar a impressão do relatório do Mapa de Faturamento com os filtros informados. Nome Público: CG02636. Grupo: MAPAF.
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 |
|---|---|---|---|
| UnidadeNegocioInicial | string |
Opcional |
|
| UnidadeNegocioFinal | string |
Opcional |
|
| SerieInicial | string |
Opcional |
|
| SerieFinal | string |
Opcional |
|
| NotaFiscalInicial | integer |
Opcional |
|
| NotaFiscalFinal | integer |
Opcional |
|
| TipoOperacaoInicial | string |
Opcional |
|
| TipoOperacaoFinal | string |
Opcional |
|
| TGTipoOperacao | integer |
Opcional |
|
| CFOPInicial | string |
Opcional |
|
| CFOPFinal | string |
Opcional |
|
| DataEmissaoInicial | date |
Opcional |
|
| DataEmissaoFinal | date |
Opcional |
|
| DivisaoClienteInicial | string |
Opcional |
|
| DivisaoClienteFinal | string |
Opcional |
|
| ClienteInicial | string |
Opcional |
|
| ClienteFinal | string |
Opcional |
|
| CNAEInicialPrefixo | string |
Opcional |
|
| CNAEInicialSufixo | string |
Opcional |
|
| CNAEFinalPrefixo | string |
Opcional |
|
| CNAEFinalSufixo | string |
Opcional |
|
| CNAEServicoInicialPrefixo | string |
Opcional |
|
| CNAEServicoInicialSufixo | string |
Opcional |
|
| CNAEServicoFinalPrefixo | string |
Opcional |
|
| CNAEServicoFinalSufixo | string |
Opcional |
|
| CentralizadoraInicial | string |
Opcional |
|
| CentralizadoraFinal | string |
Opcional |
|
| ContaInicial | string |
Opcional |
|
| ContaFinal | string |
Opcional |
|
| PortadorInicial | string |
Opcional |
|
| PortadorFinal | string |
Opcional |
|
| RemessaInicial | string |
Opcional |
|
| RemessaFinal | string |
Opcional |
|
| UFInicial | string |
Opcional |
|
| UFFinal | string |
Opcional |
|
| RepresentanteInicial | string |
Opcional |
|
| RepresentanteFinal | string |
Opcional |
|
| Transportadora | string |
Opcional |
|
| ListarLivrosInicial | string |
Opcional |
|
| ListarLivrosFinal | string |
Opcional |
|
| EspecieNotas | string |
Opcional |
|
| DesconsiderarNotasComp | boolean |
Opcional |
|
| DesconsiderarNotasDevolucao | boolean |
Opcional |
|
| ConsiderarNotasEntNula | boolean |
Opcional |
|
| ConsiderarSomenteNotasFat | boolean |
Opcional |
|
| ConsiderarSomenteNotasImp | boolean |
Opcional |
|
| SepararNotasDevolucao | boolean |
Opcional |
|
| QuebrarCFOP | boolean |
Opcional |
|
| TotalizarTipoOperacao | boolean |
Opcional |
|
| ListarFantasia | boolean |
Opcional |
|
| RepresentantesComissoes | boolean |
Opcional |
|
| TipoImpressao | string |
Opcional |
|
| OpcaoImpressao | boolean |
Opcional |
|
| QuebraPorCnae | boolean |
Opcional |
|
| NomeRelatorio | string |
Opcional |
Formato de Envio:
application/json, text/json
Exemplo:
{
"UnidadeNegocioInicial": "string 1",
"UnidadeNegocioFinal": "string 2",
"SerieInicial": "string 3",
"SerieFinal": "string 4",
"NotaFiscalInicial": 5,
"NotaFiscalFinal": 6,
"TipoOperacaoInicial": "string 7",
"TipoOperacaoFinal": "string 8",
"TGTipoOperacao": 9,
"CFOPInicial": "string 10",
"CFOPFinal": "string 11",
"DataEmissaoInicial": "2026-01-13",
"DataEmissaoFinal": "2026-01-13",
"DivisaoClienteInicial": "string 12",
"DivisaoClienteFinal": "string 13",
"ClienteInicial": "string 14",
"ClienteFinal": "string 15",
"CNAEInicialPrefixo": "string 16",
"CNAEInicialSufixo": "string 17",
"CNAEFinalPrefixo": "string 18",
"CNAEFinalSufixo": "string 19",
"CNAEServicoInicialPrefixo": "string 20",
"CNAEServicoInicialSufixo": "string 21",
"CNAEServicoFinalPrefixo": "string 22",
"CNAEServicoFinalSufixo": "string 23",
"CentralizadoraInicial": "string 24",
"CentralizadoraFinal": "string 25",
"ContaInicial": "string 26",
"ContaFinal": "string 27",
"PortadorInicial": "string 28",
"PortadorFinal": "string 29",
"RemessaInicial": "string 30",
"RemessaFinal": "string 31",
"UFInicial": "string 32",
"UFFinal": "string 33",
"RepresentanteInicial": "string 34",
"RepresentanteFinal": "string 35",
"Transportadora": "string 36",
"ListarLivrosInicial": "string 37",
"ListarLivrosFinal": "string 38",
"EspecieNotas": "string 39",
"DesconsiderarNotasComp": true,
"DesconsiderarNotasDevolucao": true,
"ConsiderarNotasEntNula": true,
"ConsiderarSomenteNotasFat": true,
"ConsiderarSomenteNotasImp": true,
"SepararNotasDevolucao": true,
"QuebrarCFOP": true,
"TotalizarTipoOperacao": true,
"ListarFantasia": true,
"RepresentantesComissoes": true,
"TipoImpressao": "string 50",
"OpcaoImpressao": true,
"QuebraPorCnae": true,
"NomeRelatorio": "string 53"
}
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"
}
|