Documentação da API

Gerar Token de Acesso

Gera um Token JWT Temporário (válido por 60 minutos) necessário para consumir os endpoints do sistema.

Você deve enviar o usuário e a senha da sua conta.
Atenção: A sua conta já deve possuir uma API Secret gerada no painel (Menu > Configurações da API) para que a requisição seja autorizada.

Headers Obrigatórios:

• Content-Type application/json

{
  "usuario": "email@suaempresa.com",
  "senha": "sua_senha_de_acesso"
}

{
  "status": "sucesso",
  "token": "eyJ0eXAiOiJKV1QiLCJ...",
  "expira_em": 3600,
  "tipo": "Bearer"
}

Listar Tomadores

Retorna a lista de tomadores já cadastrados na sua conta.
Utilize este endpoint para buscar o id de um cliente e usá-lo no campo id_tomador nas emissões de NF-e e NFS-e, evitando a necessidade de reenviar todos os dados cadastrais (endereço, bairro, etc) a cada nova nota.

Headers Obrigatórios:

• Authorization Bearer <seu_token_temporario>
• Api-Secret Sua chave secreta de validação.
• Content-Type application/json

{
  "total": 2,
  "tomadores": [
    {
      "id": 105,
      "nome_razao_social": "Empresa Cliente LTDA",
      "cpf_cnpj": "12345678000199"
    },
    {
      "id": 108,
      "nome_razao_social": "Fulano de Tal",
      "cpf_cnpj": "11122233344"
    }
  ]
}

Cadastrar Tomador

Cadastra um novo cliente/tomador na base de dados.
Ao realizar o cadastro, a API retorna o id interno deste tomador, que poderá ser utilizado nas emissões de nota para evitar o preenchimento repetitivo dos dados de endereço e contato.

{
  "nome_razao_social": "João da Silva LTDA",
  "cpf_cnpj": "12345678000199",
  "email": "joao@email.com",
  "telefone": "11999998888",
  "tipo_pessoa": "J",
  "cep": "01001000",
  "logradouro": "Praça da Sé",
  "numero": "10",
  "complemento": "Sala 5",
  "bairro": "Sé",
  "cidade": "São Paulo",
  "uf": "SP",
  "ibge_cidade": "3550308",
  "inscricao_estadual": "ISENTO",
  "indicador_ie": "9"
}

{
  "status": "sucesso",
  "message": "Tomador cadastrado com sucesso.",
  "id": 154
}

Emitir NFC-e

Endpoint para emissão síncrona de Nota Fiscal de Consumidor Eletrônica (Modelo 65).

Atenção à Estrutura: O payload deve ser enviado sempre como uma Lista (Array) de objetos JSON, mesmo que você esteja emitindo apenas uma nota por vez.

Headers Obrigatórios:

• Authorization Bearer <seu_token_temporario>
• Api-Secret Sua chave secreta de validação.
• Content-Type application/json

[
  {
    "natureza": "Venda de mercadoria",
    "presencial": true,
    "consumidorFinal": true,
    
    "emitente": {
      "cpfCnpj": "07945469000142",
      "inscricaoEstadual": "ISENTO"
    },

    "destinatario": {
      "cpfCnpj": "84965231000125",
      "email": "cliente@teste.com",
      "endereco": {
        "cep": "18550015",
        "logradouro": "Rua José Vitiello",
        "numero": "88",
        "bairro": "Centro",
        "codigoCidade": "3507001",
        "descricaoCidade": "Boituva",
        "estado": "SP"
      }
    },

    "itens": [
      {
        "codigo": "2",
        "descricao": "Teclado 70%",
        "ncm": "84716052",
        "cest": "0123456",
        "cfop": "5102",
        "valor": 220.00,
        "valorUnitario": {
          "comercial": 220.00,
          "tributavel": 220.00
        },
        "tributos": {
          "pis": { 
            "cst": "99", 
            "valor": 0, 
            "aliquota": 0,
            "baseCalculo": {
                "valor": 0,
                "quantidade": 0
            }
          },
          "cofins": { 
            "cst": "07", 
            "valor": 0, 
            "aliquota": 0,
            "baseCalculo": {
                "valor": 0
            }
          },
          "icms": { 
            "cst": "00", 
            "origem": "0", 
            "valor": 0, 
            "aliquota": 0,
            "baseCalculo": {
                "valor": 0,
                "quantidade": 0
            }
          }
        }
      }
    ],

    "pagamentos": [
      {
        "meio": "01",
        "valor": 220.00,
        "aVista": true
      }
    ],

    "responsavelTecnico": {
      "nome": "Minha Software House",
      "email": "dev@soft.com",
      "cpfCnpj": "88947125602",
      "telefone": { "ddd": "88", "numero": "88888888" }
    }
  }
]

