API/Tutoriais


API para Consultar empresa
  • Endpoints
    POST https://tffiscal.com.br/api/consultar_empresa
            POST https://tffiscal.com.br/api/consultar_empresa

         const data = {
                'tipo_pesquisa': 'razao_social',

                'token_plataforma': 'xxxxxxxxxxxxxxxxxxxxx',
                'search': 'TF FISCAL'
                      };
            
            - É permitido apenas um token, se colocar o token da empresa, não pode colocar o token da plataforma e vice-versa.
            - 'tipo_pesquisa': Indica o tipo de pesquisa que será realizada. Neste caso, o valor é 'razao_social', o que sugere que a pesquisa será feita com base na razão social de uma empresa
                e tipos da pesquisa que pode ser usados são: nome, razao_social e cnpj da empresa.

            - 'token_plataforma': É um token de autenticação da plataforma. Esse token é usado para verificar a identidade da plataforma que está sendo acessada.
            - 'search': É o termo de pesquisa que será utilizado para encontrar informações sobre uma empresa. Neste caso, o valor é 'TF FISCAL'.
API para Desativar empresa
  • Endpoints
    POST https://tffiscal.com.br/api/desativar_empresa
            POST https://tffiscal.com.br/api/desativar_empresa

         const data ={
                'cnpj': 'xxxxxxx',

                'token_plataforma': 'xxxxxxxxxxxxxxxxxxxxx',
            };
            

                 - 'cnpj': CNPJ (Cadastro Nacional de Pessoa Jurídica) da empresa que será desativada. 

                 - 'token_plataforma': É um token de autenticação da plataforma. Esse token é usado para verificar a identidade da plataforma que está sendo acessada.
API para Alterar empresa
  • Endpoints
    POST https://tffiscal.com.br/api/alterar_empresa
    Importante: As informações da empresa serão alteradas com base no certificado
            POST https://tffiscal.com.br/api/alterar_empresa

         const data = {
                "api_completa": true,
                 "token_empresa": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
                "token_plataforma": "xxxxxxxxxxxxxxxxxxxxx",




                "username": "",
                "email": "",


                "ie": "133011581111",
                "numero_serie_nfe":"",



                "certificado": "",
                 "senha_certificado": "",
                "certificado_via_link":false,
                "ultimo_numero_nfe": 600,
                "ultimo_numero_nfce": 1,
                "ultimo_numero_cte": 1,
                "ultimo_numero_mdfe": 1,
                "inscricao_municipal": "1",
                "numero_serie_nfe": "4",
                "numero_serie_nfce": 1,
                "numero_serie_cte": 1,
                "numero_serie_mdfe": 1,
                "regime":1,

                                      };
            


          - "ie": Representa o número de Inscrição Estadual da empresa. 

          - "username": Representa o nome de usuário para a conta associada à empresa. 
          - "email": Representa o endereço de e-mail associado à empresa. 

          - "token_plataforma": Representa o token da plataforma para fins de envio. 
          - "ie": Representa o número de Inscrição Estadual da empresa. 
          - "inscricao_municipal": Inscrição municipal (para empresas). 

             - "numero_serie_nfe": Número de série para NF-e (Nota Fiscal Eletrônica).


            - "certificado": Refere-se a um arquivo de certificado. Este campo espera um arquivo como entrada, em vez de um valor de texto.
            - "senha_certificado": Representa a senha associada ao certificado.
            - "certificado_via_link": Indica se o certificado será enviado via link.
            - "ultimo_numero_nfce": Último número utilizado para NFC-e (Nota Fiscal do Consumidor Eletrônica).
            - "ultimo_numero_cte": Último número utilizado para CT-e (Conhecimento de Transporte Eletrônico).
            - "ultimo_numero_mdfe": Último número utilizado para MDF-e (Manifesto Eletrônico de Documentos Fiscais).

            - "numero_serie_nfce": Número de série para NFC-e.
            - "numero_serie_cte": Número de série para CT-e.
            - "numero_serie_mdfe": Número de série para MDF-e.
 - regime: (1 para Simples e 3 para Normal).
