Weesy Docs

Notas recebidas

Consultar uma NFS-e recebida

GET https://apifiscal.weesy.com.br/v1/destinados/{modelo}/{chave}

Abrir na referência interativa

Os mesmos campos da lista, mais os eventos da nota (cancelamento, substituição, manifestações). Sem o XML.

Parâmetros

NomeOndeTipoDescrição
modelo
obrigatório		caminhostring

O tipo de documento. Por enquanto só nfse; outro valor responde 400 valor_invalido.

Valores: nfse.

chave
obrigatório		caminhostring

A chave de acesso da NFS-e (50 caracteres).

cnpjEmitentequerystring

CNPJ da empresa. Obrigatório para o integrador; com o token de API, o da própria empresa (outro CNPJ responde 404).

Exemplo de chamada

cURL

curl --request GET \
  --url "https://apifiscal.weesy.com.br/v1/destinados/<modelo>/35503082235801047000139000000000000226119388645633" \
  --header "Authorization: Bearer $WEESY_TOKEN"

Node.js

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

Python

import os

import requests

resposta = requests.get(
    "https://apifiscal.weesy.com.br/v1/destinados/<modelo>/35503082235801047000139000000000000226119388645633",
    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/<modelo>/35503082235801047000139000000000000226119388645633", 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/<modelo>/35503082235801047000139000000000000226119388645633");
Console.WriteLine($"{(int)resposta.StatusCode} {await resposta.Content.ReadAsStringAsync()}");

Respostas

Campos da resposta 200

CampoTipoDescrição
modelo
obrigatório		string

Valores: nfse.

chave
obrigatório		string

Chave de acesso da NFS-e.

papel
obrigatório		string

O papel da empresa na nota. indefinido quando o XML não abre.

Valores: tomador, intermediario, indefinido.

numerostring ou null

Número da NFS-e.

emitidaEmstring (date-time)

Data e hora da emissão (dhProc); na nota que não abre, quando o ADN gerou o documento.

competenciastring (date) ou null
emitenteobject ou null

O prestador.

emitente.documentostring ou null

CPF ou CNPJ, só números.

emitente.nomestring ou null
emitente.municipiostring ou null

Nome do município do prestador.

valorTotalnumber ou null

Valor do serviço.

valorLiquidonumber ou null
issRetidoboolean ou null

ISS retido pelo tomador ou pelo intermediário.

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.

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.

eventos
obrigatório		array de object
eventos[].tipostring

O tipo do evento no ADN.

eventos[].dataHorastring (date-time)

Data e hora no horário de Brasília (ex. 2026-10-26T09:27:34-03:00).

Notas recebidas

← Voltar ao início