Recorrência de NFS-e
Editar data ou valor de uma ocorrência
PATCH https://apifiscal.weesy.com.br/v1/recorrencias/{id}/ocorrencias/{numero}
Abrir na referência interativaSó ocorrência programada. dataPrevista: de hoje em diante, sem repetir a data de outra programada e entre a programada anterior e a seguinte. valor: maior que zero. Mudar o valor grava valorEditado (verdadeiro se diferente do valor do modelo).
avisoVespera na resposta: sem_aviso quando a nota sai sem o e-mail da véspera (a data é hoje, ou é amanhã e o aviso de hoje já saiu); senão com_aviso. Os e-mails da véspera só existem para as empresas do ERP Weesy; para integradores é sempre sem_aviso.
Parâmetros
| Nome | Onde | Tipo | Descrição |
|---|---|---|---|
| id obrigatório | caminho | string | |
| numero obrigatório | caminho | integer |
Exemplo de chamada
cURL
curl --request PATCH \
--url "https://apifiscal.weesy.com.br/v1/recorrencias/6ade6278e8340a492a46b564/ocorrencias/<numero>" \
--header "Authorization: Bearer $WEESY_TOKEN" \
--header "Content-Type: application/json" \
--data '{}'Node.js
const resposta = await fetch("https://apifiscal.weesy.com.br/v1/recorrencias/6ade6278e8340a492a46b564/ocorrencias/<numero>", {
method: "PATCH",
headers: {
Authorization: `Bearer ${process.env.WEESY_TOKEN}`,
"Content-Type": "application/json",
},
body: JSON.stringify({}),
});
console.log(resposta.status, await resposta.text());Python
import os
import requests
resposta = requests.patch(
"https://apifiscal.weesy.com.br/v1/recorrencias/6ade6278e8340a492a46b564/ocorrencias/<numero>",
headers={"Authorization": f"Bearer {os.environ['WEESY_TOKEN']}"},
json={},
timeout=30,
)
print(resposta.status_code, resposta.text)PHP
<?php
$corpo = <<<'JSON'
{}
JSON;
$contexto = stream_context_create(["http" => [
"method" => "PATCH",
"header" => implode("\r\n", ["Authorization: Bearer " . getenv("WEESY_TOKEN"), "Content-Type: application/json"]),
"content" => $corpo,
"ignore_errors" => true, // lê o corpo também nas respostas de erro
]]);
$resposta = file_get_contents("https://apifiscal.weesy.com.br/v1/recorrencias/6ade6278e8340a492a46b564/ocorrencias/<numero>", false, $contexto);
echo $http_response_header[0], PHP_EOL, $resposta, PHP_EOL;C#
using System.Net.Http.Headers;
using System.Text;
using var http = new HttpClient();
http.DefaultRequestHeaders.Authorization =
new AuthenticationHeaderValue("Bearer", Environment.GetEnvironmentVariable("WEESY_TOKEN"));
var corpo = """
{}
""";
using var resposta = await http.PatchAsync(
"https://apifiscal.weesy.com.br/v1/recorrencias/6ade6278e8340a492a46b564/ocorrencias/<numero>",
new StringContent(corpo, Encoding.UTF8, "application/json"));
Console.WriteLine($"{(int)resposta.StatusCode} {await resposta.Content.ReadAsStringAsync()}");Corpo da requisição
| Campo | Tipo | Descrição |
|---|---|---|
| dataPrevista | string (date) | |
| valor | number | Valor em reais, como número com 2 casas decimais (ex. |
Respostas
- 200: A ocorrência, com avisoVespera.
- 400: Algum dado está errado ou faltando. A lista erros diz qual campo e o que corrigir (code = validacao). (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)
- 409: A ação não vale na situação atual. O code diz o motivo: - recorrenciasituacaoinvalida — a recorrência está cancelada, concluída ou na situação errada para a ação; - recorrenciapausada — Emitir agora com a recorrência pausada (retome antes); - ocorrenciasituacaoinvalida — a ocorrência não está numa situação que aceita a ação; - prazoencerrado — o pulo só pode ser desfeito até 07:59 do dia da data prevista; - ocorrenciadataemconflito — outra ocorrência programada ocupa a data. (formato de erro)
Campos da resposta 200
| Campo | Tipo | Descrição | |||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| numero obrigatório | integer | ||||||||||||||||||||||||||||||||||||||||||||||
| dataPrevista obrigatório | string (date) | O dia (Brasília) em que a nota sai, às 08:00; vira a | |||||||||||||||||||||||||||||||||||||||||||||
| valor obrigatório | number | Valor em reais, como número com 2 casas decimais (ex. | |||||||||||||||||||||||||||||||||||||||||||||
| valorEditado obrigatório | boolean | O valor foi mudado à mão e não acompanha o valor do modelo. | |||||||||||||||||||||||||||||||||||||||||||||
| situacao obrigatório | string |
Valores: | |||||||||||||||||||||||||||||||||||||||||||||
| emitirAgora obrigatório | boolean | Marcada por Emitir agora; sai na próxima execução (até 5 min). | |||||||||||||||||||||||||||||||||||||||||||||
| idIntegracao | string ou null | O da nota desta ocorrência: | |||||||||||||||||||||||||||||||||||||||||||||
| avisadaEm | string (date-time) ou null | Quando entrou no aviso da véspera (só empresas do ERP Weesy). | |||||||||||||||||||||||||||||||||||||||||||||
| motivoImpedimento | object ou null | O que impediria a emissão, visto na véspera. | |||||||||||||||||||||||||||||||||||||||||||||
| motivoImpedimento. | string | ||||||||||||||||||||||||||||||||||||||||||||||
| motivoImpedimento. | string | ||||||||||||||||||||||||||||||||||||||||||||||
| nota | object ou null | A nota emitida, lida na hora. | |||||||||||||||||||||||||||||||||||||||||||||
| nota. | string | O | |||||||||||||||||||||||||||||||||||||||||||||
| nota. | string ou null | Número da NFS-e; nulo até autorizar. | |||||||||||||||||||||||||||||||||||||||||||||
| nota. | string | Em que pé está a nota. Novos valores podem aparecer: trate valor desconhecido sem quebrar.
| |||||||||||||||||||||||||||||||||||||||||||||
| falha | object ou null | Por que não saiu. | |||||||||||||||||||||||||||||||||||||||||||||
| falha. | string | ||||||||||||||||||||||||||||||||||||||||||||||
| falha. | string | ||||||||||||||||||||||||||||||||||||||||||||||
| falha. | string (date-time) | ||||||||||||||||||||||||||||||||||||||||||||||
| avisoVespera | string | Só na resposta de Editar data ou valor. Valores: | |||||||||||||||||||||||||||||||||||||||||||||
| mensagem | string | Só na resposta de Emitir agora. |