Consulta
A rota Consulta será utilizada para consultarmos campos específicos da nota, dentro do nosso servidor.
GET
https://managersaas.tecnospeed.com.br:8081/ManagerAPIWeb/nfe/consulta
Headers
| Nome | Descrição | Exemplo |
| Authorization | Este usuário e senha são os seus dados para logar como administrador em um grupo do SaaS | Basic YWRtaW46MTIzbXVkYXI= |
Querystring
| Nome | Descrição |
| Grupo | Nome do grupo |
| CNPJ | CNPJ que está vinculado ao grupo que será usado para realizar a consulta, apenas números |
| Filtro | Aqui você vai informar o filtro da sua consulta. Exemplo 1: situacao = AUTORIZADA and dtautorizacao >= '02/08/2017 10:59:41' Exemplo 2: codnf=123 and (origem=1 or origem=3) and docdestinatario <> '29062609000177' |
| Campos | Aqui você vai informar todos os campos que deseja obter da consulta, eles são separados por vírgula, por exemplo: chave, nprotenvio |
| Limite |
Limite de registros que a consulta deve retornar. Atenção! O valor máximo e também padrão é de 100 registros. |
| Inicio |
Define a partir de qual registro do resultado da consulta deve ser retornado. O Inicio refere-se a posição do registro dentro do resultado da consulta e não faz referência ao handle (id) do registro em si. |
| Ordem | Ordena a consulta |
| Origem |
Determina a origem dos registros que serão obtidos: 1 - Emitidas à Terceiros 2 - Recebidas de Terceiros 3 - Operação Interna 4 - Todas |
| Visao | Determina em qual tabela a consulta será realizada. Deve ser preenchido apenas na consulta de numerações inutilizadas |
| FormatarXML |
Quando valor é true, determina se o campo do tipo XML virá sem CDATA |
| Encode |
Quando valor é true, evita que o retorno traga caracteres inválidos. (Facultativo) |
Retorno
Exemplo de retorno:
Será de acordo com os campos e ordem informada no parâmetro "campos".
Ex: Filtro: chave, situacao, serie
41150429062609000177556660000006671000000012,CANCELADA,667
Atenção! Caso o parâmetro Campos da requisição estiver vazio, o retorno do Manager SaaS irá conter todos os campos disponíveis para consulta conforme a tabela da seção Campos logo abaixo.
Exemplo de retorno com erro:
Nenhum registro encontrado.
Observação: As possíveis situações para a situação de uma NF-e no Manager SaaS são:
- Autorizada: Nota autorizada pela SEFAZ.
- Cancelada: Cancelamento autorizado pela SEFAZ.
- Enviada: Nota fiscal enviada para SEFAZ, mas sem retorno da requisição de envio (Nesse caso não sabemos se a nota foi autorizada ou rejeitada).
- Registrada: Nota fiscal gravada na base de dados do Manager SaaS, mas por alguma falha a nota não foi enviada a SEFAZ até o momento. (Normalmente por problemas de conexão).
- Rejeitada: Nota fiscal rejeitada pela SEFAZ e portanto não autorizada.
- Inutilizada: Indica que a faixa de numeração da nota fiscal já foi inutilizada.
- Recebida: Indica que a nota fiscal foi enviada e a SEFAZ retornou que a nota foi recebida e ainda não tem uma situação final (autorizada ou rejeitada).
- Denegada: Indica que a nota fiscal não foi autorizada devido ao emitente possuir alguma irregularidade em seu cadastro junto a SEFAZ ou alguma pendência.
Campos
É possível realizar a consulta utilizando os seguintes campos:
| Campo | Descrição |
| handle | Identificador único do registro na base de dados do Manager SaaS/EDoc. |
| chave | Chave da NF-e. |
| situacao |
Situação da NF-e. Exemplos: AUTORIZADA, CANCELADA |
| nnf | Número da NF-e. |
| codnf | Código numérico identificador do contribuinte da NF-e. |
| nrecibo | Número do recebido de recepção da SEFAZ. |
| nprotenvio | Número do protocolo do envio da NF-e. |
| nprotcanc | Número do protocolo do cancelamento da NF-e. |
| nprotinutil | Número do protocolo de inutilização da numeração da NF-e. |
| nregdpec | Número do protocolo de envio em contingência DPEC. |
| modoentrada |
Modo do Manager SaaS/EDoc no qual a nota foi registrada no envio. Pode ter os valores: Normal, SVCAN, SVCRS, EPEC e FSDA |
| modosaida |
Modo do Manager SaaS/EDoc no qual a nota chegou a sua situação final (Autorizada, Cancelada, Rejeitada, Denegada e etc). Pode ter os valores: Normal, SVCAN, SVCRS, EPEC e FSDA |
| cnpj | CNPJ do Emissor da NF-e. |
| serie | Série da numeração da NF-e. |
| motivo | Descrição do status da resposta da SEFAZ. |
| dtautorizacao | Data de autorização da NF-e. |
| dtcadastro | Data de cadastro da NF-e na base de dados do Manager SaaS/EDoc. |
| dtcancelamento | Data de cancelamento da NF-e. |
| dtemissao | Data de emissão da NF-e. |
| impresso |
Indica se a NF-e já foi impressa. Valores possíveis: Sim - Já impressa Não - Não impressa |
| envemail |
Indica se a NF-e já foi enviada por e-mail ao destinatário. Valores possíveis: Sim - Já enviada Não - Não enviada |
| E-mail do destinatário da NF-e. | |
| docdestinatario | Número do documento do destinatário da NF-e. (CNPJ, CPF) |
| nomedestinatario | Nome do destinatário da NF-e |
| idgrupo | Identificador único do grupo do Manager SaaS/EDoc ao qual o CNPJ do emissor da NF-e faz parte. |
| idintegracao | Identificador único da NF-e com a TecnoSpeed. |
| nlote | Número do lote a qual a NF-e pertence. |
| numero | Número da NF-e. |
| dhdpec | Data e hora da entrada em contingência DPEC. |
| nomegrupo | Nome do grupo do Manager SaaS/EDoc ao qual o CNPJ do emissor da NF-e faz parte. |
| xjustcancelamento | Descrição da justificativa de cancelamento da NF-e. |
| ambiente |
Ambiente o qual a NF-e foi enviada. Homologação ou Produção. |
| impressora | Nome da impressora utilizada para impressão da NF-e. |
| origem |
Origem da NF-e. Valores possíveis: 1 - Emitida a Terceiros 2 - Recebida 3 - Interna |
| sincronizadopm |
Indica se a NF-e foi impresso utilizando a ferramenta PrintManager da TecnoSpeed. Valores possíveis: 1 - Impresso 0 - Não Impresso |
| cstat | Código do status da resposta da SEFAZ. Conforme manual do contribuinte. |
| importado |
Indica se a NF-e foi importada para a base do Manager SaaS/EDoc. Valores possíveis: 0 - Não 1 - Sim |
| valortotal | Valor Total da NF-e. |
| destinada |
Indica se a NF-e foi gravada via o processo de consulta destinadas (Que utiliza o WebService da SEFAZ). Valores possíveis: 0 - Não 1 - Sim |
| xmldestinatario | XML Destinatário da NF-e conforme padrão definido no manual do contribuinte. |
| nomeemitente | Nome do emitente da NF-e |
É possível realizar a consulta de uma inutilização passando o valor TspdNFeFaixaInut no parâmetro Visao e utilizando os seguintes campos:
| Campo | Descrição |
| cnpj | CNPJ do Emissor da NF-e. |
| serie | Série da faixa de numeração. |
| nfini | Valor inicial da faixa de numeração. |
| nffin | Valor final da faixa de numeração. |
| nrprotocolo | Número do protocolo de inutilização da faixa de numeração. |
| ano | Ano da Inutilização. |
| justificativa | Descrição da justificativa para realizar a inutilização. |
| ambiente |
Indica em qual ambiente da SEFAZ a inutilização foi executada. Valores possíveis: 1 - Produção. 2 - Homologação. |
Também é possível realizar a consulta de CCe, MDe e Cancelamento, passando o valor TspdVWEventos no parâmetro visão utilizando os seguintes campos:
Será retornado de acordo com os campos e ordem informada no parâmetro "campos".
Ex: Filtro: chavenota=111111111111111111111111111111111111111111 and tipo=CCe
Exemplo de retorno:
- Nenhum registro encontrado
- AUTORIZADA, CCe
| Campo | Descrição |
| tipo |
Valores possíveis: CCe MDe Cancelamento |
| datahoraevento |
Data de autorização do evento. |
| chavenota |
Chave da NFe que registrou o evento. |
| protocolo |
Número do protocolo de autorização. |
| motivo |
Motivo/retorno da SEFAZ. |
| xmldestinatario |
XML dos eventos vinculados a NFe. |
| situacao |
Valores possíveis: AUTORIZADA REJEITADA |
| ambiente |
Valores possíveis: 1 - Produção 2 - Homologação |
Comentários
0 comentário
Por favor, entre para comentar.