Search

finances/setSynced

Метод: POST

Подтверждение успешной синхронизации финансовых операций.

Метод принимает список финансовых операций и отмечает их как синхронизированные.

Для каждой финансовой операции необходимо передать её идентификатор и версию, полученную ранее через методы:

  • finances/get;
  • finances/getAll;
  • finances/getModified.

Параметры

Параметры передаются в теле запроса в формате JSON.

Тело запроса представляет собой массив объектов.

ТипНазваниеЗначение
string, обязательное полеidИдентификатор финансовой операции
integer, обязательное полеversionВерсия данных финансовой операции

Как работает метод

Финансовая операция будет отмечена как синхронизированная только в том случае, если одновременно совпадают:

  • идентификатор финансовой операции;
  • версия финансовой операции.

Если после получения финансовой операции её данные изменились, версия станет другой. В этом случае запрос со старой версией не отметит новую версию операции как синхронизированную.

Это защищает от ситуации, когда внешняя система подтверждает обработку устаревших данных.

Результат

После успешного выполнения метод возвращает положительный результат без дополнительных данных.

Коды ошибок

В ходе выполнения запроса могут возникнуть общие ошибки. Их описание находится на отдельной странице.

Пример запроса

https://api.laim.bz/1.0/finances/setSynced

Тело запроса

[
  {
    "id": "8f412f75-d041-48b8-9d48-6149a73325eb",
    "version": 1595823441
  },
  {
    "id": "d4f9e0bb-3126-4a94-9889-4db89be154c5",
    "version": 1595823500
  }
]

Пример ответа

{
«success»: true
}

Обратите внимание

Метод позволяет передать несколько финансовых операций одним запросом.

Для каждой финансовой операции необходимо использовать актуальное значение поля version.

Если версия финансовой операции не совпадает с текущей версией в ЛЭЙМ, статус синхронизации этой операции не изменится.

Метод не сообщает отдельно, какие финансовые операции были отмечены как синхронизированные, а какие были пропущены из-за несовпадения идентификатора или версии.

После вызова метода можно повторно запросить finances/getModified, чтобы проверить, остались ли финансовые операции, ожидающие синхронизации.

Если финансовая операция с переданным id не найдена или её версия не совпала, отдельная ошибка не возвращается.