Weesy Docs

Avisos que enviamos

NFS-e cancelada

POST para a URL configurada no seu webhook, evento nfse.cancelada

Abrir na referência interativa

A prefeitura confirmou o cancelamento. A nota passa a cancelada e não tem mais valor fiscal.

Parâmetros

NomeOndeTipoDescrição
webhook-id
obrigatório
cabeçalhostring

O id do aviso. É o mesmo em todas as tentativas e no reenvio — use para não processar duas vezes.

webhook-timestamp
obrigatório
cabeçalhointeger

Quando esta tentativa foi enviada, em segundos desde 1970 (Unix). Recuse se tiver mais de 5 minutos.

webhook-signature
obrigatório
cabeçalhostring

A assinatura, no formato es256,<código da chave>,<assinatura em base64url>. Na troca de chave podem vir duas, separadas por espaço: basta uma estar certa.

Corpo da requisição

CampoTipoDescrição
id
obrigatório
string

Identificador estável do evento, usado na deduplicação.

tipo
obrigatório
string

Tipo do evento enviado.

Valores: nfse.recebida, nfse.autorizada, nfse.rejeitada, nfse.erro, nfse.cancelada, nfse.cancelamento_rejeitado, cte.autorizado, cte.rejeitado, cte.cancelado, cte.carta_correcao_registrada, cte.erro, mdfe.autorizado, mdfe.rejeitado, mdfe.cancelado, mdfe.encerrado, mdfe.erro, teste.

versao
obrigatório
string

Versão do formato do evento.

ocorridoEm
obrigatório
string (date-time)

Data e hora em que o evento ocorreu.

empresa
obrigatório
object

A empresa da nota.

empresa.cnpj
obrigatório
string

CNPJ sem pontos, barra ou traço (14 posições). Já aceita o CNPJ com letras, que começa a valer em 2026.

dadosobject

Representação de uma NFS-e, com os dados da emissão, situação de processamento e documentos disponíveis.

dados.id
obrigatório
string

Identificador da NFS-e na Weesy.

dados.idIntegracao
obrigatório
string

Identificador informado pelo integrador na emissão.

dados.status
obrigatório
string

Situação atual do processamento da NFS-e.

ValorSignificado
recebidaRecebemos a nota e vamos enviar à prefeitura
em_processamentoEnviada à prefeitura, aguardando a resposta
autorizadaAutorizada pela prefeitura
rejeitadaRecusada pela prefeitura — corrija e emita de novo
erroNão conseguimos falar com a prefeitura — tente de novo
cancelamento_solicitadoCancelamento pedido, aguardando a prefeitura
canceladaCancelada pela prefeitura
cancelamento_rejeitadoA prefeitura recusou o cancelamento
dados.ambiente
obrigatório
string

Ambiente em que a emissão foi solicitada.

ValorSignificado
simulacaoTeste sem certificado — a Weesy responde no lugar da prefeitura
homologacaoTeste no ambiente de testes da prefeitura — precisa de certificado
producaoA nota de verdade, com valor fiscal
dados.empresa
obrigatório
object

A empresa que emitiu a nota.

dados.empresa.cnpj
obrigatório
string

CNPJ sem pontos, barra ou traço (14 posições). Já aceita o CNPJ com letras, que começa a valer em 2026.

dados.empresa.razaoSocial
obrigatório
string
dados.empresa.inscricaoMunicipalstring ou null
dados.empresa.municipio
obrigatório
object

Identificação do município por código IBGE, nome e UF.

dados.empresa.municipio.codigoIbge
obrigatório
string

Código IBGE do município.

dados.empresa.municipio.nomestring

Nome do município.

dados.empresa.municipio.ufstring

Sigla da unidade federativa.

dados.tomador
obrigatório
object

Dados do tomador registrados na nota.

dados.tomador.tipoPessoa
obrigatório
string

Tipo de pessoa do tomador.

Valores: F, J.

dados.tomador.cpfCnpj
obrigatório
string

CPF ou CNPJ registrado para o tomador.

dados.tomador.nome
obrigatório
string

Nome ou razão social do tomador.

dados.tomador.inscricaoMunicipalstring ou null

Inscrição municipal informada para o tomador.

