Швидкий старт

П’ять кроків від нуля до першого рахунку в 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 }
}

Далі

Див. також