Общее

Токен API

Для доступа к API существует обязательный параметр api_token — ключ доступа к API. Узнать его можно в разделе "Профиль" на странице настроек Adesk.

Пример ответа от API при отсутствии ключа доступа:


{
    "message": "Auth required",
    "code": 401,
    "success": false
}

Все дальнейшие описания методов подразумевают наличие ключа доступа к API и не учитывают ошибки, связанные с его отсутствием.

Необходимость продления доступа

Если время пробного периода или платной подписки истекло, то все методы публичного API будут заблокированы.

Пример ответа от API при отсутствии подписки:


{
    "message": "Payment required",
    "code": 21,
    "success": false
}

Все дальнейшие описания методов подразумевают наличие активной лицензии и не учитывают ошибки, связанные с ее отсутствием.

Статьи операций

Пример объекта статьи операции, который является основной структурой данных для методов по статьям операций

{
    "kind": 1,                  // вид деятельности: 1 — операционная, 2 — инвестиционная, 3 — финансовая
    "isOwnerTransfer": false,   // true, если это статья для ввода/вывода денег - ввод/вывод не учитывается в отчетах и графиках как выручка/расходы.
    "name": "Налоги и пошлины", // название
    "isSystem": true,           // флаг системной статьи, системные нельзя удалять или редактировать, данный флаг не нужно передавать в POST запросах
    "type": 2,                  // тип 1 — доходы, 2 — расходы
    "id": 50                    // уникальный идентификатор
}

Создание, изменение, удаление статьи

post
https://api.adesk.ru/v1/transactions/category?api_token=your_api_token
Позволяет управлять данными о статье при передаче соответствующих параметров.
Параметры (объект Form Data):
Параметр Тип Возможные значения Описание Обязательный
name String Название статьи Да
id Number Идентификатор существующий статьи, если он передан в запросе, сервер попытается найти существующую статью и обновить её, если нет - будет создана новая статья. Нет
is_owner_transfer Boolean true, false Является ли статья вводом/выводом денег. По умолчанию false. Нет
kind Number 1, 2, 3 Вид деятельности (см. описание объекта статьи) Да
type Number 1, 2 Тип статьи (см. описание объекта статьи) Да
is_deleted Boolean true, false Параметр, отвечающий за удаление статьи. Если параметр есть в запросе и имеет значение true, статья будет удалена. Нет
Варианты ответов:
В ответ на запрос будет возвращена JSON строка, содержащая следующие данные:
Параметр Тип Описание
success* Boolean

Флаг успеха выполнения запроса

*в зависимости от данного параметра могут присутствовать или отсутствовать некоторые нижеследующие данные

project Object

Объект статьи.

* только при условии успеха запроса (success)

errors Object

Список ошибок, возникших при выполнении запроса, возвращается в случае неудачи запроса (success), пример:


"errors": {
    "name": [
        "Обязательное поле."
    ]
}

Получение списка статей операций

