1. Prerequisites

Before installing the Payhawk Connector, make sure the following are in place.

Odoo apps

The module depends on these apps. Install them first (Apps → search → Install):

• Invoicing / Accounting (account)
• Analytic Accounting (analytic)
• Purchase (purchase)
• Inventory (stock)
• Employees (hr)

WARNING

If any dependency is missing, the module will refuse to install. Install the apps above before the Payhawk Connector.

Python dependency

The module requires the ratelimit Python package on the Odoo server:

pip install ratelimit

On a containerized / managed PLANA deployment this is already baked into the image. On a self-managed server, install it into the same environment that runs Odoo, then restart the Odoo service.

Permissions

You need Accounting → Account Manager rights to see and edit the Payhawk settings. The integration creates two inactive service users automatically — you do not manage them manually:

• [CRON] Payhawk Data Broker — runs the scheduled sync
• [WEBHOOK] Payhawk Data Broker — handles inbound webhooks

A Payhawk account

You need a Payhawk account with access to the Developer API so you can generate an API key. Start with a Sandbox key for testing; switch to Production once verified. See Get a Payhawk API key.

Recommended order

1. Install the Odoo apps above
2. Confirm ratelimit is installed
3. Install the Payhawk Connector module

Next: Install the module →