TF Fiscal

APIs principais

Empresas

7 endpoints

POST/api/company/create

Cadastrar nova empresa emissora

Cadastra uma empresa emissora vinculada a uma conta de distribuidor (b2b). Use este endpoint quando os dados da empresa já estão disponíveis. Para extração automática a partir do certificado digital, use /api/company/v2/create.

Headers obrigatórios

HeaderTipoDescrição
tokenstringToken do distribuidor (b2b — a conta precisa ter isb2b=true)
signstringAssinatura MD5
timestampstringUnix timestamp em segundos

Body

CampoTipoDescrição
Identificação
cnpj *stringCNPJ da empresa emissora
name *stringRazão social
ie *stringInscrição Estadual
invoice_type *stringRegime tributário (ex.: "simples_nacional", "normal")
unit *stringTipo de unidade
emailstringE-mail da empresa
Endereço
cep *stringCEP
address *stringLogradouro
house_number *stringNúmero do endereço
town *stringBairro
city *stringMunicípio
state *stringUF (sigla do estado)
Certificado digital
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
Numeração e configurações
serie *intSérie da NF-e
number *intNúmero inicial da numeração
Transporte (MDF-e / CT-e / DC-e)
serie_mdfeintSérie do MDF-e
number_mdfeintNúmero inicial do MDF-e (onde a numeração começa)
serie_cteintSérie do CT-e
number_cteintNúmero inicial do CT-e (onde a numeração começa)
serie_dceintSérie da DC-e
number_dceintNúmero inicial da DC-e (onde a numeração começa)
Comunicação (NFCom)
serie_nfcomintSérie da NFCom
number_nfcomintNúmero inicial da NFCom (onde a numeração começa)
Energia (NF3e)
serie_nf3eintSérie da NF3e
number_nf3eintNúmero inicial da NF3e (onde a numeração começa)
is_create_category_templatebooleanCria categorias fiscais padrão automaticamente. Default: true

* Campo obrigatório.

POST/api/company/v2/create

Cadastrar empresa via certificado

Versão simplificada de /api/company/create: a API valida o certificado digital e extrai automaticamente razão social, IE, endereço e demais dados via consulta interna. Apenas cnpj, cert_content e cert_pwd são obrigatórios.

Headers obrigatórios

HeaderTipoDescrição
tokenstringToken do distribuidor (b2b — a conta precisa ter isb2b=true)
signstringAssinatura MD5
timestampstringUnix timestamp em segundos

Body

CampoTipoDescrição
cnpj *stringCNPJ da empresa emissora
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
is_create_category_templatebooleanCria categorias fiscais padrão automaticamente. Default: true

* Campo obrigatório.

POST/api/company/edit

Editar dados da empresa

Atualiza dados da empresa emissora. Envie apenas os campos que deseja alterar — todos exceto company_id são opcionais. CNPJ é imutável: tentar enviá-lo retorna erro. Ao atualizar cep, o sistema resolve automaticamente stateCode e ibge. Quando cert_content e cert_pwd vêm juntos, o certificado é validado antes de salvar.

A empresa é criada com a configuração de NF-e (via /api/company/create). Para habilitar os demais documentos, complete o cadastro por aqui: este endpoint também aceita os campos de NFC-e, NFS-e, MDF-e, CT-e e DC-e (ver seções abaixo). Envie apenas os campos do(s) documento(s) que a empresa vai emitir.

Headers obrigatórios

HeaderTipoDescrição
tokenstringToken da empresa
signstringAssinatura MD5
timestampstringUnix timestamp em segundos

Body

