--- title: "Brightpearl API: connect it to your AI chat ยท Hypamoon" description: "The Brightpearl API is documented, but access goes through Brightpearl first. What it takes to connect it to your AI chat with Hypamoon, with sources." url: https://hypamoon.com/connect-to/brightpearl --- 1. [Connect to](https://hypamoon.com/connect-to) 2. Brightpearl ERP and accounting # Connect Brightpearl to Hypamoon Possible, with help from Brightpearl. The API is documented, but you cannot just create a key: access goes through Brightpearl first. Possible ## The check Three questions about the API of Brightpearl, answered from its own docs. **Public API docs**\ **Yes.** Public API reference for all Brightpearl services. [Read the docs](https://api-docs.brightpearl.com/) **A key you create yourself**\ **No.** You first register as a Brightpearl developer, and that account needs approval by Brightpearl before you can create an app. [help.brightpearl.com](https://help.brightpearl.com/hc/en-us/articles/211124886-Registering-as-a-Brightpearl-developer) **Versions or a changelog**\ **Not confirmed.** No API versions or API changelog found; Brightpearl points developers to status.sage.com for API status updates. **How it signs in**\ OAuth 2 with an Instance app created in your approved developer account; calls send a bearer token plus the brightpearl-dev-ref and brightpearl-app-ref headers. **Webhooks**\ **Yes.** It can tell your app when something changes. [api-docs.brightpearl.com](https://api-docs.brightpearl.com/integration/webhook/index.html) **Hosting**\ Cloud **Condition**\ Needs an approved Brightpearl developer account. ## In practice What it takes in a real Brightpearl administration. **Getting access**\ Register as a Brightpearl developer and wait for approval, create an Instance app in the developer panel, then the account owner authorises it through OAuth. **Limits**\ None published. **Writing**\ **Read and write.** Create sales orders, purchase orders and credits with POST on the order service, and register webhooks. **Cost**\ Not published. ## Your own B2B order portal on Brightpearl, built around how your trade customers order. - Orders, products, stock, customers and goods out notes, from the Brightpearl services. - AI that checks each portal order for prices and stock, with you approving every order. - A portal for your trade customers and an email when something needs a look. ### Ask your chat Answers straight from your Brightpearl data, in Claude or another chat with the full Hypamoon connection. - Which sales orders are waiting for stock, and since when? - Which trade customers ordered less this quarter than last quarter? ### When something happens Brightpearl sends a webhook to your app, and the app asks AI what happens next. 1. When A goods out note is picked or packed in Brightpearl. AI decides AI checks the order for anything unusual, like a split shipment. Then The customer gets an email from your app with the status. ### A screen for your team or customers An app on your own address, with sign-in, on top of the same Brightpearl data. - For your customers Trade customers sign in and see their own prices, past orders and open invoices from Brightpearl. ### Add Hypamoon Text messages, email, phone, payments and agents run in the same project as the adapter. - Agent on a schedule Once a week, an agent emails you the products that sell faster than their stock is reordered. Brightpearl stays the core: your chat builds the rest on its API, as an adapter plus an app and agents in your Hypamoon project. Reading starts after you click Allow in the portal. Every change an agent or a chat makes in Brightpearl waits for your approval, one call at a time. [How adapters work](https://hypamoon.com/docs/adapters) ### Good to know - Brightpearl signs in with OAuth or signed requests only, with tokens that expire. The Hypamoon vault holds a fixed key today, so an adapter for Brightpearl takes more work: ask your chat to check this first. - Brightpearl says to create Instance apps for OAuth; private apps and system apps are described as legacy or being deprecated. Use the API domain returned with the token for your calls. ## Try it in your chat First get access from Brightpearl. Then fill in what to read and write, and send it. Say this in your chat > Build the Hypamoon recipe build-an-adapter for Brightpearl. API docs: https://api-docs.brightpearl.com/. Read: \[what\]. Write: \[what, or nothing\]. [Open in Claude](https://claude.ai/new?q=Build%20the%20Hypamoon%20recipe%20build-an-adapter%20for%20Brightpearl.%20API%20docs%3A%20https%3A%2F%2Fapi-docs.brightpearl.com%2F.%20Read%3A%20%5Bwhat%5D.%20Write%3A%20%5Bwhat%2C%20or%20nothing%5D.) In Claude, or another chat with the full Hypamoon connection; adapters are not in ChatGPT yet. You paste the key in the portal, never in the chat. [The full recipe](https://hypamoon.com/r/build-an-adapter) ## Sources Checked on 7 November 2026. - [api-docs.brightpearl.com/](https://api-docs.brightpearl.com/) - [help.brightpearl.com/hc/en-us/articles/211124886-Registering-as-a-Brightpearl-developer](https://help.brightpearl.com/hc/en-us/articles/211124886-Registering-as-a-Brightpearl-developer) - [api-docs.brightpearl.com/integration/webhook/index.html](https://api-docs.brightpearl.com/integration/webhook/index.html) Brightpearl is a name of its owner, used here only to describe the software. This page is not an official integration and Hypamoon has no partnership with Brightpearl. Found something that changed? Tell us at [support](https://hypamoon.com/support#contact). ## More in erp and accounting - [**Acumatica** Open](https://hypamoon.com/connect-to/acumatica) - [**AFAS Profit** Open](https://hypamoon.com/connect-to/afas-profit) - [**DATEV** Possible](https://hypamoon.com/connect-to/datev) - [**e-Boekhouden.nl** Open](https://hypamoon.com/connect-to/e-boekhouden) - [**Exact for Accountancy** Open](https://hypamoon.com/connect-to/exact-for-accountancy) - [**Exact Globe+** Possible](https://hypamoon.com/connect-to/exact-globe) - [**Exact Gripp** Possible](https://hypamoon.com/connect-to/exact-gripp) - [**Exact Multivers** Possible](https://hypamoon.com/connect-to/unit4-multivers) - [**Exact Online** Open](https://hypamoon.com/connect-to/exact-online) - [**FreshBooks** Open](https://hypamoon.com/connect-to/freshbooks) - [**Holded** Open](https://hypamoon.com/connect-to/holded) - [**Isah** Unknown](https://hypamoon.com/connect-to/isah) - [**Jortt** Open](https://hypamoon.com/connect-to/jortt) - [**KING Finance** Possible](https://hypamoon.com/connect-to/king-finance) - [**Lexware Office (lexoffice)** Open](https://hypamoon.com/connect-to/lexoffice) - [**Microsoft Dynamics 365 Business Central** Open](https://hypamoon.com/connect-to/dynamics-365-business-central) - [**Microsoft Dynamics 365 Finance and Operations** Open](https://hypamoon.com/connect-to/dynamics-365-finance-operations) - [**Microsoft Dynamics NAV** Open](https://hypamoon.com/connect-to/dynamics-nav) - [**Moneybird** Open](https://hypamoon.com/connect-to/moneybird) - [**Odoo** Open](https://hypamoon.com/connect-to/odoo) - [**Oracle NetSuite** Open](https://hypamoon.com/connect-to/oracle-netsuite) - [**Pennylane** Open](https://hypamoon.com/connect-to/pennylane) - [**QuickBooks Online** Open](https://hypamoon.com/connect-to/quickbooks-online) - [**Ridder iQ** Possible](https://hypamoon.com/connect-to/ridder-iq) - [**Sage Accounting (Sage Business Cloud)** Open](https://hypamoon.com/connect-to/sage-accounting) - [**Sage Intacct** Possible](https://hypamoon.com/connect-to/sage-intacct) - [**SAP Business One** Open](https://hypamoon.com/connect-to/sap-business-one) - [**SAP S/4HANA** Open](https://hypamoon.com/connect-to/sap-s4hana) - [**sevDesk** Open](https://hypamoon.com/connect-to/sevdesk) - [**Simplicate** Open](https://hypamoon.com/connect-to/simplicate) - [**SnelStart** Possible](https://hypamoon.com/connect-to/snelstart) - [**Syntess Atrium** Closed](https://hypamoon.com/connect-to/syntess-atrium) - [**Twinfield** Possible](https://hypamoon.com/connect-to/twinfield) - [**Unit4 ERPx** Possible](https://hypamoon.com/connect-to/unit4-erpx) - [**Visma eAccounting** Possible](https://hypamoon.com/connect-to/visma-eaccounting) - [**Visma.net ERP** Possible](https://hypamoon.com/connect-to/visma-net-erp) - [**Wave** Possible](https://hypamoon.com/connect-to/wave) - [**Xero** Open](https://hypamoon.com/connect-to/xero) - [**Yuki (Nmbrs Accounting)** Open](https://hypamoon.com/connect-to/yuki) - [**Zoho Books** Open](https://hypamoon.com/connect-to/zoho-books) - [**BILL (Bill.com)** Open](https://hypamoon.com/connect-to/bill) - [**Brex** Open](https://hypamoon.com/connect-to/brex) - [**Expensify** Possible](https://hypamoon.com/connect-to/expensify) - [**Pleo** Possible](https://hypamoon.com/connect-to/pleo) - [**Ramp** Open](https://hypamoon.com/connect-to/ramp) - [**Rompslomp** Open](https://hypamoon.com/connect-to/rompslomp) - [**Informer** Open](https://hypamoon.com/connect-to/informer) - [**MKG** Possible](https://hypamoon.com/connect-to/mkg) - [**Octopus** Possible](https://hypamoon.com/connect-to/octopus) - [**Robaws** Open](https://hypamoon.com/connect-to/robaws) - [**Axonaut** Open](https://hypamoon.com/connect-to/axonaut) - [**Qonto** Open](https://hypamoon.com/connect-to/qonto) - [**weclapp** Open](https://hypamoon.com/connect-to/weclapp) - [**Xentral** Open](https://hypamoon.com/connect-to/xentral) - [**JTL-Wawi** Possible](https://hypamoon.com/connect-to/jtl-wawi) - [**PlentyONE** Open](https://hypamoon.com/connect-to/plentyone) - [**Candis** Possible](https://hypamoon.com/connect-to/candis) - [**FreeAgent** Open](https://hypamoon.com/connect-to/freeagent) - [**Dext** Closed](https://hypamoon.com/connect-to/dext) - [**Katana** Open](https://hypamoon.com/connect-to/katana) - [**Fortnox** Possible](https://hypamoon.com/connect-to/fortnox) - [**Tripletex** Open](https://hypamoon.com/connect-to/tripletex) - [**e-conomic** Possible](https://hypamoon.com/connect-to/e-conomic) - [**Fatture in Cloud** Open](https://hypamoon.com/connect-to/fatture-in-cloud) - [**Fakturoid** Open](https://hypamoon.com/connect-to/fakturoid) - [**Moloni** Open](https://hypamoon.com/connect-to/moloni) - [**inFakt** Open](https://hypamoon.com/connect-to/infakt) - [**Zenvoices** Open](https://hypamoon.com/connect-to/zenvoices) - [**Minox** Possible](https://hypamoon.com/connect-to/minox) - [**Basecone** Possible](https://hypamoon.com/connect-to/basecone) - [**Silverfin** Possible](https://hypamoon.com/connect-to/silverfin) - [**Reeleezee** Unknown](https://hypamoon.com/connect-to/reeleezee) - [**bexio** Open](https://hypamoon.com/connect-to/bexio) - [**Run my Accounts** Open](https://hypamoon.com/connect-to/run-my-accounts) - [**Abacus** Possible](https://hypamoon.com/connect-to/abacus) - [**Collmex** Unknown](https://hypamoon.com/connect-to/collmex) - [**Papierkram** Possible](https://hypamoon.com/connect-to/papierkram) - [**BuchhaltungsButler** Open](https://hypamoon.com/connect-to/buchhaltungsbutler) - [**Visma AccountView** Possible](https://hypamoon.com/connect-to/visma-accountview) - [**Evoliz** Open](https://hypamoon.com/connect-to/evoliz) - [**Billy** Open](https://hypamoon.com/connect-to/billy) - [**Bokio** Open](https://hypamoon.com/connect-to/bokio) - [**Fiken** Possible](https://hypamoon.com/connect-to/fiken) - [**Cegid Loop** Possible](https://hypamoon.com/connect-to/cegid-loop) - [**Procountor** Possible](https://hypamoon.com/connect-to/procountor) - [**Reviso** Possible](https://hypamoon.com/connect-to/reviso) - [**Dinero** Possible](https://hypamoon.com/connect-to/dinero) - [**MyUnisoft** Possible](https://hypamoon.com/connect-to/myunisoft) - [**TOConline** Open](https://hypamoon.com/connect-to/toconline) - [**PowerOffice Go** Possible](https://hypamoon.com/connect-to/poweroffice-go) - [**Uniconta** Possible](https://hypamoon.com/connect-to/uniconta) - [**Quipu** Open](https://hypamoon.com/connect-to/quipu) - [**wFirma** Possible](https://hypamoon.com/connect-to/wfirma) - [**iFirma** Unknown](https://hypamoon.com/connect-to/ifirma) - [**Merit Aktiva** Open](https://hypamoon.com/connect-to/merit-aktiva) - [**Oracle Fusion Cloud ERP** Open](https://hypamoon.com/connect-to/oracle-fusion-cloud-erp) - [**ABRA Flexi** Possible](https://hypamoon.com/connect-to/abra-flexi) - [**POHODA** Possible](https://hypamoon.com/connect-to/pohoda) - [**Clear Books** Open](https://hypamoon.com/connect-to/clear-books) - [**Minimax** Possible](https://hypamoon.com/connect-to/minimax) - [**Microsoft Dynamics GP** Possible](https://hypamoon.com/connect-to/dynamics-gp) - [**SmartAccounts** Unknown](https://hypamoon.com/connect-to/smartaccounts) - [**AccountsIQ** Possible](https://hypamoon.com/connect-to/accountsiq) - [**KashFlow** Unknown](https://hypamoon.com/connect-to/kashflow) - [**Money S3** Possible](https://hypamoon.com/connect-to/money-s3) - [**Money S5** Unknown](https://hypamoon.com/connect-to/money-s5) - [**InsERT Subiekt** Possible](https://hypamoon.com/connect-to/insert-subiekt) - [**Comarch ERP Optima** Unknown](https://hypamoon.com/connect-to/comarch-erp-optima) - [**Symfonia** Unknown](https://hypamoon.com/connect-to/symfonia) - [**Pandle** Possible](https://hypamoon.com/connect-to/pandle) - [**Modern Treasury** Open](https://hypamoon.com/connect-to/modern-treasury) - [**Trovata** Possible](https://hypamoon.com/connect-to/trovata) - [**Kyriba** Unknown](https://hypamoon.com/connect-to/kyriba) - [**Agicap** Open](https://hypamoon.com/connect-to/agicap) - [**Embat** Unknown](https://hypamoon.com/connect-to/embat) - [**Spendesk** Open](https://hypamoon.com/connect-to/spendesk) - [**Soldo** Open](https://hypamoon.com/connect-to/soldo) - [**Zoho Expense** Open](https://hypamoon.com/connect-to/zoho-expense) - [**SAP Concur** Possible](https://hypamoon.com/connect-to/sap-concur) - [**Navan** Open](https://hypamoon.com/connect-to/navan) - [**Payhawk** Open](https://hypamoon.com/connect-to/payhawk) - [**Moss** Open](https://hypamoon.com/connect-to/moss) - [**Mooncard** Possible](https://hypamoon.com/connect-to/mooncard) - [**Tipalti** Possible](https://hypamoon.com/connect-to/tipalti) - [**Rydoo** Possible](https://hypamoon.com/connect-to/rydoo) - [**Emburse** Open](https://hypamoon.com/connect-to/emburse) - [**Coupa** Open](https://hypamoon.com/connect-to/coupa) - [**Libeo** Closed](https://hypamoon.com/connect-to/libeo) - [**N2F** Possible](https://hypamoon.com/connect-to/n2f) - [**Expensya** Open](https://hypamoon.com/connect-to/expensya) - [**Fyle** Open](https://hypamoon.com/connect-to/fyle) - [**Karbon** Open](https://hypamoon.com/connect-to/karbon) - [**Conscribo** Unknown](https://hypamoon.com/connect-to/conscribo) - [**Tellow** Closed](https://hypamoon.com/connect-to/tellow) - [**Asperion** Possible](https://hypamoon.com/connect-to/asperion) - [**Gekko** Closed](https://hypamoon.com/connect-to/gekko) - [**WinBooks on Web** Unknown](https://hypamoon.com/connect-to/winbooks) - [**Horus** Possible](https://hypamoon.com/connect-to/horus) - [**Clearfacts** Unknown](https://hypamoon.com/connect-to/clearfacts) - [**Sage BOB 50** Closed](https://hypamoon.com/connect-to/sage-bob-50) - [**orgaMAX** Possible](https://hypamoon.com/connect-to/orgamax) - [**abas ERP** Possible](https://hypamoon.com/connect-to/abas-erp) - [**proALPHA** Unknown](https://hypamoon.com/connect-to/proalpha) - [**Haufe X360** Possible](https://hypamoon.com/connect-to/haufe-x360) - [**Sage 100 (Germany)** Unknown](https://hypamoon.com/connect-to/sage-100-de) - [**EBP** Possible](https://hypamoon.com/connect-to/ebp) - [**Cegid XRP Flex** Unknown](https://hypamoon.com/connect-to/cegid-xrp-flex) - [**Sage 100 (France)** Closed](https://hypamoon.com/connect-to/sage-100-fr) - [**Sage Active** Open](https://hypamoon.com/connect-to/sage-active) - [**Sage 200** Possible](https://hypamoon.com/connect-to/sage-200) - [**Sage X3** Open](https://hypamoon.com/connect-to/sage-x3) - [**Sage 50 (UK)** Closed](https://hypamoon.com/connect-to/sage-50-uk) - [**TeamSystem Enterprise** Possible](https://hypamoon.com/connect-to/teamsystem-enterprise) - [**Zucchetti (Mago)** Unknown](https://hypamoon.com/connect-to/zucchetti-mago) - [**a3innuva** Possible](https://hypamoon.com/connect-to/a3innuva) - [**Cegid Primavera (ROSE and Jasmin)** Unknown](https://hypamoon.com/connect-to/cegid-primavera) - [**PHC GO** Possible](https://hypamoon.com/connect-to/phc-go) - [**QuickBooks Desktop** Open](https://hypamoon.com/connect-to/quickbooks-desktop) - [**Epicor Kinetic** Possible](https://hypamoon.com/connect-to/epicor-kinetic) - [**Infor CloudSuite (ION API)** Open](https://hypamoon.com/connect-to/infor-ion-api) [All 1094 tools](https://hypamoon.com/connect-to) ## Tool not listed? Ask the chat to check its API. The same three checks work for any software. Your chat reads the vendor's own docs and tells you what it found. Say this in your chat > Check if \[software\] has an open API that a Hypamoon adapter can use: public API docs, a key or token I can create myself without asking the vendor, and versions or a changelog. Link the pages you used. [Open in Claude](https://claude.ai/new?q=Check%20if%20%5Bsoftware%5D%20has%20an%20open%20API%20that%20a%20Hypamoon%20adapter%20can%20use%3A%20public%20API%20docs%2C%20a%20key%20or%20token%20I%20can%20create%20myself%20without%20asking%20the%20vendor%2C%20and%20versions%20or%20a%20changelog.%20Link%20the%20pages%20you%20used.) [Open in ChatGPT](https://chatgpt.com/?q=Check%20if%20%5Bsoftware%5D%20has%20an%20open%20API%20that%20a%20Hypamoon%20adapter%20can%20use%3A%20public%20API%20docs%2C%20a%20key%20or%20token%20I%20can%20create%20myself%20without%20asking%20the%20vendor%2C%20and%20versions%20or%20a%20changelog.%20Link%20the%20pages%20you%20used.) Fill in the name of your software. Checking needs no connection to Hypamoon. ## Ready to connect Brightpearl? Connect your chat once, then ask it to build the adapter. [Start free](https://app.hypamoon.com/?mode=signup&utm_source=connect-to&utm_campaign=brightpearl) Works in Claude, ChatGPT and Copilot. [Add to Claude](https://hypamoon.com/connect?via=connect-to~brightpearl#claude) [Add to ChatGPT](https://hypamoon.com/connect?via=connect-to~brightpearl#chatgpt) [Add to Copilot](https://hypamoon.com/docs/microsoft-copilot)