Resources

Every endpoint an API key can reach, the scope each one needs, and the endpoints keys cannot reach at all.

Every path below is relative to the base URL — https://api.taxlyne.com/api/v1.

104 endpoints across 16 resources are reachable with an API key. A further 29 refuse keys entirely, listed at the end.

This page is the map: which resource, which endpoint, which scope. For exact request and response fields, use the interactive reference — it is generated from the code and cannot go stale.

Invoices

Create, file, amend and cancel invoices.

Method	Endpoint	Scope
`GET`	`/invoices`	`invoices:read`
`POST`	`/invoices`	`invoices:write`
`GET`	`/invoices/:id`	`invoices:read`
`DELETE`	`/invoices/:id`	`invoices:delete`
`POST`	`/invoice/transmit/:irn`	`invoices:write`
`PATCH`	`/invoice/transmit/:irn`	`invoices:write`
`GET`	`/invoice/transmit/pull`	`invoices:read`
`GET`	`/invoice/transmit/self-health-check`	`invoices:read`
`POST`	`/invoices/:id/cancel`	`invoices:write`
`POST`	`/invoices/:id/lines`	`invoices:write`
`POST`	`/invoices/:id/mark-paid`	`invoices:write`
`POST`	`/invoices/:id/payment-status`	`invoices:write`
`POST`	`/invoices/:id/sign`	`invoices:write`
`POST`	`/invoices/:id/submit`	`invoices:write`
`POST`	`/invoices/:id/validate`	`invoices:write`
`GET`	`/invoice/transmit/lookup/:irn`	`invoices:read`
`POST`	`/invoices/:id/lines/:lineId`	`invoices:write`
`DELETE`	`/invoices/:id/lines/:lineId`	`invoices:write`
`GET`	`/invoice/transmit/lookup/tin/:tin`	`invoices:read`

Customers

The buyers you invoice. Nested under a business.

Method	Endpoint	Scope
`GET`	`/businesses/:businessId/customers`	`customers:read`
`POST`	`/businesses/:businessId/customers`	`customers:write`
`GET`	`/businesses/:businessId/customers/:id`	`customers:read`
`PATCH`	`/businesses/:businessId/customers/:id`	`customers:write`
`DELETE`	`/businesses/:businessId/customers/:id`	`customers:delete`

Inventory

Products and services you sell, with stock movements.

Method	Endpoint	Scope
`GET`	`/inventory`	`inventory:read`
`POST`	`/inventory`	`inventory:write`
`GET`	`/inventory/:id`	`inventory:read`
`PUT`	`/inventory/:id`	`inventory:write`
`DELETE`	`/inventory/:id`	`inventory:delete`
`POST`	`/inventory/:id/adjust`	`inventory:write`
`GET`	`/inventory/:id/movements`	`inventory:read`
`GET`	`/inventory/sku/:sku`	`inventory:read`

Businesses

Your own businesses, and their FIRS onboarding.

Method	Endpoint	Scope
`GET`	`/businesses`	`business:read`
`POST`	`/businesses`	`business:write`
`GET`	`/businesses/:id`	`business:read`
`PATCH`	`/businesses/:id`	`business:write`
`DELETE`	`/businesses/:id`	`business:delete`
`GET`	`/businesses/assigned`	`business:read`
`POST`	`/businesses/register-and-onboard`	`business:write`
`POST`	`/businesses/:id/logo`	`business:write`
`POST`	`/businesses/:id/onboard`	`business:write`
`POST`	`/businesses/firs/resolve`	`business:read`

Credit and debit notes

Adjustments against an invoice already filed.

Method	Endpoint	Scope
`GET`	`/credit-debit-notes`	`credit-notes:read`
`POST`	`/credit-debit-notes`	`credit-notes:write`
`GET`	`/credit-debit-notes/:id`	`credit-notes:read`

Payments

Payments recorded against an invoice.

Method	Endpoint	Scope
`GET`	`/invoices/:id/payments`	`payments:read`
`POST`	`/invoices/:id/payments`	`payments:write`

FIRS reference data

The code lists you need to build a valid invoice.

Method	Endpoint	Scope
`GET`	`/firs/countries`	`firs:read`
`GET`	`/firs/currencies`	`firs:read`
`GET`	`/firs/hs-codes`	`firs:read`
`GET`	`/firs/invoice-types`	`firs:read`
`GET`	`/firs/lgas`	`firs:read`
`GET`	`/firs/payment-means`	`firs:read`
`GET`	`/firs/self-check`	`firs:read`
`GET`	`/firs/service-codes`	`firs:read`
`GET`	`/firs/states`	`firs:read`
`GET`	`/firs/tax-categories`	`firs:read`
`GET`	`/firs/invoice/:irn/confirm`	`firs:read`
`GET`	`/firs/irn/:irn/validate`	`firs:read`

Accounting integrations

Connect Zoho, QuickBooks, Odoo or Xero.

