Before Your Get Started

Welcome to the Pennylane API ! 💙

This guide will help you make your first API request with Pennylane, whether you are a company, an accounting firm, or an integrator.

Before you start, please be aware that by using this API, you agree to be bound by our API contract terms.

Choose Your Integration Path

We offer several ways to connect to our API, depending on your role:

Authentication

To call the Pennylane API, you must include a valid token in every request:

curl <https://api.pennylane.com/v1/me> \\
-H "Authorization: Bearer <YOUR_API_KEY>"

• Companies: generate a Company API token in your Pennylane account settings.
• Firms: generate a Firm API token in your Firm account settings.
• Integrators: obtain an OAuth 2.0 access token. Contact [email protected] to get started.

Create Your Sandbox Environment

Companies

To create your sandbox environment:

(1) Log in to your Pennylane account.

(2) Click your profile (top-right corner).

(3) Select Test environment.

(4) Click Create my sandbox.

🖕

You will now have two accounts: your live account and a sandbox account named Sandbox – [your\[email protected]](mailto:[email protected]).

Firms (Accounting Practices)

Firms use their existing Firm account to access the API.

No sandbox creation is required.

Integrators

Email [email protected] with your full name and the email address to use for sandbox creation.

Set Up Your Account for Testing

Depending on which parts of the API you want to test, you may need to configure your account in the Pennylane app.

For invoice testing:

(1) Go to your Invoice settings page.

(2) Set up the following elements:

• Company address & contact information
• Bank account details
• Logo

(3) Configure invoice numbering (required by law: sequential numbering).

📘

For further information, see Step-by-step guide.

Verify Your Setup

Once you have obtained your API token (or OAuth access token), you can verify that your setup is correct by calling the /me endpoint.

This request confirms that your authentication works and that your environment (sandbox or production) is accessible.

curl https://app.pennylane.com/api/external/v2/me \
  -H "Authorization: Bearer <YOUR_API_KEY_OR_OAUTH_TOKEN>"

Expected JSON response

{
  "id": "12345",
  "email": "[email protected]",
  "role": "customer"
}

Support

Need help? We are here for you.

• Companies→ Contact Pennylane Support
• Partners→ Email or use your Zendesk access