APIs principais
Empresas
7 endpoints
/api/company/createCadastrar nova empresa emissora
Cadastra uma empresa emissora vinculada a uma conta de distribuidor (b2b). Use este endpoint quando os dados da empresa já estão disponíveis. Para extração automática a partir do certificado digital, use /api/company/v2/create.
Headers obrigatórios
| Header | Tipo | Descrição |
|---|---|---|
| token | string | Token do distribuidor (b2b — a conta precisa ter isb2b=true) |
| sign | string | Assinatura MD5 |
| timestamp | string | Unix timestamp em segundos |
Body
| Campo | Tipo | Descrição |
|---|---|---|
| Identificação | ||
| cnpj * | string | CNPJ da empresa emissora |
| name * | string | Razão social |
| ie * | string | Inscrição Estadual |
| invoice_type * | string | Regime tributário (ex.: "simples_nacional", "normal") |
| unit * | string | Tipo de unidade |
| string | E-mail da empresa | |
| Endereço | ||
| cep * | string | CEP |
| address * | string | Logradouro |
| house_number * | string | Número do endereço |
| town * | string | Bairro |
| city * | string | Município |
| state * | string | UF (sigla do estado) |
| Certificado digital | ||
| cert_content * | string | Conteúdo do arquivo do certificado A1 (.pfx/.p12) em Base64 |
| cert_file | string | Descontinuado — rejeitado a partir de 2026-09-01. URL HTTPS do certificado |
| cert_pwd * | string | Senha do certificado |
| Numeração e configurações | ||
| serie * | int | Série da NF-e |
| number * | int | Número inicial da numeração |
| Transporte (MDF-e / CT-e / DC-e) | ||
| serie_mdfe | int | Série do MDF-e |
| number_mdfe | int | Número inicial do MDF-e (onde a numeração começa) |
| serie_cte | int | Série do CT-e |
| number_cte | int | Número inicial do CT-e (onde a numeração começa) |
| serie_dce | int | Série da DC-e |
| number_dce | int | Número inicial da DC-e (onde a numeração começa) |
| Comunicação (NFCom) | ||
| serie_nfcom | int | Série da NFCom |
| number_nfcom | int | Número inicial da NFCom (onde a numeração começa) |
| Energia (NF3e) | ||
| serie_nf3e | int | Série da NF3e |
| number_nf3e | int | Número inicial da NF3e (onde a numeração começa) |
| is_create_category_template | boolean | Cria categorias fiscais padrão automaticamente. Default: true |
* Campo obrigatório.
/api/company/v2/createCadastrar empresa via certificado
Versão simplificada de /api/company/create: a API valida o certificado digital e extrai automaticamente razão social, IE, endereço e demais dados via consulta interna. Apenas cnpj, cert_content e cert_pwd são obrigatórios.
Headers obrigatórios
| Header | Tipo | Descrição |
|---|---|---|
| token | string | Token do distribuidor (b2b — a conta precisa ter isb2b=true) |
| sign | string | Assinatura MD5 |
| timestamp | string | Unix timestamp em segundos |
Body
| Campo | Tipo | Descrição |
|---|---|---|
| cnpj * | string | CNPJ da empresa emissora |
| cert_content * | string | Conteúdo do arquivo do certificado A1 (.pfx/.p12) em Base64 |
| cert_file | string | Descontinuado — rejeitado a partir de 2026-09-01. URL HTTPS do certificado |
| cert_pwd * | string | Senha do certificado |
| is_create_category_template | boolean | Cria categorias fiscais padrão automaticamente. Default: true |
* Campo obrigatório.
/api/company/editEditar dados da empresa
Atualiza dados da empresa emissora. Envie apenas os campos que deseja alterar — todos exceto company_id são opcionais. CNPJ é imutável: tentar enviá-lo retorna erro. Ao atualizar cep, o sistema resolve automaticamente stateCode e ibge. Quando cert_content e cert_pwd vêm juntos, o certificado é validado antes de salvar.
A empresa é criada com a configuração de NF-e (via /api/company/create). Para habilitar os demais documentos, complete o cadastro por aqui: este endpoint também aceita os campos de NFC-e, NFS-e, MDF-e, CT-e e DC-e (ver seções abaixo). Envie apenas os campos do(s) documento(s) que a empresa vai emitir.
Headers obrigatórios
| Header | Tipo | Descrição |
|---|---|---|
| token | string | Token da empresa |
| sign | string | Assinatura MD5 |
| timestamp | string | Unix timestamp em segundos |
Body
| Campo | Tipo | Descrição |
|---|---|---|
| company_id * | string | ID da empresa a editar |
| name | string | Razão social |
| invoice_type | string | Regime tributário |
| ie | string | Inscrição Estadual |
| unit | string | Tipo de unidade |
| string | ||
| cep | string | CEP (atualiza stateCode e ibge automaticamente) |
| address | string | Logradouro |
| house_number | string | Número |
| town | string | Bairro |
| city | string | Município |
| state | string | UF |
| cert_content | string | Conteúdo do arquivo do certificado A1 (.pfx/.p12) em Base64 |
| cert_file | string | Descontinuado — rejeitado a partir de 2026-09-01. URL HTTPS do certificado |
| cert_pwd | string | Nova senha do certificado |
| serie | int | Nova série da NF-e |
| number | int | Novo número inicial da NF-e |
| alias | string | Nome fantasia |
| telefone | string | Telefone |
| complemento | string | Complemento do endereço |
| NFC-e | ||
| csc_id | string | ID do CSC (Código de Segurança do Contribuinte) no Fisco |
| csc | string | Token CSC (segredo compartilhado com o Fisco) |
| serie_nfce | int | Série da NFC-e |
| number_nfce | int | Próximo número da NFC-e |
| NFS-e | ||
| im | string | Inscrição Municipal |
| codigo_municipio_nfse | string | Código IBGE do município emissor |
| codigo_servico_nfse | string | Código do serviço padrão (LC 116) |
| cnae_nfse | string | CNAE da atividade padrão |
| serie_nfse | int | Série da NFS-e |
| number_nfse | int | Próximo número da NFS-e |
| regime_especial_tributacao | int | Código do regime especial de tributação |
| optante_simples_nacional | bool | Optante pelo Simples Nacional |
| Transporte (MDF-e / CT-e / DC-e) | ||
| serie_mdfe | int | Série do MDF-e |
| number_mdfe | int | Número inicial do MDF-e (onde a numeração começa) |
| serie_cte | int | Série do CT-e |
| number_cte | int | Número inicial do CT-e (onde a numeração começa) |
| serie_dce | int | Série da DC-e |
| number_dce | int | Número inicial da DC-e (onde a numeração começa) |
| Comunicação (NFCom) | ||
| serie_nfcom | int | Série da NFCom |
| number_nfcom | int | Número inicial da NFCom (onde a numeração começa) |
| Energia (NF3e) | ||
| serie_nf3e | int | Série da NF3e |
| number_nf3e | int | Número inicial da NF3e (onde a numeração começa) |
* Campo obrigatório. Enviar cnpj retorna erro. Todos os demais campos são opcionais — envie só os que quiser alterar.
/api/company/get_listListar empresas do distribuidor
Lista, com paginação, as empresas emissoras vinculadas à conta de distribuidor (b2b). Parâmetros via query string.
Headers obrigatórios
| Header | Tipo | Descrição |
|---|---|---|
| token | string | Token do distribuidor (b2b — a conta precisa ter isb2b=true) |
| sign | string | Assinatura MD5 (path inclui a query string) |
| timestamp | string | Unix timestamp em segundos |
Query string
| Parâmetro | Tipo | Descrição |
|---|---|---|
| page * | int | Número da página (≥ 1) |
| page_size * | int | Tamanho da página (1–20) |
* Campo obrigatório.
/api/company/get_detailDetalhes da empresa autenticada
Retorna os dados completos da empresa identificada pelo header token, incluindo a lista de categorias fiscais cadastradas. Não aceita body nem query string.
Headers obrigatórios
| Header | Tipo | Descrição |
|---|---|---|
| token | string | Token da empresa |
| sign | string | Assinatura MD5 |
| timestamp | string | Unix timestamp em segundos |
/api/company/get_cep_detailConsultar endereço por CEP
Resolve um CEP brasileiro retornando UF, código IBGE do município e dados do endereço. Útil para preencher endereços de empresas e clientes. Requer conta de distribuidor (b2b).
Headers obrigatórios
| Header | Tipo | Descrição |
|---|---|---|
| token | string | Token do distribuidor (b2b — a conta precisa ter isb2b=true) |
| sign | string | Assinatura MD5 (path inclui a query string) |
| timestamp | string | Unix timestamp em segundos |
Query string
| Parâmetro | Tipo | Descrição |
|---|---|---|
| cep * | string | CEP brasileiro (8 dígitos, com ou sem traço) |
* Campo obrigatório.
/api/company/get_export_invoice_month_filesListar exportações mensais
Retorna a lista de arquivos de exportação mensal que já foram gerados para a empresa no ano corrente (timezone America/Sao_Paulo). Cada mês pode ter até 4 arquivos: 1 planilha Excel (apenas status Success) + 3 XMLs (por status Success, Canceled e Voided). Apenas arquivos efetivamente exportados aparecem no retorno — use /api/invoice/get_xml para gerar novos.
Headers obrigatórios
| Header | Tipo | Descrição |
|---|---|---|
| token | string | Token da empresa |
| sign | string | Assinatura MD5 |
| timestamp | string | Unix timestamp em segundos |
Resposta
| Campo | Tipo | Descrição |
|---|---|---|
| files[] | array | Lista de arquivos disponíveis |
| files[].url | string | URL do arquivo no OSS |
| files[].year | int | Ano do período |
| files[].month | string | Mês (1–12) |
| files[].type | string | Tipo do arquivo: "xlsx" ou "xml" |
| files[].status | string | Status das notas no arquivo: "Success", "Canceled" ou "Voided" |
| files[].create | datetime | Quando o arquivo foi gerado |