diff --git a/README.md b/README.md index 6d5ec28..0aa2950 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # FiscalAPI — SDK PHP -Cliente PHP da [FiscalAPI](https://fiscalapi.com.br): 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, NFS-e por chave, Simples Nacional, SIGEF, CNIR e perfil do produtor rural. +Cliente PHP da [FiscalAPI](https://fiscalapi.com.br): 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\`). @@ -54,6 +54,7 @@ Todos os métodos devolvem `array` com o JSON da API. Use argumentos nomeados pa | `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 | @@ -157,6 +158,30 @@ if ($cte['status'] === 'ok') { 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 de saída por UF de destino (Beta) + +```php +$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](https://docs.fiscalapi.com.br/docs/difal/consultar-difal-saida). + ### Imóvel rural ```php diff --git a/composer.json b/composer.json index d3a5cd9..e969313 100644 --- a/composer.json +++ b/composer.json @@ -1,6 +1,6 @@ { "name": "fiscalapi-br/fiscalapi-php", - "description": "SDK da FiscalAPI (Brasil): Inscrição Estadual, CNPJ, certidões, NF-e, SIGEF, CNIR e perfil do produtor rural.", + "description": "SDK da FiscalAPI (Brasil): Inscrição Estadual, CNPJ, certidões, NF-e, CT-e, DIFAL, SIGEF, CNIR e perfil do produtor rural.", "type": "library", "license": "MIT", "keywords": [ @@ -11,6 +11,7 @@ "cnd", "certidao", "nfe", + "difal", "sigef", "cnir", "produtor rural", diff --git a/src/FiscalAPI.php b/src/FiscalAPI.php index fca4bc5..0de954a 100644 --- a/src/FiscalAPI.php +++ b/src/FiscalAPI.php @@ -21,7 +21,7 @@ */ final class FiscalAPI { - public const VERSION = '0.3.0'; + public const VERSION = '0.4.0'; public const DEFAULT_BASE_URL = 'https://api.fiscalapi.com.br'; /** Algumas consultas (NF-e, SIGEF) podem levar até 180 s no servidor. */ public const DEFAULT_TIMEOUT = 200; @@ -216,6 +216,42 @@ public function consultarCteXml(string $chave, string $certificado, string $senh ]); } + /** + * DIFAL de saída (EC 87/2015) por UF de destino, num mês + * (POST /api/consultar-difal-saida). Beta. + * + * Lista as NF-e do emitente com DIFAL e FCP destacados, a situação da guia + * de cada nota e o valor em aberto. Cobra 1 consulta por UF com + * status "ok". Pode levar cerca de 70 s. Não é repetido em 5xx. + * + * @param string $competencia Mês de emissão das notas, AAAA-MM (ex.: 2026-10). + * @param string $certificado Caminho do arquivo .pfx/.p12 do EMITENTE das notas + * ou o conteúdo em base64. Não é armazenado pela API. + * @param string $senha Senha do certificado. + * @param string[] $ufs Siglas das UFs de destino. Vazio = as 10 atendidas + * (AC, AP, DF, GO, MS, MT, RR, RS, SC, SE). + */ + public function consultarDifalSaida( + string $competencia, + string $certificado, + string $senha, + array $ufs = [] + ): array { + $competencia = trim($competencia); + if (!preg_match('/^\d{4}-(0[1-9]|1[0-2])$/', $competencia)) { + throw new \InvalidArgumentException('Informe a competência no formato AAAA-MM (ex.: 2026-10).'); + } + $body = [ + 'certificado' => self::certificadoBase64($certificado), + 'senha' => $senha, + 'competencia' => $competencia, + ]; + if ($ufs !== []) { + $body['ufs'] = array_values(array_map(static fn ($uf): string => self::uf((string) $uf), $ufs)); + } + return $this->request('POST', '/api/consultar-difal-saida', [], $body); + } + /** * NFS-e (padrão nacional) pela chave de acesso, sem certificado * (GET /api/consultar-nfse). Com $danfse = true, inclui o PDF do DANFSe em