1. Informações Gerais

2. Objetivo

Os serviços especificados neste documento serão consumidos pelo aplicativo Monitor de Eventos->EventsMonitor e tem por objetivo permitir ao usuário consultar o detalhamento das movimentações existentes na base e que estão pendentes de apuração, bem executar a apuração destes por fornecedor.

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 mensagem JSON com 2 visões, sintética e analítica.

Sintética: retorna a visão aglutinado por fornecedor/cliente.

Analítica: Retorna a visão analítica por documento (notas fiscais/ faturas/ recibos) ainda não apurados para o determinado fornecedor/cliente relativo a visão sintética.

{
"sinteticItems": [
{
"sinteticValue": [
{
"id": "cnpj",
"fieldValue": "26283298000188"
},
{
"id": "company",
"fieldValue": "PARTICIPANTE 2010"
},
{
"id": "status",
"fieldValue": "3"
},
{
"id": "totalGrossValue",
"fieldValue": 2000
},
{
"id": "totalTaxBase",
"fieldValue": 2000
},
{
"id": "totalTaxes",
"fieldValue": 2330
}
],
"analytic": [
{
"analyticalValue": [
{
"id": "type",
"fieldValue": "FAT"
},
{
"id": "invoice",
"fieldValue": "1009R20103 "
},
{
"id": "invoiceSeries",
"fieldValue": "0 "
},
{
"id": "item",
"fieldValue": " "
},
{
"id": "serviceCode",
"fieldValue": "100000002"
},
{
"id": "issueDate",
"fieldValue": "2019-03-13T00:00:00"
},
{
"id": "grossValue",
"fieldValue": 1000
},
{
"id": "taxBase",
"fieldValue": 1000
},
{
"id": "aliquot",
"fieldValue": 0
},
{
"id": "tax",
"fieldValue": 110
}
]
},
{
"analyticalValue": [
{
"id": "type",
"fieldValue": "FAT"
},
{
"id": "invoice",
"fieldValue": "1009R20104 "
},
{
"id": "invoiceSeries",
"fieldValue": "0 "
},
{
"id": "item",
"fieldValue": " "
},
{
"id": "serviceCode",
"fieldValue": "100000002"
},
{
"id": "issueDate",
"fieldValue": "2019-03-13T00:00:00"
},
{
"id": "grossValue",
"fieldValue": 1000
},
{
"id": "taxBase",
"fieldValue": 1000
},
{
"id": "aliquot",
"fieldValue": 0
},
{
"id": "tax",
"fieldValue": 110
}
]
},
{
"analyticalValue": [
{
"id": "type",
"fieldValue": "NFS"
},
{
"id": "invoice",
"fieldValue": "1009R20101 "
},
{
"id": "invoiceSeries",
"fieldValue": "1 "
},
{
"id": "item",
"fieldValue": "001 "
},
{
"id": "serviceCode",
"fieldValue": "100000001"
},
{
"id": "issueDate",
"fieldValue": "2019-03-13T00:00:00"
},
{
"id": "grossValue",
"fieldValue": 1000
},
{
"id": "taxBase",
"fieldValue": 1000
},
{
"id": "aliquot",
"fieldValue": 11
},
{
"id": "tax",
"fieldValue": 110
}
]
}
]
}
],
"descriptionEvent": "Retenção contribuição previdenciária - serviços tomados",
"hasNext": true
}

Descrição dos Campos:

• 
  
• sinteticItems[]: Array principal contendo as informações da visão sintética detalhadas em sinteticValue[] e seus respectivos valores da visão analítica analytic[]. 
• sinteticValue[]: Array com as informações de visão sintética por fornecedor/cliente.
• analytic[]: Array com as informações de visão analítica referente ao respectivo fornecedor/cliente existente em sinteticValue[]
• id: Quantidade de registros existentes na base (legado) que foram considerados na apuração do determinado evento
• fieldValue: Quantidade total de registros existentes na base (legado) que foram considerados ou devem ser considerados na apuração do determinado evento

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, o 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..

• Filtros

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

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