v1

latestOpenAPI 3.0.3Proprietary2026-07-26125148541.3 KB
Empresas

Criar

Cria uma nova empresa. Utilize dry_run=1 para simular a criação sem efetivar no banco de dados.

post/empresas

Query parameters

dry_run1
Example:1

Simula a criação da empresa sem persistir os dados

Request body

nomestring

Razão social da empresa

nome_fantasiastring

Nome fantasia

cnpjstring
cpfstring
inscricao_estadualinteger

Inscrição estadual

inscricao_municipalinteger

Inscrição municipal

regime_tributariointeger

Regime tributário. Valores possíveis: 1 - Simples Nacional 2 - Simples Nacional - Excesso de sublimite de receita bruta 3 - Regime Normal 4 - Simples Nacional - MEI

logradourostring

Logradouro do endereço

numerointeger

Número do endereço

complementostring

Complemento do endereço

municipiostring

Município do endereço

bairrostring

Bairro do endereço

cepinteger

CEP do endereço

ufstring

UF do endereço

telefonestring

Telefone da empresa

emailstring email

Email de contato da empresa

enviar_email_destinatarioboolean

Habilita envio de e-mail ao destinatário/tomador após emissão (produção)

discrimina_impostosboolean

Habilita o cálculo automático de impostos totais aproximados (Lei da Transparência). Não utilizado para NFSe.

habilita_nfeboolean

Habilita emissão de NFe (modelo 55)

habilita_nfceboolean

Habilita emissão de NFCe (modelo 65)

habilita_nfseboolean

Habilita emissão de NFSe (Nota Fiscal de Serviço Eletrônica). Não pode estar habilitado simultaneamente com NFSe Nacional em produção (habilita_nfsen_producao).

habilita_nfsen_producaoboolean

Habilita emissão de NFSe Nacional em produção. Não pode estar habilitado simultaneamente com NFSe (habilita_nfse).

habilita_nfsen_homologacaoboolean

Habilita emissão de NFSe Nacional em homologação

habilita_cteboolean

Habilita emissão de CTe/CTeOS (Conhecimento de Transporte)

habilita_mdfeboolean

Habilita emissão de MDFe (Manifesto Eletrônico de Documentos Fiscais)

habilita_manifestacaoboolean

Habilita busca de NFe recebidas para manifestação do destinatário (MDe)

habilita_manifestacao_cteboolean

Habilita busca de CTes recebidas

habilita_nfsen_recebidas_producaoboolean

Informa se empresa será habilitada para consulta de NFSe Nacional recebidas em ambiente de produção. Requer certificado digital com CNPJ idêntico ao da empresa.

habilita_nfsen_recebidas_homologacaoboolean

Informa se empresa será habilitada para consulta de NFSe Nacional recebidas em ambiente de homologação. Requer certificado digital com CNPJ idêntico ao da empresa.

habilita_contingencia_offline_nfceboolean

Habilita contingência offline de NFCe

reaproveita_numero_nfce_contingenciaboolean

Reaproveita número de NFCe emitido em contingência

mostrar_danfse_badgeboolean

Define exibição de distintivo (badge) da Focus na DANFSe. Se verdadeiro, badge é exibido; se falso, emissão white label.

orientacao_danfe'portrait' | 'landscape'

Orientação da DANFe. Valores possíveis: portrait (retrato) ou landscape (paisagem).

recibo_danfeboolean

Exibe recibo na DANFe

exibe_sempre_ipi_danfeboolean

Imprime sempre colunas do IPI na DANFe

exibe_issqn_danfeboolean

Mostra dados do ISSQN na DANFe

exibe_impostos_adicionais_danfeboolean

Imprime impostos adicionais na DANFe (II, PIS, COFINS, ICMS UF Destino, ICMS UF Remetente, valor total de tributos)

exibe_rastro_danfeboolean

Exibe dados de rastreabilidade na DANFe

exibe_unidade_tributaria_danfeboolean

Exibe unidade tributária na DANFe

exibe_sempre_volumes_danfeboolean

Mostra sempre volumes na DANFe

