Содержание
Добавление, Редактирование и Удаление платежей в Finmap через API
Через API есть возможность добавить следующие платежи:
Добавление платежей через 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 необходимо:
1. Перейти в API документацию https://api.finmap.online/
2. Авторизоваться с помощью ключа API
3. Выбрать тип платежа, который нужно добавить, к этим типам входят:
- operations/income
- operations/expense
- operations/transfer
4. Нажимаем на параметр PATCH
5. Выберите по какому типу будете редактировать платеж по operationID или externalID
6. Укажите необходимый ID
7. Укажите изменения, которые хотите сделать
8. Нажимаем выполнить запрос
✅ В результате данные в операции будут изменены. Вы можете менять не все параметры, а только те, что вам нужно, например можно изменить только дату (чаще всего изменение даты используют, когда нужно подтвердить плановый платеж)
Удаление платежей через API 🗑️
Для того, чтобы удалить платеж через API необходимо:
1. Перейти в API документацию https://api.finmap.online/
2. Авторизоваться с помощью ключа API
3. Выбрать тип платежа, который нужно добавить, в эти типы входят:
- operations/income
- operations/expense
- 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 (обычно находится в самом конце информации о платеже)
Если остались вопросы
Если у вас возникнут вопросы о документации API или есть пример технического запроса, который вы хотите решить, пожалуйста, напишите нам на почту support-team@finmap.online.
В письме нужно описать следующее: "Запрос …, не работает (появляется такой ответ) когда вы отправляете параметры …". Наш технический специалист рассмотрит ваш запрос (обработка запросов происходит в пределах 24 часов) и предоставит квалифицированный ответ.