1. Informações Gerais

2. Objetivo

Os serviços especificados neste documento serão consumidos pelo aplicativo Monitor de Eventos e tem por objetivo permitir ao usuário consultar os eventos cadastrados na base TAF (totvs Automação fiscal) de um navegador convencional podendo ser também smartphone ou tablet.

3. Definições de Serviços

Todos os serviços devem obedecer às boas práticas de implementação de APIs presentes no Guia de Implementação de APIs TOTVS.

Deve-se tomar um cuidado especial com os retornos da requisição, inserindo o status HTTP correto de acordo com o erro encontrado (não enviar um status http 200 em uma mensagem de erro, por exemplo).

3.1. GET /wstaf001

Retorna a lista de contratos disponíveis para consulta ao usuário logado, no formato indicado abaixo:

{
    "eventsReinfTotalizers": [ 
	{
            "event": "R-5001",
            "descriptionEvent": "Informações de bases e tributos por evento",
            "monitoring": [
                {
                    "statusCode": 0,
                    "quantity": 4
                }
            ],
            "totalMonitoring": 4
        }
		],
    "hasNext": false,
    "eventsReinf": [
        {
            "totalNotValidation": 0,
            "event": "R-2010",
            "descriptionEvent": "Retenção contribuição previdenciária - serviços tomados",
            "typeEvent": 3,
            "monitoring": [
                {
                    "statusCode": 0,
                    "quantity": 2
                }
            ],
            "totalMonitoring": 2,
            "total": 4,
            "totalValidation": 4
        }
    ]
}

Descrição dos Campos:

• 
  
• 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 - 

• 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).

Parâmetros aceitos:

• page e pageSize

Utilizados para fazer paginação.

A primeira página é a 1.

Se não for enviado um page, considerar a página 1.

Se não for passado um pageSize, considerar o tamanho de página como 10.

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):

• • GET /wscnta300/contracts -> Retorna a página padrão (1) com tamanho padrão (10) (registro do 1 ao 10, hasNext = true)
  • GET /wscnta300/contracts?page=1 -> Retorna a página 1 com tamanho padrão (10) (registro de 1 ao 10, hasNext = true)
  • GET /wscnta300/contracts?pageSize=3 -> Retorna a página padrão (1) com tamanho 3 (registro de 1 ao 3, hasNext = true)
  • GET /wscnta300/contracts?page=2&pageSize=4 -> Retorna a página (2) com tamanho (4) (registro do 5 ao 8, hasNext = true)
  • GET /wscnta300/contracts?page=4&pageSize=10 -> Retorna a página (4) com tamanho (10) (registro do 31 ao 40 -> irá retornar só o 31 e o 32, hasNext = false)
  • etc.

• 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;

eventsReinfTotalizers