Запланировать синхронизацию

/hs/syncApi/scheduleSynchronization

POST

https://business.tbank.ru/openapi/hs/syncApi/scheduleSynchronization

Запускает фоновую синхронизацию (первоначальную или регулярную) с КНАП. Вызывается КНАП при необходимости синхронизировать данные.

Авторизация

Security

Bearer API Token

RPS

Ограничение — 20 запросов в секунду

Scopes

Интеграция с КНАП → Методы для работы с документами в Бухгалтерии

Запрос

Header parameters

X-Request-Id

String<uuid>

Уникальный идентификатор для трассировки запроса. Не влияет на логику исполнения запроса.

Request body schema application/json

Required

OrganizationGuid

String<uuid>

Идентификатор организации в нашей системе.

Required

OrganizationId

Integer<int64>

Идентификатор организации в КНАП.

Required

SyncType

String

Requirements: [Initial, Regular]

Тип синхронизации — первоначальная или регулярная.

Ответ

200

Синхронизация запланирована.

400

Некорректный запрос

401

Ошибка аутентификации

403

Ошибка авторизации

422

Ошибка при обработке данных

429

Слишком много запросов

500

Ошибка сервера

Это полезный материал?

Обратиться в поддержку

Loading...