Skip to content
InvoiceRig
Theme
Theme

Documentation

Four interfaces. One run contract.

Start in the browser, move to the API for server workflows, then automate with the CLI or GitHub Action.

Open workspaceAPI quickstart

API quickstart

Authenticate. Verify. Start the run.

Start with an authorized read before creating anything. If a create request is uncertain, reconcile run history before retrying.

  1. 01

    Create a machine credential

    Developer API · CI / server token

  2. 02

    Verify project access

    Bearer · authorized organization

  3. 03

    Create a run

    Pinned execution · follow run_id

Verify API accessGET /projects
export INVOICERIG_API_ORIGIN='https://YOUR-INVOICERIG-APP-HOST'
export INVOICERIG_TOKEN='***secret manager***'
export INVOICERIG_ORGANIZATION_ID='00000000-0000-0000-0000-000000000000'

curl --fail-with-body \
  -H "Authorization: Bearer $INVOICERIG_TOKEN" \
  -H 'Accept: application/json' \
  "$INVOICERIG_API_ORIGIN/v1/organizations/$INVOICERIG_ORGANIZATION_ID/projects"
Keep the token in your secret manager; never place it in the repository.

Interfaces

Use the surface that fits the job.

The access mode changes. The run model and evidence boundary stay the same.

Hosted browser

interactive diagnosis

Sign in, choose an organization/project, start a validation, inspect history and export share-safe evidence.

API

bounded server workflows

Organization-scoped machine tokens support bounded server-side workflows. Reconcile run history before retrying an uncertain create request.

CLI and GitHub Action

local / repository automation

Use normalized local run/suite outputs and provider-free automation by default; sandbox access remains explicitly guarded.

Contract reference

What stays stable across every interface.

Formats
UBL, CII and Factur-X
Local execution supports pinned UBL 2.1, CII D16B and Factur-X 1.09.2 profiles; hosted upload appears only when encrypted upload is available.
Validation
EN 16931 and France rules
Syntax, EN 16931 and France checks remain versioned, ordered validation layers.
Sandbox
Provider sandbox evidence
Iopole and WeInvoice observations stay separate from the local conformance result.

Next step

Start in the browser, automate next.

Then move to Developer API for server or CI workflows.

View accessOpen workspace