API para Alterar Natureza de Operação
  • Endpoints
    POST https://tffiscal.com.br/api/modificar_natureza_api
            POST https://tffiscal.com.br/api/modificar_natureza_api

            const data = {
                "token_empresa": "xxxxxxxxxxxxxxxxxxxxxyvh9lwpghwjnudk6vg2n",
                "natureza": "5102",
                "cfop_entrada_estadual": "1102",
                "cfop_entrada_inter_estadual": "2102",
                "cfop_saida_estadual": "5102",
                "cfop_saida_inter_estadual": "6102",
                "sobrescreve_cfop": "10",
                "bonificacao": "111",
                "tipo": "10",
                "finNFe": "1",

                "id": 61
            };
            
            - natureza: Código da natureza da operação. 
            - cfop_entrada_estadual: Código CFOP para entrada estadual. 
            - cfop_entrada_inter_estadual: Código CFOP para entrada interestadual. 
            - cfop_saida_estadual: Código CFOP para saída estadual. 
            - cfop_saida_inter_estadual: Código CFOP para saída interestadual. 
            - sobrescreve_cfop: Sobrescreve o CFOP. 
            - bonificacao: Código de bonificação. 
            - tipo: Tipo de natureza da operação. 
            - finNFe: Finalidade da NFe. 
            - token_empresa: Token da empresa. 
            - id: ID da natureza da operação.
API para Cadastrar Clientes:
  • Endpoints
    POST https://tffiscal.com.br/api/cadastrar_cliente
            POST https://tffiscal.com.br/api/cadastrar_cliente

            const data = {
                                
                "token_empresa":"jlsjsjlfsjdjlksdjl",
                "type": "customer",
                "cpf_cnpj": "9030340",
                "ie_rg": "9030445",
                "city_id": "3732",
                "rua": "sadfas",
                "numero":"1489",
                "bairro":"asdas" ,
                "cep": "11111-090",
                "name": "exemplo exemplo",
                "state":"SP",
                "country":"Brasil",
                "mobile":"18997211111",
                "email":"[email protected]",

                                    };
            
                        - só é permitido um token, se colocar o token da empresa, não pode colocar o token da plataforma e vice-versa.

            - "token_empresa": Token para autenticação na empresa. 

            - "type": Tipo de fornecedor, 
            - "cpf_cnpj": CPF ou CPNJ do Cliente ligado a empresa, 
            - "ie_rg": Identificação do registro do Cliente, 
            - "city_id": Identificação da cidade do cliente, 
            - "rua": Rua do cliente, 
            - "numero":Número da casa do cliente, 
            - "bairro": Bairro onde o cliente mora, 
            - "cep": Cep do estado relacionado cliente, 
            - "name": Nome do cliente, 
            - "state": Estado do cliente, 
            - "uf": UF do estado do cliente exemplo SP, 
            - "country": Pais do cliente, 
            - "email": Email do cliente,
            - "mobile": Telefone,
