Быстрый старт

Пять шагов от нуля до первого счёта в JSON. Вам нужна учётная запись Ocost с ролью владельца или бухгалтера.

1. Зарегистрироваться

Зарегистрируйтесь на https://app.ocost.io/auth/sign-up или войдите. Файлы, которые вы отправляете через API, появляются в разделе Файлы, как любая загрузка.

2. Создать ключ

  1. Откройте Настройки › Разработчикам и выберите Новый ключ.
  2. Назовите ключ по тому, кто им пользуется, например «Odoo продакшн».
  3. Оставьте отмеченные права и выберите Создать ключ.
  4. Выберите Скопировать ключ. Ключ начинается с ocost_sk_, и Ocost показывает его только один раз.

Сохраните его в оболочке для следующих шагов:

Shell
export OCOST_KEY="ocost_sk_…"

3. Отправить PDF

Отправьте файл как multipart/form-data в поле file. external_ref — ваш собственный идентификатор, Ocost возвращает его вам.

curl -sS https://api.ocost.io/public/v1/files \
  -H "Authorization: Bearer $OCOST_KEY" \
  -F "file=@invoice.pdf" \
  -F "external_ref=account.move,42"

Ocost отвечает 202 Accepted и начинает чтение:

JSON
{
  "id": "01a1b08c-6e3a-7562-8f4a-7924722667b1",
  "name": "invoice.pdf",
  "status": "received",
  "reason": null,
  "external_ref": "account.move,42",
  "documents": [],
  "sha256": "0edd5593…"
}

4. Дождаться чтения

Запрашивайте файл каждые несколько секунд, пока его status равен received или reading. Большинство PDF читаются меньше чем за минуту.

curl -sS https://api.ocost.io/public/v1/files/$FILE_ID \
  -H "Authorization: Bearer $OCOST_KEY"

Прочитанный файл перечисляет свои документы:

JSON
{
  "id": "01a1b08c-6e3a-7562-8f4a-7924722667b1",
  "status": "read",
  "documents": [
    {
      "id": "01a1b08c-7aa1-7b52-9d4e-2f1f1c0c4f11",
      "kind": "invoice",
      "number": "RE-2026-1187",
      "pages": [1]
    }
  ]
}

Если файл закончил со статусом not_read или failed, причина стоит в reason. Все причины перечислены на странице Статусы и причины.

5. Прочитать документ

Запросите первый документ файла.

curl -sS https://api.ocost.io/public/v1/files/$FILE_ID/document \
  -H "Authorization: Bearer $OCOST_KEY"

Ответ — счёт в формате ocost.document.v1, здесь в сокращении:

JSON
{
  "schema": "ocost.document.v1",
  "kind": "invoice",
  "number": "RE-2026-1187",
  "issue_date": "2026-11-03",
  "due_date": "2026-12-03",
  "currency": "EUR",
  "seller": { "name": "Musterbüro Lieferant GmbH", "vat_id": "DE123456789" },
  "totals": { "net": 1068, "tax": 202.92, "gross": 1270.92 }
}

Что дальше

См. также