exibe_composicao_carga_mdfeboolean

Mostra composição da carga na MDFe

enviar_email_homologacaoboolean

Habilita envio de e-mail ao destinatário em homologação

cpf_cnpj_contabilidadestring

CPF/CNPJ da contabilidade da empresa. Alguns estados exigem esta informação (ex.: BA).

arquivo_certificado_base64string

Arquivo PFX/P12 em base64

senha_certificadostring

Senha do certificado digital. Obrigatória apenas se informado arquivo_certificado_base64.

arquivo_logo_base64string

Logomarca da empresa para DANFE. Utilize PNG até 200x200 pixels. Nem todas as prefeituras aceitam.

delete_logoboolean

Quando verdadeiro, remove a logo existente da empresa

nome_responsavelstring

Nome do responsável pela empresa

cpf_responsavelstring

CPF do responsável pela empresa

login_responsavelstring

Login da prefeitura. Necessário para emissão de NFSe em alguns municípios sem certificado digital.

senha_responsavelstring

Senha da prefeitura. Necessária em alguns municípios sem certificado digital. Por segurança, não é exibida após ser salva.

data_inicio_recebimento_nfestring date

Data inicial para recebimento de NFe (MDe). Documentos anteriores serão ignorados e não cobrados. Após definido, não pode ser alterado.

data_inicio_recebimento_ctestring date

Data inicial para recebimento de CTe. Documentos anteriores serão ignorados e não cobrados. Após definido, não pode ser alterado.

data_inicio_recebimento_nfsenstring date

Data inicial para recebimento de NFSe Nacional. Documentos anteriores serão ignorados e não cobrados. Após definido, não pode ser alterado.

habilita_filtro_mde_destinatario_empresaboolean

Quando verdadeiro, não serão salvos os documentos recebidos (NFe/CTe) que não tenham como destinatário a empresa.

smtp_enderecostring

Endereço do servidor SMTP

smtp_dominiostring

Domínio do servidor SMTP (HELO)

smtp_autenticacao'plain' | 'login' | 'cram_md5'

Tipo de autenticação do SMTP.

smtp_portainteger

Porta do servidor SMTP

smtp_loginstring

Login do servidor SMTP (se exigir autenticação)

smtp_senhastring

Senha do servidor SMTP (se exigir autenticação)

smtp_remetentestring

Remetente (from) dos e-mails enviados

smtp_responder_parastring

Endereço de resposta (reply-to) dos e-mails enviados

smtp_modo_verificacao_openssl'peer' | 'none'

Modo de verificação do OpenSSL.

smtp_habilita_starttlsboolean

Utiliza STARTTLS ao conectar no SMTP

smtp_sslboolean

Utiliza SSL ao conectar no SMTP

smtp_tlsboolean

Utiliza TLS ao conectar no SMTP

csc_nfce_producaostring

CSC para emissão de NFCe em produção. Necessário para emitir NFCe em produção (gerar no SEFAZ do estado).

id_token_nfce_producaointeger

ID do CSC para NFCe em produção. Necessário para emitir NFCe em produção (gerar no SEFAZ do estado).

csc_nfce_homologacaostring

CSC para emissão de NFCe em homologação.

id_token_nfce_homologacaointeger

ID do CSC para NFCe em homologação.

proximo_numero_nfe_producaostring

Próximo número da NFe a ser emitida em produção (calculado automaticamente)

proximo_numero_nfe_homologacaostring

Próximo número da NFe a ser emitida em homologação (calculado automaticamente)

serie_nfe_producaostring

Série da NFe em produção (padrão: 1)

serie_nfe_homologacaostring

Série da NFe em homologação (padrão: 1)

proximo_numero_nfce_producaostring

Próximo número da NFCe a ser emitida em produção (calculado automaticamente)

proximo_numero_nfce_homologacaostring

Próximo número da NFCe a ser emitida em homologação (calculado automaticamente)

serie_nfce_producaostring

Série da NFCe em produção (padrão: 1)

serie_nfce_homologacaostring

Série da NFCe em homologação (padrão: 1)