API para Cadastrar Produtos
  • Endpoints
    POST https://tffiscal.com.br/api/cadastrar_produto
    •                 POST https://tffiscal.com.br/api/cadastrar_produto
    
             const data = {
                    "api_completa": true,
                     "token_empresa": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",

                     "name":"aaa aa",

                     "type":"single",
                     "sub_unit_ids":null,
                     "alert_quantity":"0.0000",
                     "barcode_type":"C128",
                     "created_by":4,
                     "is_inactive":"0",
                     "not_for_selling":"0",
                     "perc_icms":"0.00",
                     "cfop_interno":"1102",
                     "cfop_externo":"6102",
                    "ncm":"4407.11.00",
                    "valor_partida":"10.0000",
                    "tipo":"normal",
                     "veicProd":"",
                     "tpOp":"1",
                    "cst_pis":"49",
                     "cst_cofins":"49",
                     "cst_ipi":"99",
                    
                };
                    
                 - É permitido apenas um token, se colocar o token da empresa, não pode colocar o token da plataforma e vice-versa.
                 - token_empresa: É o token da empresa usado para autenticação. 

                 - name: É o nome do produto. 
                 - co_ped_cliente_api: É o número do pedido do cliente. 

                 - type: Indica o tipo de produto. Neste caso, é "single" (único). 
                 - sub_unit_ids: São os IDs das subunidades do produto, se houver. Neste caso, é nulo. 
                 - alert_quantity: É a quantidade de alerta para o produto. Neste caso, é "0.0000". 
                 - barcode_type: Indica o tipo de código de barras usado para o produto. Neste caso, é "C128". 
                 - created_by: É o ID do usuário que criou o produto. 
                 - is_inactive: Indica se o produto está inativo. Neste caso, é "0" (ativo). 
                 - not_for_selling: Indica se o produto não está disponível para venda. Neste caso, é "0" (disponível para venda). 
                 - perc_icms, perc_pis, perc_cofins, perc_ipi: São as porcentagens de impostos aplicadas ao produto. 
                 - cfop_interno: É o CFOP (Código Fiscal de Operações e Prestações) interno do produto. 
                 - cfop_externo: É o CFOP externo do produto. 
                 - ncm: É o NCM (Nomenclatura Comum do Mercosul) do produto. 
                 - valor_partida: É o valor de partida do produto. 
                 - tipo: Indica o tipo do produto. Neste caso, é "normal". 
                 - veicProd: É um campo relacionado a produtos de veículos, se houver. Neste caso, é vazio. 
                 - tpOp: É o tipo de operação relacionada a produtos de veículos.
    • API para Gerar uma Venda
      Endpoints
      POST https://tffiscal.com.br/api/gerar_venda
                POST https://tffiscal.com.br/api/gerar_venda
    
                const data = {
                                                                "token_empresa": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
                                "payment": [{
                                  "amount": 3.00,
                                  "method": "cash",
                                  "note": "",
                                  "vencimento": "15/07/2023",
                                  "card_type": "master"
                                                                    }],
                                "products":[
                                {"product_id":"91","quantity":"1,00"},
                                {"product_id":"90","quantity":"1,00"}
                                ],
                                "status": "pending",
                                "change_return": "",
                                "final_total": 10.00,
                                "contact_id": 68,

                "natureza_id": 3,
                                "enviar_email_para_cliente":true,
                                
                            };
                

               - token_empresa: O token da empresa para autenticação. 
               - "payment": Uma lista de pagamentos feitos para a transação. Cada pagamento tem os seguintes campos:
               - "amount": Valor do pagamento. 
               - "method": Método de pagamento. 
               - "note": Observação. 
               - "vencimento": Data de vencimento. 
               - "card_type": Tipo de cartão. 
             - "products": Uma lista de produtos vendidos. Cada produto tem os seguintes campos:
              - "product_id": ID do produto.
              - "quantity": Quantidade do produto.
               - "status": Status da transação (pendente). 
              - "status": Status da transação (pendente). 
              - "change_return": Valor do troco. 
              - "final_total": Valor total final. 
              - "contact_id": ID do contato. 

              - "enviar_email_para_cliente": É para enviar email ao cliente no momento que gera nota fiscal?. 
              - "natureza_id": ID da natureza.
    API para Emitir Nota:
  • Endpoints
    POST https://tffiscal.com.br/api/emitirnfe
    •             POST https://tffiscal.com.br/api/emitirnfe
    
         const data = {

                        "id": 174,

                        "token_empresa": "xxxxxxxxxxxxxxxxxxxxxb1n7054xxjgavfueunws",
                        "excluir_clientes_produtos_pos_emissao":false
                        }
                

             -id: O ID da transação da nota fiscal a ser emitida. 

             -token_empresa: O token da empresa para autenticação. 
             -excluir_clientes_produtos_pos_emissao: É para excluir clientes e produtos após a emissão da nfe(Nota fiscal eletrônica) por completa.
    API para Listar Notas:
  • Endpoints
    POST https://tffiscal.com.br/api/listarnotas
    •             POST https://tffiscal.com.br/api/listarnotas
    
         const data = {                
                
                                        "token_empresa": "xxxxxxxxxxxxxxxxxxxxxb1n7054xxjgavfueunws",
                        "data_inicio":"2020-06-05",
                        "data_final":"2024-06-05"
                        }
                                    
                    
                                 -token_empresa: O token da empresa para autenticação. 
             -data_inicio: Data de início da pesquisa. 
             -data_final: Data final da pesquisa.
    API para Cancelar Nota:
  • Endpoints
    POST https://tffiscal.com.br/api/cancelar_nota
    •             POST https://tffiscal.com.br/api/cancelar_nota
    
         const data = {                
                
                                            "transaction_id": 182,
                            "justificativa": "Nãão quis mais essa nota gerada",

                            "token_empresa": "xxxxxxxxxxxxxxxxxxxxxb1n7054xxjgavfueunws",
                            "enviar_email_para_cliente":true
                        }
                                    
                    
                                 -transaction_id: O ID da transação da nota fiscal a ser cancelada. 
             -justificativa: A justificativa para o cancelamento da nota fiscal. 
             -token_empresa: O token da empresa para autenticação. 
             -enviar_email_para_cliente: É para enviar email ao cliente.
    API para Corrigir Nota com CCE:
  • Endpoints
    POST https://tffiscal.com.br/api/corrigir_cce
    • POST https://tffiscal.com.br/api/corrigirCce_api
    
