Notas recebidas

Listar as NFS-e recebidas

GET https://apifiscal.weesy.com.br/v1/destinados

As NFS-e em que a empresa é tomadora ou intermediária, lidas no Ambiente de Dados Nacional (ADN) com o certificado A1 da empresa enviado à Weesy. A busca roda sozinha uma vez por dia depois de ligada (Ligar a busca) e pode ser pedida a qualquer hora (Pedir uma busca agora).

Mais recente primeiro (emitidaEm decrescente) e, na mesma data e hora, pela chave.
de e ate são datas (aaaa-mm-dd), inclusivas, comparadas com a data de Brasília da emissão.
emitente procura parte do nome ou do CPF/CNPJ do prestador.
Nota cujo XML não abre volta com leitura = falha e papel = indefinido: dá para baixar o XML, mas não o PDF.
Notas emitidas pela própria empresa (prestadora) não entram.
Empresa sem a busca ligada: lista vazia.

Parâmetros

Nome	Onde	Tipo	Descrição
cnpjEmitente	query	string	CNPJ da empresa. Obrigatório para o integrador; com o token de API, o da própria empresa.
modelo	query	string	O tipo de documento. Padrão `nfse`, o único por enquanto; outro valor responde `400 valor_invalido`. Valores: `nfse`.
de	query	string (date)
ate	query	string (date)
emitente	query	string	Parte do nome ou do CPF/CNPJ do prestador.
situacao	query	string	Valores: `normal`, `cancelada`, `substituida`.
limite	query	integer
cursor	query	string	Para pegar a próxima página, repasse o `paginacao.proximoCursor` da resposta anterior.

Exemplo de chamada

cURLcurl --request GET \
  --url "https://apifiscal.weesy.com.br/v1/destinados" \
  --header "Authorization: Bearer $WEESY_TOKEN"

Node.jsconst resposta = await fetch("https://apifiscal.weesy.com.br/v1/destinados", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.WEESY_TOKEN}`,
  },
});
console.log(resposta.status, await resposta.text());

Pythonimport os

import requests

resposta = requests.get(
    "https://apifiscal.weesy.com.br/v1/destinados",
    headers={"Authorization": f"Bearer {os.environ['WEESY_TOKEN']}"},
    timeout=30,
)
print(resposta.status_code, resposta.text)

PHP<?php

$contexto = stream_context_create(["http" => [
    "method" => "GET",
    "header" => implode("\r\n", ["Authorization: Bearer " . getenv("WEESY_TOKEN")]),
    "ignore_errors" => true, // lê o corpo também nas respostas de erro
]]);
$resposta = file_get_contents("https://apifiscal.weesy.com.br/v1/destinados", false, $contexto);
echo $http_response_header[0], PHP_EOL, $resposta, PHP_EOL;

C#using System.Net.Http.Headers;

using var http = new HttpClient();
http.DefaultRequestHeaders.Authorization =
    new AuthenticationHeaderValue("Bearer", Environment.GetEnvironmentVariable("WEESY_TOKEN"));

using var resposta = await http.GetAsync("https://apifiscal.weesy.com.br/v1/destinados");
Console.WriteLine($"{(int)resposta.StatusCode} {await resposta.Content.ReadAsStringAsync()}");

Respostas

200: Página de notas recebidas.
400: Algum dado está errado ou faltando. A lista erros diz qual campo e o que corrigir (code = validacao). (formato de erro)
401: Token ausente, errado ou revogado (credencialinvalida). Confira o cabeçalho Authorization. (formato de erro)
404: Não encontrado. Pode ser que não exista ou que pertença a outra empresa — por segurança, os dois casos respondem igual. (formato de erro)
500: Erro do nosso lado (errointerno). Tente de novo; se continuar, mande o traceId para o suporte. (formato de erro)

Campos da resposta 200

Campo	Tipo	Descrição
dados obrigatório	array de object
dados[].modelo obrigatório	string	Valores: `nfse`.
dados[].chave obrigatório	string	Chave de acesso da NFS-e.
dados[].papel obrigatório	string	O papel da empresa na nota. `indefinido` quando o XML não abre. Valores: `tomador`, `intermediario`, `indefinido`.
dados[].numero	string ou null	Número da NFS-e.
dados[].emitidaEm	string (date-time)	Data e hora da emissão (`dhProc`); na nota que não abre, quando o ADN gerou o documento.
dados[].competencia	string (date) ou null
dados[].emitente	object ou null	O prestador.
dados[].emitente.documento	string ou null	CPF ou CNPJ, só números.
dados[].emitente.nome	string ou null
dados[].emitente.municipio	string ou null	Nome do município do prestador.
dados[].valorTotal	number ou null	Valor do serviço.
dados[].valorLiquido	number ou null
dados[].issRetido	boolean ou null	ISS retido pelo tomador ou pelo intermediário.
dados[].situacao obrigatório	string	`normal`; `cancelada` (cancelamento, inclusive deferido em análise fiscal ou de ofício) ou `substituida` (cancelamento por substituição). `cancelada` e `substituida` são finais. Valores: `normal`, `cancelada`, `substituida`.
dados[].leitura obrigatório	string	`falha` quando o XML não abre: os campos de dados vêm nulos e só o XML pode ser baixado. Valores: `ok`, `falha`.
paginacao obrigatório	object	Como pegar a próxima página. Enquanto `temMais` for `true`, chame a mesma rota passando `cursor=<proximoCursor>`. A lista vem da atualização mais recente para a mais antiga, e o cursor vale por 24 horas. Registros criados enquanto você pagina não bagunçam as páginas: eles aparecem numa nova consulta.
paginacao.limite obrigatório	integer	Quantos registros vêm por página (padrão 50, máximo 100).
paginacao.proximoCursor	string ou null	Código da próxima página. Repasse como veio, sem alterar — ele já leva os filtros. `null` quando acabou.
paginacao.temMais obrigatório	boolean	`true` se ainda há mais páginas.

← Voltar ao início