API REST da Frihet
Acesso programático a faturas, clientes, despesas, produtos e orçamentos. Projetada para integrações que escalam.
Feita para desenvolvedores
Atualizações parciais PATCH
Atualize apenas os campos que você precisa. Schemas parciais validados com Zod garantem a integridade.
Busca e filtros
Busca full-text com parâmetro ?q=. Mapeamento de campos por recurso para resultados precisos.
Operações em lote
Crie até 50 recursos em uma única requisição. Respostas HTTP 207 multi-status.
Chaves de idempotência
Tente novamente as requisições com segurança usando o cabeçalho Idempotency-Key. As chaves são reconhecidas por 24 horas.
Cabeçalhos de limite de taxa
X-RateLimit-Limit, Remaining e Reset em cada resposta. Planeje-se de acordo.
Spec OpenAPI 3.1
Especificação legível por máquinas em /openapi.yaml. 16 paths, 18 schemas. Gera SDKs automaticamente.
Endpoints de inteligência
Contexto de negócio, resumos mensais e dados fiscais trimestrais via /context, /monthly, /quarterly.
Exclusão segura VeriFactu
Soft delete para faturas e orçamentos não rascunho. Rastreabilidade completa para conformidade fiscal espanhola.
Endpoints
| Method | Path |
|---|---|
| GET | /v1/invoices |
| POST | /v1/invoices |
| PATCH | /v1/invoices/:id |
| DELETE | /v1/invoices/:id |
| POST | /v1/invoices/batch |
| GET | /v1/clients |
| POST | /v1/clients |
| GET | /v1/expenses |
| POST | /v1/expenses |
| GET | /v1/products |
| GET | /v1/quotes |
| GET | /v1/context |
| GET | /v1/monthly |
| GET | /v1/quarterly |
| GET | /openapi.yaml |
Exemplos de código
import { Frihet } from '@frihet/sdk';
const apiKey = process.env.FRIHET_API_KEY;
if (!apiKey) throw new Error('Set FRIHET_API_KEY before running this example');
const frihet = new Frihet({ apiKey });
// Follow each page's nextCursor until all paid invoices have been read.
let cursor: string | undefined;
do {
const page = await frihet.invoices.list({ status: 'paid', limit: 25, cursor });
for (const invoice of page.data) {
console.log(invoice.documentNumber, invoice.total);
}
cursor = page.nextCursor;
} while (cursor);
Autenticação
Gere chaves de API em Configurações > API no seu painel Frihet. Inclua sua chave como Bearer token no cabeçalho Authorization.
Authorization: Bearer fri_...
Comece a integrar hoje
Acesso à API incluído em todos os planos. Sua chave de API está pronta em Configurações.
Começar Grátis