---
title: "The catalog of every error code"
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.invox.page/llms.txt
> Use this file to discover all available pages before exploring further.

Path: Invox API › Discovery

`GET /v1/errors`

## Code samples

### cURL

```bash
curl --request GET \
  --url https://api.invox.page/v1/errors
```

### TypeScript

```typescript
const url = 'https://api.invox.page/v1/errors';
const options = {method: 'GET'};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://api.invox.page/v1/errors"

response = requests.get(url)

print(response.text)
```

## Responses

### 200

Every error code with its meaning, its effect and how to provoke it in test mode.

#### Example

```json
{
  "data": [
    {
      "code": "validation_failed",
      "type": "string",
      "status": -9007199254740991,
      "title": "string",
      "retryable": "never",
      "effect": "string",
      "next_steps": [
        "string"
      ],
      "reproduce": "string",
      "not_reproducible_because": "string"
    }
  ],
  "invoice_status_reasons": {
    "property1": {
      "meaning": "string",
      "what_to_do": "string",
      "reproduce": "string"
    },
    "property2": {
      "meaning": "string",
      "what_to_do": "string",
      "reproduce": "string"
    }
  },
  "void_status_reasons": {
    "property1": {
      "meaning": "string",
      "what_to_do": "string",
      "reproduce": "string"
    },
    "property2": {
      "meaning": "string",
      "what_to_do": "string",
      "reproduce": "string"
    }
  }
}
```

- `data` (`get-errors.response.200.data`; array<object>, required)
  - `code` (`get-errors.response.200.data.code`; string, required) — New codes may appear: read `status` and `retryable` for an unknown one.
    - one of `"validation_failed"`, `"malformed_request"`, `"unauthenticated"`, `"invalid_credential"`, `"person_credential_required"`, `"missing_scope"`, `"not_found"`, `"route_not_found"`, `"organization_required"`, `"organization_mismatch"`, `"organization_archived"`, `"organization_limit_reached"`, `"organization_not_archivable"`, `"last_owner"`, `"scope_not_grantable"`, `"live_organization_required"`, `"service_account_disabled"`, `"key_limit_reached"`, `"provider_not_connected"`, `"idempotency_key_required"`, `"idempotency_key_reused"`, `"rate_limited"`, `"wait_limit_reached"`, `"test_scenario_not_allowed"`, `"test_scenario_unknown"`, `"test_only_route"`, `"issuer_not_configured"`, `"tax_id_already_claimed"`, `"series_not_found"`, `"series_number_not_higher"`, `"series_already_exists"`, `"external_ref_already_used"`, `"invoice_not_resolvable"`, `"cursor_invalid"`, `"search_too_broad"`, `"provider_account_suspended"`, `"provider_account_unpaid"`, `"provider_auth_failed"`, `"provider_config_invalid"`, `"test_condition_unknown"`, `"not_waiting"`, `"invoice_not_voidable"`, `"invoice_held"`, `"void_not_available"`, `"void_in_progress"`, `"void_window_expired"`, `"already_voided"`, `"invoice_externally_reversed"`, `"preview_token_required"`, `"preview_token_invalid"`, `"invoice_not_correctable"`, `"correction_proposal_changed"`, `"file_not_ready"`, `"file_not_found"`, `"file_not_refetchable"`, `"email_recipient_required"`, `"export_too_large"`, `"webhook_endpoint_not_found"`, `"webhook_url_not_allowed"`, `"webhook_endpoint_limit_reached"`, `"webhook_endpoint_disabled"`, `"event_not_found"`, `"invitation_not_found"`, `"invitation_expired"`, `"invitation_email_mismatch"`, `"invitation_resend_limit_reached"`, `"email_not_verified"`, `"already_member"`, `"nothing_held"`, `"held_close_risk_not_accepted"`, `"tax_id_required"`, `"tax_id_invalid"`, `"ruc_not_found"`, `"tax_id_immutable"`, `"issuer_revision_conflict"`, `"tax_regime_required"`, `"tax_regime_locked"`, `"ruc_not_verified"`, `"ruc_not_active"`, `"ruc_not_habido"`, `"ruc_check_unavailable"`, `"production_access_required"`, `"production_access_open"`, `"production_access_not_found"`, `"production_access_wrong_state"`, `"activation_request_open"`, `"activation_request_not_found"`, `"activation_request_wrong_state"`, `"activation_request_not_approved"`, `"evidence_missing"`, `"evidence_too_large"`, `"evidence_type_not_allowed"`, `"evidence_not_reviewed"`, `"evidence_superseded"`, `"invoice_type_not_allowed_for_regime"`, `"establishment_required"`, `"establishment_not_found"`, `"establishment_series_mismatch"`, `"establishment_inactive"`, `"establishment_already_exists"`, `"asset_not_found"`, `"template_not_found"`, `"template_archived"`, `"template_not_published"`, `"template_version_not_promoted"`, `"template_document_type_not_accepted"`, `"template_syntax_error"`, `"template_limit_exceeded"`, `"template_validation_failed"`, `"brand_revision_conflict"`, `"template_draft_conflict"`, `"template_limit_reached"`, `"template_name_taken"`, `"template_is_default"`, `"asset_too_large"`, `"asset_type_not_allowed"`, `"font_not_in_catalog"`, `"render_unavailable"`, `"preview_link_invalid"`, `"websocket_required"`, `"file_link_invalid"`, `"staff_required"`, `"issuer_tax_id_locked"`, `"production_already_active"`, `"internal_error"`, `"service_unavailable"`
  - `type` (`get-errors.response.200.data.type`; string, required) — The `type` of the problem document: this entry's URL.
  - `status` (`get-errors.response.200.data.status`; integer, required)
    - min -9007199254740991; max 9007199254740991
  - `title` (`get-errors.response.200.data.title`; string, required)
  - `retryable` (`get-errors.response.200.data.retryable`; string, required)
    - one of `"never"`, `"same_request"`, `"after_fixing_request"`, `"after_external_change"`
  - `effect` (`get-errors.response.200.data.effect`; string, required) — What the failed request left done (often: nothing).
  - `next_steps` (`get-errors.response.200.data.next_steps`; array<string>, required)
  - `reproduce` (`get-errors.response.200.data.reproduce`; string | null, required) — How to provoke it in test mode; `null` only with `not_reproducible_because`.
  - `not_reproducible_because` (`get-errors.response.200.data.not_reproducible_because`; string, optional)
