TF Fiscal

APIs principais

NFS-e

6 endpoints

A API de NFS-e permite emitir, cancelar e consultar Notas Fiscais de Servico Eletronicas. O sistema detecta automaticamente o municipio da empresa e roteia para a API correta:

  • Sao Paulo (SP) - Emissao via Nota Fiscal Paulistana (SOAP)
  • Demais municipios - Emissao via API Nacional (ADN/SEFIN)

O integrador nao precisa se preocupar com qual API usar - basta enviar os dados e o sistema faz o roteamento automaticamente pelo codigo IBGE do municipio cadastrado na empresa.

EndpointMetodoDescricao
/api/nfse/createPOSTEmitir NFS-e
/api/nfse/cancelPOSTCancelar NFS-e
/api/nfse/get_danfsePOSTObter DANFSE (PDF)
/api/nfse/get_xmlPOSTDownload do XML
POST/api/nfs/company/create

Cadastrar empresa NFS-e

Cadastra (ou atualiza) uma empresa para emissão de NFS-e. Se o CNPJ já existir para o usuário, apenas os campos NFS-e e o certificado são atualizados; caso contrário, uma nova empresa é criada e um token dedicado é retornado. Atenção ao path: /api/nfs/... (sem o "e"), diferente dos demais endpoints NFS-e.

Headers obrigatórios

HeaderTipoDescrição
tokenstringToken B2B do integrador
signstringAssinatura MD5
timestampstringUnix timestamp em segundos

Body

CampoTipoDescrição
cnpj *stringCNPJ da empresa (apenas dígitos)
name *stringRazão social
cep *stringCEP (apenas dígitos)
address *stringLogradouro
house_number *stringNúmero do endereço
town *stringBairro
city *stringCidade
state *stringUF (2 dígitos, ex.: "SP")
cert_content *stringConteúdo do arquivo do certificado A1 (.pfx/.p12) em Base64
cert_filestringDescontinuado — rejeitado a partir de 2026-09-01. URL HTTPS do certificado
cert_pwd *stringSenha do certificado digital
im *stringInscrição Municipal
codigo_municipio_nfse *stringCódigo IBGE do município emissor
codigo_servico_nfse *stringCódigo do serviço padrão (LC 116)
aliasstringNome fantasia
iestringInscrição estadual
invoice_typestringRegime tributário
unitstringUnidade / filial
emailstringE-mail de contato
telefonestringTelefone
complementostringComplemento do endereço
cnae_nfsestringCNAE da atividade padrão
serie_nfseintSérie inicial da NFS-e
number_nfseintNúmero inicial da NFS-e
regime_especial_tributacaointCódigo do regime especial de tributação
optante_simples_nacionalboolOptante pelo Simples Nacional

* Campo obrigatório.

Nota: O token retornado deve ser usado nas demais chamadas NFS-e (/api/nfse/create, /cancel, /get_danfse, /get_xml). Se a empresa já existir, a mensagem será "Empresa atualizada para NFS-e" e o token retornado é o token existente.

POST/api/nfse/create

Emitir NFS-e

Headers obrigatorios

HeaderTipoDescricao
tokenstringToken da empresa
signstringAssinatura MD5: MD5(token + path + body + timestamp)
timestampstringUnix timestamp em segundos (janela de 5 minutos)

Campos Principais

CampoTipoDescricao
ambientestring"1" = Producao, "2" = Homologacao
idstringID de referencia externa (opcional)
descricao_servicostringDescricao do servico prestado (obrigatorio)
valor_servicodecimalValor total do servico em R$ (obrigatorio)
aliquota_issdecimalAliquota ISS em % (ex: 2.90)
iss_retidobooleanfalse = Nao retido, true = Retido pelo tomador
valor_issdecimalOverride do valor do ISS. Se maior que 0, sobrepoe o calculo automatico (base_calculo x aliquota_iss div 100). Default: calculado automaticamente
codigo_servicostringCodigo do servico. Se vazio, usa o padrao da empresa
cnaestringCNAE. Se vazio, usa o padrao da empresa
tomadorobjectDados do tomador do servico (obrigatorio)

Tomador - Campos

CampoTipoDescricao
cnpjstringCNPJ do tomador (somente numeros)
cpfstringCPF do tomador (usar cnpj OU cpf)
namestringNome/Razao Social (obrigatorio)
emailstringEmail do tomador
telefonestringTelefone
cepstringCEP (obrigatorio)
enderecostringLogradouro (obrigatorio)
numerostringNumero (obrigatorio)
complementostringComplemento
bairrostringBairro (obrigatorio)
citystringCidade
ufstringUF (2 digitos)
codigo_municipiostringCodigo IBGE do municipio
POST/api/nfse/cancel

Cancelar NFS-e

Headers obrigatorios

HeaderTipoDescricao
tokenstringToken da empresa
signstringAssinatura MD5
timestampstringUnix timestamp em segundos

Campos

CampoTipoDescricao
chavestringCodigo de verificacao da NFS-e (obrigatorio)
motivostringMotivo do cancelamento (obrigatório; no padrão Nacional deve ter de 15 a 255 caracteres)
c_motivostringCódigo de justificativa do cancelamento (opcional, padrão Nacional): "1" = Erro na emissão (padrão), "2" = Serviço não prestado, "9" = Outros
POST/api/nfse/get_danfse

Obter PDF da NFS-e

Headers obrigatorios

HeaderTipoDescricao
tokenstringToken da empresa
signstringAssinatura MD5
timestampstringUnix timestamp em segundos

Campos

CampoTipoDescricao
chavestringCodigo de verificacao da NFS-e (obrigatorio)

Nota: Para Paulistana (SP), retorna a URL direta do PDF da prefeitura. Para API Nacional, retorna o PDF em base64.

POST/api/nfse/get_xml

Download XML da NFS-e

Headers obrigatorios

HeaderTipoDescricao
tokenstringToken da empresa
signstringAssinatura MD5
timestampstringUnix timestamp em segundos

Campos

CampoTipoDescricao
chavestringCodigo de verificacao da NFS-e (obrigatorio)

dpsXml: Link (URL no OSS) do XML enviado para a prefeitura/ADN. nfseXml: Link do XML de retorno com o resultado da emissao. Os XMLs sobem ao OSS na primeira consulta e a URL fica em cache.

GET/api/nfse/get_list

Listar NFS-e (com paginação)

Lista as NFS-e da empresa com paginação. Parâmetros passados via query string (não no body). O filtro de tempo é opcional, mas se enviado exige ambos start_create_time e end_create_time.

Headers obrigatórios

HeaderTipoDescrição
tokenstringToken da empresa emissora
signstringAssinatura MD5 (path inclui a query string)
timestampstringUnix timestamp em segundos

Query string

ParâmetroTipoDescrição
page *intNúmero da página (≥ 1)
page_size *intTamanho da página (1–50)
start_create_timelongUnix timestamp em milissegundos — início (exige end_create_time)
end_create_timelongUnix timestamp em milissegundos — fim
statusstringFiltrar por status. Valores: "autorizada", "cancelada", "pendente", "rejeitada"

* Campo obrigatório.