const data = {
    "id": 123,
    "justificativa": "Correção na descrição do produto para incluir mais detalhes.",
    "token_empresa": "xxxxxxxxxxxxxxxxxxxxxb1n7054xxjgavfueunws",
"name_dev": "dev",
    "email_dev": "[email protected]"
    "descricao_produto": "Nova descrição com detalhamento técnico conforme cliente",
    "dados_complementares": "Observação importante incluída na nota fiscal",
    "codigo_interno_produto": "REF-8891B",
    "placa_veiculo": "ABC1234",
    "transportadora_nome": "Transportadora Sul Minas",
    "transportadora_uf": "SP",
    "transportadora_cidade": "Campinas",
    "transportadora_ie": "111111111111",
    "transportadora_cpf_cnpj": "12345678000199",
    "razao_social_destinatario": "Cliente XPTO Ltda",
    "telefone_destinatario": "(11) 99999-8888",
    "email_destinatario": "[email protected]",
    "endereco_numero": "456",
    "endereco_complemento": "Fundos",
    "endereco_cep": "13025-120",
    "numero_fatura": "FAT-2025-003",
    "duplicata_numero": "DUP123456"
}
    

 -id: O ID da nota fiscal (transação) que será corrigida. 
 -justificativa: Texto com a correção a ser registrada na CCE. 
 -token_empresa: Token da empresa para autenticação. 
 -name_dev: (opcional) Nome do desenvolvedor que está integrando. 
 -email_dev: (opcional) E-mail para registro de log e rastreabilidade. 

 -descricao_produto: Novo texto descritivo do produto (sem alterar valores). 
 -dados_complementares: Texto adicional a ser incluído na nota. 
 -codigo_interno_produto: Referência interna do produto para ajustes cadastrais. 
 -placa_veiculo: Placa do veículo de transporte. 
 -transportadora_nome: Nome da transportadora. 
 -transportadora_uf: UF da transportadora. 
 -transportadora_cidade: Cidade da transportadora. 
 -transportadora_ie: Inscrição estadual da transportadora. 
 -transportadora_cpf_cnpj: CPF ou CNPJ da transportadora. 
 -razao_social_destinatario: Correção leve no nome da empresa do destinatário. 
 -telefone_destinatario: Correção no telefone de contato. 
 -email_destinatario: Correção no e-mail de contato. 
 -endereco_numero: Correção no número do endereço. 
 -endereco_complemento: Correção no complemento do endereço. 
 -endereco_cep: Correção no CEP, desde que não altere cidade ou UF. 
 -numero_fatura: Número da fatura vinculada à nota. 
 -duplicata_numero: Número de duplicata para cobrança.
    API para Inutilizar Numeração de Nota Fiscal:
  • Endpoints
    POST https://tffiscal.com.br/api/inutilizar_nfe
    • POST https://tffiscal.com.br/api/inutilizar_nfe