get
https://api.adesk.ru/v1/transactions/categories?api_token=your_api_token
Получение списка статей операций.
Возможные параметры:
Параметры не являются обязательными. При их отсутствии, соответствующая фильтрация не будет осуществляться и вернётся список всех операций.
Параметр Возможные значения/Тип Описание
type
  • income — только поступления
  • outcome — только расходы
  • Тип статьи для фильтрации. Будут возвращены статьи только указанного типа.

    Пример запроса:
    https://api.adesk.ru/v1/transactions/categories?api_token=your_api_token&type=outcome
    Данный запрос вернёт список статей расходов.
    Варианты ответов:
    В ответ на запрос будет возвращена JSON строка, содержащая следующие данные:
    Параметр Тип Описание
    success Boolean

    Флаг успеха выполнения запроса

    categories Array

    Массив объектов статей операций.

    Проекты

    Пример объекта проекта, который является основной структурой данных для методов по проектам
    
    {
        "description": "Приложение для управления станками через интернет", // описание
        "isFinished": false,                                                // флаг завершенности проекта
        "planIncome": "0.00",                                               // планируемый доход по проекту
        "id": 60,                                                           // уникальный идентификатор
        "planOutcome": "0.00",                                              // планируемый расход по проекту
        "name": "Мобильное приложение завода",                              // название
        "created": "19.12.2018",                                            // дата создания
        "profitability": 25,                                                // рентабельность в процентах
        "grossProfit": "15000.00",                                          // валовая прибыль
        "income": "60000.00",                                               // доходы
        "outcome": "45000.00"                                               // расходы
    }
    
    

    Добавление проекта

    post
    https://api.adesk.ru/v1/project?api_token=your_api_token
    Добавляет новый проект с указанными в запросе параметрами.
    Параметры (объект Form Data):
    Параметр Тип Возможные значения Описание Обязательный
    name String Название проекта Да
    description String Краткое описание Нет
    plan_income Number Плановый доход по проекту в валюте аккаунта (по умолчанию 0) Нет
    plan_outcome Number Плановый расход по проекту в валюте аккаунта (по умолчанию 0) Нет
    Варианты ответов:
    В ответ на запрос будет возвращена JSON строка, содержащая следующие данные:
    Параметр Тип Описание
    success* Boolean

    Флаг успеха выполнения запроса

    *в зависимости от данного параметра могут присутствовать или отсутствовать некоторые нижеследующие данные

    project Object

    Объект проекта.

    * только при условии успеха запроса (success)

    errors Object

    Список ошибок, возникших при выполнении запроса, возвращается в случае неудачи запроса (success), пример:

    
    "errors": {
        "name": [
            "Обязательное поле."
        ]
    }
    
    

    Изменение проекта

    post
    https://api.adesk.ru/v1/project/<project_id>?api_token=your_api_token
    Изменяет существующий проект по его идентификатору. Для удаления текущего значения поля проекта, необходимо отправить параметр с пустой строкой.
    Параметры (объект Form Data):
    Параметр Тип Возможные значения Описание Обязательный
    name String Название проекта Нет
    description String Краткое описание Нет
    is_finished Boolean true, false Статус проекта (активный/завершенный). По умолчанию false - считает проект активным. Нет
    plan_income Number Плановый доход по проекту в валюте аккаунта Нет
    plan_outcome Number Плановый расход по проекту в валюте аккаунта Нет
    Варианты ответов:
    В ответ на запрос будет возвращена JSON строка, содержащая следующие данные:
    Параметр Тип Описание
    success* Boolean

    Флаг успеха выполнения запроса

    *в зависимости от данного параметра могут присутствовать или отсутствовать некоторые нижеследующие данные

    errors Object

    Список ошибок, возникших при выполнении запроса, возвращается в случае неудачи запроса (success), пример:

    
    "errors": {
        "name": [
            "Обязательное поле."
        ]
    }
    
    

    Удаление проекта

    post
    https://api.adesk.ru/v1/project/<project_id>/remove?api_token=your_api_token
    Удаление проекта по его идентификатору
    Варианты ответов:
    В ответ на запрос будет возвращена JSON строка, содержащая следующие данные:
    Параметр Тип Описание
    success Boolean

    Флаг успеха выполнения запроса

    Получение списка проектов

    get
    https://api.adesk.ru/v1/projects?api_token=your_api_token
    Получение списка проектов.
    Возможные параметры:
    Параметры не являются обязательными. При их отсутствии, соответствующая фильтрация не будет осуществляться и вернётся список всех операций.
    Параметр Возможные значения/Тип Описание
    active_only
  • true — только незавершенные проекты (по умолчанию)
  • false — все проекты
  • Позволяет осуществить выборку только активных проектов.

    start Number

    Позволяет установить индекс элемента из общей выборки, начиная с которого данные будут возвращены. Отсчет ведётся с 0.

    length Number

    Позволяет ограничить длину выборки. Если установлен стартовый индекс, то расчёт длины происходит начиная с него.

    Варианты ответов:
    В ответ на запрос будет возвращена JSON строка, содержащая следующие данные:
    success Boolean

    Флаг успеха выполнения запроса

    projects Array

    Массив объектов проектов. Может быть пустым, если отсутствуют проекты.

    recordsTotal Number

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

    recordsFiltered Number

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

    Обязательства

    Пример объекта проекта, который является основной структурой данных для методов по обязательствам
    
    {
        "description": "Услуги аренды имущества по договору",               // описание
        "amount": "2400.99",                                                // сумма обязательства
        "id": 60,                                                           // уникальный идентификатор
        "date": "20.03.2019",                                               // дата
        "dateFormatted": "Сегодня",                                         // форматированная дата
        "contractor": {...},                                                // контрагент
        "type": 1,                                                          // тип. 1 — входящее обязательство, 2 — исходящее обязательство
        "currency": "RUR",                                                  // валюта обязательства
        "transaction": {...},                                               // привязанная транзакция
    }
    
    

    Добавление обязательства

    post
    https://api.adesk.ru/v1/commitment?api_token=your_api_token
    Добавляет новое обязательство с указанными в запросе параметрами.
    Параметры (объект Form Data):
    Параметр Тип Возможные значения Описание Обязательный
    amount Number Сумма обязательства Да
    type String in, out Тип обязательства Да
    date String Дата создания обязательства в формате YYYY-MM-DD Да
    contractor Number id контрагента, к которому привязано обязательство Да
    currency String Валюта обязательства Да
    description String Краткое описание Нет
    Варианты ответов:
    В ответ на запрос будет возвращена JSON строка, содержащая следующие данные:
    Параметр Тип Описание
    success* Boolean

    Флаг успеха выполнения запроса

    *в зависимости от данного параметра могут присутствовать или отсутствовать некоторые нижеследующие данные

    commitment Object

    Объект обязательства

    * только при условии успеха запроса (success)

    errors Object

    Список ошибок, возникших при выполнении запроса, возвращается в случае неудачи запроса (success), пример:

    
    "errors": {
        "name": [
            "Обязательное поле."
        ]
    }
    
    

    Изменение обязательства

    post
    https://api.adesk.ru/v1/commitment/<commitment_id>?api_token=your_api_token
    Изменяет существующее обязательство по его идентификатору. Для удаления текущего значения поля обязательства, необходимо отправить параметр с пустой строкой.
    Параметры (объект Form Data):
    Параметр Тип Возможные значения Описание Обязательный
    amount Number Сумма обязательства Нет
    type String in, out Тип обязательства Нет
    date String Дата создания обязательства в формате YYYY-MM-DD Нет
    contractor Number id контрагента, к которому привязано обязательство Нет
    currency String Валюта обязательства Нет
    description String Краткое описание Нет
    Варианты ответов:
    В ответ на запрос будет возвращена JSON строка, содержащая следующие данные:
    Параметр Тип Описание
    success* Boolean

    Флаг успеха выполнения запроса

    *в зависимости от данного параметра могут присутствовать или отсутствовать некоторые нижеследующие данные

    commitment Object

    Измененный объект обязательства

    errors Object

    Список ошибок, возникших при выполнении запроса, возвращается в случае неудачи запроса (success), пример:

    
    "errors": {
        "name": [
            "Обязательное поле."
        ]
    }
    
    

    Удаление обязательства

    post
    https://api.adesk.ru/v1/commitment/<commitment_id>/remove?api_token=your_api_token
    Удаление обязательства по его идентификатору
    Варианты ответов:
    В ответ на запрос будет возвращена JSON строка, содержащая следующие данные:
    Параметр Тип Описание
    success Boolean

    Флаг успеха выполнения запроса

    Получение списка проектов

    get
    https://api.adesk.ru/v1/projects?api_token=your_api_token
    Получение списка проектов.
    Возможные параметры:
    Параметры не являются обязательными. При их отсутствии, соответствующая фильтрация не будет осуществляться и вернётся список всех операций.
    Параметр Возможные значения/Тип Описание
    active_only
  • true — только незавершенные проекты (по умолчанию)
  • false — все проекты
  • Позволяет осуществить выборку только активных проектов.

    start Number

    Позволяет установить индекс элемента из общей выборки, начиная с которого данные будут возвращены. Отсчет ведётся с 0.

    length Number

    Позволяет ограничить длину выборки. Если установлен стартовый индекс, то расчёт длины происходит начиная с него.

    Варианты ответов:
    В ответ на запрос будет возвращена JSON строка, содержащая следующие данные:
    success Boolean

    Флаг успеха выполнения запроса

    projects Array

    Массив объектов проектов. Может быть пустым, если отсутствуют проекты.

    recordsTotal Number

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

    recordsFiltered Number

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

    Банковские счета

    Пример объекта счёта, который является основной структурой данных для методов по счетам
    
    {
        "name": "Основной счет",            // название
        "created": "21.12.2018 08:46",      // реальная дата создания
        "bankName": "ПАО Сбербанк",         // название банка
        "initial_amount_date": "20.12.2018" // дата начисления начального остатка
        "number": "40817810099910004312",   // номер
        "currency": "RUR",                  // валюта счёта
        "amount": "1598360.00",             // текущий остаток
        "id": 50                            // уникальный идентификатор
    }
    
    

    Добавление счёта

    post
    https://api.adesk.ru/v1/bank-account?api_token=your_api_token
    Добавляет новый счёт с указанными в запросе параметрами.
    Параметры (объект Form Data):
    Параметр Тип Возможные значения Описание Обязательный
    name String Название счёта Да
    currency String RUR, EUR, USD, BTC, KZT, UAH, GBP Валюта счёта Да
    number Number Номер счёта Нет
    bank_name String Название банка Нет
    amount Number Сумма начального остатка. Указывается, если на момент начала работы со счётом в системе на нём уже есть какая-то сумма. Нет
    initial_amount_date String Дата в формате YYYY-MM-DD Дата начисления начального остатка. Указывается, если дата, с которой планируется регистрировать операции по счёту меньше текущей, при условии, что необходимо учесть начальный остаток. Нет
    Варианты ответов:
    В ответ на запрос будет возвращена JSON строка, содержащая следующие данные:
    Параметр Тип Описание
    success* Boolean

    Флаг успеха выполнения запроса

    *в зависимости от данного параметра могут присутствовать или отсутствовать некоторые нижеследующие данные

    bankAccount Object

    Объект счёта.

    * только при условии успеха запроса (success)

    errors Object

    Список ошибок, возникших при выполнении запроса, возвращается в случае неудачи запроса (success), пример:

    
    "errors": {
        "currency": [
            "Указана неподдерживаемая валюта. Обновите страницу и попробуйте снова."
        ],
        "amount": [
            "Обязательное поле."
        ],
        "name": [
            "Обязательное поле."
        ]
    }
    
    

    Изменение счёта

    post
    https://api.adesk.ru/v1/bank-account/<bank_account_id>?api_token=your_api_token

    Изменяет существующий счёт по его идентификатору.

    Внимание: Список параметров для редактирования ограничен.

    Параметры (объект Form Data):
    Параметр Тип Описание
    name String Название счёта
    number Number Номер счёта
    bank_name String Название банка
    Варианты ответов:
    В ответ на запрос будет возвращена JSON строка, содержащая следующие данные:
    Параметр Тип Описание
    success Boolean

    Флаг успеха выполнения запроса

    Удаление счёта

    post
    https://api.adesk.ru/v1/bank-account/<bank_account_id>/remove?api_token=your_api_token
    Удаление счёта по его идентификатору
    Варианты ответов:
    В ответ на запрос будет возвращена JSON строка, содержащая следующие данные:
    Параметр Тип Описание
    success Boolean

    Флаг успеха выполнения запроса

    Получение счёта

    get
    https://api.adesk.ru/v1/bank-account/<bank_account_id>?api_token=your_api_token
    Получение информации о счёте по его идентификатору
    Варианты ответов:
    В ответ на запрос будет возвращена JSON строка, содержащая следующие данные:
    Параметр Тип Описание
    success* Boolean

    Флаг успеха выполнения запроса

    *в зависимости от данного параметра могут присутствовать или отсутствовать некоторые нижеследующие данные

    bankAccount Object

    Объект счёта

    message String

    Сообщение об ошибке, в случае отсутствия или некорректности запрашиваемых данных

    Получение списка счетов

    get
    https://api.adesk.ru/v1/bank-accounts?api_token=your_api_token
    Получение списка счетов.
    Возможные параметры:
    Параметры не являются обязательными. При их отсутствии, соответствующая фильтрация не будет осуществляться и вернётся список всех счетов.
    Параметр Возможные значения/Тип Описание
    start Number

    Позволяет установить индекс элемента из общей выборки, начиная с которого данные будут возвращены. Отсчет ведётся с 0.

    length Number

    Позволяет ограничить длину выборки. Если установлен стартовый индекс, то расчёт длины происходит начиная с него.

    Варианты ответов:
    В ответ на запрос будет возвращена JSON строка, содержащая следующие данные:
    Параметр Тип Описание
    success* Boolean

    Флаг успеха выполнения запроса

    *в зависимости от данного параметра могут присутствовать или отсутствовать некоторые нижеследующие данные

    bankAccounts Array

    Массив объектов счетов. Может быть пустым, если отсутствуют счета.

    * только при условии успеха запроса (success)

    recordsTotal Number

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

    recordsFiltered Number

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

    Переводы

    Пример объекта перевода, который является основной структурой данных для методов по переводам
    
    {
        "from": {                               // данные счёта-отправителя
            "currency": "RUR",
            "bankName": "ПАО Сбербанк",
            "id": 1,
            "number": "40702810638050013199"
        },
        "exchangeRate": 0.0148,                 // курс валюты на момент перевода
        "to": {                                 // данные счёта-получателя
            "currency": "USD",
            "bankName": "ПАО ВТБ Банк",
            "id": 2,
            "number": "40702810638050013199"
        },
        "amount": "10000.00",                   // сумма перевода в валюте счёта-отправителя
        "date": "15.02.2018",                   // дата перевода
        "id": 16                                // уникальный идентификатор
    }
    
    

    Добавление перевода

    post
    https://api.adesk.ru/v1/transfer?api_token=your_api_token
    Добавляет новый перевод с указанными в запросе параметрами.
    Параметры (объект Form Data):
    Параметр Тип Описание Обязательный
    exchange_rate Number Коэффициент обмена валюты для пересчёта суммы. Да
    amount Number Сумма списания со счёта-отправителя. Будет умножена на коэффициент и добавлена на счёт-получатель Да
    from_bank_account Number id счёта-отправителя. Да
    to_bank_account Number id счёта-получателя Да
    Варианты ответов:
    В ответ на запрос будет возвращена JSON строка, содержащая следующие данные:
    Параметр Тип Описание
    success* Boolean

    Флаг успеха выполнения запроса

    *в зависимости от данного параметра могут присутствовать или отсутствовать некоторые нижеследующие данные

    message String

    Сообщение о некорректных данных или некоторых ошибках.

    * только при условии неудачи запроса (success)

    errors Object

    Список ошибок, возникших при выполнении запроса, возвращается в случае неудачи запроса (success), пример:

    
    "errors": {
        "amount": [
            "Обязательное поле."
        ],
        "from_bank_account": [
            "Обязательное поле."
        ]
    }
    
    

    Получение списка переводов

    get
    https://api.adesk.ru/v1/transfers?api_token=your_api_token
    Получение списка переводов с возможностью выбора по конкретному периоду.
    Возможные параметры:
    Параметры не являются обязательными. При их отсутствии, соответствующая фильтрация не будет осуществляться и вернётся список всех переводов.
    Параметр Возможные значения/Тип Описание
    range
  • all_time — всё время (по умолчанию)
  • this_month — текущий месяц
  • this_quarter — текущий квартал
  • this_year — текущий год
  • prev_month — предыдущий месяц
  • prev_quarter — предыдущий квартал
  • prev_year — предыдущий год
  • custom — произвольный период*
  • Позволяет выбрать период, за который необходимо сформировать отчёт. Если параметр не задан, отчёт формируется за всё время.

    * при выборе интервала custom параметры range_start и range_end являются обязательными

    range_start YYYY-MM-DD — формат даты для передачи в запросе

    Используется только в сочетании с периодом custom, позволяет задать дату начала желаемого периода.

    Игнорируется во всех других случаях.

    range_end YYYY-MM-DD — формат даты для передачи в запросе

    Используется только в сочетании с периодом custom, позволяет задать дату окончания желаемого периода.

    Игнорируется во всех других случаях.

    start Number

    Позволяет установить индекс элемента из общей выборки, начиная с которого данные будут возвращены. Отсчет ведётся с 0.

    length Number

    Позволяет ограничить длину выборки. Если установлен стартовый индекс, то расчёт длины происходит начиная с него.

    Пример запроса:
    https://api.adesk.ru/v1/transfers?api_token=your_api_token&range=prev_quarter&start=10&length=10
    Данный запрос вернёт список переводов с десятого по двадцатый из тех, что были осуществлены за прошлый квартал.
    Варианты ответов:
    В ответ на запрос будет возвращена JSON строка, содержащая следующие данные:
    Параметр Тип Описание
    success* Boolean

    Флаг успеха выполнения запроса

    *в зависимости от данного параметра могут присутствовать или отсутствовать некоторые нижеследующие данные

    transfers Array

    Массив объектов переводов. Может быть пустым, если ничего не попадает под параметры фильтрации.

    * только при условии успеха запроса (success)

    recordsTotal Number

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

    recordsFiltered Number

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

    Операции

    Пример объекта операции, который является основной структурой данных для методов по операциям
    
    {
        "bankAccount": {                // счёт, по которому осуществлена операция
            "currency": "RUR",
            "bankName": "",
            "id": 43,
            "name": "123",
            "number": "",
            "bankCode": 989145333,
            "amount": 1289.44,
            "initial_amount_date": 01.03.2018,
            "created": 20.10.2018,
            "isBankIntegrationConfigured": false
        },
        "category": {                   // статья
            "kind": 1,
            "isOwnerTransfer": true,
            "name": "Продажи",
            "isSystem": false,
            "type": 1,
            "id": 48
        },
        "contractor": {                 // контрагент
            "id": 15,
            "name": "Сбербанк",
            "contactPerson": "Харитонов Василий Акимович",
            "phoneNumber": "+7999999999",
            "email": "sber@mail.com"
        },
        "amount": "67",                 // сумма
        "description": "",              // описание
        "relatedDate": "20.12.2018",    // дата начисления по операции
        "dateFormatted": "Вчера",       // отформатированная дата создания
        "isPlanned": false,             // флаг запланированной операции 
        "date": "20.12.2018",           // дата создания
        "type": 1,                      // тип. 1 — поступление, 2 — расход
        "id": 5590,                     // уникальный идентификатор
        "bankAccountAmount": "-233.00", // состояние счёта после совершения операции
        "isTransfer": false,            // флаг операции-перевода
        "isPeriodic": true,             // флаг периодичности операции
        "period": "month",              // частота повторения операции
        "periodicChain": 14553,         // "корневая" операция в цепочке повторяющихся операций
        "hasCommitment": false          // флаг наличия обязательств с этой транзакцией
    }
    
    

    Добавление операции

    post
    https://api.adesk.ru/v1/transaction?api_token=your_api_token
    Добавляет новую операцию с указанными в запросе параметрами.
    Параметры (объект Form Data):
    Параметр Тип Возможные значения Описание Обязательный
    date String Дата создания операции в формате YYYY-MM-DD Да
    type String income, outcome Тип операции: Приход или Расход Да
    category Number id статьи операции. Тип статьи должен соответствовать типу создаваемой операции. Нет
    project Number id проекта, к которому привязана операция. Нет
    contractor Number id контрагента, к которому привязана операция. Нет
    amount Number Сумма операции Да
    bank_account Number id счёта, по которому проводилась операция. Да
    description String Описание операции. Произвольная строка. Ограничение длины — 510 символов. Нет
    related_date String Дата в формате YYYY-MM-DD. Указывается только если дата начисления по операции отличается от даты создания. Нет
    is_periodic Boolean true, false Указывает нужно ли повторять данную операцию с заданной периодичностью. Нет
    period String week, month, two_months, quarter, half_year, year Периодичность с которой повторяется операция. Нет
    is_commitment Boolean true, false Указывает нужно ли учитывать операцию как обязательство. Нет
    Варианты ответов:
    В ответ на запрос будет возвращена JSON строка, содержащая следующие данные:
    Параметр Тип Описание
    success* Boolean

    Флаг успеха выполнения запроса

    *в зависимости от данного параметра могут присутствовать или отсутствовать некоторые нижеследующие данные

    transaction Object

    Объект операции.

    * только при условии успеха запроса (success)

    errors Object

    Список ошибок, возникших при выполнении запроса, возвращается в случае неудачи запроса (success), пример:

    
    "errors": {
        "amount": [
            "Обязательное поле."
        ],
        "bank_account": [
            "Обязательное поле."
        ]
    }
    
    

    Изменение операции

    post
    https://api.adesk.ru/v1/transaction/<transaction_id>?api_token=your_api_token

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

    Параметры (объект Form Data):
    Параметр Тип Возможные значения Описание Обязательный
    date String Дата создания операции в формате YYYY-MM-DD Нет
    type String income, outcome Тип операции: Приход или Расход Нет
    category Number id статьи операции. Тип статьи должен соответствовать типу редактируемой операции. Нет
    project Number id проекта, к которому привязана операция. Нет
    contractor Number id контрагента, к которому привязана операция. Нет
    bank_account Number id банковского счета, к которому привязана операция. Нет
    amount Number Сумма операции Нет
    description String Описание операции. Произвольная строка. Ограничение длины — 510 символов. Нет
    related_date String Дата в формате YYYY-MM-DD. Указывается только если дата начисления операции отличается от даты создания. Нет
    is_periodic Boolean true, false Указывает нужно ли повторять данную операцию с заданной периодичностью. Нет
    period String week, month, two_months, quarter, half_year, year Периодичность с которой повторяется операция. Нет
    is_commitment Boolean true, false Указывает нужно ли учитывать операцию как обязательство. Нет
    Варианты ответов:
    В ответ на запрос будет возвращена JSON строка, содержащая следующие данные:
    Параметр Тип Описание
    success* Boolean

    Флаг успеха выполнения запроса

    *в зависимости от данного параметра могут присутствовать или отсутствовать некоторые нижеследующие данные

    transaction Object

    Объект операции.

    Внимание: При обновлени, в объекте операции возвращается новый id и в дальнейшем обращаться к этой операции необходимо уже по нему.

    * только при условии успеха запроса (success)

    errors Object

    Список ошибок, возникших при выполнении запроса, возвращается в случае неудачи запроса (success), пример:

    
    "errors": {
        "amount": [
            "Обязательное поле."
        ]
    }
    
    

    Удаление операции

    post
    https://api.adesk.ru/v1/transaction/<transaction_id>/remove?api_token=your_api_token
    Удаление операции по ее идентификатору
    Варианты ответов:
    В ответ на запрос будет возвращена JSON строка, содержащая следующие данные:
    Параметр Тип Описание
    success Boolean

    Флаг успеха выполнения запроса

    Подтверждение операции

    post
    https://api.adesk.ru/v1/transaction/<transaction_id>/complete?api_token=your_api_token
    Позволяет отметить ранее запланированную (isPlanned) операцию как состоявшуюся.
    Данный метод не использует каких-либо специфических POST параметров.
    Варианты ответов:
    В ответ на запрос будет возвращена JSON строка, содержащая следующие данные:
    Параметр Тип Описание
    success* Boolean

    Флаг успеха выполнения запроса

    Получение операции

    get
    https://api.adesk.ru/v1/transaction/<transaction_id>?api_token=your_api_token
    Получение информации об операции по ее идентификатору
    Варианты ответов:
    В ответ на запрос будет возвращена JSON строка, содержащая следующие данные:
    Параметр Тип Описание
    success* Boolean

    Флаг успеха выполнения запроса

    *в зависимости от данного параметра могут присутствовать или отсутствовать некоторые нижеследующие данные

    transaction Object

    Объект операции

    * только при условии успеха запроса (success)

    message String

    Сообщение об ошибке, в случае отсутствия или некорректности запрашиваемых данных

    Получение списка операций

    get
    https://api.adesk.ru/v1/transactions?api_token=your_api_token
    Получение списка операций с возможностью выбора по конкретному периоду, а также фильтрацией по счёту, типу и конкретной статье.
    Возможные параметры:
    Параметры не являются обязательными. При их отсутствии, соответствующая фильтрация не будет осуществляться и вернётся список всех операций.
    Параметр Возможные значения/Тип Описание
    range
  • all_time — всё время (по умолчанию)
  • this_month — текущий месяц
  • this_quarter — текущий квартал
  • this_year — текущий год
  • prev_month — предыдущий месяц
  • prev_quarter — предыдущий квартал
  • prev_year — предыдущий год
  • custom — произвольный период*
  • Позволяет выбрать период, за который необходимо сформировать отчёт. Если параметр не задан, отчёт формируется за всё время.

    * при выборе интервала custom параметры range_start и range_end являются обязательными

    range_start YYYY-MM-DD — формат даты для передачи в запросе

    Используется только в сочетании с периодом custom, позволяет задать дату начала желаемого периода.

    Игнорируется во всех других случаях.

    range_end YYYY-MM-DD — формат даты для передачи в запросе

    Используется только в сочетании с периодом custom, позволяет задать дату окончания желаемого периода.

    Игнорируется во всех других случаях.

    type
  • all — все типы (по умолчанию)
  • income — только поступления
  • outcome — только расходы
  • Тип операций для фильтрации. Будут возвращены операции только указанного типа.

    category
  • all — все статьи (по умолчанию)
  • Number (тип) — идентификатор статьи
  • no_category — без статьи
  • Идентификатор статьи для фильтрации. Будут возвращены операции только с указанной статьей. Выбранная статья должна соответствовать типу, указанному выше, иначе список будет пустым. Значение "no_category" вернёт только те операции, у которых не указана статья.

    bank_account Number

    Идентификатор счёта для фильтрации. Будут возвращены только операции, привязанные к конкретному счёту.

    start Number

    Позволяет установить индекс элемента из общей выборки, начиная с которого данные будут возвращены. Отсчет ведётся с 0.

    length Number

    Позволяет ограничить длину выборки. Если установлен стартовый индекс, то расчёт длины происходит начиная с него.

    Пример запроса:
    https://api.adesk.ru/v1/transactions?api_token=your_api_token&range=custom&range_start=2018-12-05&range_end=2018-12-15&type=income
    Данный запрос вернёт список операций типа "поступление" по всем статьям и счетам за произвольный период с 5 по 15 декабря 2018 года.
    Варианты ответов:
    В ответ на запрос будет возвращена JSON строка, содержащая следующие данные:
    Параметр Тип Описание
    success* Boolean

    Флаг успеха выполнения запроса

    *в зависимости от данного параметра могут присутствовать или отсутствовать некоторые нижеследующие данные

    transactions Array

    Массив объектов операций. Может быть пустым, если ничего не попадает под параметры фильтрации.

    * только при условии успеха запроса (success)

    recordsTotal Number

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

    recordsFiltered Number

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

    Отмена повторения операции

    get
    https://api.adesk.ru/v1/transaction/<chain_root_id>/drop?api_token=your_api_token
    Удаляет все еще не выполненные повторяющиеся операции.
    Варианты ответов:
    В ответ на запрос будет возвращена JSON строка, содержащая следующие данные:
    Параметр Тип Описание
    success Boolean

    Флаг успеха выполнения запроса

    message String

    Сообщение об ошибке, в случае отсутствия или некорректности запрашиваемых данных.

    Контрагенты

    Пример объекта контрагента, который является основной структурой данных для методов по контрагентам
    
    {
        "id": 1245,                                  // уникальный идентификатор
        "name": "ИП Борей",                          // название контрагента
        "contactPerson": "Иванов Дмитрий Сергеевич", // контактное лицо
        "phoneNumber": "+79999999999",               // номер телефона
        "email": "borealis@mail.ru"                  // адрес электронной почты
        "balance": -14000.00,                        // баланс обязательств контрагентау
    }
    
    

    Получение списка контрагентов

    get
    https://api.adesk.ru/v1/contractors?api_token=your_api_token
    Получение списка всех неудаленных объектов контрагентов на аккаунте.
    Возможные параметры:
    Параметры не являются обязательными. При их отсутствии, соответствующая фильтрация не будет осуществляться и вернётся список всех контрагентов.
    Параметр Тип Описание
    q String

    Строка для поиска по имени контрагента.

    Варианты ответов:
    В ответ на запрос будет возвращена JSON строка, содержащая следующие данные:
    Параметр Тип Описание
    success Boolean

    Флаг успеха выполнения запроса

    contractors Array

    Массив объектов контрагентов. Может быть пустым, если на аккаунте нет неудаленных объектов контрагентов.

    Получение контрагента

    get
    https://api.adesk.ru/v1/contractor/<contractor_id>?api_token=your_api_token
    Получение детальной информации о контрагенте по его идентификатору.
    Варианты ответов:
    В ответ на запрос будет возвращена JSON строка, содержащая следующие данные:
    Параметр Тип Описание
    success* Boolean

    Флаг успеха выполнения запроса

    *в зависимости от данного параметра могут присутствовать или отсутствовать некоторые нижеследующие данные

    contractor Object

    Объект контрагента

    * только при условии успеха запроса (success)

    message String

    Сообщение об ошибке, в случае отсутствия или некорректности запрашиваемых данных

    Получение списка обязательств контрагента

    get
    https://api.adesk.ru/v1/contractor/<contractor_id>/commitments?api_token=your_api_token
    Получение списка всех неудаленных обязательств контрагента на аккаунте.
    Варианты ответов:
    В ответ на запрос будет возвращена JSON строка, содержащая следующие данные:
    Параметр Тип Описание
    success Boolean

    Флаг успеха выполнения запроса

    commitments Array

    Массив объектов обязательств. Может быть пустым, если на аккаунте нет неудаленных объектов обязательств.

    Добавление контрагента

    post
    https://api.adesk.ru/v1/contractor?api_token=your_api_token

    Добавляет нового контрагента с указанными в запросе параметрами.

    Параметры (объект Form Data):
    Параметр Тип Возможные значения Описание Обязательный
    name String Название контрагента Да
    contact_person String Контактное лицо Нет
    phone_number String Телефонный номер Нет
    email String Адрес электроннной почты контрагента Нет
    description String Краткое описание контрагента Нет
    Варианты ответов:
    В ответ на запрос будет возвращена JSON строка, содержащая следующие данные:
    Параметр Тип Описание
    success* Boolean

    Флаг успеха выполнения запроса

    *в зависимости от данного параметра могут присутствовать или отсутствовать некоторые нижеследующие данные

    contractor Object

    Объект контрагента.

    errors Object

    Список ошибок, возникших при выполнении запроса, возвращается в случае неудачи запроса (success), пример:

    
    "errors": {
        "amount": [
            "Обязательное поле."
        ]
    }
    
    

    Изменение контрагента

    post
    https://api.adesk.ru/v1/contractor/<contractor_id>?api_token=your_api_token

    Изменяет данные о контрагенте по его идентификатору. Для удаления текущего значения поля контрагента, необходимо отправить параметр с пустой строкой.

    Параметры (объект Form Data):
    Параметр Тип Возможные значения Описание Обязательный
    name String Название контрагента Нет
    contact_person String Контактное лицо Нет
    phone_number String Телефонный номер Нет
    email String Адрес электроннной почты контрагента Нет
    description String Краткое описание контрагента Нет
    Варианты ответов:
    В ответ на запрос будет возвращена JSON строка, содержащая следующие данные:
    Параметр Тип Описание
    success* Boolean

    Флаг успеха выполнения запроса

    *в зависимости от данного параметра могут присутствовать или отсутствовать некоторые нижеследующие данные

    contractor Object

    Объект контрагента.

    errors Object

    Список ошибок, возникших при выполнении запроса, возвращается в случае неудачи запроса (success), пример:

    
    "errors": {
        "amount": [
            "Обязательное поле."
        ]
    }