SDKs & Postman

Client libraries for PHP, JavaScript/TypeScript and Python, and a Postman collection, generated from the HassleFreeBooks API's OpenAPI document — all 156 operations. Each one handles authentication, token refresh, retries on rate limits and the response envelope, and verifies webhook signatures. MIT licensed, no dependencies.

Version 1.0.3 · regenerated whenever the API changes · OpenAPI document

{
    "repositories": [
        {
            "type": "package",
            "package": {
                "name": "hasslefreebooks/hasslefreebooks-php",
                "version": "1.0.3",
                "dist": {
                    "url": "https://hasslefreebooks.com/developer-portal/sdks/hasslefreebooks-php.zip",
                    "type": "zip"
                },
                "require": {
                    "php": ">=8.1",
                    "ext-curl": "*",
                    "ext-json": "*"
                },
                "autoload": {
                    "psr-4": {
                        "HassleFreeBooks\\": "src/"
                    }
                }
            }
        }
    ]
}

npm install https://hasslefreebooks.com/developer-portal/sdks/hasslefreebooks-js.tgz

pip install https://hasslefreebooks.com/developer-portal/sdks/hasslefreebooks-python.zip

https://hasslefreebooks.com/developer-portal/sdks/hasslefreebooks.postman_collection.json

Quick start

Create an API key at /api-keys (choose its scopes; it is shown once). Then:

use HassleFreeBooks\Client;
use HassleFreeBooks\ApiException;

$hfb = new Client(['api_key' => getenv('HFB_API_KEY')]);

try {
    $page    = $hfb->listTransactions(query: ['start_date' => '2026-01-01', 'page' => 1]);
    $invoice = $hfb->getInvoice(42);
    $entry   = $hfb->createJournalEntry($body, options: ['headers' => ['Idempotency-Key' => $uuid]]);
} catch (ApiException $e) {
    error_log("{$e->status} {$e->errorCode} {$e->requestId}");   // branch on errorCode
}

import { HassleFreeBooks, ApiError } from 'hasslefreebooks';

const hfb = new HassleFreeBooks({ apiKey: process.env.HFB_API_KEY });

try {
  const page = await hfb.listTransactions({ start_date: '2026-01-01', page: 1 });
  const invoice = await hfb.getInvoice(42);
  const entry = await hfb.createJournalEntry(body, { headers: { 'Idempotency-Key': crypto.randomUUID() } });
} catch (err) {
  if (err instanceof ApiError) console.error(err.status, err.code, err.requestId);
}

import os, uuid
from hasslefreebooks import HassleFreeBooks, ApiError

hfb = HassleFreeBooks(api_key=os.environ["HFB_API_KEY"])

try:
    page = hfb.list_transactions(start_date="2026-01-01", page=1)
    invoice = hfb.get_invoice(42)
    entry = hfb.create_journal_entry(body, idempotency_key=str(uuid.uuid4()))
except ApiError as err:
    print(err.status, err.code, err.request_id)

What every SDK does for you

• One method per operation, named after the operation id in the reference (snake_case in Python). Arguments: path parameters in URL order, then the body, then query parameters, then options.
• Returns data from the {ok, request_id, data, meta} envelope and raises an ApiError/ApiException with the stable code, details and request_id otherwise. Downloads (the accountant package ZIP) return the bytes.
• Signing in as a user: login() keeps the tokens; an expired access token is refreshed once, by itself. Refresh tokens are single-use, so pass the onTokens callback and store the newest pair.
• Retries a 429 after Retry-After, and 502/503/504 or network failures on reads and on requests carrying an Idempotency-Key. Other writes are never retried behind your back.
• Money is a decimal ("1500.00"); keep it out of floats.

Webhooks

Each SDK verifies X-HassleFreBooks-Signature (sha256= + HMAC-SHA256 of the raw body, keyed with the endpoint's signing secret) in constant time: Webhook::verify(), verifyWebhookSignature(), verify_webhook_signature(). Verify the raw bytes before decoding, answer 2xx within 30 seconds, and de-duplicate on X-HassleFreBooks-Delivery.

Another language

Point any OpenAPI 3.0 generator at the live document, for example:

npx @openapitools/openapi-generator-cli generate -i https://hasslefreebooks.com/api/v1/openapi -g go -o hasslefreebooks-go