Skip to main content
PUT
Alterar Nota Fiscal de Serviço
PUT substitui o registro inteiro — envie todos os campos, não apenas os alterados.

Authorizations

Authorization
string
header
required

Envie o token retornado por /v2/autenticar no header Authorization, no formato Bearer {token}.

Body

application/json

Nota Fiscal de Serviço (NFS-e). Campos obrigatórios: codigoDaFilial, codigoDaNotaFiscal, codigoDoMunicipioDePrestacaoDoServico (dispensável apenas para clientes no exterior), codigoDaFormaDePagamento (deve existir), descricaoDoServico e valorDoServico (>= 0).

codigoDaNotaFiscal
integer<int16>
required

Código do tipo/modelo de nota fiscal cadastrado. Deve ser válido para a filial.

codigoDaFilial
integer<int16>
required

Código da filial emissora. Deve ser uma filial válida da empresa.

codigoDoMunicipioDePrestacaoDoServico
string | null
required

Código IBGE do município de prestação do serviço. Obrigatório, exceto para clientes no exterior.

descricaoDoServico
string
required

Descrição do serviço prestado.

valorDoServico
number
required

Valor do serviço. Deve ser maior ou igual a zero.

codigoDaFormaDePagamento
integer<int16>
required

Código da forma/condição de pagamento. Deve existir e estar cadastrada na empresa.

idNF
number

Id. interno da Nota Fiscal. Obrigatório para PUT (alteração); ignorado/gerado pelo servidor na inclusão.

rps
integer<int32> | null

Número do RPS (Recibo Provisório de Serviços), quando aplicável ao município.

dataDeCadastro
string<date-time> | null

Data de cadastro da nota.

dataDaProximaEmissao
string<date-time> | null

Data prevista para emissão da nota.

dataDeProcessamento
string<date-time> | null

Data em que a nota foi processada/emitida.

dataDeCancelamento
string<date-time> | null

Data de cancelamento da nota.

dataDeEmissao
string<date-time> | null

Data de emissão da nota.

numeroDaOrdemDeServico
number | null

Número da Ordem de Serviço que originou a nota, quando aplicável.

codigoDoCliente
integer<int32>

Código do cliente tomador do serviço.

nomeDoCliente
string | null

Nome/razão social do cliente.

naturezaJuridica
string | null

Natureza jurídica do cliente (Física/Jurídica).

cnpjcpf
string | null

CNPJ ou CPF do cliente.

cep
string | null

CEP do cliente.

logradouro
string | null

Logradouro do endereço do cliente.

numero
string | null

Número do endereço do cliente.

complemento
string | null

Complemento do endereço do cliente.

bairro
string | null

Bairro do endereço do cliente.

cidade
string | null

Cidade do endereço do cliente.

uf
string | null

UF do endereço do cliente.

telefone
string | null

Telefone de contato do cliente.

email
string | null

E-mail de contato do cliente.

codigoDoCentroDeCusto
string | null

Código do centro de custo, quando informado deve ser válido.

codigoDoProjeto
integer<int32> | null

Código do projeto, quando informado deve ser válido.

codigoDaClassificacaoAuxiliar
integer<int32> | null

Código da classificação auxiliar financeira, quando informado deve ser válida.

codigoDoItemDeLancamento
string | null

Código do item de lançamento de receita (Contas a Receber), quando informado deve ser um item válido.

dadosAdicionais
string | null

Informações complementares impressas na NFS-e.

observacaoCR
string | null

Observação do lançamento de Contas a Receber.

historicoCR
string | null

Histórico do lançamento de Contas a Receber.

codigoDaContaCorrente
integer<int16> | null

Código da conta corrente para recebimento, quando informado deve ser válida.

codigoDaCarteira
integer<int16> | null

Código da carteira de cobrança, quando informado deve ser válida para a conta corrente.

codigoDoMunicipio
string | null

Código IBGE do município do cliente.

codigoDoServico
integer<int32> | null

Código do serviço (CodigosDeServico).

codigoDoServicoPrestado
string | null

Código do serviço prestado (lista LC 116 / item municipal).

codigoNBS
string | null

Código NBS (Nomenclatura Brasileira de Serviços), quando aplicável.

codigoIndicadorDaOperacao
string | null

Código do indicador da operação (IBS/CBS).

codigoTipoDaOperacao
integer<int32> | null

Código do tipo da operação (IBS/CBS).

codigoIndicadorDoDestinatario
integer<int32> | null

Código do indicador do destinatário (IBS/CBS).

codigoDaSituacaoTributariaIBSCBS
string | null

Código da situação tributária IBS/CBS (CST).

classificacaoIBSCBS
string | null

Classificação tributária IBS/CBS (cClassTrib).

aliquotaIBSMunicipal
number

Alíquota do IBS municipal.

valorIBSMunicipal
number

Valor do IBS municipal.

aliquotaIBSEstadual
number

Alíquota do IBS estadual.

valorIBSEstadual
number

Valor do IBS estadual.

aliquotaCBS
number

Alíquota da CBS.

valorCBS
number

Valor da CBS.

valorDaDeducao
number

Valor de deduções sobre o serviço, permitido pela legislação municipal.

baseISS
number

Base de cálculo do ISS.

aliquotaISS
number

Alíquota do ISS.

valorISS
number

Valor do ISS.

tipoTributacao
integer<int16>

Código do tipo de tributação do ISS no município.

exigibilidade
integer<int16>

Código de exigibilidade do ISS.

aliquotaISSRetido
number

Alíquota do ISS retido na fonte.

valorISSRetido
number

Valor do ISS retido na fonte.

valorINSSRetido
number

Valor do INSS retido.

basePISCOFINSCSLL
number

Base de cálculo comum de PIS/COFINS/CSLL.

valorPIS
number

Valor do PIS.

codigoDaSituacaoTributariaPIS
string | null

Código da situação tributária do PIS (CST).

valorCOFINS
number

Valor da COFINS.

codigoDaSituacaoTributariaCOFINS
string | null

Código da situação tributária da COFINS (CST).

valorCSLL
number

Valor da CSLL.

codigoDaRetencaoPisCofinsCsll
string | null

Tipo/código de retenção de PIS, COFINS e CSLL.

baseIR
number

Base de cálculo do IR.

aliquotaIR
number

Alíquota do IR.

valorIR
number

Valor do IR.

tipoDePagamento
integer<int16> | null

Tipo de pagamento aplicado à nota.

codigoDaCondicaoDePagamento
integer<int32>

Código da condição de pagamento aplicada à nota.

parcelas
object[]

Parcelas de recebimento da nota fiscal. Se não informadas, são geradas automaticamente conforme a condição de pagamento.

redeIdentificadorTID
string | null

Identificador da transação (TID) da Rede, para conciliação de pagamentos com cartão.

redeIdentificadorNSU
string | null

Número Sequencial Único (NSU) da Rede, para conciliação de pagamentos com cartão.

Response

Sucesso.

success
boolean
Example:

true

data
object

Nota Fiscal de Serviço (NFS-e). Campos obrigatórios: codigoDaFilial, codigoDaNotaFiscal, codigoDoMunicipioDePrestacaoDoServico (dispensável apenas para clientes no exterior), codigoDaFormaDePagamento (deve existir), descricaoDoServico e valorDoServico (>= 0).