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/nfse/consulta
Headers
Nome | Descrição | Exemplo |
Authorization |
Este usuário e senha são os seus dados para acessar a interface Web do grupo desejado do SaaS, localizado em https://managersaas.tecnospeed.com.br:8081 Este parâmetro deve ser gerado a partir de um Base64 da seguinte informação: usuario:senha |
Para o exemplo de usuario:senha = admin:1234, o valor gerado é: Basic YWRtaW46MTIzNA== |
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 |
NomeCidade | Nome da cidade do emitente (Ex: CidadeUF) |
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: nrps, nprotocolo |
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. |
Limite |
Limite de registros que a consulta deve retornar. Atenção! O valor máximo e também padrão é de 100 registros. |
Visao | Nome da tabela usada para consulta das informações, como por exemplo Visao=TspdNFSeVWConsulta |
encode |
Tratamento de encode da resposta do manager SaaS. Enviar com o valor true |
FormatarXML |
Retira o CDATA dos campos que armazenam XML e modifica o delimitador dos campos da consulta (que por padrão é virgula) para [delimiter] |
Retorno
Exemplo de retorno:
Será de acordo com os campos e ordem informada no parâmetro "campos".
Ex: Filtro: nnfse, idintegracao, situacao
1346, 0, CANCELADA
Exemplo de retorno com erro:
Nenhum registro encontrado.
Campos
É possível realizar a consulta utilizando os seguintes campos:
Nome | Descrição |
idintegracao | Número do idintegração |
situacao | Situação da nota |
nrps | Número do RPS |
nlote | Número do Lote |
nprotocolo | Número do protocolo de envio para consulta |
dtemissao | Data de emissão da NFSe |
E-mail do Tomador | |
handle | Handle da nota |
dtautorizacao | Data de autorização da nota |
dtcancelamento | Data de cancelamento da nota |
cnpj | CNPJ do Prestador |
cidade | Cidade de emissão |
idgrupo | Número do ID do grupo |
serie | Série do RPS |
tipo | Tipo do RPS |
cnpjtomador | CNPJ do Tomador |
nometomador | Nome do Tomador |
nnfse | Número da NFS-e |
serieprestacao | Série de Prestação da nota |
nomegrupo | Nome do Grupo configurado no Saas |
razaosocialprestador | Razão Social do Prestador |
enderecoprestator | Endereço do Prestador |
telefoneprestador | Telefone do Prestador |
emailprestador | E-mail do Prestador |
inscricaomunicipalprestador | Inscrição Municipal do Prestador |
fantasiaprestador | Nome Fantasia do Prestador |
codcidadeprestador | Código da Cidade do Prestador (IBGE) |
descricaopadraocomuf | Descrição padrão do município (Ex:CIDADEUF) |
ufprestador | Sigla da UF do Prestador |
inscricaoestadualprestador | Número da Inscrição Estadual do Prestador |
dadosimpressao | Informações dos campos customizáveis (caso houver) |
dtcadastro | Data de cadastro do RPS no Edoc/Saas |
ambiente | Ambiente de Emissão 1-Produção 2-Homologação |
impressora | Nome da Impressora configurada como padrão |
motivo | Mensagem de Autorização ou Rejeição da nota |
sincronizadopm | Sincronização com o PrintManager 0-Não sincronizado 1-Sincronizado |
codverificacao | Código de verificação da NFS-e |
imprestadornota | Inscrição Municipal do Prestador da NFS-e |
impresso | Impressão da NFS-e Sim-NFS-e Impressa Não-NFS-e não impressa |
envemail | Envio de e-mail da NFS-e Sim-Envio de e-mail da NFS-e realizado Não-Envio de e-mail da NFS-e não realizado |
Atenção! Para fazer a consulta do XML do RPS de envio da NFS-e, deve ser utilizado o campo xmlrps e alterar o parâmetro Visao para: Visao=TspdNFSe.
Comentários
0 comentário
Por favor, entre para comentar.