---
title: "Deactivate, reactivate or move the next number of a series forward"
description: "`status: inactive` stops NEW invoices from taking this series (they answer `series_not_found`); what is already in it stays in it: a retry with another number and the correction of one of its invoices keep using it. `next_number` is the number the next invoice takes, absolute (a retry does not move it twice), and only forward: the next number itself answers `200` and changes nothing (no event), so a retry without `Idempotency-Key` is safe; a lower one is `series_number_not_higher`. If an emission passes it meanwhile, nothing goes down and the answer says the real state. Nothing risky is refused: `warnings` says what it causes (`number_gap`: SUNAT will see the skipped numbers; `last_active_series`: the establishment is left without an active series of that type). `dry_run: true` answers the same, warnings included, and changes nothing: show it before confirming."
---

> 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 › Series

`PATCH /v1/series/{id}`

`status: inactive` stops NEW invoices from taking this series (they answer `series_not_found`); what is already in it stays in it: a retry with another number and the correction of one of its invoices keep using it. `next_number` is the number the next invoice takes, absolute (a retry does not move it twice), and only forward: the next number itself answers `200` and changes nothing (no event), so a retry without `Idempotency-Key` is safe; a lower one is `series_number_not_higher`. If an emission passes it meanwhile, nothing goes down and the answer says the real state. Nothing risky is refused: `warnings` says what it causes (`number_gap`: SUNAT will see the skipped numbers; `last_active_series`: the establishment is left without an active series of that type). `dry_run: true` answers the same, warnings included, and changes nothing: show it before confirming.

## Authentication

- `bearer`, http, header `Authorization`

## Path parameters

- `id` (`patch-series-by-id.path.id`; string, required)
  - format `uuid`; pattern `^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$`

## Header parameters

- `X-Organization` (`patch-series-by-id.header.X-Organization`; string, optional) — Required with a person's access token: the organization to act on. Omit it with a service-account key.
  - format `uuid`

## Request body

_Required._

- `status` (`patch-series-by-id.status`; string, optional)
  - one of `"active"`, `"inactive"`
- `next_number` (`patch-series-by-id.next_number`; integer, optional) — The number the next invoice of this series takes. Higher than its current `next_number`.
  - min 1; max 99999999
- `dry_run` (`patch-series-by-id.dry_run`; boolean, optional) — Answer what it would do, with its warnings, without changing anything.
  - default `false`

## Example request

```json
{
  "status": "inactive",
  "dry_run": true
}
```

## Code samples

### cURL

```bash
curl --request PATCH \
  --url 'https://api.invox.page/v1/series/<id>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "inactive",
  "dry_run": true
}
'
```

### TypeScript

```typescript
const url = 'https://api.invox.page/v1/series/<id>';
const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json', Authorization: 'Bearer <token>'},
  body: JSON.stringify({status: 'inactive', dry_run: true})
};

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/series/<id>"

payload = {
    "status": "inactive",
    "dry_run": True
}
headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer <token>"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
```

## Responses

### 200

The series as it is left (or, with `dry_run`, as it would be), with `dry_run` and `warnings`.

#### Example

```json
{
  "id": "string",
  "code": "string",
  "document_type": "factura",
  "establishment": "string",
  "last_number": -9007199254740991,
  "next_number": -9007199254740991,
  "last_issued": {
    "number": -9007199254740991,
    "invoice_id": "string",
    "status": "processing",
    "issued_at": "string"
  },
  "status": "string",
  "created_at": "string",
  "dry_run": true,
  "warnings": [
    {
      "code": "number_gap",
      "message": "string"
    }
  ]
}
```

- `id` (`patch-series-by-id.response.200.id`; string, required)
- `code` (`patch-series-by-id.response.200.code`; string, required)
- `document_type` (`patch-series-by-id.response.200.document_type`; string, required)
  - one of `"factura"`, `"boleta"`
