Додавання, Редагування та Видалення платежів у Finmap через API


ㅤЧас читання матеріалу – 8 хв
Finmap


Додавання платежів через API


Через API є можливість додати наступні платежі:

  • Витрати
  • Доходи
  • Перекази



Для того, щоб додати платіж через API необхідно:

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

2. Авторизуватися за допомогою ключа API

3. Обрати тип платежу, який потрібно додати, до цих типів входять:

  1. operations/income
  2. operations/expense
  3. 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 необхідно:
ㅤㅤ

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

2. Авторизуватися за допомогою ключа API

3. Обрати тип платежу, який потрібно додати, до цих типів входять:

  1. operations/income
  2. operations/expense
  3. operations/transfer

4. Натискаємо на параметр PATCH

5. Оберіть по якому типу будете редагувати платіж по operationID або externalID

6. Вкажіть необхідне ID

7. Вкажіть зміни які хочете зробити

8. Виконайте запит

В результаті дані в операції будуть змінені. Ви можете змінювати не всі параметри, а лише ті, що вам потрібно, наприклад можна змінити лише дату (найчастіше зміну дати використовують, коли потрібно підтвердити майбутній платіж)

Видалення платежів через API 🗑️


Для того, щоб видалити платіж через API необхідно:

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

2. Авторизуватися за допомогою ключа API

3. Обрати тип платежу, який потрібно додати, до цих типів входять:

  1. operations/income
  2. operations/expense
  3. operations/transfer

4. Натискаємо на параметр DELETE

5. Оберіть по якому типу будете редагувати платіж по operationID або externalID

6. Вкажіть необхідне ID

7. Виконайте запит


ㅤㅤ

Як отримати operation id 👀


Віднайти operation id можна наступним чином:

1. Використовуючи Webhook


2. Використовуючи інструменти розробника

ㅤ2.1 Щоб це зробити вам потрібно в браузері відкрити інструменти розробника

ㅤ2.2 Перейти у вкладку Network


ㅤ2.3 Обрати log (в цьому параметрі знаходяться дані про всі платежі, які у вас є на сторінці Finmap)

ㅤ2.4 Натиснути на вкладку Preview


ㅤ2.5 Відкриваємо всі платежі в цій вкладці


ㅤ2.6 Обираємо потрібний платіж

ㅤ2.7 Та знаходимо його id (зазвичай знаходиться в самому кінці інформації про платіж)