API consulta CTE
A rota consulta será utilizada para consultarmos campos específicos do CT-e, dentro do nosso servidor.
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. |
Ordem | Ordena a consulta |
Visao | Determina em qual tabela a consulta será realizada, como por exemplo: Visao=TspdCTeVWConsulta ou Visao=TspdVWCTeEventos |
Retorno
Exemplo de retorno:
Será de acordo com os campos e ordem informada no parâmetro “campos”.
Ex: Filtro: chave, situacao, serie
41150408187168000160576660000006671000000012, CANCELADA, 324
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 do CT-e |
numero | Número do CT-e |
codct | Código numérico que compõe a Chave de Acesso |
nrecibo | Número do recibo do CT-e (15 dígitos) |
nprotenvio | Número do protocolo de envio do CT-e (15 dígitos) |
nprotcanc | Número do protocolo de cancelamento do CT-e (15 dígitos) |
nprotinutil | Número do protocolo de inutilização do CT-e (15 dígitos) |
modoentrada | Modo de entrada Normal,EPEC,FSDA,SVSRS,SVCSP |
nlote | Número do Lote do CT-e |
dtemissao | Data de emissão do CT-e |
E-mail do Tomador | |
handle | Handle do CT-e (Identificador único do registro) |
chave | Chave do CT-e (44 dígitos) |
dtautorizacao | Data de autorização do CT-e |
dtcancelamento | Data de cancelamento do CT-e |
cnpj | CNPJ do Emitente |
idgrupo | Número do ID do grupo |
serie | Série do CT-e |
nomegrupo | Nome do Grupo configurado no Saas |
docdestinatario | CNPJ do Destinatário |
eventos | Quantidade de eventos que o CT-e recebeu |
origem | Determina a origem dos registros que serão obtidos: |
tomador | Indica o papel do tomador do serviço no CT-e |
nomedestinatario | Nome do Destinatário |
xmlcteautorizado | XML autorizado do CT-e |
doctomador | CNPJ do Tomador do CT-e |
docremetente | CNPJ do Remetente do CT-e |
docexpedidor | CNPJ do Expedidor do CT-e |
docrecebedor | CNPJ do Recebedor do CT-e |
dtcadastro | Data de cadastro do CT-e no Edoc/Saas |
ambiente | Ambiente de Emissão |
impressora | Nome da Impressora configurada como padrão |
motivo | Mensagem de Autorização ou Rejeição do CT-e |
cstat | Número do cstat retornado pela SEFAZ |
sincronizadopm | Sincronização com o PrintManager |
impresso | Impressão do CT-e |
envemail | Envio de e-mail da CT-e |
É possível consultar os dados das NF-es transportadas, utilize estes campos e o valor TspdCTeNFeVWConsultaTransportada no parâmetro Visao e utilizando os seguintes campos:
Nome | Descrição |
situacao | Situação da NF-e |
xmldestinatario | XML Destinatário da NF-e |
dtemissao | Data de emissão da NF-e |
handle | Handle da NF-e |
chave | Chave da NF-e (44 dígitos) |
dtautorizacao | Data de autorização da NF-e |
cnpj | CNPJ da Emitente da NF-e |
destinada | Informa se a NFe é destinada |
nomedestinatario | Nome do Destinatário da NF-e |
emitente | Nome do Emitente da NF-e |
cnpjdestinatario | CNPJ do Destinatário da NF-e |
Também é possível realizar a consulta de CCe, MDe e Cancelamento passando o valor TspdVWCTeEventos no parâmetro visão utilizando os seguintes campos:
Campo | Descrição |
tipo | Valores possíveis: CCe MDe Cancelamento |
datahoraevento | Data de autorização do evento. |
chave | Chave da CTe 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 |
numerosequenciaevento | Número da Sequência do Evento |