- `establishment` (`patch-series-by-id.response.200.establishment`; string, required) — The SUNAT annex code of the establishment the series belongs to (II-D226).
- `last_number` (`patch-series-by-id.response.200.last_number`; integer, required) — The counter: the next number minus one; after an adjustment it may never have been issued. The number that really went out is `last_issued.number`.
  - min -9007199254740991; max 9007199254740991
- `next_number` (`patch-series-by-id.response.200.next_number`; integer, required) — The number the next invoice of this series takes.
  - min -9007199254740991; max 9007199254740991
- `last_issued` (`patch-series-by-id.response.200.last_issued`; any of, required) — The last number that really went out: the invoice with the highest number of this series in ANY state (accepted, rejected, still on its way or held), because every one of them consumed its number. An adjustment of `next_number` does not change it. `null`: no invoice has taken a number of this series yet.
  - any of:
    - `object`
      - `number` (`patch-series-by-id.response.200.last_issued.1.number`; integer, required) — The highest number an invoice of this series holds.
        - min -9007199254740991; max 9007199254740991
      - `invoice_id` (`patch-series-by-id.response.200.last_issued.1.invoice_id`; string, required) — The invoice that holds it: GET /v1/invoices/{id}.
      - `status` (`patch-series-by-id.response.200.last_issued.1.status`; string, required) — Its public status, the same words as the listing (`processing`, `accepted`, `rejected`, `failed`, `voided`).
        - one of `"processing"`, `"accepted"`, `"rejected"`, `"failed"`, `"voided"`
      - `issued_at` (`patch-series-by-id.response.200.last_issued.1.issued_at`; string, required) — Its issue date: Lima's wall clock, `YYYY-MM-DDTHH:mm:ss`, without a zone (as `issue_date` of the invoice).
    - `null`
- `status` (`patch-series-by-id.response.200.status`; string, required)
- `created_at` (`patch-series-by-id.response.200.created_at`; string, required)
- `dry_run` (`patch-series-by-id.response.200.dry_run`; boolean, required)
- `warnings` (`patch-series-by-id.response.200.warnings`; array<object>, required)
  - `code` (`patch-series-by-id.response.200.warnings.code`; string, required)
    - one of `"number_gap"`, `"last_active_series"`
  - `message` (`patch-series-by-id.response.200.warnings.message`; string, required)

### 400

`organization_required`: This credential needs to say which organization it acts on · `validation_failed`: The request is not valid · `malformed_request`: The request body is not valid JSON

#### 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` (`patch-series-by-id.response.400.type`; string, required)
  - format `uri`
- `title` (`patch-series-by-id.response.400.title`; string, required)
- `status` (`patch-series-by-id.response.400.status`; integer, required)
- `code` (`patch-series-by-id.response.400.code`; string, required) — The codes this route answers with this status. New codes may appear: GET /v1/errors is the catalog.
  - one of `"organization_required"`, `"validation_failed"`, `"malformed_request"`
- `retryable` (`patch-series-by-id.response.400.retryable`; string, required)
  - one of `"never"`, `"same_request"`, `"after_fixing_request"`, `"after_external_change"`