{
  "status": "sucesso",
  "codigo_http": 200,
  "resposta": {
    "mensagem": "NFC-e enviada com sucesso",
    "idNota": "NFCe_6751ad3..."
  }
}

Consultar NFC-e

Consulta os detalhes e o status atual de uma NFC-e utilizando o ID ou NUMERO da nota.
Utilize este recurso para verificar se uma nota foi autorizada ou rejeitada após o envio.

Headers Obrigatórios:

• Authorization Bearer <seu_token_temporario>
• Api-Secret Sua chave secreta de validação.
• Content-Type application/json

{
  "idNota": "NFCe_69307838171da"
}

{
  "numero": "1000013"
}

{
  "status": "sucesso",
  "nota": {
    "idIntegracao": "NFCe_69307838171da",
    "numero": "502",
    "valor_total": "150.00",
    "status": "emitida"
  }
}

Cancelar NFC-e

Solicita o cancelamento de uma nota fiscal de consumidor previamente autorizada.
O sistema realizará uma busca automática pelo número da nota vinculado ao token do cliente para encontrar o registro e processar o cancelamento na SEFAZ.

Headers Obrigatórios:

• Authorization Bearer <seu_token_temporario>
• Api-Secret Sua chave secreta de validação.
• Content-Type application/json

{
  "numero": "1050",
  "justificativa": "Erro operacional na digitação dos valores do item"
}

{
  "status": "sucesso",
  "mensagem": "Cancelamento efetuado com sucesso",
  "resposta": {
    "message": "Cancelamento em processamento"
  }
}

Emitir NF-e

Endpoint para emissão de Nota Fiscal Eletrônica (Modelo 55). Utilizada para operações de venda, devolução e transferência entre empresas ou entregas.
A validação dos campos é rigorosa. Certifique-se de enviar os dados tributários (ICMS, PIS, COFINS) e de endereço corretos para evitar rejeição da SEFAZ.

{
  "id_tomador": 123, 
  
  "emitente": {
    "cpfCnpj": "07945469000142"
  },
  
  "destinatario": {
    "cpfCnpj": "78656454500",
    "endereco": {
      "logradouro": "Rua Exemplo",
      "numero": "100",
      "bairro": "Centro",
      "cep": "12345678",
      "codigoCidade": "3550308",
      "estado": "SP",
      "tipoLogradouro": "Rua"
    }
  },

  "itens": [
    {
      "descricao": "Produto Teste",
      "ncm": "61091000",
      "cfop": "5102",
      "quantidade": 1,
      "valorUnitario": {
        "comercial": 50.00,
        "tributavel": 50.00
      }
    }
  ],

  "pagamentos": [
    {
      "meio": "01",
      "valor": 50.00,
      "aVista": true
    }
  ]
}

{
  "status": "sucesso",
  "codigo_http": 200,
  "resposta": {
    "mensagem": "NF-e enviada com sucesso",
    "idNota": "NFe_6751ad3b..."
  }
}

Consultar NF-e

Consulta os detalhes e o status atual de uma NF-e utilizando o ID ou NUMERO da nota.
Utilize este recurso para verificar se uma nota foi autorizada, cancelada ou rejeitada após o envio.

Headers Obrigatórios:

• Authorization Bearer <seu_token_temporario>
• Api-Secret Sua chave secreta de validação.
• Content-Type application/json

{
  "idNota": "NFe_6751ad3b..."
}

{
  "numero": "1000013"
}

{
  "status": "sucesso",
  "nota": {
    "idIntegracao": "NFe_6751ad3b...",
    "numero": "5020",
    "valor_total": "1500.00",
    "status": "emitida"
  }
}

Cancelar NF-e

Solicita o cancelamento de uma NF-e modelo 55.
Informe o número da nota e a justificativa. O sistema localizará o ID interno automaticamente.

{
  "numero": "5020",
  "justificativa": "Dados do destinatário preenchidos incorretamente"
}

{
  "status": "sucesso",
  "mensagem": "Cancelamento efetuado com sucesso",
  "resposta": {
    "message": "Cancelamento em processamento"
  }
}

Emitir NFS-e

