Contract 1.3.0:einvoice.status

Invoice status

Check network processing status.

POST/v1/einvoice/status

Overview

Check network processing status.

Use cases

Use `einvoice.status` when you need invoice status through the provider-neutral QuoAPI contract.

Authentication

Send a QuoAPI API key as `Authorization: Bearer gi_test_...` or an approved live key. Test and live environments are isolated.

Quick start

Send `POST` to `/v1/einvoice/status`. Start in the test environment and keep the request ID for support and tracing.

Request fields

- `reference` — string, required. - `country` — string, optional. Optional ISO 3166-1 alpha-2 routing context. - `currency` — string, optional. Optional ISO 4217 commercial context.

Response fields

The response envelope contains `data` validated against the canonical response schema and `request_id`. Response schema type: `object`.

Errors

Errors use `error.code`, `error.message`, `error.request_id` and structured `error.details`. Provider names, credentials, upstream URLs and raw upstream errors are not part of the public contract.

Webhooks

This capability does not emit a public webhook event.

Rate limits

Rate limits are enforced by API key, organization, plan, capability and environment. Responses include standard rate-limit headers and `Retry-After` when applicable.

Idempotency

Retryable write operations support QuoAPI idempotency semantics so a replay does not create duplicate billing or side effects.

Sandbox

The Playground uses deterministic safe sandbox behavior. Anonymous demos cannot perform purchases, registrations, messages or destructive actions.

Pricing

Usage is measured in `document` and priced in `document` units.

Async behavior

The operation returns through the normal request lifecycle.

Contract version

`1.3.0:einvoice.status` — schema checksum `f7a4669f44f4c1e9d21abab2a6ef4e0f5dac384ca4760229155f3f6999327286`.

Request schema

{
  "additionalProperties": false,
  "properties": {
    "country": {
      "description": "Optional ISO 3166-1 alpha-2 routing context.",
      "pattern": "^[A-Z]{2}$",
      "type": "string",
      "x-quoapi-hidden": true,
      "x-quoapi-widget": "country"
    },
    "currency": {
      "description": "Optional ISO 4217 commercial context.",
      "pattern": "^[A-Z]{3}$",
      "type": "string",
      "x-quoapi-hidden": true,
      "x-quoapi-widget": "currency"
    },
    "reference": {
      "default": "einv_demo_001",
      "title": "Reference",
      "type": "string",
      "x-quoapi-widget": "text"
    }
  },
  "required": [
    "reference"
  ],
  "type": "object"
}

Response schema

{
  "additionalProperties": true,
  "description": "Canonical QuoAPI response data for this capability.",
  "type": "object"
}