dados.tomador.emailstring ou null

E-mail registrado para o tomador.

dados.tomador.telefonestring ou null

Telefone registrado para o tomador.

dados.tomador.enderecoobject

Endereço registrado para o tomador.

dados.tomador.endereco.cep
obrigatório
string

CEP do endereço, sem pontuação.

dados.tomador.endereco.logradouro
obrigatório
string

Tipo e nome do logradouro.

dados.tomador.endereco.numero
obrigatório
string

Número do endereço. Sem número? Mande S/N.

dados.tomador.endereco.complementostring

Complemento do endereço, quando aplicável.

dados.tomador.endereco.bairro
obrigatório
string

Bairro do endereço.

dados.tomador.endereco.codigoIbge
obrigatório
string

Código IBGE do município do endereço.

dados.tomador.endereco.cidadestring
dados.tomador.endereco.ufstring
dados.servico
obrigatório
object

Serviço congelado na nota.

dados.servico.idinteger
dados.servico.descricaostring
dados.servico.itemListaServicostring
dados.servico.codigoTributacaoMunicipiostring ou null
dados.servico.codigoTributacaoNacionalstring ou null
dados.servico.nbsstring
dados.servico.cIndOpstring
dados.servico.cClassTribstring
dados.servico.cststring
dados.discriminacaostring

Descrição da prestação registrada na nota.

dados.competenciastring (date)

Data de competência da prestação.

dados.valores
obrigatório
object

Valores calculados e registrados para a nota.

dados.valores.serviconumber

Valor do serviço prestado.

dados.valores.deducoesnumber

Valor das deduções consideradas.

dados.valores.descontoIncondicionadonumber

Valor do desconto incondicionado.

dados.valores.descontoCondicionadonumber

Valor do desconto condicionado.

dados.valores.baseCalculonumber

Base de cálculo apurada para o ISS.

dados.valores.aliquotaIssnumber

Alíquota de ISS aplicada no cálculo, em percentual.

dados.valores.issnumber

Valor de ISS apurado.

dados.valores.issRetidoboolean

Indica a retenção do ISS.

dados.valores.retencoesFederaisobject

Valores de retenções federais.

dados.valores.retencoesFederais.pisnumber

Valor da retenção de PIS.

dados.valores.retencoesFederais.cofinsnumber

Valor da retenção de COFINS.

dados.valores.retencoesFederais.csllnumber

Valor da retenção de CSLL.

dados.valores.retencoesFederais.irnumber

Valor da retenção de Imposto de Renda.

dados.valores.retencoesFederais.inssnumber

Valor da retenção de INSS.

dados.valores.liquidonumber

Valor líquido da prestação.

dados.ibsCbsobject

Ausente quando a nota não tem o grupo IBS/CBS.

dados.ibsCbs.cIndOpstring
dados.ibsCbs.cClassTribstring
dados.ibsCbs.cststring
dados.ibsCbs.localidadeIncidenciastring

Código IBGE do município.

dados.rpsobject

Numeração e série do RPS da nota.

dados.rps.numerostring
dados.rps.seriestring
dados.documentoobject

Ausente até autorizar.

dados.documento.numerostring
dados.documento.codigoVerificacaostring
dados.documento.chaveAcessostring ou null
dados.documento.emitidoEmstring (date-time)

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

dados.provedorobject

A última resposta da prefeitura (ou do sistema nacional).

dados.provedor.padraostring
dados.provedor.codigostring ou null
dados.provedor.mensagemstring ou null
dados.provedor.protocolostring ou null
dados.historicoarray de object

Histórico das mudanças de situação da NFS-e.

dados.historico[].status
obrigatório
string

Em que pé está a nota. Novos valores podem aparecer: trate valor desconhecido sem quebrar.

