Добавление, Редактирование и Удаление платежей в Finmap через API

ㅤВремя чтения материала — 8 мин.
ㅤFinmap
ㅤ

Добавление платежей через API ➕

ㅤ
Через API есть возможность добавить следующие платежи:

Расходы
Доходы
Переводы

ㅤ
ㅤ
Для того, чтобы добавить платеж через API необходимо:

ㅤ

1. Перейти в API документацию https://api.finmap.online/

2. Авторизоваться с помощью ключа API

3. Выбрать тип платежа, который нужно добавить, к этим типам входят:

operations/income
operations/expense
operations/transfer

ㅤ

4. Нажимаем на параметр POST

5. Указываем необходимые данные к платежу

6. Нажимаем выполнить запрос

ㅤ
ㅤ✅ В результате в сервисе Finmap будет добавлен новый платеж
ㅤ

Параметры, которые могут содержаться в операции:
ㅤ

«date» — Дата проведения платежа
«amount» — Сумма платежа
«comment» — Комментарий
«amountInCompanyCurrency» — Сумма в валюте компании (этот параметр полезен, если вы проводите операцию на счет, валюта которого отличается от валюты компании)
«exchangeRate» — Валютный курс
«transactionSum — Сумма платежа
«transactionCurrency» — Валюта проведения платежа
«transactionCurrencyRate» — Валютный курс
«dateOfPayment» — Дата начисления платежа
«startDate» — Начало периода начисления платежа
«endDate» — Конец периода начисления платежа
«accountToId» — ID счета
«categoryId» — ID категории
«counterpartyId» — ID контрагента
«projectId»— ID проэкта
«tagIds» — ID тега (можно добавлять сразу несколько ID тегов)
«externalId»: — ID операции (собственноручно указываете id, чтобы потом могли по этому id редактировать, или удалить платеж)

ㅤㅤ
ㅤ
ㅤ❗ Для добавления платежа не обязательно использовать все параметры.

ㅤ❗❗ Важно: Наш сервис работает в часовом поясе UTC 0, если вам нужно указать другой часовой пояс, тогда на помощь придет параметр offset.
Обратите внимание, что параметр date необходимо указывать в UNIX (миллисекунды) формате.
Пример «date»: 1717158515050
ㅤ

ㅤ
ㅤ

Редактирование платежей через API ⚙️

ㅤ
Через API есть возможность редактировать следующие платежи:

Расходы
Доходы
Переводы

ㅤ
Для того, чтобы редактировать платеж через API необходимо:
ㅤㅤ

operations/income
operations/expense
operations/transfer

ㅤ

4. Нажимаем на параметр PATCH

5. Выберите по какому типу будете редактировать платеж по operationID или externalID

ㅤ

6. Укажите необходимый ID

7. Укажите изменения которые хотите сделать

8. Нажимаем выполнить запрос

ㅤ

✅ В результате данные в операции будут изменены. Вы можете менять не все параметры, а только те, что вам нужно, например можно изменить только дату (чаще всего изменение даты используют, когда нужно подтвердить будущий платеж)
ㅤ
ㅤ