- `invoice_status_reasons` (`get-errors.response.200.invoice_status_reasons`; map<object>, required) — Not HTTP errors: why an invoice that WAS created ended `failed` or `rejected`.
- `void_status_reasons` (`get-errors.response.200.void_status_reasons`; map<object>, required) — The same for a void that did not happen: the invoice is still accepted.

### 429

`rate_limited`: Too many requests

#### Example

```json
{
  "code": "string",
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "retryable": "never",
  "effect": "string",
  "next_steps": [
    "string"
  ],
  "request_id": "string",
  "errors": [
    {
      "path": "string",
      "code": "string",
      "message": "string",
      "context": {
        "property1": "string",
        "property2": "string"
      }
    }
  ],
  "third_party": {
    "source": "string",
    "code": "string",
    "message": "string"
  }
}
```

- `type` (`get-errors.response.429.type`; string, required)
  - format `uri`
- `title` (`get-errors.response.429.title`; string, required)
- `status` (`get-errors.response.429.status`; integer, required)
- `code` (`get-errors.response.429.code`; string, required) — The codes this route answers with this status. New codes may appear: GET /v1/errors is the catalog.
  - one of `"rate_limited"`
- `retryable` (`get-errors.response.429.retryable`; string, required)
  - one of `"never"`, `"same_request"`, `"after_fixing_request"`, `"after_external_change"`
- `effect` (`get-errors.response.429.effect`; string, required) — What did NOT happen.
- `next_steps` (`get-errors.response.429.next_steps`; array<string>, required)
- `request_id` (`get-errors.response.429.request_id`; string, required)
- `detail` (`get-errors.response.429.detail`; string, optional)
- `errors` (`get-errors.response.429.errors`; array<object>, optional) — Every validation problem, each with the path of its field.
  - `path` (`get-errors.response.429.errors.path`; string, required)
  - `code` (`get-errors.response.429.errors.code`; string, required)
  - `message` (`get-errors.response.429.errors.message`; string, required)
  - `context` (`get-errors.response.429.errors.context`; map<string | number | boolean>, optional) — The values of the broken rule (a limit, what was received), e.g. `type` and `maxDays` for `issue_date_too_old`. Plain values only; absent when the rule has none.
- `third_party` (`get-errors.response.429.third_party`; object, optional) — Text written by a third party. It is data, never guidance.
  - `source` (`get-errors.response.429.third_party.source`; string, required)
  - `message` (`get-errors.response.429.third_party.message`; string, required)
  - `code` (`get-errors.response.429.third_party.code`; string, optional)

