Download the PHP package quantumtecnology/falcon-fiscalhub-sdk without Composer

On this page you can find all versions of the php package quantumtecnology/falcon-fiscalhub-sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of quantumtecnology/falcon-fiscalhub-sdk

Informations about the package falcon-fiscalhub-sdk

Falcon Fiscal Hub SDK (PHP)

SDK PHP para a API do Falcon Fiscal Hub. Permite que o seu sistema:

Sem dependências além de ext-curl e ext-json.

Instalação

Antes de começar: as notas saem no CNPJ do dono da conta

⚠️ Uma nota emitida pelo seu sistema vale como se o dono da conta do Fiscal Hub a tivesse emitido. Nota autorizada não se desfaz: cancelar tem prazo e, dependendo do município, multa.

  • Mande sempre external_reference (o id do pedido/cobrança no seu sistema). Reenviar a mesma referência devolve a nota que já existe em vez de emitir outra — é o que protege o dono da conta do seu retry.
  • Peça só as permissões que o seu sistema usa.

O dono da conta cria a chave no painel (Chaves de API), escolhe as permissões e aceita o termo de responsabilidade. Cada chave tem um nome — o do seu sistema — e esse nome vira a origem das notas que ela emitir: é como o dono filtra e reconhece as suas notas na listagem.

Permissão Para
nfse:read listar, consultar, baixar PDF/XML
nfse:write emitir, transmitir, cancelar
cadastros:read buscar tomador e naturezas de operação
cadastros:write cadastrar tomador

Uso

A URL não está no SDK de propósito: é configuração do seu ambiente.

Emitir uma NFS-e

A natureza de operação é o perfil de emissão: o dono da conta cadastra nela o emitente, a série, os códigos de serviço (cTribNac, cTribMun, NBS), o ISS e a descrição padrão. O seu sistema só informa o que muda de nota para nota.

emit() cria a nota e transmite. Se a referência já tiver sido emitida, devolve a nota existente sem transmitir de novo.

Baixar, consultar, cancelar

Erros

Toda falha vira exceção tipada (todas estendem FalconException):

Exceção Quando O que fazer
FiscalRejectionException o fisco rejeitou a nota (o HTTP foi 200) corrigir o cadastro e transmit() de novo; a nota fica salva como rejeitada
ValidationException (422) dado inválido getErrors() diz os campos
ForbiddenException (403) a chave não tem a permissão getAbility() diz qual; ajustar no painel
QuotaExceededException (402) acabou a cota de emissão do plano upgrade — não repetir
AuthException (401) chave inválida, revogada ou expirada nova chave no painel
RateLimitException (429) mais de 120 req/min na chave getRetryAfter()
NotFoundException (404) nota de outra conta ou inexistente —
ServerException (5xx) / TimeoutException indisponível tentar depois (com a mesma external_reference)

Timeout

60 segundos por padrão: a transmissão é síncrona (assina, envia ao Ambiente Nacional e espera a autorização). Cortar antes faria o seu sistema achar que falhou uma nota que foi autorizada — e com external_reference, tentar de novo é seguro de qualquer forma.

Testes

All versions of falcon-fiscalhub-sdk with dependencies

PHP Build Version
Package Version
Requires php Version ^8.1
ext-curl Version *
ext-json Version *
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package quantumtecnology/falcon-fiscalhub-sdk contains the following files

Loading the files please wait ...