API para Cadastrar uma empresa
-
Endpoints
POST https://tffiscal.com.br/api/cadastrar_empresa
POST https://tffiscal.com.br/api/cadastrar_empresa
const data =
{
"api_completa": true,
"token_plataforma": "xxxxxxxxxxxxxxxxxxxxx",
"name": "empresa2",
"first_name": "Exemplo",
"username": "aaaa",
"email": "[email protected]",
"password": "88900",
"time_zone": "11",
"landmark": "nenhum",
"surname": "asdfs",
"last_name": "Teste",
"start_date": "2023-09-13",
"tax_number_1": null,
"tax_label_1": null,
"tax_number_2": null,
"tax_label_2": null,
"default_sales_tax": null,
"default_profit_percent": 25,
"fy_start_month": 1,
"accounting_method": "fifo",
"default_sales_discount": null,
"sell_price_tax": "includes",
"logo": null,
"sku_prefix": null,
"enable_product_expiry": 0,
"expiry_type": "add_expiry",
"on_product_expiry": "keep_selling",
"stop_selling_before": 0,
"enable_tooltip": 1,
"purchase_in_diff_currency": 0,
"purchase_currency_id": null,
"p_exchange_rate": "1.000",
"transaction_edit_days": 30,
"stock_expiry_alert_days": 30,
"keyboard_shortcuts": "{\"pos\":{\"express_checkout\":\"shift+e\",\"pay_n_ckeckout\":\"shift+p\",\"draft\":\"shift+d\",\"cancel\":\"shift+c\",\"edit_discount\":\"shift+i\",\"edit_order_tax\":\"shift+t\",\"add_payment_row\":\"shift+r\",\"finalize_payment\":\"shift+f\",\"recent_product_quantity\":\"f2\",\"add_new_product\":\"f4\"}}",
"pos_settings": null,
"weighing_scale_setting": null,
"manufacturing_settings": null,
"enable_brand": 1,
"enable_category": 1,
"enable_sub_category": 1,
"enable_price_tax": 1,
"enable_purchase_status": 1,
"enable_lot_number": 0,
"default_unit": null,
"enable_sub_units": 0,
"enable_racks": 0,
"enable_row": 0,
"enable_position": 0,
"enable_editing_product_from_purchase": 1,
"sales_cmsn_agnt": null,
"item_addition_method": 1,
"enable_inline_tax": 0,
"currency_symbol_placement": "before",
"enabled_modules": [
"purchases",
"add_sale",
"pos_sale",
"stock_transfers",
"stock_adjustment",
"expenses",
"revenues"
],
"date_format": "d\/m\/Y",
"time_format": "24",
"natureza_id": 1,
"ref_no_prefixes": {
"purchase": "PO",
"stock_transfer": "ST",
"stock_adjustment": "SA",
"sell_return": "CN",
"expense": "EP",
"contacts": "CO",
"purchase_payment": "PP",
"sell_payment": "SP",
"business_location": "BL"
},
"theme_color": null,
"created_by": null,
"enable_rp": 0,
"rp_name": null,
"amount_for_unit_rp": "1.0000",
"min_order_total_for_rp": "1.0000",
"max_rp_per_order": null,
"redeem_amount_per_unit_rp": "1.0000",
"min_order_total_for_redeem": "1.0000",
"min_redeem_point": null,
"max_redeem_point": null,
"rp_expiry_period": null,
"rp_expiry_type": "year",
"repair_settings": null,
"email_settings": null,
"sms_settings": null,
"custom_labels": null,
"common_settings": null,
"perc_icms_padrao": "0.00",
"perc_pis_padrao": "0.00",
"perc_cofins_padrao": "0.00",
"perc_ipi_padrao": "0.00",
"cfop_saida_estadual_padrao": "",
"cfop_saida_inter_estadual_padrao": "",
"csc": "1",
"csc_id": "1",
"aut_xml": "",
"certificado_urn": "",
"casas_decimais_valor": 2,
"created_at": "2023-09-13T17: 43: 34.000000Z",
"updated_at": "2023-09-13T17: 43: 34.000000Z",
"bus_metodo": 1,
"bus_is_master": 0,
"bus_id_master": 0,
"cidade_id": null,
"bus_nome_envio_api": "",
"ncm_padrao": "",
"cst_csosn_padrao": 101,
"cst_cofins_padrao": 49,
"cst_pis_padrao": 49,
"cst_ipi_padrao": 99,
"ie": "133011581111",
"senha_certificado": "1234",
"certificado": "",
"certificado_via_link":false,
"telefone": "00 00000-0000",
"ultimo_numero_nfe": 0,
"ultimo_numero_nfce": 1,
"ultimo_numero_cte": 0,
"ultimo_numero_mdfe": 1,
"inscricao_municipal": "1",
"numero_serie_nfe": 1,
"numero_serie_nfce": 1,
"numero_serie_cte": "1",
"numero_serie_mdfe": "1",
};
- username: Nome de usuário da empresa.
- email: Email da empresa.
- password: Senha da empresa.
- surname: Sobrenome da empresa.
- last_name: Último nome da empresa.
- start_date: Data de início.
- tax_number_1: Número de imposto 1.
- tax_label_1: Rótulo de imposto 1.
- tax_number_2: Número de imposto 2.
- tax_label_2: Rótulo de imposto 2.
- default_sales_tax: Imposto de venda padrão.
- default_profit_percent: Percentual de lucro padrão.
- fy_start_month: Mês de início do ano fiscal.
- accounting_method: Método de contabilidade.
- default_sales_discount: Desconto de venda padrão.
- sell_price_tax: Imposto incluído no preço de venda.
- logo: Logotipo da empresa.
- sku_prefix: Prefixo SKU.
- enable_product_expiry: Habilitar validade do produto.
- expiry_type: Tipo de validade.
- on_product_expiry: Ação ao expirar o produto.
- stop_selling_before: Parar de vender antes da expiração.
- enable_tooltip: Habilitar dica de ferramenta.
- purchase_in_diff_currency: Compra em moeda diferente.
- purchase_currency_id: ID da moeda de compra.
- p_exchange_rate: Taxa de câmbio de compra.
- transaction_edit_days: Dias para editar transações.
- stock_expiry_alert_days: Dias para alerta de validade do estoque.
- keyboard_shortcuts: Atalhos de teclado.
- pos_settings: Configurações do ponto de venda.
- weighing_scale_setting: Configurações da balança.
- manufacturing_settings: Configurações de fabricação.
- time_zone: Fuso horário.
- enable_brand: Habilitar marca.
- enable_category: Habilitar categoria.
- enable_sub_category: Habilitar subcategoria.
- enable_price_tax: Habilitar imposto de preço.
- enable_purchase_status: Habilitar status de compra.
- enable_lot_number: Habilitar número de lote.
- default_unit: Unidade padrão.
- enable_sub_units: Habilitar subunidades.
- enable_racks: Habilitar prateleiras.
- enable_row: Habilitar linha.
- enable_position: Habilitar posição.
- enable_editing_product_from_purchase: Habilitar edição de produto a partir da compra.
- sales_cmsn_agnt: Agente de comissão de vendas.
- item_addition_method: Método de adição de itens.
- enable_inline_tax: Habilitar imposto embutido.
- currency_symbol_placement: Posição do símbolo da moeda.
- enabled_modules: Módulos habilitados.
- date_format: Formato de data.
- time_format: Formato de hora.
- natureza_id: ID da natureza.
- ref_no_prefixes: Prefixos de referência.
- theme_color: Cor do tema.
- created_by: Criado por.
- enable_rp: Habilitar pontos de recompensa.
- rp_name: Nome dos pontos de recompensa.
- amount_for_unit_rp: Valor para cada ponto de recompensa.
- min_order_total_for_rp: Total mínimo do pedido para pontos de recompensa.
- max_rp_per_order: Máximo de pontos de recompensa por pedido.
- redeem_amount_per_unit_rp: Valor de resgate por ponto de recompensa.
- min_order_total_for_redeem: Total mínimo do pedido para resgate de pontos de recompensa.
- min_redeem_point: Ponto mínimo para resgate.
- max_redeem_point: Ponto máximo para resgate.
- rp_expiry_period: Período de validade dos pontos de recompensa.
- rp_expiry_type: Tipo de validade dos pontos de recompensa.
- repair_settings: Configurações de reparo.
- email_settings: Configurações de email.
- sms_settings: Configurações de SMS.
- custom_labels: Rótulos personalizados.
- common_settings: Configurações comuns.
- perc_icms_padrao: Percentual de ICMS padrão.
- perc_pis_padrao: Percentual de PIS padrão.
- perc_cofins_padrao: Percentual de COFINS padrão.
- perc_ipi_padrao: Percentual de IPI padrão.
- cfop_saida_estadual_padrao: CFOP de saída estadual padrão.
- cfop_saida_inter_estadual_padrao: CFOP de saída interestadual padrão.
- csc: CSC (Código de Segurança do Contribuinte).
- csc_id: ID do CSC.
- aut_xml: Autorização XML.
- certificado_urn: URN do certificado.
- casas_decimais_valor: Casas decimais para valor.
- created_at: Data de criação.
- updated_at: Data de atualização.
- bus_nome_empresa: Nome da empresa de negócios.
- cidade_id: ID da cidade.
- bus_nome_envio_api: Nome da emprea que vai aparecer de envio de email da API .
- ncm_padrao: NCM padrão.
- cst_csosn_padrao: CST/CSOSN padrão.
00 - Tributa integralmente
10 - Tributada e com cobrança do ICMS por substituição tributária
20 - Com redução da Base de Cálculo
30 - Isenta / não tributada e com cobrança do ICMS por substituição tributária
40 - Isenta
41 - Não tributada
50 - Com suspensão
51 - Com diferimento
60 - ICMS cobrado anteriormente por substituição tributária
70 - Com redução da Base de Cálculo e cobrança do ICMS por substituição tributária
90 - Outras
101 - Tributada pelo Simples Nacional com permissão de crédito
102 - Tributada pelo Simples Nacional sem permissão de crédito
103 - Isenção do ICMS no Simples Nacional para faixa de receita bruta
201 - Tributada pelo Simples Nacional com permissão de crédito e com cobrança do ICMS por substituição tributária
202 - Tributada pelo Simples Nacional sem permissão de crédito e com cobrança do ICMS por substituição tributária
203 - Isenção do ICMS no Simples Nacional para faixa de receita bruta e com cobrança do ICMS por substituição tributária
300 - Imune
400 - Não tributada pelo Simples Nacional
500 - ICMS cobrado anteriormente por substituição tributária (substituído) ou por antecipação
900 - Outros
- cst_cofins_padrao: CST COFINS padrão.
01 - Operação Tributável com Alíquota Básica
02 - Operação Tributável com Alíquota por Unidade de Medida de Produto
03 - Operação Tributável com Alíquota por Unidade de Medida de Produto
04 - Operação Tributável Monofásica – empresas a Alíquota Zero
05 - Operação Tributável por Substituição Tributária
06 - Operação Tributável a Alíquota Zero
07 - Operação Isenta da Contribuição
08 - Operação sem Incidência da Contribuição
09 - Operação com Suspensão da Contribuição
49 - Outras Operações de Saída
- cst_pis_padrao: CST PIS padrão.
01 - Operação Tributável com Alíquota Básica
02 - Operação Tributável com Alíquota por Unidade de Medida de Produto
03 - Operação Tributável com Alíquota por Unidade de Medida de Produto
04 - Operação Tributável Monofásica – empresas a Alíquota Zero
05 - Operação Tributável por Substituição Tributária
06 - Operação Tributável a Alíquota Zero
07 - Operação Isenta da Contribuição
08 - Operação sem Incidência da Contribuição
09 - Operação com Suspensão da Contribuição
49 - Outras Operações de Saída
- cst_ipi_padrao: CST IPI padrão.
50: Saída Tributada
51: Saída Tributável com Alíquota Zero
52: Saída Isenta
53: Saída Não Tributada
54: Saída Imune
55: Saída com Suspensão
99: Outras Saídas
- is_active: Ativo.
- ie: Inscrição Estadual.
- senha_certificado: Senha do certificado.
- certificado: Certificado.
- certificado_via_link: Caso seja true, o certificado será enviado via link.
- ultimo_numero_nfe: Último número da NFe.
- ultimo_numero_nfce: Último número da NFCe.
- ultimo_numero_cte: Último número do CT-e.
- ultimo_numero_mdfe: Último número do MDF-e.
- inscricao_municipal: Inscrição Municipal.
- numero_serie_nfe: Número de série da NFe.
- numero_serie_nfce: Número de série da NFCe.
- numero_serie_cte: Número de série do CT-e.
- numero_serie_mdfe: Número de série do MDF-e.
- regime: (1 para Simples e 3 para Normal).
API para Listar empresa
-
Endpoints
POST https://tffiscal.com.br/api/listar_empresa
POST https://tffiscal.com.br/api/listar_empresa
const data = {
'token_plataforma': 'xxxxxxxxxxxxxxxxxxxxx'
};
- 'token_plataforma': É um token de autenticação da plataforma. Esse token é usado para verificar a identidade da plataforma que está sendo acessada.
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,
"last_name": "",
"time_zone": "",
"ie": "133011581111",
"inscricao_municipal":"",
"mobile": "",
"landmark": "Nenhum",
"certificado": "",
"senha_certificado": "",
"surname": "Sr",
"password": "",
"confirm_password": "",
"razao_social": "",
"bus_id_patrocinador:"",
"csc_id":"",
"csc":""
};
- "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 = {
"api_completa": true,
"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]",
"contribuinte":"1" ,
"supplier_business_name":"",
"consumidor_final": "1",
"tax_number":"8033440",
"pay_term_number":"",
"pay_term_type":"",
"credit_limit":0.0000
"landline":"",
"contact_status":active,
"alternate_number":"",
"city":"São Paulo",
"landmark":"",
"customer_group_id":"",
"contact_id":"C0001",
"custom_field1":"",
"custom_field2":"",
"custom_field3":"",
"custom_field4":"",
"shipping_address":"",
"position":"",
"cod_pais":"1058",
"id_estrangeiro":"",
"rua_entrega":"asdfas",
"numero_entrega":"1489",
"bairro_entrega":"Vila xxxxx ",
"cep_entrega":"11111-090",
"city_id_entrega":"3830",
"complement":"",
};
- "api_completa": Indica se a API é completa ou não.
- 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,
- "contribuinte": Tipo de contribuição,
- "supplier_business_name": Fornecedor da empresa,
- "consumidor_final": O consumidor cadastrado,
- "tax_number":"",
- "pay_term_number": Numero pagamento,
- "pay_term_type": Tipo de pagamento,
- "landline": Número de telefone do cliente,
- "alternate_number": Número de telefone alterantivo do cliente,
- "city": Cidade do cliente,
- "landmark": Marco,
- "customer_group_id": Grupo associado,
- "contact_id": Identificação do cliente,
- "custom_field1":"",
- "custom_field2":"",
- "custom_field3":"",
- "custom_field4":"",
- "shipping_address": Endereço de envio,
- "position": Ponto de referência,
- "cod_pais": Código do pais,
- "id_estrangeiro": Identificação do estrangeiro,
- "rua_entrega": Rua da entrega,
- "numero_entrega": Numero da entrega,
- "bairro_entrega": Localização do bairro da entrega,
- "cep_entrega": Cep do estado da entrega,
- "city_id_entrega": Id da cidade onde será entregue,
- "complement": Complemento do endereço
API para Consultar Clientes:
-
Endpoints
POST https://tffiscal.com.br/api/search_cliente
POST https://tffiscal.com.br/api/search_cliente
const data = {
"tipo_pesquisa": "contact_id",
"search": "TF FISCAL",
"token_empresa": "xxxxxxxxxxxxxxxxxxxxx"
};
- É 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 os tipos são: name, type e contact_id do contato ou cliete.
- 'token_empresa': É um token de autenticação da empresa. Esse token é usado para verificar a identidade da empresa que está realizando a pesquisa.
- 'search': É o termo de pesquisa que será utilizado para encontrar informações sobre uma empresa. Neste caso, o valor é 'TF FISCAL'.
API para Atualizar Clientes:
-
Endpoints
POST https://tffiscal.com.br/api/edit_cliente
POST https://tffiscal.com.br/api/edit_cliente
const data = {
"api_completa": true,
"cep": "11111-090",
"name": "exemplo exemplo",
"mobile": "99721-1111",
"city_id": "São Paulo",
"state": "SP",
"ie_rg": "23432",
"country": "Brasil",
"id": "1",
"email": "[email protected]",
"token_empresa": "xxxxxxxxxxxxxxxxxxxxx"
"contact_id": "C0001",
"type": "customer",
"contribuinte": "1",
"contact_id": "C0001",
"supplier_business_name":""
"consumidor_final": "1",
"rua": "sadfas",
"numero": "1489",
"bairro": "asdas",
"tax_number": "8033440",
"pay_term_number": "",
"pay_term_type": "",
"landline": "",
"alternate_number": "",
"landmark": "",
"customer_group_id": "",
"custom_field1": "",
"custom_field2": "",
"custom_field3": "",
"custom_field4": "",
"shipping_address": "",
"position": "",
"city_id": "3732",
"cod_pais": "1058",
"id_estrangeiro": "",
"rua_entrega": "asdfas",
"numero_entrega": "1489",
"bairro_entrega": "Vila xxxxx",
"cep_entrega": "11111-090",
"city_id_entrega": "3830",
"complement": "",
"credit_limit": 0.0000,
"contact_status": "active",
};
- É permitido apenas um token, se colocar o token da empresa, não pode colocar o token da plataforma e vice-versa.
- 'token_empresa': É um token de autenticação da empresa. Esse token é usado para verificar a identidade da empresa que está realizando a pesquisa.
- "cep": Cep do estado relacionado ao cliente.
- "name": Nome do cliente.
- "mobile": Telefone.
- "ie_rg": Identificação do registro do cliente.
- "city_id": Cidade do cliente.
- "state": Estado do cliente.
- "uf": UF do estado do cliente exemplo SP.
- "country": País do cliente.
- "id": Identificação do cliente.
- "contact_id": Identificação do cliente.
- "email": Email do cliente.
- "type": Tipo de fornecedor.
- "contribuinte": Tipo de contribuição.
- "supplier_business_name": Fornecedor da empresa.
- "consumidor_final": O consumidor cadastrado.
- "rua": Rua do cliente.
- "numero": Número da casa do cliente.
- "bairro": Bairro onde o cliente mora.
- "tax_number": .
- "pay_term_number": Número de pagamento.
- "pay_term_type": Tipo de pagamento.
- "landline": Número de telefone do cliente.
- "alternate_number": Número de telefone alternativo do cliente.
- "landmark": Marco.
- "customer_group_id": Grupo associado.
- "custom_field1": .
- "custom_field2": .
- "custom_field3": .
- "custom_field4": .
- "shipping_address": Endereço de envio.
- "position": Ponto de referência.
- "cod_pais": Código do país.
- "id_estrangeiro": Identificação do estrangeiro.
- "rua_entrega": Rua da entrega.
- "numero_entrega": Número da entrega.
- "bairro_entrega": Localização do bairro da entrega.
- "cep_entrega": Cep do estado da entrega.
- "city_id_entrega": Id da cidade onde será entregue.
- "complement": Complemento do endereço.
- "credit_limit": Limite de Crédito do cliente.
- "contact_status": status do cliente.
API para Desativar Clientes:
-
Endpoints
POST https://tffiscal.com.br/api/pausar_cliente
POST https://tffiscal.com.br/api/pausar_cliente
const data = {
"contact_id":"1",
"token_empresa":"xxxxxxxxxxxxxxxxxxxxx",
};
- "contact_id": Id do cliente,
- "token_empresa": Token que cada empresa tem,
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",
"cst_csosn":"101",
"tax_type":"exclusive",
"enable_stock":"0",
"brand_id":2,
"unit_id":2,
"sku":2,
"expiry_period":null,
"expiry_period_type":null,
"enable_sr_no":"0",
"weight":"0",
"product_custom_field1":null,
"product_custom_field2":null,
"product_custom_field3":null,
"product_custom_field4":null,
"image":null,
"product_description":null,
"warranty_id":null,
"cest":null,
"perc_glp":"0.00",
"unidade_tributavel":"",
"quantidade_tributavel":"0.0000",
"chassi":"",
"perc_pis":"0.00",
"perc_cofins":"0.00",
"perc_ipi":"0.00",
"cenq_ipi":"999",
"ecommerce":"0",
"valor_ecommerce":"0.00",
"altura":"0.00",
"destaque":"0",
"novo":"0",
"perc_icms_interestadual":"0.00",
"perc_icms_interno":"0.00",
"modBCST":"0",
"pICMSST":"0.00",
"image_url":"https://tffiscal.com.br//img/default.png"
"perc_gnn":"0.00",
"perc_gni":"0.00",
"largura":"0.00",
"comprimento":"0.00",
"cCor":"",
"xCor":"",
"pot":"0",
"cilin":"0",
"pesoL":"0.0000",
"pesoB":"0.0000",
"nSerie":"",
"tpComb":"1",
"nMotor":"",
"CMT":"0.0000",
"dist":"0.0000",
"anoMod":"0",
"anoFab":"0",
"tpPint":"F",
"tpVeic":"2",
"espVeic":"1",
"VIN":"R",
"condVeic":"1",
"cMod":"0",
"cCorDENATRAN":"1",
"lota":"0",
"modBC":"0",
};
- É 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.
- brand_id: É o ID da marca do produto .
- unit_id: É o ID da unidade do produto.
- cst_csosn, cst_pis, cst_cofins, cst_ipi: São os códigos de situação tributária aplicados ao produto.
- tax_type: Indica o tipo de imposto aplicado ao produto. Neste caso, é "exclusive" (exclusivo).
- enable_stock: Indica se o controle de estoque está habilitado para o produto. Neste caso, é "0" (desabilitado).
- sku: É o SKU (Unidade de Manutenção de Estoque) do produto.
- expiry_period: É o período de validade do produto, se houver. Neste caso, é nulo.
- expiry_period_type: É o tipo de período de validade do produto, se houver. Neste caso, é nulo.
- enable_sr_no: Indica se o número de série está habilitado para o produto. Neste caso, é "0" (desabilitado).
- weight: É o peso do produto.
- product_custom_field1 a product_custom_field4: São campos personalizados adicionais para o produto, se houver. Neste caso, são nulos.
- image: É a imagem do produto, se houver. Neste caso, é nula.
- product_description: É a descrição do produto, se houver. Neste caso, é nula.
- warranty_id: É o ID da garantia do produto, se houver. Neste caso, é nulo.
- cest: É o CEST (Código Especificador da Substituição Tributária) do produto, se houver. Neste caso, é nulo.
- perc_glp, perc_gnn, perc_gni: São as porcentagens de impostos aplicadas a produtos relacionados a combustíveis.
- unidade_tributavel: É a unidade tributável do produto, se houver. Neste caso, é nula.
- quantidade_tributavel: É a quantidade tributável do produto.
- chassi, cCor, xCor, pot, cilin, pesoL, pesoB, nSerie, tpComb, nMotor, CMT, dist, anoMod, anoFab, tpPint, tpVeic, espVeic, VIN, condVeic, cMod, cCorDENATRAN, lota, tpRest, origem: São campos relacionados a produtos de veículos, se houver. Neste caso, são todos preenchidos com valores padrão.
- cenq_ipi: É o código de enquadramento do IPI (Imposto sobre Produtos Industrializados).
- ecommerce: Indica se o produto está disponível para venda online. Neste caso, é "0" (não disponível).
- valor_ecommerce: É o valor do produto para venda online.
- altura, largura, comprimento: São as dimensões do produto.
- destaque: Indica se o produto é destacado. Neste caso, é "0" (não destacado).
- novo: Indica se o produto é novo. Neste caso, é "0" (não novo).
- perc_icms_interestadual, perc_icms_interno, perc_fcp_interestadual: São as porcentagens de impostos aplicadas a produtos relacionados a operações interestaduais.
- modBCST, modBC: São os modos de base de cálculo do ICMS ST (Imposto sobre Circulação de Mercadorias e Serviços - Substituição Tributária) e ICMS (Imposto sobre Circulação de Mercadorias e Serviços), respectivamente.
- pICMSST: É a porcentagem do ICMS ST.
- image_url: É a URL da imagem do produto.
API para Consultar Produtos
Endpoints
POST https://tffiscal.com.br/api/consultar_produto
POST https://tffiscal.com.br/api/consultar_produto
const data = {
"token_empresa": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"tipo_pesquisa":"name",
"search": 'TF FISCAL'
}
- É 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.
- 'tipo_pesquisa': Indica o tipo de pesquisa que será realizada.
Neste caso, o valor é 'name', o que sugere que a pesquisa será feita com base no name
de uma empresa e seus podem ser usados além do name os tipos são name, type e sku do produto.
- 'search': É o termo de pesquisa que será utilizado para encontrar informações sobre uma empresa. Neste caso, o valor é 'TF FISCAL'.
API para Modificar Produtos
Endpoints
POST https://tffiscal.com.br/api/modificar_produto
POST https://tffiscal.com.br/api/modificar_produto
const data = {
"api_completa": true,
"id": 1,
"token_empresa": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"name":"aaa aa",
"type":"single",
"unit_id":2,
"enable_stock":"0",
"sku":2,
"weight":"0",
"product_description":null,
"created_by":4,
"is_inactive":"0",
"cfop_interno":"1102",
"cfop_externo":"6102",
"cst_csosn":"101",
"cst_pis":"49",
"cst_cofins":"49",
"cst_ipi":"99",
"ncm":"4407.11.00",
"valor_partida":"10.0000",
"tipo":"normal",
"sub_unit_ids":null,
"tax_type":"exclusive",
"alert_quantity":"0.0000",
"barcode_type":"C128",
"expiry_period":null,
"expiry_period_type":null,
"enable_sr_no":"0",
"product_custom_field1":null,
"product_custom_field2":null,
"product_custom_field3":null,
"product_custom_field4":null,
"image":null,
"warranty_id":null,
"not_for_selling":"0",
"perc_icms":"0.00",
"perc_pis":"0.00",
"perc_cofins":"0.00",
"perc_ipi":"0.00",
"cest":null,
"perc_glp":"0.00",
"perc_gnn":"0.00",
"perc_gni":"0.00",
"unidade_tributavel":"",
"quantidade_tributavel":"0.0000",
"chassi":"",
"cCor":"",
"xCor":"",
"pot":"0",
"cilin":"0",
"pesoL":"0.0000",
"pesoB":"0.0000",
"nSerie":"",
"tpComb":"1",
"nMotor":"",
"CMT":"0.0000",
"dist":"0.0000",
"anoMod":"0",
"anoFab":"0",
"tpPint":"F",
"tpVeic":"2",
"espVeic":"1",
"VIN":"R",
"condVeic":"1",
"cMod":"0",
"cCorDENATRAN":"1",
"lota":"0",
"tpRest":"0",
"origem":"0",
"cenq_ipi":"999",
"ecommerce":"0",
"valor_ecommerce":"0.00",
"altura":"0.00",
"largura":"0.00",
"comprimento":"0.00",
"destaque":"0",
"novo":"0",
"perc_icms_interestadual":"0.00",
"perc_icms_interno":"0.00",
"perc_fcp_interestadual":"0.00",
"modBCST":"0",
"modBC":"0",
"pICMSST":"0.00",
"image_url":"https://tffiscal.com.br//img/default.png"
"tpOp":"1"
}
- id (integer): ID do produto
- É permitido apenas um token, se colocar o token da empresa, não pode colocar o token da plataforma e vice-versa.
- token_empresa (string): Token da empresa
- name (string): Nome do produto
- co_ped_cliente_api (string): É o número do pedido do cliente.
- type (string): Tipo do produto
- unit_id (integer): ID da unidade
- enable_stock (string): Habilitar controle de estoque
- sku (integer): SKU do produto
- weight (string): Peso do produto
- product_description (string): Descrição do produto
- created_by (integer): ID do criador do produto
- is_inactive (string): Produto inativo
- cfop_interno (string): CFOP interno
- cfop_externo (string): CFOP externo
- cst_csosn (string): CST/CSOSN
- cst_pis (string): CST PIS
- cst_cofins (string): CST COFINS
- cst_ipi (string): CST IPI
- ncm (string): NCM
- valor_partida (string): Valor de partida
- tipo (string): Tipo
- tpOp (string): Tipo de operação
- sub_unit_ids (array): IDs das subunidades
- tax_type (string): Tipo de imposto
- alert_quantity (string): Quantidade de alerta
- barcode_type (string): Tipo de código de barras
- expiry_period (string): Período de validade
- expiry_period_type (string): Tipo de período de validade
- enable_sr_no (string): Habilitar número de série
- product_custom_field1 (string): Campo personalizado 1 do produto
- product_custom_field2 (string): Campo personalizado 2 do produto
- product_custom_field3 (string): Campo personalizado 3 do produto
- product_custom_field4 (string): Campo personalizado 4 do produto
- image (string): URL da imagem do produto
- warranty_id (integer): ID da garantia
- not_for_selling (string): Produto não disponível para venda
- perc_icms (string): Percentual de ICMS
- perc_pis (string): Percentual de PIS
- perc_cofins (string): Percentual de COFINS
- perc_ipi (string): Percentual de IPI
- cest (string): CEST
- perc_glp (string): Percentual de GLP
- perc_gnn (string): Percentual de GNN
- perc_gni (string): Percentual de GNI
- unidade_tributavel (string): Unidade tributável
- quantidade_tributavel (string): Quantidade tributável
- veicProd (string): Produto veicular
- chassi (string): Chassi
- cCor (string): Cor atual
- xCor (string): Cor
- pot (string): Potência
- cilin (string): Cilindrada
- pesoL (string): Peso líquido
- pesoB (string): Peso bruto
- nSerie (string): Número de série
- tpComb (string): Tipo de combustível
- nMotor (string): Número de motor
- CMT (string): Capacidade máxima de tração
- dist (string): Distância entre eixos
- anoMod (string): Ano modelo
- anoFab (string): Ano fabricação
- tpPint (string): Tipo de pintura
- tpVeic (string): Tipo de veículo
- espVeic (string): Espécie de veículo
- VIN (string): VIN
- condVeic (string): Condição do veículo
- cMod (string): Código do modelo
- cCorDENATRAN (string): Cor DENATRAN
- lota (string): Lotação
- tpRest (string): Tipo de restrição
- origem (string): Origem
- cenq_ipi (string): CEnq IPI
- ecommerce (string): Produto para e-commerce
- valor_ecommerce (string): Valor para e-commerce
- altura (string): Altura
- largura (string): Largura
- comprimento (string): Comprimento
- destaque (string): Destaque
- novo (string): Novo
- perc_icms_interestadual (string): Percentual de ICMS interestadual
- perc_icms_interno (string): Percentual de ICMS interno
- perc_fcp_interestadual (string): Percentual de FCP interestadual
- modBCST (string): Modo de cálculo do ICMS ST
- modBC (string): Modo de cálculo do ICMS
- pICMSST (string): Percentual de ICMS ST
- image_url (string): URL da imagem do produto
'TF FISCAL'.
API para Desativar Produtos
Endpoints
POST https://tffiscal.com.br/api/desativar_produto
POST https://tffiscal.com.br/api/consultar_produto
const data = {
"token_empresa": "xxxxxxxxxxxxxxxxxxxxxb1n7054xxjgavfueunws",
"product_id": 1
}
- É permitido apenas um token, se colocar o token da empresa, não pode colocar o token da plataforma e vice-versa.
- "product_id": Id do produto,
- "token_empresa": Token que cada empresa tem,
-
API para Gerar uma Venda
Endpoints
POST https://tffiscal.com.br/api/gerar_venda
POST https://tffiscal.com.br/api/gerar_venda
const data = {
"api_completa": true,
"token_empresa": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"payment": [{
"amount": 3.00,
"method": "cash",
"note": "",
"vencimento": "15/07/2023",
"card_type": "master"
"card_security"*: "",
"card_month": 1,
"card_year": 2012,
"card_number": 9000002,
"bank_account_number": 9003030,
"transaction_no_1": "",
"transaction_no_2": "",
"transaction_no_3": "",
"card_holder_name": "",
"card_transaction_number": "0000000",
"cheque_number": 9000002,
}],
"products":[
{"product_id":"91","quantity":"1,00","product_type":"single","unit_price":"10,00","line_discount_type":"fixed","line_discount_amount":"0,00","item_tax":"0,00","tax_id":null,"sell_line_note":"","variation_id":"82","enable_stock":"0","product_unit_id":"3","sub_unit_id":"3","base_unit_multiplier":"1","unit_price_inc_tax":"10,00"},
{"product_id":"90","quantity":"1,00","product_type":"single","unit_price":"10,00","line_discount_type":"fixed","line_discount_amount":"0,00","item_tax":"0,00","tax_id":null,"sell_line_note":"","variation_id":"81","enable_stock":"0","product_unit_id":"3","sub_unit_id":"3","base_unit_multiplier":"1","unit_price_inc_tax":"10,00"}
],
"status": "pending",
"change_return": "",
"final_total": 10.00,
"contact_id": 68,
"natureza_id": 3,
"enviar_email_para_cliente":true,
"variation_id": 63,
"location_id": 3,
"created_by": 48,
"is_quotation": 0,
"discount_type": "percentage",
"discount_amount": 0.0,
"is_direct_sale": 1,
"tax_rate_id": 0,
};
- 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.
- "created_by": 48 (ID do criador da transação).
- "card_security": Código de segurança do cartão.
- "card_month": Mês de validade do cartão.
- "card_year": Ano de validade do cartão.
- "card_number": Número do cartão.
- "bank_account_number": Número da conta bancária.
- "transaction_no_1": Número de transação 1.
- "transaction_no_2": Número de transação 2.
- "transaction_no_3": Número de transação 3.
- "card_holder_name": Nome do titular do cartão.
- "card_transaction_number": Número da transação do cartão.
- "cheque_number": Número do cheque.
- "products": Uma lista de produtos vendidos. Cada produto tem os seguintes campos:
- "product_id": ID do produto.
- "quantity": Quantidade do produto.
- "product_type": Tipo do produto.
- "unit_price": Preço unitário.
- "line_discount_type": Tipo de desconto (fixo).
- "line_discount_amount": Valor do desconto.
- "item_tax": Imposto do item.
- "tax_id": ID do imposto.
- "sell_line_note": Observação da linha de venda.
- "variation_id": ID da variação.
- "enable_stock": Habilitar estoque.
- "product_unit_id": ID da unidade do produto.
- "sub_unit_id": ID da subunidade do produto.
- "base_unit_multiplier": Multiplicador da unidade base.
- "unit_price_inc_tax": Preço unitário com imposto.
- "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.
- "variation_id": ID da variação.
- "location_id": ID do local.
- "is_quotation": Indicador se é uma cotação (0 para não).
- "discount_type": Tipo de desconto (porcentagem).
- "discount_amount": Valor do desconto.
- "is_direct_sale": Indicador de venda direta (1 para sim).
- "tax_rate_id": ID da taxa de imposto.
API para Cancelar uma Venda:
-
Endpoints
POST https://tffiscal.com.br/api/cancelar_venda
POST https://tffiscal.com.br/api/cancelar_venda
const data = {
"venda_id": "",
"token_empresa":"xxxxxxxxxxxxxxxxxxxxx",
};
-venda_id: O ID da Venda a ser cancelada.
-token_empresa: O token da empresa para autenticação.
API para Modificar uma Venda:
-
Endpoints
POST https://tffiscal.com.br/api/edit_venda
POST https://tffiscal.com.br/api/edit_venda
const data = {
"api_completa": true,
"id_empresa" = 2;
"valor_total_pagamento_venda" = "10,00";
"vencimento_venda" = "15/07/2023";
"nome_produto" = "aaa aa";
"cfop_interno_produto" = "1102";
"cfop_externo_produto" = "6102";
"cst_csosn_produto" = "101";
"data_hora_venda" = "06-07-2023 10:07";
"valor_total_venda" = "10,00";
"cpf_cnpj_cliente" = "014.338.029-02";
"nome_cliente" = "Seu zee a9128a2";
"token_cliente" = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx";
"cst_pis_produto" = "49";
"cst_cofins_produto" = "49";
"cst_ipi_produto" = "99";
"ncm_produto" = "4407.11.00";
"bairro_cliente" = "asdas";
"cep_cliente" = "19570-000";
"email_cliente" = "[email protected]";
};
- "id_empresa": Id da empresa que efetou a venda;
- "valor_total_pagamento_venda": Valor da venda;
- "vencimento_venda": Vencimento da venda;
- "nome_produto": Nome do Produto;
- "cfop_interno_produto": CFOP do Produto interno;
- "cfop_externo_produto": CFOP do Produto interno;
- "cst_csosn_produto": CSOSN do Produto interno;
- "data_hora_venda": Data e Hora da Venda;
- "valor_total_venda": Valor total da venda;
- "cpf_cnpj_cliente": CPF ou CPNJ do cliente;
- "nome_cliente": Nome completo;
- "token_cliente": Token do cliente;
- "cst_pis_produto": Pis do Produto ;
- "cst_cofins_produto": Confins do produto;
- "cst_ipi_produto": Imposto do produto;
- "ncm_produto": NCM do Produto;
- "bairro_cliente": Bairro do cliente;
- "cep_cliente": cep do cliente;
- "email_cliente": Email do cliente;
API para Consultar uma Venda:
-
Endpoints
POST https://tffiscal.com.br/api/search_venda
POST https://tffiscal.com.br/api/search_venda
const data = {
"type": "",
"name": "",
"contact_id":"",
"token_empresa":"xxxxxxxxxxxxxxxxxxxxx",
};
-type: O tipo de pesquisa para localizar avenda.
-name: Conteudo da pesquisa.
-contact_id: O ID cliente da Venda.
-token_empresa: O token da empresa para autenticação.
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 Emitir Nota pela API Transparente:
Endpoints
POST https://tffiscal.com.br/api/emitir_transparente
POST https://tffiscal.com.br/api/emitir_transparente
const data = {
"token_empresa": "xxxxxxxxxxxxxxxxxxxxxb1n7054xxjgavfueunws",
"excluir_clientes_produtos_pos_emissao":false,
"is_transparente":true,
"name_dev":"Seu zee a9128a2",
"email_dev":"[email protected]",
"itens":[
{"name":"aaa aa","quantity":1,"unit_price":10.00,"perc_icms":"0.00","cfop_interno":"1102","cfop_externo":"6102","ncm":"4407.11.00","cst_pis":"49","cst_cofins":"49","cst_ipi":"99","sku":"1234567890123","co_ped_cliente_api":"1234567890"},
{"name":"aaa aa","quantity":1,"unit_price":10.00,"perc_icms":"0.00","cfop_interno":"1102","cfop_externo":"6102","ncm":"4407.11.00","cst_pis":"49","cst_cofins":"49","cst_ipi":"99","sku":"1234567890123","co_ped_cliente_api":"1234567890"}
],
"cliente":{
"name":"Seu zee a9128a2",
"cpf_cnpj":"01433802902",
"ie_rg":"01433802902",
"email":"[email protected]",
"mobile":"15996000000",
"rua":"Rua das flores",
"numero":"123",
"country":"Brasil",
"bairro":"asdas",
"cep":"2222-000",
"state":"SP",
"city_id":"Sorocaba"
},
"payment": [{
"amount": 100.00,
"method": "cash",
"note": "",
"vencimento": "10/08/2024",
"card_type": "credit",
"card_number":"xxx-xxx-xxx-xxx",
"card_holder_nam":"XXXXXXXXX",
"card_transaction_numbe":"011",
"card_security":"01",
}],
"valor_total": 10.00,
"final_total": 10.00
}
-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.
-is_transparente: É para emitir nota fiscal transparente.
-name_dev: Nome do desenvolvedor.
-email_dev: Email do desenvolvedor.
-itens: Lista de itens da nota fiscal.
-name: Nome do produto.
-co_ped_cliente_api: É o número do pedido do cliente.
-sku: SKU do produto.
-quantity: Quantidade do produto.
-unit_price: Preço unitário do produto.
-perc_icms: Percentual de ICMS do produto.
-cfop_interno: CFOP interno do produto.
-cfop_externo: CFOP externo do produto.
-ncm: NCM do produto.
-cst_pis: CST PIS do produto.
-cst_cofins: CST COFINS do produto.
-cst_ipi: CST IPI do produto.
-cliente: Informações do cliente.
-name: Nome do cliente.
-cpf_cnpj: CPF ou CNPJ do cliente.
-ie_rg: IE ou RG do cliente.
-email: Email do cliente.
-telefone: Telefone do cliente.
-rua: Rua do cliente.
-numero: Número do cliente.
-country: País do cliente.
-bairro: Bairro do cliente.
-cep: CEP do cliente.
-estado: Estado do cliente.
-uf: UF do estado do cliente exemplo SP.
-city_id: Cidade do cliente.
-payment: Lista de pagamentos.
-amount: Valor do pagamento.
-method: Método de pagamento(cash, card, debit,pix).
-note: Observação.
-vencimento: Data de vencimento.
-card_type: Tipo de cartão.
-card_number: Número do cartão(01,02,03,04,05,06,07,08,09,99).
-card_holder_name: Nome do titular do cartão.
-card_transaction_number: Número da transação do cartão.
-card_security: Código de segurança do cartão.
-valor_total: Valor total da nota fiscal.
-final_total: Valor total da nota fiscal.
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 |