Skip to main content
Business
Заявка

Clozo для разработчиков

HTTP API с опубликованной схемой

Выставляйте, доставляйте и сверяйте счета из своей системы. Схема опубликована и доступна для просмотра; ключами, вебхуками и учётом использования вы управляете сами в рабочем пространстве.

Открыть справочник API

Справочник генерируется из работающего сервиса, поэтому не может описывать прежнюю версию.

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

curl https://api.useclozo.com/b2b/v1/documents \
  -X POST \
  -H "Authorization: Bearer clz_live_<keyid>_<secret>" \
  -H "Idempotency-Key: order-4471-v1" \
  -H "Content-Type: application/json" \
  -d '{
    "issuer_id": "3f6c1b8e-2d4a-4e7b-9a15-6c0d2e8f7a41",
    "customer": {
      "name": "Kestrel Logistics GmbH",
      "country": "DE",
      "vat_number": "DE123456789"
    },
    "currency": "EUR",
    "line_items": [
      {
        "description": "Consulting, October",
        "quantity": "1",
        "unit_amount": 395000,
        "tax_rate": 0,
        "tax_category": "AE"
      }
    ]
  }'
HTTP/1.1 201 Created
{
  "object": "document",
  "id": "doc_5Hq2m8Zr4Kd9",
  "issuer_id": "3f6c1b8e-2d4a-4e7b-9a15-6c0d2e8f7a41",
  "issuer_country": "NL",
  "currency": "EUR",
  "subtotal": 395000,
  "tax_total": 0,
  "total": 395000,
  "reverse_charge": true,
  "status_bucket": "created",
  "status_detail": "draft",
  "invoice_number": ""
}
// ...

Создайте API-ключ в рабочем пространстве и передавайте его как Bearer-токен. Запросы, которые создают или выставляют документы либо регистрируют денежные операции, принимают заголовок Idempotency-Key, поэтому повтор никогда не создаст дубликат. issuer_id — это UUID одного из ваших юрлиц.

Одно правило, которое стоит прочитать до начала

Организация определяется по учётным данным, а не по параметру запроса. Ключ, выпущенный для одной организации, не может обратиться к другой — идентификатор организации не передаётся, и расширить область доступа, изменив запрос, нельзя. Лимиты частоты запросов сообщаются в каждом ответе через заголовки X-RateLimit — и при успехе, и при ответе 429, — поэтому клиент может сам регулировать темп, а не действовать наугад.

Что покрывает API

Всё перечисленное доступно уже сегодня, если не отмечено как «Ранний доступ».

Опубликованная схема и браузер для неё

Схема OpenAPI и Swagger UI — их отдаёт сам API. Генерируйте клиент из схемы, а не переписывайте эндпоинты вручную.

API-ключи с областями доступа и перевыпуском — без обращения к нам

Создавайте, перевыпускайте и отзывайте ключи в рабочем пространстве. При перевыпуске новый ключ выдаётся до того, как старый перестанет работать, поэтому выкладку не нужно делать одномоментно.

Подписанные вебхуки с журналом доставки и повторной отправкой

Регистрируйте эндпоинты, отправляйте тестовое событие, читайте журнал доставки и повторно отправляйте отдельное событие или всю очередь недоставленных (DLQ). Пропущенную доставку можно восстановить без обращения к нам.

Использование, которое вы видите сами

Сколько потребила организация, включая письма, — это эндпоинт, а не вопрос в поддержку.

Экспорт с фильтрами

Выгрузки в CSV и XLSX тех же данных, что доступны списком через API, — для случаев, когда таблица всё ещё лучший ответ.

Доставка электронных счетов-фактур через PeppolРанний доступ. Ранний доступ: отправку и получение через Peppol, KSeF и SdI мы подключаем вместе с клиентами раннего доступа.

Доставка документа участнику Peppol получателя; статус доставки можно прочитать через тот же API. Где доступен электронный документооборот, смотрите на странице стран.

Что умеет рабочее пространствоЭДО по странам