APIs principais
NFS-e
6 endpoints
A API de NFS-e permite emitir, cancelar e consultar Notas Fiscais de Servico Eletronicas. O sistema detecta automaticamente o municipio da empresa e roteia para a API correta:
- Sao Paulo (SP) - Emissao via Nota Fiscal Paulistana (SOAP)
- Demais municipios - Emissao via API Nacional (ADN/SEFIN)
O integrador nao precisa se preocupar com qual API usar - basta enviar os dados e o sistema faz o roteamento automaticamente pelo codigo IBGE do municipio cadastrado na empresa.
| Endpoint | Metodo | Descricao |
|---|---|---|
/api/nfse/create | POST | Emitir NFS-e |
/api/nfse/cancel | POST | Cancelar NFS-e |
/api/nfse/get_danfse | POST | Obter DANFSE (PDF) |
/api/nfse/get_xml | POST | Download do XML |
/api/nfs/company/createCadastrar empresa NFS-e
Cadastra (ou atualiza) uma empresa para emissão de NFS-e. Se o CNPJ já existir para o usuário, apenas os campos NFS-e e o certificado são atualizados; caso contrário, uma nova empresa é criada e um token dedicado é retornado. Atenção ao path: /api/nfs/... (sem o "e"), diferente dos demais endpoints NFS-e.
Headers obrigatórios
| Header | Tipo | Descrição |
|---|---|---|
| token | string | Token B2B do integrador |
| sign | string | Assinatura MD5 |
| timestamp | string | Unix timestamp em segundos |
Body
| Campo | Tipo | Descrição |
|---|---|---|
| cnpj * | string | CNPJ da empresa (apenas dígitos) |
| name * | string | Razão social |
| cep * | string | CEP (apenas dígitos) |
| address * | string | Logradouro |
| house_number * | string | Número do endereço |
| town * | string | Bairro |
| city * | string | Cidade |
| state * | string | UF (2 dígitos, ex.: "SP") |
| 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 digital |
| 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) |
| alias | string | Nome fantasia |
| ie | string | Inscrição estadual |
| invoice_type | string | Regime tributário |
| unit | string | Unidade / filial |
| string | E-mail de contato | |
| telefone | string | Telefone |
| complemento | string | Complemento do endereço |
| cnae_nfse | string | CNAE da atividade padrão |
| serie_nfse | int | Série inicial da NFS-e |
| number_nfse | int | Número inicial da NFS-e |
| regime_especial_tributacao | int | Código do regime especial de tributação |
| optante_simples_nacional | bool | Optante pelo Simples Nacional |
* Campo obrigatório.
Nota: O token retornado deve ser usado nas demais chamadas NFS-e (/api/nfse/create, /cancel, /get_danfse, /get_xml). Se a empresa já existir, a mensagem será "Empresa atualizada para NFS-e" e o token retornado é o token existente.
/api/nfse/createEmitir NFS-e
Headers obrigatorios
| Header | Tipo | Descricao |
|---|---|---|
| token | string | Token da empresa |
| sign | string | Assinatura MD5: MD5(token + path + body + timestamp) |
| timestamp | string | Unix timestamp em segundos (janela de 5 minutos) |
Campos Principais
| Campo | Tipo | Descricao |
|---|---|---|
| ambiente | string | "1" = Producao, "2" = Homologacao |
| id | string | ID de referencia externa (opcional) |
| descricao_servico | string | Descricao do servico prestado (obrigatorio) |
| valor_servico | decimal | Valor total do servico em R$ (obrigatorio) |
| aliquota_iss | decimal | Aliquota ISS em % (ex: 2.90) |
| iss_retido | boolean | false = Nao retido, true = Retido pelo tomador |
| valor_iss | decimal | Override do valor do ISS. Se maior que 0, sobrepoe o calculo automatico (base_calculo x aliquota_iss div 100). Default: calculado automaticamente |
| codigo_servico | string | Codigo do servico. Se vazio, usa o padrao da empresa |
| cnae | string | CNAE. Se vazio, usa o padrao da empresa |
| tomador | object | Dados do tomador do servico (obrigatorio) |
Tomador - Campos
| Campo | Tipo | Descricao |
|---|---|---|
| cnpj | string | CNPJ do tomador (somente numeros) |
| cpf | string | CPF do tomador (usar cnpj OU cpf) |
| name | string | Nome/Razao Social (obrigatorio) |
| string | Email do tomador | |
| telefone | string | Telefone |
| cep | string | CEP (obrigatorio) |
| endereco | string | Logradouro (obrigatorio) |
| numero | string | Numero (obrigatorio) |
| complemento | string | Complemento |
| bairro | string | Bairro (obrigatorio) |
| city | string | Cidade |
| uf | string | UF (2 digitos) |
| codigo_municipio | string | Codigo IBGE do municipio |
/api/nfse/cancelCancelar NFS-e
Headers obrigatorios
| Header | Tipo | Descricao |
|---|---|---|
| token | string | Token da empresa |
| sign | string | Assinatura MD5 |
| timestamp | string | Unix timestamp em segundos |
Campos
| Campo | Tipo | Descricao |
|---|---|---|
| chave | string | Codigo de verificacao da NFS-e (obrigatorio) |
| motivo | string | Motivo do cancelamento (obrigatório; no padrão Nacional deve ter de 15 a 255 caracteres) |
| c_motivo | string | Código de justificativa do cancelamento (opcional, padrão Nacional): "1" = Erro na emissão (padrão), "2" = Serviço não prestado, "9" = Outros |
/api/nfse/get_danfseObter PDF da NFS-e
Headers obrigatorios
| Header | Tipo | Descricao |
|---|---|---|
| token | string | Token da empresa |
| sign | string | Assinatura MD5 |
| timestamp | string | Unix timestamp em segundos |
Campos
| Campo | Tipo | Descricao |
|---|---|---|
| chave | string | Codigo de verificacao da NFS-e (obrigatorio) |
Nota: Para Paulistana (SP), retorna a URL direta do PDF da prefeitura. Para API Nacional, retorna o PDF em base64.
/api/nfse/get_xmlDownload XML da NFS-e
Headers obrigatorios
| Header | Tipo | Descricao |
|---|---|---|
| token | string | Token da empresa |
| sign | string | Assinatura MD5 |
| timestamp | string | Unix timestamp em segundos |
Campos
| Campo | Tipo | Descricao |
|---|---|---|
| chave | string | Codigo de verificacao da NFS-e (obrigatorio) |
dpsXml: Link (URL no OSS) do XML enviado para a prefeitura/ADN. nfseXml: Link do XML de retorno com o resultado da emissao. Os XMLs sobem ao OSS na primeira consulta e a URL fica em cache.
/api/nfse/get_listListar NFS-e (com paginação)
Lista as NFS-e da empresa com paginação. Parâmetros passados via query string (não no body). O filtro de tempo é opcional, mas se enviado exige ambos start_create_time e end_create_time.
Headers obrigatórios
| Header | Tipo | Descrição |
|---|---|---|
| token | string | Token da empresa emissora |
| 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–50) |
| start_create_time | long | Unix timestamp em milissegundos — início (exige end_create_time) |
| end_create_time | long | Unix timestamp em milissegundos — fim |
| status | string | Filtrar por status. Valores: "autorizada", "cancelada", "pendente", "rejeitada" |
* Campo obrigatório.