Notas de Implementação:
Gerar a impressão do relatório de Mapa Geral Mensal para cliente com os filtros informados. Nome Público: WW00025. Grupo: MAPA.
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:
DsmLojaRelMapaGeralMensal
Modelo:
| Nome | Descrição | Tipo | Informação Adicional |
|---|---|---|---|
| Modelo | string |
Opcional |
|
| DataInicial | date |
Opcional |
|
| DataFinal | date |
Opcional |
|
| UnidadeNegocioInicial | string |
Opcional |
|
| UnidadeNegocioFinal | string |
Opcional |
|
| TgUnidadeNegocio | integer |
Opcional |
|
| SerieInicial | string |
Opcional |
|
| SerieFinal | string |
Opcional |
|
| TgSerie | integer |
Opcional |
|
| TipoOperacaoInicial | string |
Opcional |
|
| TipoOperacaoFinal | string |
Opcional |
|
| TgTipoOperacao | integer |
Opcional |
|
| TipoPagamentoInicial | string |
Opcional |
|
| TipoPagamentoFinal | string |
Opcional |
|
| PortadorInicial | string |
Opcional |
|
| PortadorFinal | string |
Opcional |
|
| HistoricoVendas | string |
Opcional |
|
| RepresentanteInicial | string |
Opcional |
|
| RepresentanteFinal | string |
Opcional |
|
| Operador | string |
Opcional |
|
| ConsiderarDivergenciaBaseComissao | boolean |
Opcional |
|
| SomenteComDiferenca | boolean |
Opcional |
|
| ImprimiDevolucoes | boolean |
Opcional |
|
| NomeRelatorio | string |
Opcional |
Formato de Envio:
application/json, text/json
Exemplo:
{
"Modelo": "string 1",
"DataInicial": "2026-01-13",
"DataFinal": "2026-01-13",
"UnidadeNegocioInicial": "string 2",
"UnidadeNegocioFinal": "string 3",
"TgUnidadeNegocio": 4,
"SerieInicial": "string 5",
"SerieFinal": "string 6",
"TgSerie": 7,
"TipoOperacaoInicial": "string 8",
"TipoOperacaoFinal": "string 9",
"TgTipoOperacao": 10,
"TipoPagamentoInicial": "string 11",
"TipoPagamentoFinal": "string 12",
"PortadorInicial": "string 13",
"PortadorFinal": "string 14",
"HistoricoVendas": "string 15",
"RepresentanteInicial": "string 16",
"RepresentanteFinal": "string 17",
"Operador": "string 18",
"ConsiderarDivergenciaBaseComissao": true,
"SomenteComDiferenca": true,
"ImprimiDevolucoes": true,
"NomeRelatorio": "string 22"
}
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"
}
|