Skip to main content

API Reference

The full interactive API reference is available at:

https://e-invoicing-staging.vercel.app/v1/docs

It is powered by Swagger UI and documents every endpoint with live request/response examples you can execute directly in the browser.


What's covered

CategoryEndpoints
AuthenticationLogin, refresh, password reset, team member auth, FIRS OAuth
TenantsCreate, list, update, activate, suspend, delete
OnboardingStatus tracking, credential upload, activation links
API KeysGenerate, list, revoke, rotate
ERP SyncConfigure and retrieve ERP integration settings
WebhooksGenerate webhook URL, test delivery
TeamInvite, manage, and remove team members
Business SettingsView and update business profile
Event RoutingConfigure the invoice processing pipeline per tenant
SandboxTest transform, validate, and full pipeline runs
Admin ConfigFIRS data dictionary, supported ERPs, event/action reference

Base URL

https://e-invoicing-staging.vercel.app

Authentication

All requests require one of three headers depending on the operation — see Authentication for full details.

HeaderUsed for
x-api-keyTenant API calls (ERP integrations, team actions)
Authorization: Bearer <token>Team member sessions (JWT from /v1/auth/)
x-admin-keyPlatform admin operations