const data = {
    "serie": 1,
    "numero_inicial": 101,
    "numero_final": 105,
    "justificativa": "Documentos não emitidos por erro operacional",
    "token_empresa": "xxxxxxxxxxxxxxxxxxxxxb1n7054xxjgavfueunws"
}


- serie: Número da série da nota fiscal a ser inutilizada. 
- numero_inicial: Número inicial da faixa a ser inutilizada. 
- numero_final: Número final da faixa a ser inutilizada. 
- justificativa: Motivo da inutilização (mínimo 15, máximo 90 caracteres). 
- token_empresa: O token da empresa para autenticação.
    API para Registrar Evento de Insucesso na Entrega (NF-e):
  • Endpoints
    POST https://tffiscal.com.br/api/registrar_insucesso_entrega
    • POST https://tffiscal.com.br/api/registrar_insucesso_entrega
    
const data = {
    "chave_nfe": "35190112345678000123550010000000011234567890",
    "motivo": "Destinatário ausente no local de entrega",
    "token_empresa": "xxxxxxxxxxxxxxxxxxxxxb1n7054xxjgavfueunws"
}
    
- chave_nfe: A chave de acesso da nota fiscal eletrônica (44 dígitos). 
- motivo: Motivo pelo qual a entrega da carga não foi concluída. 
- token_empresa: O token da empresa para autenticação.
    API para Consultar Nota:
  • Endpoints
    POST https://tffiscal.com.br/api/consultar_nota
    •             POST https://tffiscal.com.br/api/consultar_nota
    
         const data = {

                                
                
                                            "co_ped_cliente_api": "xxxxxxxxxx",
                            "token_empresa": "xxxxxxxxxxxxxxxxxxxxxb1n7054xxjgavfueunws"
                        }
                                    
                    
                                  -co_ped_cliente_api: O número do pedido do cliente associado à nota fiscal. 
              -token_empresa: O token da empresa para autenticação.
    Modelos Fiscais:
    ATENÇÃO: Os modelos fiscais são baseados em IA do uso comum de várias empresas e projetos. Por favor confira com seu contador ou time administrativo contábil o uso do mesmo. Não nos responsabilizamos pelo uso imperito de um modelo. Att. TFfiscal
    Id Descrição CFOP Saída Estadual CFOP Entrada Estadual CFOP Saída Interestadual CFOP Entrada Interestadual
    1 Venda Fisica 5199 1199 6100 2100
    10 Venda Fisica 5102 5102 6108 6108
    18 Venda interestadual Juridica 5102 1102 6102 1102
    Feedbacks de Erros:
    Descrição Solução
    Rejeição:Inscrição estadual do emitente invalida! Por favor consulte via API ou pelo console Consulte via API ou pelo console
    Rejeição: Emissor não habilitado para emissão da NF-e, com o CNPJ consulte no Sintegra a situação da empresa com a Recieta Federal ou se possui alguma pendencia no Sefaz Consulte no Sintegra a situação da empresa com a Recieta Federal ou se possui alguma pendencia no Sefaz
    Duplicidade de NF-e, mude o ultimo numero de nota emitida Mude o ultimo numero de nota emitida via console ou API
    Token invalido Token invalido, por favor verifique o token da empresa
    Resposta vazia Resposta vazia, por favor verifique os dados enviados se esta no formato certo o json, se a codificação esta utf8 ou entre em contato com o Suporte