CampoTipoDescrição
company_id *stringID da empresa a editar
namestringRazão social
invoice_typestringRegime tributário
iestringInscrição Estadual
unitstringTipo de unidade
emailstringE-mail
cepstringCEP (atualiza stateCode e ibge automaticamente)
addressstringLogradouro
house_numberstringNúmero
townstringBairro
citystringMunicípio
statestringUF
cert_contentstringConteúdo do arquivo do certificado A1 (.pfx/.p12) em Base64
cert_filestringDescontinuado — rejeitado a partir de 2026-09-01. URL HTTPS do certificado
cert_pwdstringNova senha do certificado
serieintNova série da NF-e
numberintNovo número inicial da NF-e
aliasstringNome fantasia
telefonestringTelefone
complementostringComplemento do endereço
NFC-e
csc_idstringID do CSC (Código de Segurança do Contribuinte) no Fisco
cscstringToken CSC (segredo compartilhado com o Fisco)
serie_nfceintSérie da NFC-e
number_nfceintPróximo número da NFC-e
NFS-e
imstringInscrição Municipal
codigo_municipio_nfsestringCódigo IBGE do município emissor
codigo_servico_nfsestringCódigo do serviço padrão (LC 116)
cnae_nfsestringCNAE da atividade padrão
serie_nfseintSérie da NFS-e
number_nfseintPróximo número da NFS-e
regime_especial_tributacaointCódigo do regime especial de tributação
optante_simples_nacionalboolOptante pelo Simples Nacional
Transporte (MDF-e / CT-e / DC-e)
serie_mdfeintSérie do MDF-e
number_mdfeintNúmero inicial do MDF-e (onde a numeração começa)
serie_cteintSérie do CT-e
number_cteintNúmero inicial do CT-e (onde a numeração começa)
serie_dceintSérie da DC-e
number_dceintNúmero inicial da DC-e (onde a numeração começa)
Comunicação (NFCom)
serie_nfcomintSérie da NFCom
number_nfcomintNúmero inicial da NFCom (onde a numeração começa)
Energia (NF3e)
serie_nf3eintSérie da NF3e
number_nf3eintNúmero inicial da NF3e (onde a numeração começa)

* Campo obrigatório. Enviar cnpj retorna erro. Todos os demais campos são opcionais — envie só os que quiser alterar.

GET/api/company/get_list

Listar empresas do distribuidor

Lista, com paginação, as empresas emissoras vinculadas à conta de distribuidor (b2b). Parâmetros via query string.

Headers obrigatórios

HeaderTipoDescrição
tokenstringToken do distribuidor (b2b — a conta precisa ter isb2b=true)
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–20)

* Campo obrigatório.

GET/api/company/get_detail

Detalhes da empresa autenticada

Retorna os dados completos da empresa identificada pelo header token, incluindo a lista de categorias fiscais cadastradas. Não aceita body nem query string.

Headers obrigatórios

HeaderTipoDescrição
tokenstringToken da empresa
signstringAssinatura MD5
timestampstringUnix timestamp em segundos
GET/api/company/get_cep_detail

Consultar endereço por CEP

Resolve um CEP brasileiro retornando UF, código IBGE do município e dados do endereço. Útil para preencher endereços de empresas e clientes. Requer conta de distribuidor (b2b).

Headers obrigatórios

HeaderTipoDescrição
tokenstringToken do distribuidor (b2b — a conta precisa ter isb2b=true)
signstringAssinatura MD5 (path inclui a query string)
timestampstringUnix timestamp em segundos

Query string

ParâmetroTipoDescrição
cep *stringCEP brasileiro (8 dígitos, com ou sem traço)

* Campo obrigatório.

GET/api/company/get_export_invoice_month_files

Listar exportações mensais

Retorna a lista de arquivos de exportação mensal que já foram gerados para a empresa no ano corrente (timezone America/Sao_Paulo). Cada mês pode ter até 4 arquivos: 1 planilha Excel (apenas status Success) + 3 XMLs (por status Success, Canceled e Voided). Apenas arquivos efetivamente exportados aparecem no retorno — use /api/invoice/get_xml para gerar novos.

Headers obrigatórios

HeaderTipoDescrição
tokenstringToken da empresa
signstringAssinatura MD5
timestampstringUnix timestamp em segundos

Resposta

CampoTipoDescrição
files[]arrayLista de arquivos disponíveis
files[].urlstringURL do arquivo no OSS
files[].yearintAno do período
files[].monthstringMês (1–12)
files[].typestringTipo do arquivo: "xlsx" ou "xml"
files[].statusstringStatus das notas no arquivo: "Success", "Canceled" ou "Voided"
files[].createdatetimeQuando o arquivo foi gerado