Connect Enterpryze to the rest of your business.

The Enterpryze API gives your apps, reporting tools and partners a secure, controlled way to read and update the information that runs your business, across the whole platform.

Enterpryze API, version 2

Request JSON over HTTPS
GET /v2/sales/orders
    ?status=O
    &fields=documentNumber,companyName,total,status
Authorization: Bearer <access token>
Response 200 OK
{
  "value": [
    {
      "documentNumber": 10482,
      "companyName": "Harbour Home Supplies",
      "total": 4820.00,
      "status": "O"
    },
    …
  ],
  "skip": 0,
  "limit": 20,
  "total": 37
}
OAuth 2.0 sign-in
The open standard for secure app access
JSON over HTTPS
Plain, readable requests and responses
OpenAPI 3.1 reference
Every endpoint and field, in Enterpryze Settings
Permissions by area
Read and write, granted separately

Why it matters

When systems don’t talk, people fill the gaps.

Orders retyped from another system. Figures that are out of date by lunchtime. Spreadsheets exported every Monday to feed a report. Each gap between systems costs time and invites mistakes.

The Enterpryze API closes those gaps, so information is entered once and every connected system can pick it up.

Enter it once

Records created in another system arrive in Enterpryze ready to work with, with no rekeying.

Keep systems in step

Pick up only the records that changed since your last check, so the systems around Enterpryze stay current without heavy reloads.

Put your data to work

Feed reporting tools, data warehouses and AI tools with current business data from across the platform, through permissions you choose.

What you can build

Common ways to put it to work.

Each of these uses the same building blocks, so you can start with one connection and add to it as the API grows.

Commerce channels

Connect your online store or marketplace, so orders flow in and product and stock information flows out.

Reporting and analytics

Load business data into your reporting tool or data warehouse, on a schedule that suits you.

Operations and logistics

Connect scanning apps, logistics partners and shop-floor tools, so what happens on site is recorded as it happens.

Mobile and field apps

Give people in the field a purpose-built app that works with live Enterpryze data, within the access you give it.

Partners and suppliers

Exchange information with the businesses you trade with, without anyone retyping it on either side.

AI tools

Give the AI tools your team already uses read-only access, so they can answer questions about your business without being able to change anything.

The platform

One API for the whole of Enterpryze.

Enterpryze brings your finance, trading, stock and operations into one system. The API is being extended to reach all of it, so you get a single, consistent way into everything the platform does.

One connection

Register an app once and give it access to the parts of Enterpryze it needs. As the API grows, you extend the same connection rather than starting again.

One way of working

Every area follows the same conventions for listing, filtering, creating and updating, so what you learn in one place carries over to the next.

One set of controls

Permissions, rate limits and your monthly allowance work the same way across the platform, whatever an app is connected to.

Always one place to check

The API reference in Enterpryze Settings lists exactly what is available now, so your team always has the current picture.

Permissions follow the shape of the platform

Access is granted area by area, with read and write granted separately, so every connection gets only what it needs.

AccountingBankingCompaniesCRMExpensesItemsProductionPurchasingSalesServices

These are the permission areas an administrator can assign. Which records and actions the API offers in each area is shown in the reference in Settings.

Growing The API is being extended across the platform, so new areas arrive in the same style as the ones before.

How it works

From approval to first call in four steps.

  1. 1

    Create a connection

    Once API access is switched on for your organisation, an administrator registers the app or integration in Enterpryze Settings and chooses which areas it can read or change.

  2. 2

    Sign in securely

    The app signs in with OAuth 2.0 and receives a short-lived access token. It never handles anyone’s password.

  3. 3

    Read and write data

    The app sends simple JSON requests over HTTPS to list, filter, create and update records.

  4. 4

    Every call is checked

    Each request is checked against the connection’s permissions, validated before anything is saved and counted towards your allowance.

Two ways to connect

Choose the one that matches how your app or integration runs. Either can have read access, write access or both, area by area.

As a user

For browser, mobile and desktop apps where a person signs in with their own Enterpryze account. The app works on their behalf, within the access you’ve given it.

Good for
Reporting add-ins, mobile sales apps and internal tools
Signs in with
OAuth 2.0 authorisation code flow with PKCE

As an application

For integrations that run unattended between systems, using credentials of their own rather than a person’s.

Good for
Online store sync, data warehouse loads and logistics partners
Signs in with
OAuth 2.0 client credentials flow

For developers

Predictable by design.

If you’ve worked with a modern REST API, you’ll feel at home. The same conventions run through the whole API, in every area.

Open standards

OAuth 2.0, JSON over HTTPS and a full OpenAPI 3.1 description, ready for the tools and code generators you already use.

One pattern everywhere

List, get, create and update follow the same pattern wherever a record supports them. Learn one and the rest feel familiar.

Filter, sort and page

Combine filters and date ranges, sort by date or number, and page through up to 100 records at a time with a total count.

Only what changed

Filter on when records were last updated and sync just the changes since your last run.

Choose your fields

Ask for only the fields you need, or expand a document to include its lines and custom fields.

Partial updates

Send only what changes. On documents with lines, you can add, change or remove lines in the same call.

Valid codes on hand

Reference lists give you the valid codes, such as accounts, tax codes and warehouses, to check against before you send.

Errors you can act on

Every error has a stable code and a readable description, and rate limits tell you how long to wait.

Corrections the way your accountant expects