proximo_numero_nfse_producaostring

Próximo número do RPS da NFSe em produção (calculado automaticamente)

proximo_numero_nfse_homologacaostring

Próximo número do RPS da NFSe em homologação (calculado automaticamente)

serie_nfse_producaostring

Série do RPS da NFSe em produção. Algumas prefeituras não utilizam.

serie_nfse_homologacaostring

Série do RPS da NFSe em homologação

proximo_numero_nfsen_producaostring

Próximo número do RPS da NFSe Nacional em produção (calculado automaticamente)

proximo_numero_nfsen_homologacaostring

Próximo número do RPS da NFSe Nacional em homologação (calculado automaticamente)

serie_nfsen_producaostring

Série do RPS para NFSe Nacional em produção. Algumas prefeituras não utilizam.

serie_nfsen_homologacaostring

Série do RPS para NFSe Nacional em homologação. Algumas prefeituras não utilizam.

proximo_numero_cte_producaostring

Próximo número da CTe a ser emitida em produção (calculado automaticamente)

proximo_numero_cte_homologacaostring

Próximo número da CTe a ser emitida em homologação (calculado automaticamente)

serie_cte_producaostring

Série da CTe em produção (padrão: 1)

serie_cte_homologacaostring

Série da CTe em homologação (padrão: 1)

proximo_numero_cte_os_producaostring

Próximo número da CTeOS a ser emitida em produção (calculado automaticamente)

proximo_numero_cte_os_homologacaostring

Próximo número da CTeOS a ser emitida em homologação (calculado automaticamente)

serie_cte_os_producaostring

Série da CTeOS em produção (padrão: 1)

serie_cte_os_homologacaostring

Série da CTeOS em homologação (padrão: 1)

proximo_numero_mdfe_producaostring

Próximo número da MDFe a ser emitida em produção (calculado automaticamente)

proximo_numero_mdfe_homologacaostring

Próximo número da MDFe a ser emitida em homologação (calculado automaticamente)

serie_mdfe_producaostring

Série da MDFe em produção (padrão: 1)

serie_mdfe_homologacaostring

Série da MDFe em homologação (padrão: 1)

habilita_nfcomboolean

Habilita emissão de NFCom (Nota Fiscal de Comunicação)

proximo_numero_nfcom_producaostring

Próximo número da NFCom a ser emitida em produção (calculado automaticamente)

proximo_numero_nfcom_homologacaostring

Próximo número da NFCom a ser emitida em homologação (calculado automaticamente)

serie_nfcom_producaostring

Série da NFCom em produção (padrão: 1)

serie_nfcom_homologacaostring

Série da NFCom em homologação (padrão: 1)

habilita_dceboolean

Habilita emissão de DCE (Declaração de Conteúdo Eletrônica)

proximo_numero_dce_producaostring

Próximo número da DCE a ser emitida em produção (calculado automaticamente)

proximo_numero_dce_homologacaostring

Próximo número da DCE a ser emitida em homologação (calculado automaticamente)

serie_dce_producaostring

Série da DCE em produção (padrão: 1)

serie_dce_homologacaostring

Série da DCE em homologação (padrão: 1)

nfe_sincronoboolean

Define emissão síncrona da NFe. Se verdadeiro, a autorização/rejeição ocorre na mesma requisição. Em caso de SEFAZ indisponível e contingência desligada, não há alternância automática; será necessário reenviar quando a contingência estiver disponível.

nfe_sincrono_homologacaoboolean

Define emissão síncrona da NFe em homologação

mdfe_sincronoboolean

Define emissão síncrona da MDFe. Se verdadeiro, a autorização/rejeição ocorre na mesma requisição. Em indisponibilidade, não alterna automaticamente para contingência desligada.

mdfe_sincrono_homologacaoboolean

Define emissão síncrona da MDFe em homologação

senha_responsavel_preenchidaboolean

Indica se o campo senha_responsavel está preenchido

Response

Requisição processada com sucesso

