Список методів
| currency/update_rate | Встановлення курсу валюти |
| currency/list | Отримання довідника валют (з поточним курсом) |
| currency/add | Створення валюти в довіднику |
| currency/update | Оновлення валюти в довіднику |
| currency/markasdelete | Видалення або архівування валюти |
| currency/restore | Відновлення валюти з архіву |
Методи нижче на цій сторінці розділені на дві незалежні групи: currency/update_rate працює з курсами (qfin.CurrencyRates) і описаний першим, а currency/list, currency/add, currency/update, currency/markasdelete, currency/restore працюють з довідником самих валют (qfin.Currencies) і описані нижче.
Встановлення курсу валюти
Метод: /api/v2/currency/update_rate
Метод додає або оновлює курс валюти на певну дату.
Параметри запиту:
| array Тип: масив (Обов’язковий) | Поля: |
| currency_code - цифровий код валюти. Обов’язкове поле | |
| rate_date - дата, на яку встановлюємо курс. Обов’язкове поле | |
| rate_value - Значення курсу |
Результат запиту:
Метод повертає масив:
| success | true або false |
Приклад:
Запит:
{
""array"": [
{
""currency_code"": ""840"",
""rate_date"": ""2024-09-01"",
""rate_value"": ""42,3578"",
},
]
}Результат:
{
""success"": true,
}Довідник валют
Отримання довідника валют
Метод: /api/v2/currency/list
Повертає весь довідник валют разом з останнім відомим курсом на поточну дату. Метод не має пагінації - повертає всі валюти, які відповідають фільтру.
Параметри запиту
| Поле | Опис |
|---|---|
filter | Об’єкт з фільтрами. Необов’язковий. |
filter.Archive | Ознака архівності. Якщо не передати, за замовчуванням повертаються тільки активні валюти (false). |
Поля відповіді
| Поле | Опис |
|---|---|
Id | Ідентифікатор валюти (числовий код, наприклад 840). |
Name | Назва валюти. |
Code | Буквений код валюти. |
Memo | Коментар. |
IsBase | Ознака базової валюти обліку. |
IsDefault | Ознака валюти за замовчуванням. |
Void | Ознака архівності. |
Rate | Останній відомий курс на поточну дату. |
RateDate | Дата останнього відомого курсу. |
Створення та оновлення валют у довіднику
Назва методу створення: /api/v2/currency/add
Назва методу оновлення: /api/v2/currency/update
Методи додають або оновлюють валюти пакетами до 100 елементів. На відміну від більшості інших довідників, Id валюти не генерується автоматично - це числовий код валюти (наприклад, 840 для USD), і його треба передати самостійно як для /api/v2/currency/add, так і для /api/v2/currency/update. Якщо Id не передати, метод поверне помилку Execution terminated. "Id" is required.
Під час створення нової валюти автоматично додається початковий курс (1 на 2000-01-01), який пізніше можна змінити методом /api/v2/currency/update_rate.
Параметри запиту
| Поле | Опис |
|---|---|
array | Масив валют. Обов’язковий. |
array[].Id | Числовий код валюти. Обов’язковий і для add, і для update. |
array[].Name | Назва валюти. Обов’язкова. |
array[].Code | Буквений код валюти. |
array[].Memo | Коментар. |
array[].IsRateUpdate | Ознака автоматичного оновлення курсу. |
Формат відповіді
| Поле | Опис |
|---|---|
success | true або false. |
data | Масив ідентифікаторів створених або оновлених валют. |
error | Текст помилки, якщо success = false. |
Видалення, архівування та відновлення валют
Валюти входять до довідників з уніфікованим контрактом видалення й відновлення (/api/v2/currency/markasdelete і /api/v2/currency/restore). Повний опис формату запиту, відповіді та кодів відмов - у розділі Видалення, архівування та відновлення довідників.