Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 22 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# FiscalAPI — SDK Node.js / TypeScript

Cliente JavaScript/TypeScript 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 por chave, NFS-e por chave, Simples Nacional, SIGEF, CNIR e perfil do produtor rural.
Cliente JavaScript/TypeScript 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.

- Zero dependências: usa o `fetch` nativo (Node 18+, Bun, Deno, edge runtimes).
- Tipado em TypeScript, com ESM e CommonJS.
Expand Down Expand Up @@ -56,12 +56,13 @@ const { FiscalAPI } = require('fiscalapi-br');
| `consultarSimplesNacional({ cnpj })` | `GET /api/consultar-simples-nacional` | Situação no Simples Nacional e SIMEI |
| `consultarNfse({ chave, danfse? })` | `GET /api/consultar-nfse` | NFS-e (padrão nacional) por chave, sem certificado |
| `consultarNfeXml({ chave, certificado, senha, manifestar? })` | `POST /api/consultar-nfe-xml` | XML completo da NF-e |
| `consultarCteXml({ chave, certificado, senha })` | `POST /api/consultar-cte-xml` | XML completo do CT-e |
| `consultarSigef({ cpf \| cnpj })` | `GET /api/consultar-sigef` | Parcelas certificadas no SIGEF/INCRA |
| `consultarSigefParcela({ uuid, forceFresh? })` | `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. As respostas trazem o JSON completo da API, com tipos exportados (`ConsultaIEResponse`, `CNDResponse`, `NfeXmlResponse` etc.).
Informe **um** documento por chamada. Pontuação é aceita. As respostas trazem o JSON completo da API, com tipos exportados (`ConsultaIEResponse`, `CNDResponse`, `NfeXmlResponse`, `CteXmlResponse` etc.).

## Exemplos

Expand Down Expand Up @@ -144,6 +145,25 @@ if (nota.status === 'ok' && nota.xml) {

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.

### XML de CT-e por chave

```ts
import { readFile, writeFile } from 'node:fs/promises';

const cte = await api.consultarCteXml({
chave: '51261011222333000181570010000001231123456784',
certificado: await readFile('certificado.pfx'), // bytes ou string base64
senha: 'senha-do-certificado',
});
if (cte.status === 'ok' && cte.xml) {
await writeFile(`${cte.chave}.xml`, cte.xml, 'utf8');
} else {
console.log(cte.status, cte.mensagem);
}
```

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.

### Imóvel rural

```ts
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "fiscalapi-br",
"version": "0.2.0",
"version": "0.3.0",
"description": "SDK da FiscalAPI (Brasil): Inscrição Estadual, CNPJ, certidões, NF-e, SIGEF, CNIR e perfil do produtor rural.",
"license": "MIT",
"author": {
Expand Down
21 changes: 21 additions & 0 deletions src/client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ import type {
CNPJResponse,
ConsultaIEResponse,
ConsultaIETodosResponse,
CteXmlResponse,
NfeXmlResponse,
NfseResponse,
PerfilProdutorResponse,
Expand Down Expand Up @@ -202,6 +203,26 @@ export class FiscalAPI {
});
}

/**
* XML completo de um CT-e, CT-e OS ou GTV-e pela chave de acesso
* (`POST /api/consultar-cte-xml`). O certificado A1 precisa ser de um
* participante do documento e não é armazenado. Só há cobrança quando o XML
* é devolvido. Não é repetido automaticamente em 5xx.
*/
consultarCteXml(params: {
chave: string;
certificado: Certificado;
senha: string;
}): Promise<CteXmlResponse> {
if (!params.chave) throw new Error('Informe a chave de acesso.');
return this.request('POST', '/api/consultar-cte-xml', undefined, {
// Aceita CNPJ alfanumérico: só tira separadores e põe em maiúsculas.
chave: params.chave.replace(/[^0-9A-Za-z]/g, '').toUpperCase(),
certificado: certificadoBase64(params.certificado),
senha: params.senha,
});
}

/**
* NFS-e (padrão nacional) pela chave de acesso, sem certificado
* (`GET /api/consultar-nfse`). Com `danfse: true`, inclui o PDF em base64.
Expand Down
10 changes: 10 additions & 0 deletions src/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,16 @@ export interface NfeXmlResponse {
resultados: NfeXmlResultado[];
}

export interface CteXmlResponse {
request_id: string;
chave: string;
status: 'ok' | 'nao_autorizado' | 'nao_encontrado' | 'erro';
/** XML completo (cteProc), presente quando `status === 'ok'`. */
xml?: string | null;
mensagem?: string;
creditos_cobrados: number;
}

export interface SigefParcela {
parcel_id?: string;
codigo_parcela?: string;
Expand Down
2 changes: 1 addition & 1 deletion src/version.ts
Original file line number Diff line number Diff line change
@@ -1 +1 @@
export const VERSION = '0.2.0';
export const VERSION = '0.3.0';
Loading