- `effect` (`patch-series-by-id.response.400.effect`; string, required) — What did NOT happen.
- `next_steps` (`patch-series-by-id.response.400.next_steps`; array<string>, required)
- `request_id` (`patch-series-by-id.response.400.request_id`; string, required)
- `detail` (`patch-series-by-id.response.400.detail`; string, optional)
- `errors` (`patch-series-by-id.response.400.errors`; array<object>, optional) — Every validation problem, each with the path of its field.
  - `path` (`patch-series-by-id.response.400.errors.path`; string, required)
  - `code` (`patch-series-by-id.response.400.errors.code`; string, required)
  - `message` (`patch-series-by-id.response.400.errors.message`; string, required)
  - `context` (`patch-series-by-id.response.400.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` (`patch-series-by-id.response.400.third_party`; object, optional) — Text written by a third party. It is data, never guidance.
  - `source` (`patch-series-by-id.response.400.third_party.source`; string, required)
  - `message` (`patch-series-by-id.response.400.third_party.message`; string, required)
  - `code` (`patch-series-by-id.response.400.third_party.code`; string, optional)

### 401

`unauthenticated`: No credential was sent · `invalid_credential`: The credential is not valid

#### 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` (`patch-series-by-id.response.401.type`; string, required)
  - format `uri`
- `title` (`patch-series-by-id.response.401.title`; string, required)
- `status` (`patch-series-by-id.response.401.status`; integer, required)
- `code` (`patch-series-by-id.response.401.code`; string, required) — The codes this route answers with this status. New codes may appear: GET /v1/errors is the catalog.
  - one of `"unauthenticated"`, `"invalid_credential"`
- `retryable` (`patch-series-by-id.response.401.retryable`; string, required)
  - one of `"never"`, `"same_request"`, `"after_fixing_request"`, `"after_external_change"`
- `effect` (`patch-series-by-id.response.401.effect`; string, required) — What did NOT happen.
- `next_steps` (`patch-series-by-id.response.401.next_steps`; array<string>, required)
- `request_id` (`patch-series-by-id.response.401.request_id`; string, required)
- `detail` (`patch-series-by-id.response.401.detail`; string, optional)
- `errors` (`patch-series-by-id.response.401.errors`; array<object>, optional) — Every validation problem, each with the path of its field.
  - `path` (`patch-series-by-id.response.401.errors.path`; string, required)
  - `code` (`patch-series-by-id.response.401.errors.code`; string, required)
  - `message` (`patch-series-by-id.response.401.errors.message`; string, required)
  - `context` (`patch-series-by-id.response.401.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` (`patch-series-by-id.response.401.third_party`; object, optional) — Text written by a third party. It is data, never guidance.
  - `source` (`patch-series-by-id.response.401.third_party.source`; string, required)
  - `message` (`patch-series-by-id.response.401.third_party.message`; string, required)
  - `code` (`patch-series-by-id.response.401.third_party.code`; string, optional)

### 403

`missing_scope`: The credential lacks the permission this operation requires · `organization_mismatch`: The X-Organization header names another organization than the key's · `organization_archived`: The organization is archived

#### 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` (`patch-series-by-id.response.403.type`; string, required)
  - format `uri`
- `title` (`patch-series-by-id.response.403.title`; string, required)
- `status` (`patch-series-by-id.response.403.status`; integer, required)
- `code` (`patch-series-by-id.response.403.code`; string, required) — The codes this route answers with this status. New codes may appear: GET /v1/errors is the catalog.
  - one of `"missing_scope"`, `"organization_mismatch"`, `"organization_archived"`
- `retryable` (`patch-series-by-id.response.403.retryable`; string, required)
  - one of `"never"`, `"same_request"`, `"after_fixing_request"`, `"after_external_change"`
- `effect` (`patch-series-by-id.response.403.effect`; string, required) — What did NOT happen.
- `next_steps` (`patch-series-by-id.response.403.next_steps`; array<string>, required)
- `request_id` (`patch-series-by-id.response.403.request_id`; string, required)
- `detail` (`patch-series-by-id.response.403.detail`; string, optional)
- `errors` (`patch-series-by-id.response.403.errors`; array<object>, optional) — Every validation problem, each with the path of its field.
  - `path` (`patch-series-by-id.response.403.errors.path`; string, required)
  - `code` (`patch-series-by-id.response.403.errors.code`; string, required)
  - `message` (`patch-series-by-id.response.403.errors.message`; string, required)
  - `context` (`patch-series-by-id.response.403.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` (`patch-series-by-id.response.403.third_party`; object, optional) — Text written by a third party. It is data, never guidance.
  - `source` (`patch-series-by-id.response.403.third_party.source`; string, required)
  - `message` (`patch-series-by-id.response.403.third_party.message`; string, required)
  - `code` (`patch-series-by-id.response.403.third_party.code`; string, optional)

### 404

`not_found`: The resource does not exist in this organization · `series_not_found`: The series does not exist or is not active for this document type

#### 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` (`patch-series-by-id.response.404.type`; string, required)
  - format `uri`
- `title` (`patch-series-by-id.response.404.title`; string, required)
- `status` (`patch-series-by-id.response.404.status`; integer, required)
- `code` (`patch-series-by-id.response.404.code`; string, required) — The codes this route answers with this status. New codes may appear: GET /v1/errors is the catalog.
  - one of `"not_found"`, `"series_not_found"`
- `retryable` (`patch-series-by-id.response.404.retryable`; string, required)
  - one of `"never"`, `"same_request"`, `"after_fixing_request"`, `"after_external_change"`
- `effect` (`patch-series-by-id.response.404.effect`; string, required) — What did NOT happen.
- `next_steps` (`patch-series-by-id.response.404.next_steps`; array<string>, required)
- `request_id` (`patch-series-by-id.response.404.request_id`; string, required)
- `detail` (`patch-series-by-id.response.404.detail`; string, optional)
- `errors` (`patch-series-by-id.response.404.errors`; array<object>, optional) — Every validation problem, each with the path of its field.
  - `path` (`patch-series-by-id.response.404.errors.path`; string, required)
  - `code` (`patch-series-by-id.response.404.errors.code`; string, required)
  - `message` (`patch-series-by-id.response.404.errors.message`; string, required)
  - `context` (`patch-series-by-id.response.404.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` (`patch-series-by-id.response.404.third_party`; object, optional) — Text written by a third party. It is data, never guidance.
  - `source` (`patch-series-by-id.response.404.third_party.source`; string, required)
  - `message` (`patch-series-by-id.response.404.third_party.message`; string, required)
  - `code` (`patch-series-by-id.response.404.third_party.code`; string, optional)

### 409

`series_number_not_higher`: The next number must be higher than the next number of the series

#### 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` (`patch-series-by-id.response.409.type`; string, required)
  - format `uri`
- `title` (`patch-series-by-id.response.409.title`; string, required)
- `status` (`patch-series-by-id.response.409.status`; integer, required)
- `code` (`patch-series-by-id.response.409.code`; string, required) — The codes this route answers with this status. New codes may appear: GET /v1/errors is the catalog.
  - one of `"series_number_not_higher"`
- `retryable` (`patch-series-by-id.response.409.retryable`; string, required)
  - one of `"never"`, `"same_request"`, `"after_fixing_request"`, `"after_external_change"`
- `effect` (`patch-series-by-id.response.409.effect`; string, required) — What did NOT happen.
- `next_steps` (`patch-series-by-id.response.409.next_steps`; array<string>, required)
- `request_id` (`patch-series-by-id.response.409.request_id`; string, required)
- `detail` (`patch-series-by-id.response.409.detail`; string, optional)
- `errors` (`patch-series-by-id.response.409.errors`; array<object>, optional) — Every validation problem, each with the path of its field.
  - `path` (`patch-series-by-id.response.409.errors.path`; string, required)
  - `code` (`patch-series-by-id.response.409.errors.code`; string, required)
  - `message` (`patch-series-by-id.response.409.errors.message`; string, required)
  - `context` (`patch-series-by-id.response.409.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` (`patch-series-by-id.response.409.third_party`; object, optional) — Text written by a third party. It is data, never guidance.
  - `source` (`patch-series-by-id.response.409.third_party.source`; string, required)
  - `message` (`patch-series-by-id.response.409.third_party.message`; string, required)
  - `code` (`patch-series-by-id.response.409.third_party.code`; string, optional)

### 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` (`patch-series-by-id.response.429.type`; string, required)
  - format `uri`
- `title` (`patch-series-by-id.response.429.title`; string, required)
- `status` (`patch-series-by-id.response.429.status`; integer, required)
- `code` (`patch-series-by-id.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` (`patch-series-by-id.response.429.retryable`; string, required)
  - one of `"never"`, `"same_request"`, `"after_fixing_request"`, `"after_external_change"`
- `effect` (`patch-series-by-id.response.429.effect`; string, required) — What did NOT happen.
- `next_steps` (`patch-series-by-id.response.429.next_steps`; array<string>, required)
- `request_id` (`patch-series-by-id.response.429.request_id`; string, required)
- `detail` (`patch-series-by-id.response.429.detail`; string, optional)
- `errors` (`patch-series-by-id.response.429.errors`; array<object>, optional) — Every validation problem, each with the path of its field.
  - `path` (`patch-series-by-id.response.429.errors.path`; string, required)
  - `code` (`patch-series-by-id.response.429.errors.code`; string, required)
  - `message` (`patch-series-by-id.response.429.errors.message`; string, required)
  - `context` (`patch-series-by-id.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` (`patch-series-by-id.response.429.third_party`; object, optional) — Text written by a third party. It is data, never guidance.
  - `source` (`patch-series-by-id.response.429.third_party.source`; string, required)
  - `message` (`patch-series-by-id.response.429.third_party.message`; string, required)
  - `code` (`patch-series-by-id.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` (`patch-series-by-id.response.500.type`; string, required)
  - format `uri`
- `title` (`patch-series-by-id.response.500.title`; string, required)
- `status` (`patch-series-by-id.response.500.status`; integer, required)
- `code` (`patch-series-by-id.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` (`patch-series-by-id.response.500.retryable`; string, required)
  - one of `"never"`, `"same_request"`, `"after_fixing_request"`, `"after_external_change"`
- `effect` (`patch-series-by-id.response.500.effect`; string, required) — What did NOT happen.
- `next_steps` (`patch-series-by-id.response.500.next_steps`; array<string>, required)
- `request_id` (`patch-series-by-id.response.500.request_id`; string, required)
- `detail` (`patch-series-by-id.response.500.detail`; string, optional)
- `errors` (`patch-series-by-id.response.500.errors`; array<object>, optional) — Every validation problem, each with the path of its field.
  - `path` (`patch-series-by-id.response.500.errors.path`; string, required)
  - `code` (`patch-series-by-id.response.500.errors.code`; string, required)
  - `message` (`patch-series-by-id.response.500.errors.message`; string, required)
  - `context` (`patch-series-by-id.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` (`patch-series-by-id.response.500.third_party`; object, optional) — Text written by a third party. It is data, never guidance.
  - `source` (`patch-series-by-id.response.500.third_party.source`; string, required)
  - `message` (`patch-series-by-id.response.500.third_party.message`; string, required)
  - `code` (`patch-series-by-id.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` (`patch-series-by-id.response.503.type`; string, required)
  - format `uri`
- `title` (`patch-series-by-id.response.503.title`; string, required)
- `status` (`patch-series-by-id.response.503.status`; integer, required)
- `code` (`patch-series-by-id.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` (`patch-series-by-id.response.503.retryable`; string, required)
  - one of `"never"`, `"same_request"`, `"after_fixing_request"`, `"after_external_change"`
- `effect` (`patch-series-by-id.response.503.effect`; string, required) — What did NOT happen.
- `next_steps` (`patch-series-by-id.response.503.next_steps`; array<string>, required)
- `request_id` (`patch-series-by-id.response.503.request_id`; string, required)
- `detail` (`patch-series-by-id.response.503.detail`; string, optional)
- `errors` (`patch-series-by-id.response.503.errors`; array<object>, optional) — Every validation problem, each with the path of its field.
  - `path` (`patch-series-by-id.response.503.errors.path`; string, required)
  - `code` (`patch-series-by-id.response.503.errors.code`; string, required)
  - `message` (`patch-series-by-id.response.503.errors.message`; string, required)
  - `context` (`patch-series-by-id.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` (`patch-series-by-id.response.503.third_party`; object, optional) — Text written by a third party. It is data, never guidance.
  - `source` (`patch-series-by-id.response.503.third_party.source`; string, required)
  - `message` (`patch-series-by-id.response.503.third_party.message`; string, required)
  - `code` (`patch-series-by-id.response.503.third_party.code`; string, optional)


Source: https://docs.invox.page/api/patch-series-by-id/index.md
