Weesy Docs

Notas recebidas

Ligar a busca das NFS-e recebidas

PUT https://apifiscal.weesy.com.br/v1/destinados/sincronizacao/{modelo}

Abrir na referência interativa

Liga a busca diária. Pode chamar mais de uma vez: ativadaEm fica o da primeira. A primeira leitura traz o histórico que o ADN guardar e começa na próxima execução da rotina (até 5 minutos). Exige o certificado A1 da empresa enviado à Weesy.

Parâmetros

NomeOndeTipoDescrição
modelo
obrigatório
caminhostring

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

Valores: nfse.

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 PUT \
  --url "https://apifiscal.weesy.com.br/v1/destinados/sincronizacao/<modelo>" \
  --header "Authorization: Bearer $WEESY_TOKEN"

Node.js

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

Python

import os

import requests

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

PHP

<?php

$contexto = stream_context_create(["http" => [
    "method" => "PUT",
    "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/sincronizacao/<modelo>", 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.PutAsync(
    "https://apifiscal.weesy.com.br/v1/destinados/sincronizacao/<modelo>",
    null);
Console.WriteLine($"{(int)resposta.StatusCode} {await resposta.Content.ReadAsStringAsync()}");

Respostas

Campos da resposta 200

CampoTipoDescrição
modelo
obrigatório
string

Valores: nfse.

ativo
obrigatório
boolean
ativadaEmstring (date-time) ou null
primeiraLeituraFeita
obrigatório
boolean

Já houve uma busca que deu certo.

pendente
obrigatório
boolean

Ainda há histórico a ler; continua na próxima execução.

solicitadaEmstring (date-time) ou null

Pedido de busca à espera da próxima execução.

ultimaExecucaoobject ou null
ultimaExecucao.iniciostring (date-time)

Data e hora em UTC, terminada em Z (ex. 2026-10-26T12:27:34Z).

ultimaExecucao.fimstring (date-time)

Data e hora em UTC, terminada em Z (ex. 2026-10-26T12:27:34Z).

ultimaExecucao.resultadostring

Valores: ok, pendente, falha, certificado_ausente, certificado_vencido.

ultimaExecucao.mensagemstring ou null
ultimaExecucao.documentosLidosinteger
falhasSeguidas
obrigatório
integer
ultimoSucessoEmstring (date-time) ou null
certificado
obrigatório
string

O certificado A1 da empresa no cofre da Weesy, lido na hora.

Valores: ok, ausente, vencido.

certificadoValidoAtestring (date-time)

Validade do certificado A1. Ausente quando não há certificado.

← Voltar ao início