1. Informações Gerais (recurso ainda não disponível)

...

• 
  
• eventsReinfTotalizers[]: Array com os eventos do tipo totalizadores. R-5001 e R-5011
• eventsReinf[]: Array com os eventos dos tipos Tabelas, Periódicos e Não Periódicos
• totalNotValidation: Quantidade de registros existentes na base (legado) que irá ou ao menos deveria compor a apuração do determinado evento
• totalValidation: Quantidade de registros existentes na base (legado) que foram considerados na apuração do determinado evento
• total: Quantidade total de registros existentes na base (legado) que foram considerados ou devem ser considerados na apuração do determinado evento
• event: Evento consultado. Ex: R-1000, R-2030
• typeEvent: Tipo do evento  1 - Todos, 2 - Tabelas, 3 - Periódicos, 4 - Não Periódicos, 5 - Totalizadores
• 
  
• totalMonitoring[]: Array com os eventos existentes no monitor de transmissão.
• totalMonitoring[n].statusCode: Status do evento no monitor. 0 - - Aguardando transmissão , 2 - Aguardando retorno, 3 - Retorno com erros, 4 - Transmitido Ok.
• totalMonitoring[n].quantity: Quantidade do evento existente no monitor para o determinado statusCode

• hasNext: Indica se existe mais uma página de resultados ou se já está na última página (ver mais detalhes nos parâmetros aceitos: page e pageSize).

...

Se não for passado um pageSize, considerar o tamanho de página como 10o parâmetro é desconsiderado e a mensagem pe retornada  completa apenas com base nos outros parâmetros.

TODA requisição de lista deve retornar um atributo hasNext indicando se atingiu a última página ou não.

Exemplos (Supondo que existam 32 registros na base):

...

.

• Filtros

Deve suportar filtrar os resultados de acordo com alguns parâmetros:

• • searchKey: Filtro chave, capaz de filtrar em diversos campos diferentes do contrato, como cliente ou fornecedor, número, descrição, etc (máximo de lugares possíveis).
  • _type: Tipo de contrato, indica se é um contrato de compra (_type="1") ou de venda (_type="2"). Caso não seja informado, retornar todos os tipos.
  • customer: Cliente relacionado ao contrato. Deve ser considerado apenas se o parâmetro _type for enviado com o valor "2" (venda).
  • supplier: Fornecedor relacionado ao contrato. Deve ser considerado apenas se o parâmetro _type for enviado com o valor "1" (compra).
  • unit: Loja do cliente ou do fornecedor relacionado ao contrato. Deve ser considerado apenas se o parâmetro customer ou supplier for enviado em conjunto.
  • expiring: Indicador de contratos à vencer. Se for true: retornar apenas os contratos próximos do vencimento. Se for false ou não for enviado, retornar todos.
  • status: indica a situação atual do contrato. O parâmetro aceita os seguintes valores:
    
    • 0 - Todos os contratos, com exceção dos revisados e em revisão;
    • 1 - Contratos vigentes (Valor Default);
    • 2 - Contratos em elaboração;
    • 3 - Contratos aguardando aprovação;
    • 4 - Contratos paralisados;
    • 5 - Contratos em reajuste;
    • 6 - Contratos vencidos;
    • 7 - Contratos a vencer em 30 dias;
    • 8 - Todos os contratos com exceção dos revisados;

...

• • sourceBranch: Código Identificador da filial do ERP emissor. Deve existe em C1E_CODFIL
  • period: Período desejado para a consulta.
  • status: Array do tipo numérico que contem o status desejado para a consulta. 1 - Todos, 2 - Pendente apuração, 3 - Apurados, 4 - Pendentes transmissão, 5 - Retorno com erros, 6 - Transmitidos, 7 - Aguardando retorno, 8 - Retorno com erros, 9 - Sem pendências .
  • events: Array do tipo string contendo os eventos a serem consultados. Ex: {"R-2010", "R-2020"}  para consultar apenas R-2010 e R-2020, Ex: {totds} para retornar todos os eventos.
  • eventType: Array do tipo numérico contendo  os tipos dos eventos que devem ser retornados. Ex: {1,2, 3, 4}. 1 - Todos, 2 - Tabelas, 3 - Periódicos, 4 - Não Periódicos, 5 - Totalizadores.
  • page: Indica o numero da pagina desejada, este parâmetro trabalha em conjunto com pageSize.
  • pageSize: Quantidade de registros que a pagina deve conter, este parâmetro trabalha cem conjunto com page.