Endpoint unificado para emissão de Notas de Serviço.
Nossa API abstrai as diferenças técnicas entre as prefeituras. Você envia um JSON padrão e nós convertemos para o layout específico do município do prestador (padrão ABRASF ou proprietário).

{
  "prestador": {
    "cpfCnpj": "07945469000142",
    "inscricaoMunicipal": "12345678"
  },

  "tomador": {
    "cpfCnpj": "55222111000199",
    "razaoSocial": "Cliente Exemplo LTDA",
    "email": "financeiro@cliente.com",
    "endereco": {
       "cep": "01001000",
       "logradouro": "Praça da Sé",
       "numero": "10",
       "codigoCidade": "3550308"
    }
  },

  "servico": {
    "codigo": "12.24",
    "discriminacao": "Desenvolvimento de software customizado ref. Projeto X",
    "iss": {
      "aliquota": 5.00,
      "retido": false
    },
    "valor": {
      "servico": 1500.00
    }
  }
}

{
  "status": "sucesso",
  "codigo_http": 200,
  "resposta": {
    "mensagem": "NFS-e enviada com sucesso",
    "idNota": "NFSe_6751ad3b..."
  }
}

Consultar NFS-e

Consulta os detalhes e o status atual de uma NFS-e utilizando o ID ou NUMERO da nota.
Utilize este recurso para verificar se uma nota foi autorizada, cancelada ou rejeitada após o envio.

Headers Obrigatórios:

• Authorization Bearer <seu_token_temporario>
• Api-Secret Sua chave secreta de validação.
• Content-Type application/json

{
  "idNota": "NFSe_6751ad3b..."
}

{
  "numero": "1000013"
}

{
  "status": "sucesso",
  "nota": {
    "idIntegracao": "NFSe_6751ad3b...",
    "numero": "2024",
    "valor": "1500.00",
    "status": "emitida"
  }
}

Cancelar NFS-e

Solicita o cancelamento da nota de serviço junto à prefeitura.
Informe o número da nota e a justificativa. O sistema localizará o registro interno e comunicará o município.

{
  "numero": "2024",
  "justificativa": "Serviço não prestado devido a desacordo comercial"
}

{
  "status": "sucesso",
  "mensagem": "Cancelamento efetuado com sucesso",
  "resposta": {
    "message": "Cancelamento em processamento"
  }
}

Consultar Configurações de Webhook

Retorna todas as URLs de webhook configuradas para o cliente autenticado.

Headers Obrigatórios:

• Authorization Bearer <seu_token_jwt>
• Api-Secret Sua chave secreta da API.
• Content-Type application/json

{
  "status": "sucesso",
  "cliente": "07945469000142",
  "webhooks": [
    {
      "id": 1,
      "url": "https://sistema.com.br/notas",
      "method": "POST"
    },
    {
      "id": 2,
      "url": "https://erp.com/receber",
      "method": "POST"
    }
  ]
}

Cadastrar Webhook

Registra uma nova URL de webhook para receber notificações automáticas de eventos e alterações de status.
Observação: O sistema permite múltiplos webhooks por cliente, desde que a URL não esteja duplicada.

Headers Obrigatórios:

• Authorization Bearer <seu_token_jwt>
• Api-Secret Sua chave secreta da API.
• Content-Type application/json

{
  "url": "https://seusistema.com.br/callback",
  "method": "POST"
}

{
  "status": "sucesso",
  "cliente": "07945469000142",
  "url": "https://seusistema.com.br/callback",
  "method": "POST"
}

Alterar Webhook

Atualiza a URL ou o método HTTP de um webhook já cadastrado.
É necessário informar o ID do webhook que será alterado.

Headers Obrigatórios:

• Authorization Bearer <seu_token_jwt>
• Api-Secret Sua chave secreta da API.
• Content-Type application/json

{
  "id": 1,
  "url": "https://nova-url.com.br/callback",
  "method": "POST"
}

{
  "status": "sucesso",
  "cliente": "07945469000142",
  "url": "https://nova-url.com.br/callback",
  "method": "POST"
}

Remover Webhook

Remove um webhook previamente cadastrado da conta autenticada.
Após a remoção, sua aplicação deixará de receber notificações automáticas relacionadas às notas fiscais.

Headers Obrigatórios:

• Authorization Bearer <seu_token_jwt>
• Api-Secret Sua chave secreta da API.
• Content-Type application/json

{
  "url": "https://seusistema.com.br/callback"
}

{
  "status": "sucesso",
  "cliente": "07945469000142",
  "mensagem": "Webhook removido com sucesso."
}