API Reference

Enterprise API Overview

This page will help you get started with Enterprise API.

The Enterprise API extends our standard API capabilities to meet the needs of larger, multi-organization environments. It provides powerful tools for managing complex organizational structures while maintaining strict security and centralized control.

Key Features

Multi-Organisation Management

  • Seamlessly manage multiple organisations across different geographic regions
  • Allow global access while retaining per organisation user roles

Document Management

  • Access organisation-specific document listings with granular permission controls
  • Perform global document queries across all or selected organizations

Organization Lifecycle Management

  • Create, update, and manage organisations throughout their entire lifecycle
  • Configure organisation settings and integrations

Enterprise-Grade Capabilities

  • Enhanced security features designed for enterprise compliance requirements
  • Higher rate limits to support increased transaction volumes
  • Expanded usage policies to accommodate enterprise-scale operations

Authentication

The Enterprise API uses the same underlying requirements as our standard API, with one key difference:

Authentication: X-Api-Key: your-enterprise-api-key

Your enterprise API key must be included in the request headers rather than as a query parameter.

Getting Started

To begin using the Enterprise API, you'll need to request enterprise credentials from our support team. Once provisioned, you can immediately use the enhanced capabilities while maintaining compatibility with your existing API implementations.

API endpoints

Organisation

The Enterprise API introduces new endpoints for creating and managing organisations on an enterprise level. Enterprise API users can create child organisations for easy invoice creation and retrieval on both a per organisation and global level.

Invoice

Invoices can now be created per organization by using the following API endpoints.

Create

POST /org/{orgId}/invoice

Read

GET /org/{orgId}/invoice/{invoiceId}

List by org

GET /org/{orgId}/invoice

List all

GET /org/invoice


Credit note

Credit notes can now be created per organization by using the following API endpoints.

Create

POST /org/{orgId}/credit-note

Read

GET /org/{orgId}/credit-note/{creditNoteId}

List by org

GET /org/{orgId}/credit-note

List all

GET /org/credit-note