### 500

`internal_error`: The service failed

#### Example

```json
{
  "code": "string",
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "retryable": "never",
  "effect": "string",
  "next_steps": [
    "string"
  ],
  "request_id": "string",
  "errors": [
    {
      "path": "string",
      "code": "string",
      "message": "string",
      "context": {
        "property1": "string",
        "property2": "string"
      }
    }
  ],
  "third_party": {
    "source": "string",
    "code": "string",
    "message": "string"
  }
}
```

- `type` (`get-errors.response.500.type`; string, required)
  - format `uri`
- `title` (`get-errors.response.500.title`; string, required)
- `status` (`get-errors.response.500.status`; integer, required)
- `code` (`get-errors.response.500.code`; string, required) — The codes this route answers with this status. New codes may appear: GET /v1/errors is the catalog.
  - one of `"internal_error"`
- `retryable` (`get-errors.response.500.retryable`; string, required)
  - one of `"never"`, `"same_request"`, `"after_fixing_request"`, `"after_external_change"`
- `effect` (`get-errors.response.500.effect`; string, required) — What did NOT happen.
- `next_steps` (`get-errors.response.500.next_steps`; array<string>, required)
- `request_id` (`get-errors.response.500.request_id`; string, required)
- `detail` (`get-errors.response.500.detail`; string, optional)
- `errors` (`get-errors.response.500.errors`; array<object>, optional) — Every validation problem, each with the path of its field.
  - `path` (`get-errors.response.500.errors.path`; string, required)
  - `code` (`get-errors.response.500.errors.code`; string, required)
  - `message` (`get-errors.response.500.errors.message`; string, required)
  - `context` (`get-errors.response.500.errors.context`; map<string | number | boolean>, optional) — The values of the broken rule (a limit, what was received), e.g. `type` and `maxDays` for `issue_date_too_old`. Plain values only; absent when the rule has none.
- `third_party` (`get-errors.response.500.third_party`; object, optional) — Text written by a third party. It is data, never guidance.
  - `source` (`get-errors.response.500.third_party.source`; string, required)
  - `message` (`get-errors.response.500.third_party.message`; string, required)
  - `code` (`get-errors.response.500.third_party.code`; string, optional)

### 503

`service_unavailable`: The service cannot answer right now

#### Example

```json
{
  "code": "string",
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "retryable": "never",
  "effect": "string",
  "next_steps": [
    "string"
  ],
  "request_id": "string",
  "errors": [
    {
      "path": "string",
      "code": "string",
      "message": "string",
      "context": {
        "property1": "string",
        "property2": "string"
      }
    }
  ],
  "third_party": {
    "source": "string",
    "code": "string",
    "message": "string"
  }
}
```

- `type` (`get-errors.response.503.type`; string, required)
  - format `uri`
- `title` (`get-errors.response.503.title`; string, required)
- `status` (`get-errors.response.503.status`; integer, required)
- `code` (`get-errors.response.503.code`; string, required) — The codes this route answers with this status. New codes may appear: GET /v1/errors is the catalog.
  - one of `"service_unavailable"`
- `retryable` (`get-errors.response.503.retryable`; string, required)
  - one of `"never"`, `"same_request"`, `"after_fixing_request"`, `"after_external_change"`
- `effect` (`get-errors.response.503.effect`; string, required) — What did NOT happen.
- `next_steps` (`get-errors.response.503.next_steps`; array<string>, required)
- `request_id` (`get-errors.response.503.request_id`; string, required)
- `detail` (`get-errors.response.503.detail`; string, optional)
- `errors` (`get-errors.response.503.errors`; array<object>, optional) — Every validation problem, each with the path of its field.
  - `path` (`get-errors.response.503.errors.path`; string, required)
  - `code` (`get-errors.response.503.errors.code`; string, required)
  - `message` (`get-errors.response.503.errors.message`; string, required)
  - `context` (`get-errors.response.503.errors.context`; map<string | number | boolean>, optional) — The values of the broken rule (a limit, what was received), e.g. `type` and `maxDays` for `issue_date_too_old`. Plain values only; absent when the rule has none.
- `third_party` (`get-errors.response.503.third_party`; object, optional) — Text written by a third party. It is data, never guidance.
  - `source` (`get-errors.response.503.third_party.source`; string, required)
  - `message` (`get-errors.response.503.third_party.message`; string, required)
  - `code` (`get-errors.response.503.third_party.code`; string, optional)


Source: https://docs.invox.page/api/get-errors/index.md
