Nesta rota, você pode realizar consultas por período, a fim de obter as chaves das notas e um breve resumo do conteúdo delas, em formato json.

 

GET

 

Querystring

 

Nome	Descrição
environment	Ambiente em que o Documento foi emitido.
softwarehouse_token	Token de identificação da sua Software House.
cpf_cnpj	CNPJ ou CPF para identificar o cliente.
date_ini	Data inicial do período.
date_end	Data final do período.
mod	Modelo do documento.
transaction	Tipo de transação.
limit	Limite de resultados por consulta. (Máximo 30)
last_id	Ultimo ID encontrado.
filter	Buscar notas que já foram baixadas ou não baixadas.
serie	Serie do documento.
number	Numero do documento.
cnpj_cpf_emitter	CNPJ do Emissor do Documento.
cnpj_cpf_recipient	CNPJ ou CNPF do Destinatário.
situation	Situação do Documento.
resume	Nota contém ou não XML completo

environment -  Campo não obrigatório. Valores válidos: 1 (produção) ou 2 (homologação).

cpf_cnpj - Deve ser informado o CNPJ ou CPF do cliente vinculado a software House. 

date_ini e data_end - Formato: AAAA-MM-DD (Período máximo permitido é de 31 dias). Será levado em consideração a data de emissão do documento.

mod - Valores válidos: NFE, CCE, NFCE, CTE, CCECTE, SAT e CTEOS

serie -  Campo não obrigatório. Exemplo: 001

number -  Campo não obrigatório. Exemplo: 256689

cnpj_cpf_emitter -  Campo não obrigatório. Exemplo: 05197129000103

cnpj_cpf_recipient - Utilizado para filtrar apenas notas destinadas (RECEIVED) ao CNPJ informado no campo cpf_cnpj. Quando não utilizado serão retornados todos os documentos  conforme o campo transaction. Campo não obrigatório. Exemplo: 06197958000102

situation -  Campo não obrigatório. Valores válidos: AUTORIZADA, DENEGADA, CONTINGENCIA, CANCELADA.

transaction - Valores válidos: RECEIVED, SENT, OTHER, ALL.

limit: Valores válidos: de 0 até 30. (limite de 30 itens por consulta).

last_id: Utilizado para realizar a paginação, após realizar uma consulta será retornado o campo "last_id" no body, tendo esse valor ele é utilizado como parâmetro para ser retornado os próximos itens. Na primeira consulta não é necessário informa-lo.

filter - valores válidos: downloaded, not_downloaded, all. (Utilizado para filtrar as notas que já foram baixadas ou não baixadas, esse campo não é obrigatório).

manifests - Valores válidos: 1 (utilizado para retornar o tipo e o status do evento de manifestação. Exemplo: "type": "CIENCIA", "status": "SUCCESS")

Possíveis type: CONFIRMAR, DESCONHECIMENTO, NAO_REALIZADA, CIENCIA E DESACORDO

resume - valores válidos false (iremos retornar apenas notas com xml completo) e true (serão retornadas notas com xml completo e xml resumido, porém, com um campo a mais no retorno mostrando se xmlCompleto=true/false). Em ambos valores, iremos retornar o campo science_status=true/false , para identificar se a nota teve a Ciência da Operação realizada com sucesso ou não.

Retorno

  

Exemplo de retorno de validações:

{
 "error": true,
 "message": "Campo "transaction" não informado ou inválido, valores aceitos: received, sent, other, all"
}

 

Exemplo de retorno com sucesso:

{
 "error": false,
 "message": "Chaves retornadas.",
 "data": {
 "invoices": [
 {
 "key": "4119010818712800016055889000653321000000102",
 "id": "2314324",
 "mod": "55",
 "serie": "001",
 "cnpj_emitter": "03669919002145",
 "cnpj_addressee":"01565938012089",
 "razao_social": "Razão Social da empresa",
 "fantasia": "Nome fantasia da empresa",
 "number":"5767",
 "date_emission": "2019-07-01",
 "value": 178.7,
 "situation": "CANCELADA"
 },
 {
 "key": "411901081812368000160558890006549959000000103",
 "id": "2314325",
 "mod": "55",
 "serie": "001",
 "cnpj_emitter": "03669919002145",
 "cnpj_addressee":"01565938012089",
 "razao_social": "Razão Social da empresa",
 "fantasia": "Nome fantasia da empresa",
 "number":"35",
 "date_emission": "2019-07-02",
 "value": 1069.0,
 "situation": "AUTORIZADO"
 "manifest": {
              "type": "CIENCIA",
              "status": "SUCCESS"
             },
 }
 ],
 "last_id": "2314325",
 "mod": "NFE",
 "count": 2,
 "total": 13
 }
}

 

invoices - registros encontradas

last_id - ultimo id encontrado (utilizado para próxima consulta)

count -  quantidade de registros retornados na consulta

total - quantidade  total de registros entrados no período 

 

OBS.: em alguns casos o campo cnpj_addressee pode se manter null. Isto ocorre quando a nota ainda não tem o xml completo. O xml completo de uma nota será gerado apenas após a Ciência da Operação ou após outro Evento de manifestação. Assim que obtiver sucesso em um destes eventos, será fornecido o xml com todas as informações e consequentemente, o campo cnpj_addressee será preenchido.