idinteger
nomestring
nome_fantasiastring
inscricao_estadualstring
inscricao_municipalstring
bairrostring
cargo_responsavelstring
cepstring
cnpjstring
cpfstring
codigo_municipiostring
codigo_paisstring
codigo_ufstring
complementostring
cpf_cnpj_contabilidadestring
cpf_responsavelstring
discrimina_impostosboolean
emailstring
enviar_email_destinatarioboolean
enviar_email_homologacaoboolean
habilita_nfceboolean
habilita_nfeboolean
habilita_nfseboolean
habilita_nfcomboolean
habilita_dceboolean
habilita_nfsen_producaoboolean
habilita_nfsen_homologacaoboolean
habilita_cteboolean
habilita_mdfeboolean
habilita_manifestacaoboolean
habilita_manifestacao_homologacaoboolean
habilita_manifestacao_cteboolean
habilita_manifestacao_cte_homologacaoboolean
logradourostring
municipiostring
nome_responsavelstring
numerostring
paisstring
regime_tributariostring
telefonestring
ufstring
habilita_contingencia_offline_nfceboolean
habilita_contingencia_epec_nfceboolean
reaproveita_numero_nfce_contingenciaboolean
mostrar_danfse_badgeboolean
csc_nfce_producaostring
id_token_nfce_producaostring
csc_nfce_homologacaostring
id_token_nfce_homologacaostring
proximo_numero_nfe_producaostring
proximo_numero_nfe_homologacaostring
serie_nfe_producaostring
serie_nfe_homologacaostring
proximo_numero_nfse_producaostring
proximo_numero_nfse_homologacaostring
proximo_numero_nfsen_producaostring
proximo_numero_nfsen_homologacaostring
serie_nfse_producaostring
serie_nfse_homologacaostring
serie_nfsen_producaostring
serie_nfsen_homologacaostring
proximo_numero_nfcom_producaostring
proximo_numero_nfcom_homologacaostring
serie_nfcom_producaostring
serie_nfcom_homologacaostring
proximo_numero_dce_producaostring
proximo_numero_dce_homologacaostring
serie_dce_producaostring
serie_dce_homologacaostring
proximo_numero_nfce_producaostring
proximo_numero_nfce_homologacaostring
serie_nfce_producaostring
serie_nfce_homologacaostring
proximo_numero_cte_producaostring
proximo_numero_cte_homologacaostring
serie_cte_producaostring
serie_cte_homologacaostring
proximo_numero_cte_os_producaostring
proximo_numero_cte_os_homologacaostring
serie_cte_os_producaostring
serie_cte_os_homologacaostring
proximo_numero_mdfe_producaostring
proximo_numero_mdfe_homologacaostring
serie_mdfe_producaostring
serie_mdfe_homologacaostring
certificado_valido_atestring
certificado_valido_destring
certificado_cnpjstring
certificado_especificoboolean
data_ultima_emissaostring
caminho_logostring
login_responsavelstring
senha_responsavel_preenchidaboolean
orientacao_danfestring
recibo_danfeboolean
exibe_sempre_ipi_danfeboolean
exibe_issqn_danfeboolean
exibe_impostos_adicionais_danfeboolean
exibe_fatura_danfeboolean
exibe_rastro_danfeboolean
exibe_unidade_tributaria_danfeboolean
exibe_desconto_itensboolean
exibe_sempre_volumes_danfeboolean
exibe_composicao_carga_mdfeboolean
data_inicio_recebimento_nfestring
data_inicio_recebimento_ctestring
data_inicio_recebimento_nfsenstring
habilita_filtro_mde_destinatario_empresaboolean
habilita_csrt_nfeboolean
nfe_sincronoboolean
nfe_sincrono_homologacaoboolean
mdfe_sincronoboolean
mdfe_sincrono_homologacaoboolean
smtp_enderecostring
smtp_dominiostring
smtp_autenticacaostring
smtp_portastring
smtp_loginstring
smtp_remetentestring
smtp_responder_parastring
smtp_modo_verificacao_opensslstring
smtp_habilita_starttllsboolean
smtp_sslboolean
smtp_tlsboolean
token_producaostring
token_homologacaostring