Métodos responsáveis por definir e gerenciar configurações essenciais das empresas cadastradas na plataforma. Cada empresa possui configurações individuais que podem ser alteradas tanto pelo painel quanto pelo webservice, e tais informações são de total responsabilidade do usuário.
Essas configurações impactam diretamente o funcionamento de diversos serviços, como:
- Emissão de documentos fiscais (NF-e, NFC-e, CT-e, MDF-e, NFS-e, DC-e).
- Geração de SPED, SINTEGRA e arquivos magnéticos.
- Armazenamento, consultas, eventos e operações diversas.
- Vinculação e validação de certificados digitais.
Cabeçalhos obrigatórios
Para utilizar os métodos desta seção, envie os seguintes HTTP headers:
Code
O UserToken identifica o usuário autenticado; o Token identifica qual empresa será manipulada pela operação. Adicionar e Buscar Todas dispensam o Token por não atuarem sobre uma empresa específica.
O que esta seção cobre
- Adicionar uma nova empresa à plataforma.
- Editar os dados de uma empresa existente.
- Buscar dados de uma ou de todas as empresas cadastradas.
- Alterar o certificado digital vinculado à empresa.
- Verificar o certificado digital cadastrado.
- Gerar link de ativação para liberar o uso da empresa.
- Consultar numeração atual de cada combinação modelo + série + ambiente.
- Atualizar numeração para alinhar contadores em migrações de ERP ou abrir novas séries.
Nota: As informações cadastradas são utilizadas em vários serviços fiscais. Mantenha-as sempre corretas e atualizadas para evitar rejeições ou falhas nas transmissões.
Adicionar
Cadastra uma nova empresa na plataforma, habilitando o uso dos serviços fiscais disponíveis (emissão de documentos, geração de escriturações, consultas, eventos, etc.).
Como funciona na API
O endpoint recebe os dados cadastrais, fiscais e de configuração da empresa e retorna o Token que identificará a empresa nas demais operações. Esse Token deve ser usado como cabeçalho Token: token_empresa nas chamadas subsequentes.
Próximos passos após o cadastro
- Editar os dados, se necessário.
- Vincular o certificado digital através do endpoint Alterar Certificado.
- Gerar o link de ativação para liberar o uso fiscal da empresa.
Nota: Os cabeçalhos obrigatórios e o contexto geral desta seção estão descritos na visão geral. Apenas o UserToken é necessário para este endpoint - o Token da empresa ainda não existe no momento do cadastro.
Headers
UserTokenToken de identificação do usuário autenticado. Obrigatório em todos os métodos da seção Empresas.
Adicionar › Request Body
CNPJCNPJ ou CPF (14 ou 11 dígitos).
CodigoInternoCódigo de identificação da empresa no sistema do integrador.
Campo opcional e livre, usado pelo integrador para correlacionar a empresa do Brasil NFe com o cadastro interno do próprio ERP/sistema (ex.: chave primária, código de cliente, SKU). O valor é apenas armazenado e devolvido pela API (eco em codigoInterno no retorno).
NmFantasiaNome fantasia.
RzSocialRazão social.
IEInscrição estadual.
IMInscrição municipal.
CRTCódigo do regime tributário.
Obrigatoriedade por regime
- CRT 1 (Simples Nacional) ou CRT 4 (MEI) → use CSOSN (101, 102, 103, 201, 202, 203, 300, 400, 500, 900).
- CRT 2 (Simples Nacional - Excesso Sublimite) → use CSOSN.
- CRT 3 (Regime Normal: Lucro Presumido/Real) → use CST (00, 10, 20, 30, 40, 41, 50, 51, 60, 70, 90).
O validador rejeita a emissão se o código informado for incompatível com o CRT da empresa.
Ver também
Valores Possíveis:
1: Simples Nacional
2: Simples Nacional - Exesso Sublimite
3: Lucro Presumido (Regime Normal)
4: Lucro Real (Regime Normal)
CNAEClassificação Nacional de Atividades Econômicas.
TokenToken Brasil NFe (somente para consulta - devolvido nas operações de leitura).
SiteExemplo: www.brasilnfe.com.br.
CodGrupoCódigo do grupo.
Informações de endereço da empresa.
Informações de contato da empresa.
Agrupamento das configurações por tipo de documento e papel da empresa.
Adicionar › Responses
Successful operation
tokenToken da empresa que foi adicionada ou editada. Não é retornado em operações de exclusão.
statusStatus da operação de adição, edição ou exclusão de empresa.
Valores Possíveis:
true: operação realizada com sucesso;
false: operação não foi realizada (ver Error);
codigoInternoEco do valor enviado em CodigoInterno durante o cadastro/edição da empresa, permitindo ao integrador correlacionar a resposta da API com o cadastro interno do próprio ERP/sistema.
ErrorDescrição do erro, caso o status retornado for igual a false.
AvisosLista de avisos não-fatais emitidos durante a operação (validações leves, depreciações).
Editar
Este método permite alterar os dados de uma empresa já existente, mantendo suas configurações fiscais alinhadas ao perfil atual da organização.
É útil para atualizar:
- Dados cadastrais e fiscais.
- Configurações de emissão.
- Endereço e informações de contato.
- Dados de operação e regimes tributários.
- Informações complementares necessárias para a SEFAZ.
Manter esses dados atualizados previne rejeições durante transmissões e garante a conformidade fiscal.
Nota: As informações cadastradas ou editadas são utilizadas por diversos módulos fiscais da plataforma. Recomenda-se revisá-las periodicamente para evitar inconsistências e garantir o correto funcionamento dos serviços..
Headers
TokenToken de identificação da empresa. Obrigatório em todas as operações fiscais (NF-e, NFC-e, NFS-e, CT-e, MDF-e, DC-e, Consultas, Escriturações, Energia e Comunicação) e nos métodos da seção Empresas que atuam sobre uma empresa específica (Buscar, Editar, Alterar Certificado, Verificar Certificado, Gerar Link de Ativação, Deletar, Consultar Numeração, Atualizar Numeração). Não é exigido em Adicionar nem em Buscar Todas.
UserTokenToken de identificação do usuário autenticado. Obrigatório em todos os métodos da seção Empresas.
Editar › Request Body
CNPJCNPJ ou CPF (14 ou 11 dígitos).
CodigoInternoCódigo de identificação da empresa no sistema do integrador.
Campo opcional e livre, usado pelo integrador para correlacionar a empresa do Brasil NFe com o cadastro interno do próprio ERP/sistema (ex.: chave primária, código de cliente, SKU). O valor é apenas armazenado e devolvido pela API (eco em codigoInterno no retorno).
NmFantasiaNome fantasia.
RzSocialRazão social.
IEInscrição estadual.
IMInscrição municipal.
CRTCódigo do regime tributário.
Obrigatoriedade por regime
- CRT 1 (Simples Nacional) ou CRT 4 (MEI) → use CSOSN (101, 102, 103, 201, 202, 203, 300, 400, 500, 900).
- CRT 2 (Simples Nacional - Excesso Sublimite) → use CSOSN.
- CRT 3 (Regime Normal: Lucro Presumido/Real) → use CST (00, 10, 20, 30, 40, 41, 50, 51, 60, 70, 90).
O validador rejeita a emissão se o código informado for incompatível com o CRT da empresa.
Ver também
Valores Possíveis:
1: Simples Nacional
2: Simples Nacional - Exesso Sublimite
3: Lucro Presumido (Regime Normal)
4: Lucro Real (Regime Normal)
CNAEClassificação Nacional de Atividades Econômicas.
TokenToken Brasil NFe (somente para consulta - devolvido nas operações de leitura).
SiteExemplo: www.brasilnfe.com.br.
CodGrupoCódigo do grupo.
Informações de endereço da empresa.
Informações de contato da empresa.
Agrupamento das configurações por tipo de documento e papel da empresa.
Editar › Responses
Successful operation
tokenToken da empresa que foi adicionada ou editada. Não é retornado em operações de exclusão.
statusStatus da operação de adição, edição ou exclusão de empresa.
Valores Possíveis:
true: operação realizada com sucesso;
false: operação não foi realizada (ver Error);
codigoInternoEco do valor enviado em CodigoInterno durante o cadastro/edição da empresa, permitindo ao integrador correlacionar a resposta da API com o cadastro interno do próprio ERP/sistema.
ErrorDescrição do erro, caso o status retornado for igual a false.
AvisosLista de avisos não-fatais emitidos durante a operação (validações leves, depreciações).
Deletar
Este método exclui uma empresa do Brasil NFe, identificada pelo header Token. A operação é irreversível pela API - não há endpoint de restauração.
O que acontece na exclusão
- O certificado digital A1 (.pfx/.p12) e a respectiva senha criptografada são removidos permanentemente do armazenamento da Brasil NFe - o arquivo é apagado e nem o certificado nem a senha ficam em backup recuperável via API. Após a exclusão, emissões que exigem assinatura passam a falhar imediatamente; para voltar a operar, será necessário recadastrar a empresa e enviar o certificado novamente pelo endpoint Alterar Certificado.
- Todos os serviços fiscais ativos da empresa são desativados, interrompendo emissões, manifestações automáticas e demais rotinas associadas.
- A empresa deixa de aparecer em Buscar Todas Empresas e seu
Tokené invalidado imediatamente - qualquer requisição fiscal subsequente com esse token retornará erro de autenticação.
Quando usar
- Encerramento da operação da empresa (baixa no CNPJ, fim de contrato com o cliente final).
- Cadastro feito por engano que precisa ser removido.
- Remoção solicitada pelo titular (LGPD - direito ao apagamento).
Importante
- Documentos fiscais já emitidos (NF-e, NFC-e, NFS-e, CT-e, MDF-e, DC-e) não são apagados - permanecem armazenados para fins de auditoria e consulta posterior pelos órgãos fiscais. A exclusão é do cadastro da empresa, não do histórico fiscal.
- O cabeçalho
Tokené obrigatório e identifica a empresa a ser excluída. Só é possível excluir empresas do próprio usuário autenticado (headerUserToken).
Nota: Empresas excluídas não podem ser reativadas pela API. Se você precisar restaurar uma empresa removida, entre em contato com o suporte.
Headers
TokenToken de identificação da empresa. Obrigatório em todas as operações fiscais (NF-e, NFC-e, NFS-e, CT-e, MDF-e, DC-e, Consultas, Escriturações, Energia e Comunicação) e nos métodos da seção Empresas que atuam sobre uma empresa específica (Buscar, Editar, Alterar Certificado, Verificar Certificado, Gerar Link de Ativação, Deletar, Consultar Numeração, Atualizar Numeração). Não é exigido em Adicionar nem em Buscar Todas.
UserTokenToken de identificação do usuário autenticado. Obrigatório em todos os métodos da seção Empresas.
Deletar › Responses
Successful operation
tokenToken da empresa que foi adicionada ou editada. Não é retornado em operações de exclusão.
statusStatus da operação de adição, edição ou exclusão de empresa.
Valores Possíveis:
true: operação realizada com sucesso;
false: operação não foi realizada (ver Error);
codigoInternoEco do valor enviado em CodigoInterno durante o cadastro/edição da empresa, permitindo ao integrador correlacionar a resposta da API com o cadastro interno do próprio ERP/sistema.
ErrorDescrição do erro, caso o status retornado for igual a false.
AvisosLista de avisos não-fatais emitidos durante a operação (validações leves, depreciações).
Buscar
Este método permite obter os dados completos de uma empresa específica, utilizando o token da empresa informado no cabeçalho da requisição.
É ideal para:
- Carregar configurações fiscais de uma empresa no sistema.
- Verificar dados antes de emitir documentos fiscais.
- Validar informações cadastrais ou de certificado digital.
Headers
TokenToken de identificação da empresa. Obrigatório em todas as operações fiscais (NF-e, NFC-e, NFS-e, CT-e, MDF-e, DC-e, Consultas, Escriturações, Energia e Comunicação) e nos métodos da seção Empresas que atuam sobre uma empresa específica (Buscar, Editar, Alterar Certificado, Verificar Certificado, Gerar Link de Ativação, Deletar, Consultar Numeração, Atualizar Numeração). Não é exigido em Adicionar nem em Buscar Todas.
UserTokenToken de identificação do usuário autenticado. Obrigatório em todos os métodos da seção Empresas.
Buscar › Responses
Successful operation
CNPJCNPJ ou CPF (14 ou 11 dígitos).
CodigoInternoCódigo de identificação da empresa no sistema do integrador.
Campo opcional e livre, usado pelo integrador para correlacionar a empresa do Brasil NFe com o cadastro interno do próprio ERP/sistema (ex.: chave primária, código de cliente, SKU). O valor é apenas armazenado e devolvido pela API (eco em codigoInterno no retorno).
NmFantasiaNome fantasia.
RzSocialRazão social.
IEInscrição estadual.
IMInscrição municipal.
CRTCódigo do regime tributário.
Obrigatoriedade por regime
- CRT 1 (Simples Nacional) ou CRT 4 (MEI) → use CSOSN (101, 102, 103, 201, 202, 203, 300, 400, 500, 900).
- CRT 2 (Simples Nacional - Excesso Sublimite) → use CSOSN.
- CRT 3 (Regime Normal: Lucro Presumido/Real) → use CST (00, 10, 20, 30, 40, 41, 50, 51, 60, 70, 90).
O validador rejeita a emissão se o código informado for incompatível com o CRT da empresa.
Ver também
Valores Possíveis:
1: Simples Nacional
2: Simples Nacional - Exesso Sublimite
3: Lucro Presumido (Regime Normal)
4: Lucro Real (Regime Normal)
CNAEClassificação Nacional de Atividades Econômicas.
TokenToken Brasil NFe (somente para consulta - devolvido nas operações de leitura).
SiteExemplo: www.brasilnfe.com.br.
CodGrupoCódigo do grupo.
Informações de endereço da empresa.
Informações de contato da empresa.
Agrupamento das configurações por tipo de documento e papel da empresa.
Buscar Todas
Este método permite listar todas as empresas cadastradas para o usuário autenticado, retornando uma coleção contendo as informações essenciais de cada uma.
É útil para:
- Sistemas que administram múltiplas empresas.
- Seleção dinâmica de empresa em ERPs multicliente.
- Painéis de gerenciamento fiscal.
Headers
UserTokenToken de identificação do usuário autenticado. Obrigatório em todos os métodos da seção Empresas.
Buscar Todas › Responses
Successful operation
Lista com as informações das empresas cadastradas
CNPJCNPJ ou CPF (14 ou 11 dígitos).
CodigoInternoCódigo de identificação da empresa no sistema do integrador.
Campo opcional e livre, usado pelo integrador para correlacionar a empresa do Brasil NFe com o cadastro interno do próprio ERP/sistema (ex.: chave primária, código de cliente, SKU). O valor é apenas armazenado e devolvido pela API (eco em codigoInterno no retorno).
NmFantasiaNome fantasia.
RzSocialRazão social.
IEInscrição estadual.
IMInscrição municipal.
CRTCódigo do regime tributário.
Obrigatoriedade por regime
- CRT 1 (Simples Nacional) ou CRT 4 (MEI) → use CSOSN (101, 102, 103, 201, 202, 203, 300, 400, 500, 900).
- CRT 2 (Simples Nacional - Excesso Sublimite) → use CSOSN.
- CRT 3 (Regime Normal: Lucro Presumido/Real) → use CST (00, 10, 20, 30, 40, 41, 50, 51, 60, 70, 90).
O validador rejeita a emissão se o código informado for incompatível com o CRT da empresa.
Ver também
Valores Possíveis:
1: Simples Nacional
2: Simples Nacional - Exesso Sublimite
3: Lucro Presumido (Regime Normal)
4: Lucro Real (Regime Normal)
CNAEClassificação Nacional de Atividades Econômicas.
TokenToken Brasil NFe (somente para consulta - devolvido nas operações de leitura).
SiteExemplo: www.brasilnfe.com.br.
CodGrupoCódigo do grupo.
Informações de endereço da empresa.
Informações de contato da empresa.
Agrupamento das configurações por tipo de documento e papel da empresa.
Alterar Certificado
Este método permite alterar o certificado digital associado a uma empresa. A atualização do certificado é obrigatória sempre que ele expirar ou quando houver troca do arquivo de assinatura. Caso o certificado esteja inválido ou vencido, os métodos de emissão de NF-e, NFC-e, CT-e, MDF-e e NFS-e (em alguns municípios) deixarão de funcionar.
Tipo de certificado suportado
A API aceita exclusivamente certificados digitais do tipo A1, que são arquivos com extensão .pfx ou .p12.
O certificado deve ser enviado em Base64, juntamente com a sua senha de proteção, garantindo segurança e compatibilidade no processamento.
Quando usar este método?
Utilize este endpoint quando:
- O certificado digital da empresa estiver próximo do vencimento.
- O certificado já tiver expirado.
- Houver necessidade de substituição preventiva.
- A empresa trocar seu certificado por motivos de segurança.
Funcionamento
O método:
- Recebe o arquivo do certificado digital em Base64.
- Valida o conteúdo e a senha informada.
- Atribui o novo certificado digital à empresa informada pelo header
Token. - Disponibiliza imediatamente o certificado para uso nos serviços fiscais.
Importante
- Sempre mantenha uma cópia segura do certificado original.
- Certificados inválidos, corrompidos ou com senha incorreta serão rejeitados.
- A troca de certificado não altera nenhuma configuração fiscal existente da empresa.
Nota: O cabeçalho Token é obrigatório para este método, pois identifica a empresa cujo certificado será substituído.
Headers
TokenToken de identificação da empresa. Obrigatório em todas as operações fiscais (NF-e, NFC-e, NFS-e, CT-e, MDF-e, DC-e, Consultas, Escriturações, Energia e Comunicação) e nos métodos da seção Empresas que atuam sobre uma empresa específica (Buscar, Editar, Alterar Certificado, Verificar Certificado, Gerar Link de Ativação, Deletar, Consultar Numeração, Atualizar Numeração). Não é exigido em Adicionar nem em Buscar Todas.
UserTokenToken de identificação do usuário autenticado. Obrigatório em todos os métodos da seção Empresas.
Alterar Certificado › Request Body
SenhaSenha do certificado digital.
Base64CertificateFileBase64 contendo o arquivo .pfx /.p12
Alterar Certificado › Responses
Successful operation
ExpiradoSituação do certificado digital.
Valores Possíveis:
true: Expirado
false: Não Expirado
DtExpiracaoData em que o certificado expira.
statusStatus da solicitação de alteração do certificado.
Valores Possíveis:
1: Certificado alterado com sucesso
2: Não foi possível alterar o certificado
ErrorDescrição detalhada do erro, caso o campo 'status' retorne '2 - Não foi possível alterar o certificado'.
AvisosLista de avisos não-fatais emitidos durante a verificação/alteração (ex.: certificado próximo do vencimento).
Verificar Certificado
Este método permite verificar a situação do certificado digital cadastrado para uma empresa, identificando se ele está válido, próximo do vencimento ou expirado. Essa verificação é essencial para garantir o funcionamento contínuo dos serviços fiscais, como emissão de NF-e, NFC-e, CT-e, MDF-e e NFS-e (em alguns municípios).
Funcionamento
Ao consultar o certificado, o método retorna informações como:
- Data de validade.
- Dias restantes para expiração.
- Situação atual (válido, prestes a expirar ou expirado).
- Informações adicionais conforme o processamento.
O certificado deve seguir os critérios:
- Tipo: A1.
- Extensões suportadas: .pfx ou .p12.
- O arquivo deve ser enviado em Base64 através da propriedade
Base64CertificateFile. - A senha do certificado também deve ser informada.
Quando usar este método?
Use este endpoint quando for necessário:
- Confirmar se o certificado atual está válido.
- Verificar se está próximo da data de expiração.
- Identificar a necessidade de substituição preventiva.
- Validar certificados enviados externamente.
Importante
- Certificados expirados impedem a emissão de documentos fiscais.
- Certificados enviados em Base64 devem estar corretos e íntegros.
- O cabeçalho
Tokené obrigatório para identificar a empresa cuja validade será verificada.
Nota: Este método não substitui o certificado automaticamente, ele apenas verifica. Para trocar o certificado, utilize o método Alterar Certificado.
Headers
TokenToken de identificação da empresa. Obrigatório em todas as operações fiscais (NF-e, NFC-e, NFS-e, CT-e, MDF-e, DC-e, Consultas, Escriturações, Energia e Comunicação) e nos métodos da seção Empresas que atuam sobre uma empresa específica (Buscar, Editar, Alterar Certificado, Verificar Certificado, Gerar Link de Ativação, Deletar, Consultar Numeração, Atualizar Numeração). Não é exigido em Adicionar nem em Buscar Todas.
UserTokenToken de identificação do usuário autenticado. Obrigatório em todos os métodos da seção Empresas.
Verificar Certificado › Request Body
SenhaSenha do certificado digital.
Requisito
A Brasil NFe exige certificado A1 ICP-Brasil (arquivo .pfx/.p12) válido, com CN contendo o CNPJ da empresa. Certificados A3 (token/cartão) não são suportados. O vencimento do certificado bloqueia novas emissões - configure alerta com antecedência.
Ver também
Base64CertificateFileBase64 contendo o arquivo .pfx /.p12
InternoForma de verificação do certificado. Padrão: Falso.
Valores Possíveis:
true: Vai verificar o certificado digital atual cadastrado na empresa
false: Vai verificar o certificado digital enviado na propriedade Base64CertificateFile;
Verificar Certificado › Responses
Successful operation
ExpiradoSituação do certificado digital.
Valores Possíveis:
true: Expirado
false: Não Expirado
DtExpiracaoData em que o certificado expira.
statusStatus da solicitação de alteração do certificado.
Valores Possíveis:
1: Certificado alterado com sucesso
2: Não foi possível alterar o certificado
ErrorDescrição detalhada do erro, caso o campo 'status' retorne '2 - Não foi possível alterar o certificado'.
AvisosLista de avisos não-fatais emitidos durante a verificação/alteração (ex.: certificado próximo do vencimento).
Consultar Numeração
Lista todas as numerações cadastradas da empresa identificada pelo header Token, ordenadas por modelo de documento, ambiente (produção/homologação) e série.
Cada entrada representa o contador interno mantido pela Brasil NFe para a combinação Empresa + Modelo + Série + Ambiente e indica o próximo número que será utilizado em emissões automáticas (quando Serie, Numero e Lote são omitidos na requisição de emissão).
Quando usar
- Auditar o estado atual da numeração antes de migrar para controle manual.
- Sincronizar contadores com um ERP externo após restauração de backup.
- Diagnosticar rejeições de número fora de sequência comparando com o último autorizado pela SEFAZ.
- Identificar qual série está marcada como padrão em cada modelo.
Modelos retornados
Quando a empresa é criada via /AdicionarEmpresa, a API inicializa automaticamente uma numeração padrão (Numero = 1) para cada modelo suportado, em ambos os ambientes (produção e homologação): 55 (NF-e), 65 (NFC-e), 10 (NFS-e), 57 (CT-e), 58 (MDF-e), 6 (Energia Elétrica), 21 (Comunicação) e 22 (Telecomunicação).
Veja Numeração e Séries para o detalhamento das regras.
Headers
TokenToken de identificação da empresa. Obrigatório em todas as operações fiscais (NF-e, NFC-e, NFS-e, CT-e, MDF-e, DC-e, Consultas, Escriturações, Energia e Comunicação) e nos métodos da seção Empresas que atuam sobre uma empresa específica (Buscar, Editar, Alterar Certificado, Verificar Certificado, Gerar Link de Ativação, Deletar, Consultar Numeração, Atualizar Numeração). Não é exigido em Adicionar nem em Buscar Todas.
UserTokenToken de identificação do usuário autenticado. Obrigatório em todos os métodos da seção Empresas.
Consultar Numeração › Responses
Successful operation
statusStatus da operação.
Valores Possíveis:
true: consulta realizada com sucesso;
false: consulta não foi realizada (ver Error);
Lista de numerações cadastradas para a empresa, ordenada por modelo de documento, ambiente e série.
ErrorDescrição do erro, caso o status retornado for igual a false.
AvisosLista de avisos não-bloqueantes da consulta (vazia em sucesso sem ressalvas).
Atualizar Numeração
Atualiza (ou cria, caso ainda não exista) o contador de numeração da combinação Empresa + Modelo + Série + Ambiente identificada na requisição. A empresa-alvo é a do header Token.
Quando usar
- Migração de ERP: alinhar o próximo número emitido pela Brasil NFe ao último autorizado no sistema antigo, evitando duplicidades.
- Abertura de nova série: cadastrar uma série adicional (ex.:
2,3) começando emNumero = 1. - Definir série padrão: marcar uma série específica como padrão (
Padrao = true) - a API automaticamente desmarca as demais séries do mesmo modelo e ambiente. - Correção pós-incidente: após inutilização ou descarte manual, reposicionar o contador.
Comportamento
- Se já existir numeração para a combinação
TipoAmbiente + ModeloDocumento + Serie, ela é atualizada (NumeroePadrao). - Caso contrário, uma nova entrada é criada.
- Quando
Padrao = true, todas as demais séries do mesmo modelo e ambiente perdem o status de padrão automaticamente.
Validações
TipoAmbientedeve ser1(Produção) ou2(Homologação).ModeloDocumentodeve estar na lista:55, 65, 10, 57, 58, 6, 21, 22.SerieeNumerosão obrigatórios;Numerodeve ser maior que zero.
Atenção
Nunca defina Numero igual ou inferior a um número já autorizado pela SEFAZ na mesma série/modelo/ambiente. Isso provocará rejeição por chave de acesso duplicada na próxima emissão automática. Para descartar números pulados use o evento /InutilizarNumeracao.
Veja Numeração e Séries para o detalhamento das regras de continuidade.
Headers
TokenToken de identificação da empresa. Obrigatório em todas as operações fiscais (NF-e, NFC-e, NFS-e, CT-e, MDF-e, DC-e, Consultas, Escriturações, Energia e Comunicação) e nos métodos da seção Empresas que atuam sobre uma empresa específica (Buscar, Editar, Alterar Certificado, Verificar Certificado, Gerar Link de Ativação, Deletar, Consultar Numeração, Atualizar Numeração). Não é exigido em Adicionar nem em Buscar Todas.
UserTokenToken de identificação do usuário autenticado. Obrigatório em todos os métodos da seção Empresas.
Atualizar Numeração › Request Body
TipoAmbienteAmbiente da SEFAZ no qual a numeração é aplicada.
Valores Possíveis:
1: Produção
2: Homologação
ModeloDocumentoModelo do documento fiscal.
Valores Possíveis:
55: NF-e (Nota Fiscal Eletrônica)
65: NFC-e (Nota Fiscal de Consumidor Eletrônica)
10: NFS-e (Nota Fiscal de Serviços Eletrônica)
57: CT-e (Conhecimento de Transporte Eletrônico)
58: MDF-e (Manifesto Eletrônico de Documentos Fiscais)
6: Nota Fiscal/Conta de Energia Elétrica
21: Nota Fiscal de Serviço de Comunicação
22: Nota Fiscal de Serviço de Telecomunicação
SerieSérie do documento fiscal. Aceita valores numéricos (ex.: 1, 2) ou alfanuméricos para modelos de Energia/Comunicação (ex.: SER). Combinada com Numero, identifica unicamente o documento dentro da empresa e ambiente.
NumeroPróximo número a ser utilizado na sequência. Em AtualizarNumeracao, este é o valor que passa a vigorar como contador atual da série; emissões automáticas subsequentes partirão deste número.
Atenção: nunca defina um número inferior ou igual a um número já autorizado pela SEFAZ na mesma série/modelo/ambiente, sob pena de gerar chave de acesso duplicada e rejeição.
PadraoIndica se esta é a série padrão para o modelo + ambiente. Quando uma emissão omite Serie, a API usa a série marcada como padrão.
Ao atualizar uma série com Padrao = true, as demais séries do mesmo modelo e ambiente são automaticamente desmarcadas - só pode haver uma padrão por combinação.
Atualizar Numeração › Responses
Successful operation
statusStatus da operação.
Valores Possíveis:
true: atualização realizada com sucesso;
false: atualização não foi realizada (ver Error);
Configuração de numeração de uma combinação Empresa + Modelo + Série + Ambiente. Cada empresa possui um contador independente por modelo de documento, série e ambiente (produção/homologação).
Veja Numeração e Séries para detalhes sobre controle automático vs manual e regras de continuidade.
ErrorDescrição do erro, caso o status retornado for igual a false.
AvisosLista de avisos não-bloqueantes da operação (vazia em sucesso sem ressalvas).
Ativar Assinatura
Ativa diretamente uma assinatura de servicos para a empresa do header Token, sem checkout web. A assinatura e criada aguardando pagamento e os servicos ativam automaticamente quando o pagamento e confirmado.
Informe em Servicos os servicos a ativar (ex.: "NF-e/NFC-e", "NFS-e", "CT-e", "MDF-e", "DC-e", "SPED", "SINTEGRA", "FCI", "Sincronizar Docs"). Opcionalmente informe um Representante (responsavel financeiro/pagador diferente da empresa).
A resposta traz os dados da cobranca (PIX copia-e-cola, QR Code, PDF do boleto e linha digitavel) e o FaturaId. Chamadas repetidas com cobranca pendente identica reaproveitam a cobranca (campo Reaproveitada).
Headers
TokenToken de identificacao da empresa. Obrigatorio nos metodos da secao Empresas que atuam sobre uma empresa especifica (Buscar, Editar, Alterar Certificado, Verificar Certificado, Gerar Link de Ativacao, Deletar, Consultar Numeracao, Atualizar Numeracao, Ativar Assinatura, Cancelar Assinatura, Consultar Servicos, Consultar Faturas).
UserTokenToken de identificacao do usuario autenticado. Obrigatorio em todos os metodos da secao Empresas.
Ativar Assinatura › Request Body
ServicosOBRIGATORIO. Servicos a ativar, pelo nome: "NF-e/NFC-e", "NFS-e", "CT-e", "MDF-e", "DC-e", "SPED", "SINTEGRA", "FCI", "Sincronizar Docs". Comparacao ignora maiusculas/minusculas; nome invalido retorna erro com a lista disponivel.
FormaPagamentoForma de pagamento da assinatura.
Valores Possíveis:
BOLETO_PIX: boleto com PIX (padrão)
CREDIT_CARD: cartão de crédito
PIX: PIX
OPCIONAL. Responsavel financeiro (pagador) diferente da empresa. Omitido, a propria empresa e a pagadora.
Ativar Assinatura › Responses
Successful operation
MensagemMensagem informativa da operacao.
Reaproveitadatrue quando ja existia cobranca pendente identica e ela foi reaproveitada (chamadas repetidas nao geram duplicidade).
SemCobrancaImediatatrue quando a assinatura foi ativada sem cobranca imediata (o valor e consolidado na proxima fatura recorrente).
ServicosServicos incluidos na assinatura. Nulo quando o plano completo foi contratado.
ValorValor da cobranca gerada.
FaturaIdId da fatura, utilizavel nos endpoints de faturas/boleto.
PixCopiaEColaPIX copia-e-cola para pagamento.
PixQrCodeQR Code do PIX.
BoletoPdfPDF do boleto (base64 data URI ou URL). No BOLETO_PIX a emissao e assincrona: pode vir vazio logo apos a criacao.
LinhaDigitavelLinha digitavel do boleto (quando disponivel).
Lista de erros quando a operacao falha. Vazia em caso de sucesso. Cada item traz codigo, descricao e correcao.
avisosAvisos nao bloqueantes. Pode vir preenchida mesmo em sucesso.
statusCodigo de status do processamento (0 = sucesso).
Cancelar Assinatura
Cancela as assinaturas em andamento da empresa (header Token) que contem os servicos informados em Servicos, e desativa esses servicos na empresa. A comparacao ignora maiusculas/minusculas; nome invalido retorna erro com a lista disponivel.
Headers
TokenToken de identificacao da empresa. Obrigatorio nos metodos da secao Empresas que atuam sobre uma empresa especifica (Buscar, Editar, Alterar Certificado, Verificar Certificado, Gerar Link de Ativacao, Deletar, Consultar Numeracao, Atualizar Numeracao, Ativar Assinatura, Cancelar Assinatura, Consultar Servicos, Consultar Faturas).
UserTokenToken de identificacao do usuario autenticado. Obrigatorio em todos os metodos da secao Empresas.
Cancelar Assinatura › Request Body
ServicosOBRIGATORIO. Servicos a cancelar, pelo nome (mesma lista de AtivarAssinatura). As assinaturas em andamento que contem esses servicos sao canceladas e os servicos desativados na empresa.
Cancelar Assinatura › Responses
Successful operation
MensagemMensagem informativa da operacao.
AssinaturasCanceladasIds das assinaturas canceladas.
AcessoAteFimDoPeriodotrue quando o cancelamento é no fim do período (assinatura paga): o(s) serviço(s) continuam ativos até AcessoAte e são desativados automaticamente depois. false = desativação imediata (nunca foi paga).
AcessoAteData até quando o acesso continua, quando cancelado no fim do período.
Lista de erros quando a operacao falha. Vazia em caso de sucesso. Cada item traz codigo, descricao e correcao.
avisosAvisos nao bloqueantes. Pode vir preenchida mesmo em sucesso.
statusCodigo de status do processamento (0 = sucesso).
Consultar Servicos
Retorna o catalogo de servicos contrataveis e a situacao (ativo ou nao) de cada um para a empresa do header Token. O campo Nome de cada servico e exatamente o texto aceito em Servicos de Ativar/Cancelar Assinatura.
Headers
TokenToken de identificacao da empresa. Obrigatorio nos metodos da secao Empresas que atuam sobre uma empresa especifica (Buscar, Editar, Alterar Certificado, Verificar Certificado, Gerar Link de Ativacao, Deletar, Consultar Numeracao, Atualizar Numeracao, Ativar Assinatura, Cancelar Assinatura, Consultar Servicos, Consultar Faturas).
UserTokenToken de identificacao do usuario autenticado. Obrigatorio em todos os metodos da secao Empresas.
Consultar Servicos › Responses
Successful operation
Servicos disponiveis, com a situacao atual na empresa.
Lista de erros quando a operacao falha. Vazia em caso de sucesso. Cada item traz codigo, descricao e correcao.
avisosAvisos nao bloqueantes. Pode vir preenchida mesmo em sucesso.
statusCodigo de status do processamento (0 = sucesso).
Consultar Faturas
Lista as faturas de assinatura da empresa (header Token), da mais recente para a mais antiga, com status (PENDING/PAID/EXPIRED/CANCELED), valores, datas e forma de pagamento.
Headers
TokenToken de identificacao da empresa. Obrigatorio nos metodos da secao Empresas que atuam sobre uma empresa especifica (Buscar, Editar, Alterar Certificado, Verificar Certificado, Gerar Link de Ativacao, Deletar, Consultar Numeracao, Atualizar Numeracao, Ativar Assinatura, Cancelar Assinatura, Consultar Servicos, Consultar Faturas).
UserTokenToken de identificacao do usuario autenticado. Obrigatorio em todos os metodos da secao Empresas.
Consultar Faturas › Responses
Successful operation
Faturas da empresa, da mais recente para a mais antiga.
Lista de erros quando a operacao falha. Vazia em caso de sucesso. Cada item traz codigo, descricao e correcao.
avisosAvisos nao bloqueantes. Pode vir preenchida mesmo em sucesso.
statusCodigo de status do processamento (0 = sucesso).
Consultar Fatura
Consulta uma fatura de assinatura da empresa (header Token) pelo FaturaId, com os dados de pagamento (PIX copia-e-cola, QR Code, PDF do boleto e linha digitavel) prontos para exibir/reexibir ao pagador. O FaturaId e o mesmo retornado por Ativar Assinatura e em Consultar Faturas.
Headers
TokenToken de identificacao da empresa. Obrigatorio nos metodos da secao Empresas que atuam sobre uma empresa especifica.
UserTokenToken de identificacao do usuario autenticado. Obrigatorio em todos os metodos da secao Empresas.
Consultar Fatura › Request Body
FaturaIdOBRIGATORIO. Id da fatura a consultar - o mesmo FaturaId retornado por AtivarAssinatura e nas faturas de ConsultarFaturas.
Consultar Fatura › Responses
Successful operation
FaturaIdId da fatura.
StatusSituacao da fatura.
Valores Possíveis:
PENDING: aguardando pagamento
PAID: paga
EXPIRED: vencida
CANCELED: cancelada
SituacaoDescricao amigavel da situacao (ex.: "Aguardando pagamento").
Pagatrue quando a fatura ja foi paga (nesse caso nao ha dados de pagamento pendente).
ValorValor total da fatura.
DtVencimentoData de vencimento.
DtPagamentoData do pagamento, quando paga.
FormaPagamentoForma de pagamento.
Valores Possíveis:
PIX: PIX
BOLETO_PIX: boleto com PIX
CREDIT_CARD: cartao de credito
ServicosServicos cobrados na fatura.
PixCopiaEColaPIX copia-e-cola para pagamento (quando pendente).
PixQrCodeQR Code do PIX (quando pendente).
BoletoPdfPDF do boleto (base64 data URI). No BOLETO_PIX a emissao e assincrona: pode vir vazio logo apos a criacao; consulte novamente.
LinhaDigitavelLinha digitavel do boleto (quando disponivel).
Lista de erros quando a operacao falha. Vazia em caso de sucesso. Cada item traz codigo, descricao e correcao.
avisosAvisos nao bloqueantes. Pode vir preenchida mesmo em sucesso.
statusCodigo de status do processamento (0 = sucesso).
Gerar Link de Ativação
Gera um link de ativação de serviços para a empresa do usuário autenticado.
Headers
TokenToken de identificação da empresa. Obrigatório em todas as operações fiscais (NF-e, NFC-e, NFS-e, CT-e, MDF-e, DC-e, Consultas, Escriturações, Energia e Comunicação) e nos métodos da seção Empresas que atuam sobre uma empresa específica (Buscar, Editar, Alterar Certificado, Verificar Certificado, Gerar Link de Ativação, Deletar, Consultar Numeração, Atualizar Numeração). Não é exigido em Adicionar nem em Buscar Todas.
UserTokenToken de identificação do usuário autenticado. Obrigatório em todos os métodos da seção Empresas.
Gerar Link de Ativação › Responses
Link de ativação gerado com sucesso