Skip to main content

Getting started with the Weel OpenAPI

  • Updated

The Weel OpenAPI gives your team programmatic read and write access to your Weel account. Use it to pull transactions, statements, and balances into your own systems, and to push master data into Weel from any system, including ERPs and HRIS platforms Weel doesn't natively integrate with.

This feature is available on the Enterprise plan.

Key benefits

  • Build the integration you need: If Weel doesn't natively integrate with your ERP (such as Sage, TechOne, MYOB Exo, or Certinia), the OpenAPI lets you or your systems integrator build the connection yourselves.
  • No more manual data entry: Sync GL codes, categories, and custom field values straight from your source system instead of re-keying them in Weel.
  • User provisioning that matches your HR workflows: Invite, update, and deactivate users in line with your HRIS, so access is ready on day one and closed the moment someone leaves.
  • Spend controls driven by your own systems: Create and adjust budgets programmatically, triggered by events in the tools you already run.

What can you do with the OpenAPI?

Read data out of Weel:

  • Transactions and statements
  • Your account balance
  • Users, roles, and budgets
  • Custom fields and your chart of accounts

Write data into Weel, across four groups of endpoints:

  • User provisioning: Invite a user, update their role, payment types, and delegation settings, and deactivate them when they leave your business.
  • Budgets: Create, update, and delete budgets, including budget members, Budget Owners, and top-ups.
  • Chart of accounts: Create and maintain GL codes, categories, and the mapping between them, so your coding structure in Weel matches your ERP.
  • Custom fields: Manage custom fields and their values, with no cap on the number of values. Define a structure like project code or cost centre and keep thousands of values current automatically.

The full endpoint reference is at developer.letsweel.com.

How to get started

  1. Check your access: You'll need a Weel Enterprise plan, and Admin access or the API permission enabled for your role.
  2. Generate an API key: In the Weel web app, go to Settings > API and click Create New API Key. Your key is shown once only, so store it securely. See How to generate and manage API keys for full steps.
  3. Read the API documentation at developer.letsweel.com.
  4. Authenticate your requests: Include your key as a bearer token in the Authorization header of every request: Authorization: Bearer <your API key>.
  5. Call the endpoints: Use GET to read, POST to create, PATCH to update, and DELETE to remove.
  6. Wire it to your source system: Schedule or event-trigger the calls from your ERP or HRIS, so your data in Weel stays current automatically.

Common questions

Do API keys expire?
No. Keys remain valid until you delete them in Settings > API. Once deleted, any requests using that key are rejected immediately.

Can I use the OpenAPI alongside a native integration?
Yes. If you're already using a native integration like Xero or NetSuite, you can still use the OpenAPI for things the native sync doesn't cover, such as user provisioning and budget management.

Who can generate API keys?
Only Admins, or roles with the API permission enabled.

Related articles