Empresas (emitentes)
nfe.companies gerencia as empresas emitentes (host api.nfe.io). A empresa é
o pré-requisito de toda emissão — e precisa de inscrição
(municipal/estadual) e certificado.
Métodos
| Método | Descrição | Retorno |
|---|---|---|
create(data) | Cria uma empresa. | Company |
retrieve(id) / update(id, data) / remove(id) | CRUD. | Company / void |
exists(id) | Existência via HEAD (404 → false). | boolean |
list(options?) | Lista paginada. | ListResponse<Company> ({ data, page }) |
listAll() | Coleta todas as páginas. | Company[] |
listIterator() | Async iterator (lazy). | AsyncIterableIterator<Company> |
findByTaxNumber(cnpj) / findByName(name) | Busca. | Company / lista |
uploadCertificate / replaceCertificate / validateCertificate | Certificado (.pfx). | metadados |
getCertificateStatus / checkCertificateExpiration | Status/validade do certificado. | info |
Criar e verificar
const company = await nfe.companies.create({
name: 'Minha Empresa LTDA',
federalTaxNumber: 11222333000181,
email: 'fiscal@empresa.com',
});
if (await nfe.companies.exists(company.id)) {
// pronta para configurar inscrições e certificado
}
Iterar todas as empresas
for await (const c of nfe.companies.listIterator()) {
console.log(c.id, c.name);
}
Certificado
O upload do certificado (uploadCertificate) vive no host api.nfe.io. A
consulta/remoção por thumbprint fica em Certificados
(host api.nfse.io).