Pennylane API Client

A TypeScript client for the Pennylane accounting API V2, automatically generated from the OpenAPI specification.

Features

• 🔄 Automatically generated from the latest OpenAPI specification
• 📦 Provides full TypeScript type definitions
• 📚 Includes JSDoc documentation from the OpenAPI spec
• 🚀 Modern ES6+ compatible code
• 🌐 Uses native fetch API (no external HTTP libraries)
• 📈 Weekly updates to keep in sync with the API
• 💯 Full TypeScript implementation (even for build scripts)

Requirements

• Node.js >= 18.0.0 (required for native fetch support)

Installation

npm install @upflowhq/pennylane-client

Usage

import { OpenAPI, PennylaneService } from 'pennylane-api-client';

// Configure the base URL and authentication
OpenAPI.BASE = 'https://api.pennylane.com/v2';
OpenAPI.TOKEN = 'your-api-token';

// Use the client
async function getCompanies() {
  try {
    const companies = await PennylaneService.getCompanies();
    console.log(companies);
  } catch (error) {
    console.error('Error fetching companies:', error);
  }
}

getCompanies();

Available Services

The client provides access to all Pennylane API endpoints, organized into services:

• CompaniesService - Manage company information
• InvoicesService - Work with invoices
• CustomersService - Handle customer data
• ProductsService - Manage products and services
• And many more...

Each service contains methods that correspond to API endpoints, with full TypeScript typing and documentation.

Development

This client is automatically generated from the Pennylane OpenAPI specification. The generation process is automated via GitHub Actions and runs weekly to ensure the client stays up-to-date with the latest API changes.

Local Development

To generate the client locally:

1. Clone the repository
2. Install dependencies: npm install
3. Fetch the latest OpenAPI spec: npm run fetch-spec
4. Generate the client: npm run generate
5. Build: npm run build

Project Structure

pennylane-client/
├── .github/workflows/         # GitHub Actions workflows
├── scripts/                   # TypeScript build scripts
├── src/                       # Generated client source code
├── package.json               # Project configuration
├── tsconfig.json              # TypeScript configuration
└── README.md                  # This file