2016
Diferença entre o WS arecepcao.aspx e o WS aexportardocumentos.aspx
19 de dezembro de 2016Para facilitar seu entendimento sobre quando usar o WS arecepcao.aspx ou o WS aexportardocumentos.aspx para efetuar a consulta de seus documentos elaboramos uma tabela comparativa, que lista as principais características e diferenças entre estes dois Web Services, como a forma de retorno, os filtros permitidos na consulta, os retornos obtidos e a quantidade de documentos retornados.
As possíveis combinações de filtros para as consultas em cada Web Service são as seguintes:
– Faixa de numeração: Deve informar o número inicial e final, juntamente com a série do documento.
– Chave de acesso: Informar apenas a chave de acesso do documento, obrigatório caso ocorra a consulta de um documento que não esteja na base de dados do InvoiCy. Neste caso o sistema irá consultar seu status junto a SEFAZ.
– Intervalo de datas de emissão: A data inicial e a data final de emissão deverão ser preenchidas, juntamente com o horário, caso desejar. Ao optar por essa forma de consulta, as tags de numeração e série deverão ser preenchidas com zero, ou removidas da estrutura do layout enviado, e as tags de datas de inclusão também deverão ser removidas.
2016-06-01T00:00:01
2016-06-30T23:59:00
– Intervalo de datas de inclusão: A data inicial e a data final de inclusão deverão ser preenchidas, juntamente com o horário, caso desejar. Ao optar por essa forma de consulta, as tags de numeração e série deverão ser preenchidas com zero, ou removidas da estrutura do layout enviado, e as tags de datas de emissão também deverão ser removidas.
– Por série: Informar apenas a série utilizada pela empresa, onde será retornada a numeração do último documento emitido para a respectiva série.
Vale ressaltar que deve-se optar por apenas uma destas opções de consulta por requisição ao Web Service, caso seja informada mais de uma o sistema irá buscar os documentos pela primeira forma de consulta encontrada, seguindo a ordem descrita acima.
– Status do documento: Juntamente com as formas de consulta listadas acima, é possível ainda filtrar pelo status específico do documento, informando na tag os possíveis status listados a seguir:
1 – Pendente; 2 – Autorizado; 3 – Rejeitado; 4 – Necessita interação; 5 – Cancelado; 6 – Inutilizado; 7 – Aguardando Consulta; 8 – Encerrado; 9 – Em Conflito; 10 – EPEC; 11 – Contingência off-line; 12 – Denegado; 13 – Contingência FS-DA; 18 – Resumo.
Na tabela a seguir são destacados quais os filtros aceitos para cada WS em específico.
Particularidades | WS arecepcao.aspx | WS aexportardocumentos.aspx |
Layout XML | Download | Download |
Forma de retorno | Síncrono, retornando os arquivos XML em formato Base64. | Assíncrono, retornando os arquivos XML compactados em formato .zip, convertido para Base64. |
Limite de documentos retornados | 100 documentos, mas este valor pode ser alterado para menos, sempre em escala de 50 em 50. Salientando que não será retornado nenhum documento quando o limite for excedido. | Os lotes serão compostos por no máximo 50 arquivos, e ao consultar uma quantidade maior os documentos serão retornados mesmo assim. Por exemplo, se a exportação for de 100 arquivos serão gerados 2 protocolos contendo 50 arquivos cada. |
Consulta pelo status específico de um documento | Sim | Sim |
Consulta por faixa de numeração e série | Sim. É possível consultar informando apenas a série utilizada pela empresa. | Sim |
Consulta informando a chave de acesso de um documento | Sim | Não, pois o objetivo desse WS é retornar lotes de arquivo, por isso não se aplica a consulta por uma chave de acesso específica. |
Consulta por intervalo de datas de emissão | Sim. Não possui um limite de dias. | Sim. Destacando que o período de datas informado não pode ultrapassar 31 dias. |
Consulta por intervalo de datas de inclusão | Sim. Não possui um limite de dias. | Sim. Destacando que o período de datas informado não pode ultrapassar 31 dias. |
Consulta de um resumo do documento | Sim | Sim |
Retorno do XML completo na consulta | Sim | Sim |
Retorno do link do XML na consulta | Sim | Apenas será retornado o link para download do arquivo XML quando consultado o resumo do documento, e o conteúdo não será compactado e nem convertido para base64. |
Retorno do PDF em Base64 na consulta | Sim | Não |
Retorno do link do PDF na consulta | Sim | Apenas será retornado o link para download do arquivo PDF quando consultado o resumo do documento, e o conteúdo não será compactado e nem convertido para base64. |
Retorno dos Eventos na consulta | Sim | Sim |
Sugestão de uso | Indicado para efetuar a consulta de poucos documentos, devido a limitação de retorno de apenas 50 documentos. | Indicado para efetuar a exportação de um grande volume de documentos, devido a possibilidade de exportar vários lotes. |