Skip to main content
Version: v1

Scribee API

The Scribee Partner API is a REST/JSON API for Scribee, a French Plateforme Agréée for the electronic-invoicing reform: invoices, quotes, mandates, e-reporting, and the customer/supplier directory are all reachable here.

Authentication is OAuth 2.0 client-credentials. Every access token carries one or more of three scopes: read (read access to resources), write (create, update, and DELETE unless :destroy is required by the endpoint), and destroy (permission to delete resources via HTTP DELETE - a least-privilege alternative to write for destructive endpoints). Request a token at POST /oauth/token.

All resource endpoints are namespaced under /api/v1/ and versioned as a unit - a breaking change ships as /api/v2/, never as an in-place change to v1.

Human-readable guides (authentication walkthrough, resource overview, webhooks) live in docs/feature_registry/10_rest_api.md and docs/webhooks.md in the Scribee repository.

Authentication​

Security Scheme Type:

oauth2

OAuth Flow (clientCredentials):

Token URL: /oauth/token

Scopes:

  • read: Read access to resources

  • write: Write access to resources (create, update, and DELETE unless :destroy is required by the endpoint)

  • destroy: Permission to delete resources via HTTP DELETE (least-privilege alternative to :write for destructive endpoints)