Method	Endpoint	Scope
`GET`	`/integrations`	`integrations:read`
`GET`	`/integrations/:id`	`integrations:read`
`GET`	`/integrations/supported-erp-integrations`	`integrations:read`
`POST`	`/integrations/odoo/create`	`integrations:write`
`POST`	`/integrations/quickbooks/create`	`integrations:write`
`GET`	`/integrations/xero/connect`	`integrations:write`
`POST`	`/integrations/xero/create`	`integrations:write`
`POST`	`/integrations/zoho/create`	`integrations:write`
`GET`	`/integrations/odoo/:integrationId/sync-invoices`	`integrations:write`
`DELETE`	`/integrations/odoo/disconnect/:integrationId`	`integrations:delete`
`GET`	`/integrations/quickbooks/:integrationId/sync-invoices`	`integrations:write`
`GET`	`/integrations/quickbooks/connect/:businessId`	`integrations:write`
`DELETE`	`/integrations/quickbooks/disconnect/:integrationId`	`integrations:delete`
`GET`	`/integrations/xero/:integrationId/sync-invoices`	`integrations:write`
`DELETE`	`/integrations/xero/disconnect/:integrationId`	`integrations:delete`
`GET`	`/integrations/zoho/:integrationId/sync-invoices`	`integrations:write`
`GET`	`/integrations/zoho/connect/:businessId`	`integrations:write`
`DELETE`	`/integrations/zoho/disconnect/:integrationId`	`integrations:delete`

Webhooks

Method	Endpoint	Scope
`GET`	`/webhooks`	`webhooks:read`
`POST`	`/webhooks`	`webhooks:write`
`GET`	`/webhooks/:id`	`webhooks:read`
`PATCH`	`/webhooks/:id`	`webhooks:write`
`DELETE`	`/webhooks/:id`	`webhooks:delete`
`GET`	`/webhooks/events`	`webhooks:read`
`GET`	`/webhooks/:id/deliveries`	`webhooks:read`
`POST`	`/webhooks/:id/rotate-secret`	`webhooks:write`
`POST`	`/webhooks/:id/test`	`webhooks:write`

Received invoices

Invoices other businesses have sent you.

Method	Endpoint	Scope
`GET`	`/received-invoices`	`received-invoices:read`
`GET`	`/received-invoices/:id`	`received-invoices:read`

Notifications

Your in-app notifications.

Method	Endpoint	Scope
`GET`	`/notifications`	`notifications:read`
`GET`	`/notifications/:id`	`notifications:read`

Audit history

What your account has done.

Method	Endpoint	Scope
`GET`	`/audit/me`	`audit:read`

Statistics

Invoice analytics for a business.

Method	Endpoint	Scope
`GET`	`/stats/:businessId/invoice-analytics`	`stats:read`
`GET`	`/stats/:businessId/invoice-analytics-over-time`	`stats:read`

System integrator

Dashboards and settings for integrator accounts.

Method	Endpoint	Scope
`GET`	`/system-integrators/dashboard/invoices-over-time`	`si:read`
`GET`	`/system-integrators/dashboard/overview`	`si:read`
`GET`	`/system-integrators/dashboard/recent-activities`	`si:read`
`GET`	`/system-integrators/settings/time-and-language`	`si:read`
`PATCH`	`/system-integrators/settings/time-and-language`	`si:write`
`GET`	`/system-integrators/usage/api-calls-over-time`	`si:read`
`GET`	`/system-integrators/usage/error-distribution`	`si:read`
`GET`	`/system-integrators/usage/stats`	`si:read`
`GET`	`/system-integrators/usage/top-endpoints`	`si:read`

Storage

Signed URLs for files your business owns.

Method	Endpoint	Scope
`POST`	`/storage/signed-url`	`storage:read`

Profile

Who the current credentials belong to.

Method	Endpoint	Scope
`GET`	`/auth/me`	`profile:read`

Endpoints an API key cannot reach

These refuse a key whatever scopes it holds, because they change who can act or what they can act with. They need a signed-in session — see Scopes and permissions for why a scope cannot substitute.

Method	Endpoint
`GET`	`/api-key`
`POST`	`/api-key`
`GET`	`/api-key/:id`
`DELETE`	`/api-key/:id`
`GET`	`/api-key/:id/reveal`
`POST`	`/auth/logout`
`POST`	`/auth/logout-all`
`POST`	`/billing/initialize`
`GET`	`/billing/verify/:reference`
`GET`	`/roles`
`POST`	`/roles`
`GET`	`/roles/:id`
`PATCH`	`/roles/:id`
`DELETE`	`/roles/:id`
`GET`	`/roles/permissions`
`POST`	`/subscription-tiers`
`PATCH`	`/subscription-tiers/:id`
`DELETE`	`/subscription-tiers/:id`
`PATCH`	`/system-integrators/settings/change-password`
`GET`	`/user`
`GET`	`/user-subscriptions/active`
`POST`	`/user-subscriptions/purchase-extra-units`
`POST`	`/user-subscriptions/purchase-tier`
`GET`	`/user/:id`
`DELETE`	`/user/:id/delete`
`PATCH`	`/user/:id/reactivate`
`PATCH`	`/user/:id/suspend`
`PATCH`	`/user/:id/update`
`POST`	`/user/create`

There are also staff-only endpoints under /admin, which are not part of the customer API and are omitted here.

A 404 may mean "not in this environment". Staging usually runs a little ahead of production, so a newly added endpoint can be absent in production until the next release. Check the one you need responds in production before shipping.

Resources

On this page