Cliente PHP da FiscalAPI: Inscrição Estadual nos 27 estados, CNPJ, certidões (CND estadual, CND Federal, CNDT, CRF/FGTS), XML de NF-e e de CT-e por chave, DIFAL de saída por UF, NFS-e por chave, Simples Nacional, SIGEF, CNIR e perfil do produtor rural.
- PHP 8.1 ou superior, só com a extensão
curl(nenhum pacote do Composer). - Autoload PSR-4 (
FiscalApiBr\). - Novas tentativas automáticas em
429e em falhas temporárias. - Exceções tipadas para chave inválida, falta de saldo e limite de requisições.
composer require fiscalapi-br/fiscalapi-php- Crie sua conta em app.fiscalapi.com.br e copie a chave de API no painel.
- Plano ou recarga: pela API, toda consulta pede plano ou saldo, a partir de R$ 50 por mês. As 10 consultas grátis do mês são só no painel: teste lá antes de assinar. Sem plano nem saldo, a API responde
402(InsufficientBalanceException). Sem chave,403(AuthenticationException). - Planos e consumo de créditos: docs.fiscalapi.com.br.
<?php
require 'vendor/autoload.php';
use FiscalApiBr\FiscalAPI;
$api = new FiscalAPI('sua-chave'); // ou defina FISCALAPI_API_KEY
$resp = $api->consultarIe('MT', cpf: '12345678909');
foreach ($resp['results'] as $ie) {
echo $ie['inscricao_estadual'], ' ', $ie['situacao_ie'], ' ', $ie['municipio'], PHP_EOL;
}Todos os métodos devolvem array com o JSON da API. Use argumentos nomeados para o documento.
| Método | Endpoint | O que retorna |
|---|---|---|
consultarIe($uf, cpf: | cnpj: | ie:, secundarias: false) |
GET /api/consultar |
Inscrições estaduais em uma UF |
consultarIeTodos(cpf: | cnpj: | ie:, secundarias: false) |
GET /api/consultar-ie-todos |
Inscrições em todos os estados |
consultarCnpj($cnpj, forceFresh: false) |
GET /api/consultar-cnpj |
Dados cadastrais da Receita Federal |
consultarCnd($uf, cpf: | cnpj:) |
GET /api/consultar-cnd |
CND estadual (ICMS) com PDF |
consultarCndTodos(cpf: | cnpj:) |
GET /api/consultar-cnd-todos |
CND estadual em todos os estados disponíveis |
consultarCndFederal(cpf: | cnpj:, emitirNova: false) |
GET /api/consultar-cnd-federal |
CND Federal (Receita Federal + PGFN) |
consultarCndt(cpf: | cnpj:) |
GET /api/consultar-cndt |
Certidão de débitos trabalhistas |
consultarCrfFgts(cpf: | cnpj:) |
GET /api/consultar-crf-fgts |
Regularidade do FGTS |
consultarCertidoesTodas(cpf: | cnpj:, skipEstaduais: false) |
GET /api/certidoes-todas |
Todas as certidões em uma chamada |
consultarSimplesNacional($cnpj) |
GET /api/consultar-simples-nacional |
Situação no Simples Nacional e SIMEI |
consultarNfse($chave, danfse: false) |
GET /api/consultar-nfse |
NFS-e (padrão nacional) por chave, sem certificado |
consultarNfeXml($chave, $certificado, $senha, manifestar: true) |
POST /api/consultar-nfe-xml |
XML completo da NF-e |
consultarCteXml($chave, $certificado, $senha) |
POST /api/consultar-cte-xml |
XML completo do CT-e |
consultarDifalSaida($competencia, $certificado, $senha, $ufs = []) |
POST /api/consultar-difal-saida |
DIFAL de saída por UF de destino (Beta) |
consultarSigef(cpf: | cnpj:) |
GET /api/consultar-sigef |
Parcelas certificadas no SIGEF/INCRA |
consultarSigefParcela($uuid, forceFresh: false) |
GET /api/consultar-sigef-parcela |
Uma parcela com polígono, vértices e confrontantes |
consultarCnir(cpf: | cnpj:) |
GET /api/consultar-cnir |
Imóveis rurais no CNIR/CAFIR |
perfilProdutor(cpf: | cnpj:) |
GET /api/perfil-produtor |
Perfil consolidado do produtor |
Informe um documento por chamada. Pontuação é aceita.
$resp = $api->consultarIeTodos(cnpj: '12.345.678/0001-95');
if (($resp['complete'] ?? true) === false) {
echo "Algum estado não respondeu; tente de novo antes de concluir que não há IE.\n";
}
foreach ($resp['results'] as $uf) {
foreach ($uf['results'] as $ie) {
echo $uf['uf'], ' ', $ie['inscricao_estadual'], ' ', $ie['situacao_ie'], PHP_EOL;
}
}$empresa = $api->consultarCnpj('12345678000195');
echo $empresa['result']['razao_social'], ' — ', $empresa['result']['situacao_cadastral'], PHP_EOL;
// Dado atual, sem cache (consome mais créditos):
$api->consultarCnpj('12345678000195', forceFresh: true);$r = $api->consultarSimplesNacional('11222333000181');
var_dump($r['optante_simples'], $r['situacao_simei'], $r['regime_regular_ibs']);$nfse = $api->consultarNfse(
'35503082211222333000181000000000012326100000045676',
danfse: true, // opcional: PDF do DANFSe em base64
);
echo $nfse['emitente']['razao_social'], ' — ', $nfse['tributacao_municipal']['valor_servico'], PHP_EOL;Uma consulta nova leva de 30 a 60 segundos. Só a NFS-e entregue é cobrada.
$cnd = $api->consultarCnd('MT', cpf: '12345678909');
echo $cnd['result']['status'], ' até ', $cnd['result']['validade_iso'], PHP_EOL;
if (!empty($cnd['result']['pdf_base64'])) {
file_put_contents('cnd-mt.pdf', base64_decode($cnd['result']['pdf_base64']));
}
$federal = $api->consultarCndFederal(cnpj: '12345678000195');
$trabalhista = $api->consultarCndt(cnpj: '12345678000195');
$fgts = $api->consultarCrfFgts(cnpj: '12345678000195');O campo status vem como negativa, positiva, positiva_com_efeitos_de_negativa, nao_contribuinte, sem_certidao ou erro.
$resp = $api->consultarNfeXml(
'35260112345678000195550010000012341000012345',
'certificado.pfx', // caminho do arquivo ou conteúdo em base64
'senha-do-certificado',
);
$nota = $resp['resultados'][0];
if ($nota['status'] === 'ok') {
file_put_contents($nota['chave'] . '.xml', $nota['xml']);
} else {
echo $nota['status'], ': ', $nota['mensagem'], PHP_EOL;
}O certificado A1 precisa ser de um participante da nota (emitente, destinatário, transportador ou autorizado) e não é armazenado pela API. Só há cobrança quando o XML é devolvido.
$cte = $api->consultarCteXml(
'51261011222333000181570010000001231123456784',
'certificado.pfx', // caminho do arquivo ou conteúdo em base64
'senha-do-certificado',
);
if ($cte['status'] === 'ok') {
file_put_contents($cte['chave'] . '.xml', $cte['xml']);
} else {
echo $cte['status'], ': ', $cte['mensagem'], PHP_EOL;
}Aceita CT-e (modelo 57), CT-e OS (67) e GTV-e (64). O certificado A1 precisa ser de um participante do documento (emitente, tomador, remetente, destinatário, expedidor ou recebedor) e não é armazenado pela API. Só há cobrança quando o XML é devolvido.
$difal = $api->consultarDifalSaida(
'2026-10',
'certificado-do-emitente.pfx', // caminho do arquivo ou conteúdo em base64
'senha-do-certificado',
['RS', 'SC'], // omita para as 10 UFs
);
foreach ($difal['ufs'] as $uf) {
echo $uf['uf'], ' ', $uf['status'], ' ', $uf['valor_em_aberto'], PHP_EOL;
foreach ($uf['notas'] as $nota) {
if ($nota['em_aberto']) {
echo ' ', $nota['serie'], ' ', $nota['numero'], ' ', $nota['situacao_guia_difal'], PHP_EOL;
}
}
}
if (!$difal['completo']) {
echo 'Alguma UF não veio completa: os totais podem estar incompletos.', PHP_EOL;
}Lista as NF-e do mês com DIFAL e FCP destacados, a situação da guia de cada nota e o valor em aberto, nas UFs de destino AC, AP, DF, GO, MS, MT, RR, RS, SC e SE. O certificado A1 é o do emitente das notas e não é armazenado pela API. Só paga quita: sem_guia_no_portal, pendente_pagamento e geracao_rejeitada somam em valor_em_aberto, menos em DF, GO e MT, onde a guia é emitida no sistema da SEFAZ e a nota sem_guia_no_portal soma em valor_a_conferir. Cobra 1 consulta por UF com status ok. Guia emitida fora do portal (ERP, Portal GNRE) não aparece. Detalhes: documentação.
$sigef = $api->consultarSigef(cpf: '12345678909');
foreach ($sigef['result']['parcelas'] ?? [] as $p) {
echo $p['denominacao'], ' — ', $p['area_ha'], ' ha — ', $p['municipio'], '/', $p['uf'], PHP_EOL;
}
$parcela = $api->consultarSigefParcela('0f1e2d3c-4b5a-6978-8a9b-0c1d2e3f4a5b');
echo $parcela['result']['geometria_wkt'], PHP_EOL;
$cnir = $api->consultarCnir(cpf: '12345678909');
echo $cnir['total_imoveis'], " imóveis\n";$perfil = $api->perfilProdutor(cpf: '12345678909');Uma resposta 200 pode trazer source_status.status diferente de success (por exemplo, timeout quando o órgão não respondeu a tempo). Confira esse campo antes de concluir que o documento não tem registro.
use FiscalApiBr\Exception\{
FiscalAPIException, AuthenticationException, InsufficientBalanceException,
RateLimitException, BadRequestException, ServerException, APIConnectionException
};
try {
$api->consultarIe('SP', cnpj: '12345678000195');
} catch (AuthenticationException $e) {
// chave ausente, inválida ou revogada (401/403)
} catch (InsufficientBalanceException $e) {
echo $e->getConsultasRestantes(); // plano ou saldo esgotado (402)
} catch (RateLimitException $e) {
echo $e->getRetryAfter(); // limite por minuto do plano (429)
} catch (BadRequestException $e) {
echo $e->errorCode, ': ', $e->getMessage(); // parâmetro ausente ou inválido (400/422)
} catch (FiscalAPIException $e) {
echo $e->statusCode, ' ', $e->requestId; // informe o requestId ao suporte
}$api = new FiscalAPI('sua-chave', timeout: 200, maxRetries: 3);429: o SDK espera o tempo do cabeçalhoRetry-Aftere tenta de novo.500,502,503,504e falhas de rede: novas tentativas com espera exponencial, só em consultas GET. A consulta de NF-e (POST) não é repetida automaticamente.- Algumas consultas (NF-e, SIGEF) podem levar até 3 minutos; o timeout padrão é 200 s. Ajuste também o
max_execution_timedo PHP, se for o caso.
- Documentação: docs.fiscalapi.com.br
- Guias (Excel, Google Sheets, n8n, Make, Power Automate, Python, Node.js, PHP): docs.fiscalapi.com.br/docs/guias
- Especificação OpenAPI: docs.fiscalapi.com.br/openapi.json
- Servidor MCP: fiscalapi-br/fiscalapi-mcp
- Para desenvolvedores: fiscalapi.com.br/desenvolvedores
- Painel: app.fiscalapi.com.br
- Suporte: contato@fiscalapi.com.br
MIT