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/nfce/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: situacao=AUTORIZADA and dtautorizacao = 02/08/2017 10:59:41 |
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 |
Visao | Determina em qual tabela a consulta será realizada. Deve ser preenchido apenas na consulta de numerações inutilizadas |
Retorno
Exemplo de retorno:
Será de acordo com os campos e ordem informada no parâmetro "campos".
Ex: Filtro: chave, situacao, serie
41150408187168000160556660000006671000000012,CANCELADA,667
Exemplo de retorno com erro:
Nenhum registro encontrado.
Campos/Filtros
É 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 NFC-e. |
situacao |
Situação da NFC-e. Exemplos: AUTORIZADA, CANCELADA |
nnf | Número da NFC-e. |
codnf | Código numérico identificador do contribuinte da NFC-e. |
nrecibo | Número do recebido de recepção da SEFAZ. |
nprotenvio | Número do protocolo do envio da NFC-e. |
nprotcanc | Número do protocolo do cancelamento da NFC-e. |
nprotinutil | Número do protocolo de inutilização da numeração da NFC-e. |
modoentrada |
Modo do Manager SaaS/EDoc no qual a nota foi registrada no envio. Pode ter os valores:
Normal e Contingencia Offline |
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 e Contingencia Offline |
cnpj | CNPJ do Emissor da NFC-e. |
serie | Série da numeração da NFC-e. |
motivo | Descrição do status da resposta da SEFAZ. |
dtautorizacao | Data de autorização da NFC-e. |
dtcadastro | Data de cadastro da NFC-e na base de dados do Manager SaaS/EDoc. |
dtcancelamento | Data de cancelamento da NFC-e. |
dtemissao | Data de emissão da NFC-e. |
impresso |
Indica se a NFC-e já foi impressa. Valores possíveis:
Sim - Já impressa Não - Não impressa |
envemail |
Indica se a NFC-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 NFC-e. | |
docdestinatario | Número do documento do destinatário da NFC-e. |
nomedestinatario | Nome do destinatário da NFC-e. |
idgrupo | Identificador único do grupo do Manager SaaS/EDoc ao qual o CNPJ do emissor da NFC-e faz parte. |
idintegracao | Identificador único da NFC-e com a TecnoSpeed. |
nlote | Número do lote a qual a NFC-e pertence. |
numero | Número da NFC-e. |
nomegrupo | Nome do grupo do Manager SaaS/EDoc ao qual o CNPJ do emissor da NFC-e faz parte. |
justificativa | Descrição da justificativa de cancelamento da NFC-e. |
ambiente |
Ambiente o qual a NFC-e foi enviada. Valores possíveis:
Homologação ou Produção. |
impressora | Nome da impressora utilizada para impressão da NFC-e. |
sincronizadopm |
Indica se a NFC-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. |
valortotal | Valor Total da NFC-e. |
valortroco | Valor do troco da NFC-e. |
valorrecebido | Valor recebido da NFC-e. |
Consultando notas Inutilizadas
É possível realizar a consulta de uma inutilização passando o valor TspdNFCeFaixaInut no parâmetro Visao e utilizando os seguintes campos:
Campo | Descrição |
cnpj | CNPJ do Emissor da NFC-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. |
Utilização da rota no POSTMAN
Colocamos um exemplo de como funciona a rota de CONSULTAR NOTA E CONSULTAR NOTA INUTILIZADA SaaS/eDoc utilizando requisição HTTPS via POSTMAN.
Basta baixar nosso exemplo se encontra no final desta documentação e importar para seu postman ou para outro software de requisição de rota.
Comentários
0 comentário
Por favor, entre para comentar.