ValorO que quer dizerO que fazer
recebidaRecebemos a nota e vamos enviar à prefeituraAguardar
em_processamentoEnviada à prefeitura, aguardando a respostaAguardar
autorizadaA prefeitura autorizou — a nota tem número e código de verificaçãoPronto: baixe o PDF e o XML
rejeitadaA prefeitura recusou por algum dado erradoLeia o motivo em mensagens, corrija e emita de novo com o mesmo idIntegracao
erroNão conseguimos falar com a prefeitura (fora do ar, demora)Tentar emitir de novo
cancelamento_solicitadoPedimos o cancelamento, aguardando a prefeituraAguardar
canceladaA prefeitura cancelou a nota—
cancelamento_rejeitadoA prefeitura recusou o cancelamento — a nota continua valendoLeia o motivo; às vezes é preciso cancelar no site da prefeitura
ValorSignificado
recebidaRecebemos a nota e vamos enviar à prefeitura
em_processamentoEnviada à prefeitura, aguardando a resposta
autorizadaAutorizada pela prefeitura
rejeitadaRecusada pela prefeitura — corrija e emita de novo
erroNão conseguimos falar com a prefeitura — tente de novo
cancelamento_solicitadoCancelamento pedido, aguardando a prefeitura
canceladaCancelada pela prefeitura
cancelamento_rejeitadoA prefeitura recusou o cancelamento
dados.historico[].em
obrigatório
string (date-time)

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

dados.historico[].mensagensarray de object
dados.historico[].mensagens[].codigostring
dados.historico[].mensagens[].mensagemstring
dados.cancelamentoobject

Dados e situação da solicitação de cancelamento, quando houver.

dados.cancelamento.motivointeger
dados.cancelamento.justificativastring
dados.cancelamento.solicitadoEmstring (date-time)

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

dados.cancelamento.concluidoEmstring (date-time) ou null
dados.links
obrigatório
object

Endereços relativos para consultar a nota e obter seus documentos, conforme disponibilidade.

dados.links.self
obrigatório
string
dados.links.xmlstring ou null

Nulo até autorizar.

dados.links.pdfstring ou null

Nulo até autorizar.

dados.criadoEm
obrigatório
string (date-time)

Instante de criação do registro na Weesy.

dados.atualizadoEm
obrigatório
string (date-time)

Instante da última atualização do registro.

Exemplo

JSON
{
  "id": "evt_01K8G2C4R7V9X3Z5B8D1F6H0JE",
  "tipo": "nfse.cancelada",
  "versao": "v1",
  "ocorridoEm": "2026-10-27T14:05:12Z",
  "empresa": {
    "cnpj": "21664333000195"
  },
  "dados": {
    "id": "6ade6278e8340a492a46b564",
    "idIntegracao": "pedido-10432",
    "status": "cancelada",
    "ambiente": "producao",
    "empresa": {
      "cnpj": "21664333000195",
      "razaoSocial": "WEESY SOFTWARE LTDA",
      "inscricaoMunicipal": "249122",
      "municipio": {
        "codigoIbge": "3547809",
        "nome": "Santo André",
        "uf": "SP"
      }
    },
    "tomador": {
      "tipoPessoa": "J",
      "cpfCnpj": "11222333000181",
      "nome": "EMPRESA EXEMPLO LTDA"
    },
    "servico": {
      "id": 42,
      "descricao": "Suporte técnico",
      "itemListaServico": "01.07",
      "codigoTributacaoMunicipio": "620910000",
      "nbs": "115013000",
      "cIndOp": "100301",
      "cClassTrib": "000001",
      "cst": "000"
    },
    "valores": {
      "servico": 100,
      "baseCalculo": 100,
      "aliquotaIss": 3,
      "iss": 0,
      "issRetido": false,
      "liquido": 100
    },
    "documento": {
      "numero": "947",
      "codigoVerificacao": "H45N1MFG0",
      "emitidoEm": "2026-10-26T09:28:10-03:00"
    },
    "cancelamento": {
      "motivo": 1,
      "justificativa": "Nota emitida com o valor errado; uma nova nota será emitida.",
      "solicitadoEm": "2026-10-27T14:04:50Z",
      "concluidoEm": "2026-10-27T14:05:12Z"
    },
    "links": {
      "self": "/v1/nfse/6ade6278e8340a492a46b564",
      "xml": "/v1/nfse/6ade6278e8340a492a46b564/xml",
      "pdf": "/v1/nfse/6ade6278e8340a492a46b564/pdf"
    },
    "criadoEm": "2026-10-26T12:27:34Z",
    "atualizadoEm": "2026-10-27T14:05:12Z"
  }
}

Respostas

← Voltar ao início