{"object":"docs","name":"Invox","description":"Guides for integrating this API, generated from the code that serves it. Start with the first page and follow the links.","format":"text/markdown","data":[{"id":"start","title":"Getting a credential","summary":"From the base URL to a credential that acts on an organization, without any screen of ours.","url":"https://api.invox.page/v1/docs/start"},{"id":"first-invoice","title":"The first invoice, in test mode","summary":"Issue a test invoice end to end: series, preview, the call, and what the answer means.","url":"https://api.invox.page/v1/docs/first-invoice"},{"id":"follow-invoice","title":"Following an invoice to its outcome","summary":"Waiting on the invoice or on the event stream (no public URL needed) and reading its files and emails.","url":"https://api.invox.page/v1/docs/follow-invoice"},{"id":"webhooks","title":"Webhooks","summary":"Receiving events at a URL: verifying the signature, discarding duplicates, and reconciling with the event stream.","url":"https://api.invox.page/v1/docs/webhooks"},{"id":"void-and-correct","title":"Voiding and correcting","summary":"The two irreversible actions: each needs the token of its own preview.","url":"https://api.invox.page/v1/docs/void-and-correct"},{"id":"test-mode","title":"Test mode: scenarios and provider conditions","summary":"Provoking every outcome (accepted, rejected, pending, a blocked provider account) without touching anything real.","url":"https://api.invox.page/v1/docs/test-mode"},{"id":"production","title":"The road to production","summary":"What is still missing to issue for real, who must do each thing, and what changes when it is done.","url":"https://api.invox.page/v1/docs/production"},{"id":"people","title":"Members and invitations","summary":"Who can do what, and how a person joins an organization: only by invitation.","url":"https://api.invox.page/v1/docs/people"},{"id":"reports","title":"The sales report (CSV)","summary":"The invoices of a period as a spreadsheet, in one call.","url":"https://api.invox.page/v1/docs/reports"},{"id":"errors","title":"Errors","summary":"How to read an error and act on it without guessing; the full catalog.","url":"https://api.invox.page/v1/docs/errors"},{"id":"reference","title":"Reference: routes, permissions and limits","summary":"Every route with the permission it needs and how a retry is made safe; the scopes; the limits.","url":"https://api.invox.page/v1/docs/reference"}],"see_also":{"openapi":"https://api.invox.page/v1/openapi.json","errors":"https://api.invox.page/v1/errors","event_types":"https://api.invox.page/v1/event_types"}}