The API doesn’t delete trading documents. Mistakes are put right with returns and credit notes, and stock movements are final once recorded, so your audit trail stays intact.

Examples

Three everyday requests.

Simplified for reading, using orders and items as illustrations. The same patterns apply across the platform, and the full request and response formats are in the API reference in Enterpryze Settings.

Read

Find open sales orders since 01/11/2026

Filter by status (O means open) and date, newest first, and get back only the fields you asked for. The total at the end tells you how many orders match.

Shows filtering, sorting and field selection.

Request
GET /v2/sales/orders
    ?status=O
    &documentDate[gte]=2026-11-01
    &sort=-documentDate
    &fields=documentNumber,companyName,total
Authorization: Bearer <access token>
Response 200 OK
{
  "value": [
    {
      "documentNumber": 10482,
      "companyName": "Harbour Home Supplies",
      "total": 4820.00
    },
    …
  ],
  "skip": 0,
  "limit": 20,
  "total": 37
}
Create

Send an online store order into Enterpryze

Create a sales order for an existing customer, with your store’s order number as the reference. Enterpryze checks it and returns the new order with its document number.

Shows creating a document.

Request
POST /v2/sales/orders
Authorization: Bearer <access token>
Content-Type: application/json

{
  "companyId": "C10023",
  "documentType": "item",
  "dueDate": "2026-11-19",
  "customerReference": "WEB-48213",
  "lines": [
    {
      "itemCode": "LMP-220",
      "quantity": 4,
      "unitPrice": 18.50,
      "warehouseCode": "01"
    }
  ]
}
Response, abridged 201 Created
{
  "id": 5531,
  "documentNumber": 10483,
  "companyName": "Harbour Home Supplies",
  "customerReference": "WEB-48213",
  "status": "O"
}
Sync

Pick up items changed since yesterday

Ask only for items created or changed since your last run. Schedule it and your store, reports or warehouse tools stay current without reloading everything.

Shows changes since a point in time, and paging. More than 100 results? Ask for the next page with skip=100.

Request
GET /v2/items
    ?lastUpdated[gte]=2026-11-04T00:00:00Z
    &limit=100
Authorization: Bearer <access token>
Response 200 OK
{
  "value": [ … ],
  "skip": 0,
  "limit": 100,
  "total": 212
}

Security and control

You decide who connects and what they can do.

Security is part of how every connection is made, not something added afterwards.

Industry-standard sign-in

Connections use OAuth 2.0, so apps never handle a user’s password.

Least privilege

Each connection gets only the areas, and only the read or write access, that an administrator assigns.

No quiet surprises

Ask for a permission a connection hasn’t been given and the request is refused outright, never quietly trimmed.

Short-lived access tokens

Access tokens expire after a short time, which limits the damage if one is ever exposed.

Registered web addresses

Browser-based apps only work from the web addresses registered for them.

Switch off at any time

Revoke a connection and its access stops straight away, without changing anyone’s password.

Sales orders Example view
NumberCustomerTotalSource
10483Harbour Home Supplies€91.02API
10482Harbour Home Supplies€4,820.00API
10481Kestrel Engineering€1,240.50Web
10480Larchfield Foods€2,986.20Mobile

Records created through the API carry an API source in Enterpryze grids, so you can always see what came from where.

Access and usage

Usage you can plan for.

Each connection has its own rate limit and each organisation has a monthly allowance, so usage stays predictable and fair for everyone.

Fair-use rate limits

Each connection has a rate limit. If it sends too many requests at once, the API asks it to wait and says for how long.

Monthly allowance

Each organisation has a monthly API allowance. If it runs out, calls are declined with a clear message until it resets or is raised.

Common questions about the API

Which parts of Enterpryze does the API cover?

The API is being extended to cover the whole platform. The reference in Enterpryze Settings lists exactly what is available today, and new areas follow the same conventions as existing ones.

Do you need to be an Enterpryze customer?

Yes. Every connection belongs to an Enterpryze organisation and is approved by its administrator. If you’re a partner building for several customers, each customer sets up a connection for your app in their own organisation, and we’re happy to help you get started.

Where is the full technical reference?

Inside Enterpryze, under Settings. Once API access is enabled, your team can see every endpoint, field and error code there, along with how to sign in.

How secure is it?

Connections sign in with OAuth 2.0, access tokens are short-lived, every call is checked against the permissions you granted, and an administrator can revoke a connection at any time.

Can the API delete records?

No. Trading documents are corrected with returns and credit notes, the way your accountant would expect. Where a document is still open, you can change it or close it.

How do integrations stay up to date?

By asking for records changed since their last check, using the last updated filter. This keeps the number of calls low, and you choose how often it runs.

Are there limits?

Yes. Each connection has a fair-use rate limit, each organisation has a monthly allowance, and lists return up to 100 records per page.

Can you use your own custom fields?

Yes. The API lists the custom fields set up for your organisation and accepts values for them on the records that support them.

Can AI tools use the API?

Yes. An AI tool connects like any other app, with the permissions you choose. Read-only access lets it answer questions about your business without changing anything.

Ready to connect?

Tell us what you’d like to connect and we’ll help you take the first step.

Already a customer

Request API access for your organisation and we’ll help you set up your first connection.

Building an integration

Tell us what you’re building. We’ll get you set up with access and answer your technical questions.

Evaluating Enterpryze

Book a chat and bring your integration questions. We’ll show you how Enterpryze fits with the systems you already use.

Request API access