Общее

Токен API

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

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


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

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

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

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

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


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

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

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

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

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

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

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

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

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

category* Object

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

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

errors Object

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


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

message String

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

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

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

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

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

    recordsTotal Number Количество записей, отфильтрованных для текущей страницы.
    recordsFiltered Number Общее количество записей, доступных по указанному фильтру.
    categories Array[Object] Список объектов статей.
    message String Сообщение об ошибке, в случае отсутствия или некорректности запрашиваемых данных.

    Проекты

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

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

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

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

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

    project* Object

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

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

    errors Object

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

    
    "errors": {
        "name": [
            "Обязательное поле."
        ]
    }
    
    
    message String Сообщение об ошибке, в случае отсутствия или некорректности запрашиваемых данных.

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

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

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

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

    project* Object

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

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

    errors Object

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

    
    "errors": {
        "name": [
            "Обязательное поле."
        ]
    }
    
    
    message String Сообщение об ошибке, в случае отсутствия или некорректности запрашиваемых данных.

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

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

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

    message String

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

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

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

    start Number

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

    length Number

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

    q String

    Строка для поиска по названию проекта.

    reduced Boolean (true, false)
    Параметр, отвечающий за ограничение количества выводимых параметров в ответе. Если true, то в ответе будут только поля id, name, isFinished.
    sorting
  • alphabetically — в алфавитном порядке
  • last_modified — по обновлениям (по умолчанию)
  • popularity — по популярности
  • Позволяет отсортировать выборку.
    Варианты ответов:
    В ответ на запрос будет возвращена JSON строка, содержащая следующие данные:
    success Boolean

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

    projects Array[Object]

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

    recordsTotal Number

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

    recordsFiltered Number

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

    total Object Ключевые показатели проекта (приход, расход, прибыль, рентабельность) и их плановые значения.
    message String

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

    Список направлений проектов

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

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

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

    categories Array[Object]

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

    recordsTotal Number

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

    recordsFiltered Number

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

    message String

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

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

    Пример объекта проекта, который является основной структурой данных для методов по обязательствам:
    
    {
        "id": 60,                                                           // уникальный идентификатор
        "amount": "2400.99",                                                // сумма обязательства
        "description": "Услуги аренды имущества по договору",               // описание
        "date": "20.03.2019",                                               // дата
        "dateFormatted": "Сегодня",                                         // форматированная дата
        "contractor": {...},                                                // контрагент
        "project": 36,                                                      // id проекта, к которому привязано обязательство
        "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 RUR, EUR, USD, KZT, UAH, GBP, BYN Валюта обязательства. Да
    description String Краткое описание.
    Максимальная длина поля: 510 символов.
    Нет
    project Number id проекта, к которому привязано обязательство. Нет
    Варианты ответов:
    В ответ на запрос будет возвращена JSON строка, содержащая следующие данные:
    Параметр Тип Описание
    success* Boolean

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

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

    commitment* Object

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

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

    errors Object

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

    
    "errors": {
        "name": [
            "Обязательное поле."
        ]
    }
    
    
    message String Сообщение об ошибке, в случае отсутствия или некорректности запрашиваемых данных.

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

    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 RUR, EUR, USD, KZT, UAH, GBP, BYN Валюта обязательства. Нет
    description String Краткое описание.
    Максимальная длина поля: 510 символов.
    Нет
    project Number id проекта, к которому привязано обязательство. Нет
    Варианты ответов:
    В ответ на запрос будет возвращена JSON строка, содержащая следующие данные:
    Параметр Тип Описание
    success* Boolean

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

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

    commitment Object

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

    errors Object

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

    
    "errors": {
        "name": [
            "Обязательное поле."
        ]
    }
    
    
    message String Сообщение об ошибке, в случае отсутствия или некорректности запрашиваемых данных.

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

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

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

    message String

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

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

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

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

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

    Тип счета. 1 - наличные\касса, 2 - банковский счет.

    По умолчанию создается банковский счет.

    Нет
    bank_code Number БИК банка. Нет
    correspondent_account Number Корреспондентский счёт банка.
    Максимальная длина поля: 64 символа.
    Нет
    is_acquiring_enabled Boolean true, false Подключен ли к счёту эквайринг. Нет
    commission_category Number Статья коммиссии по эквайрингу. Нет
    refund_category Number Статья возврата по эквайрингу. Нет
    Варианты ответов:
    В ответ на запрос будет возвращена 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 Название банка. Нет
    bank_code Number БИК банка. Нет
    initial_amount Number Сумма начального остатка. Нет
    initial_amount_date String Дата в формате YYYY-MM-DD Дата начисления начального остатка. Указывается, если дата, с которой планируется регистрировать операции по счету меньше текущей, при условии, что необходимо учесть начальный остаток. Нет
    legal_entity Number id юрлица, к которому привязан счет. Нет
    type Number 1, 2

    Тип счета. 1 - наличные\касса, 2 - банковский счет.

    По умолчанию создается банковский счет.

    Нет
    correspondent_account Number Корреспондентский счёт банка.
    Максимальная длина поля: 64 символа.
    Нет
    is_acquiring_enabled Boolean true, false Подключен ли к счёту эквайринг. Нет
    commission_category Number Статья коммиссии по эквайрингу. Нет
    refund_category Number Статья возврата по эквайрингу. Нет
    Варианты ответов:
    В ответ на запрос будет возвращена JSON строка, содержащая следующие данные:
    Параметр Тип Описание
    success Boolean

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

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

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

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

    message String

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

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

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

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

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

    bankAccount* Object

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

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

    message String

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

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

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

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

    length Number

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

    reduced Boolean (true, false)

    Параметр, отвечающий за ограничение количества выводимых параметров в ответе. Если true, то ответ не детализированный.

    with_sum_amount Boolean (true, false)

    Параметр, отвечающий за добавление суммарного остатка по всем счетам.

    bank_account_type
  • Bank — банковский счет
  • Cash — наличный счет или касса
  • Позволяет осуществить выборку счетов по типу.
    status
  • open — открытый счёт
  • closed — закрытый счёт
  • Позволяет осуществить выборку счетов по статусу.
    Варианты ответов:
    В ответ на запрос будет возвращена JSON строка, содержащая следующие данные:
    Параметр Тип Описание
    success* Boolean

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

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

    bankAccounts* Array[Object]

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

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

    recordsTotal Number

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

    recordsFiltered Number

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

    Переводы

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

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

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

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

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

    transfer* Object

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

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

    message String

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

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

    errors Object

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

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

    Операции

    Пример объекта операции, который является основной структурой данных для методов по операциям:
    
    {
        "id": 5590,                     // уникальный идентификатор
        "isSplitted": false,            // указывает была ли операция разбитой на части
        "splitId":,                     // id коренной операции
        "amount": "67",                 // сумма
        "date": "20.12.2018",           // дата создания
        "dateIso": "2018.12.20",
        "type": 1,                      // тип. 1 — поступление, 2 — расход
        "description": "",              // описание
        "dateFormatted": "Вчера",       // отформатированная дата создания
        "relatedDate": "20.12.2018",    // дата начисления по операции
        "confirmAccrual": true,         // флаг подтверждения начисления
        "isPlanned": false,             // флаг запланированной операции
        "isReadyToBeConfirmed": true,   // флаг готовности к подтверждению
        "isPeriodic": true,             // флаг периодичности операции
        "periodicChain": 14553,         // "корневая" операция в цепочке повторяющихся операций
        "period": "month",              // частота повторения операции
        "isCommitment": true,           // флаг обязательства
        "isTransfer": false,            // флаг операции-перевода
        "bankAccountAmount": "-233.00", // состояние счета после совершения операции
    
        "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,
            "legalEntity": {            // юр лицо
                "id": 54,
                "name": "345"
            }
        },
        "category": {                   // статья
            "kind": 1,
            "isOwnerTransfer": true,
            "name": "Продажи",
            "isSystem": false,
            "type": 1,
            "id": 48,
            "group": {                  // группа статьи
                "id": 43,
                "name": "Продажи",
                "type": 1               // тип группы (1-доход, 2-расход)
            }
        },
        "contractor": {                 // контрагент
            "id": 15,
            "name": "Сбербанк",
            "contactPerson": "Харитонов Василий Акимович",
            "phoneNumber": "+7999999999",
            "email": "sber@mail.com"
        },
        "project": {                    // проект
            "id": 46,
            "name": "Мобильное приложение завода",
            "isFinished": false,
            "category": {               // направление бизнеса
                "id": 30,
                "name": "Разработка"
            }
        }
    }
    
    

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

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

    JSON строка, которая представляет собой список объектов, в котором содержится информация о разбиении операции.

    Принимаются следующие параметры: amount, contractor, project, category, related_date. Параметры аналогичны тем, что используются при обычном создании операции. Параметр amount обязателен.

    Нет
    Варианты ответов:
    В ответ на запрос будет возвращена 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. Да
    category Number id статьи операции. Тип статьи должен соответствовать типу редактируемой операции. Игнорируется если is_splitted = true. Нет
    project Number id проекта, к которому привязана операция. Игнорируется если is_splitted = true. Нет
    contractor Number id контрагента, к которому привязана операция. Игнорируется если is_splitted = true. Нет
    bank_account Number id банковского счета, к которому привязана операция. Да
    amount Number Сумма операции. Да
    description String Описание операции. Произвольная строка. Ограничение длины — 510 символов. Нет
    related_date String Дата в формате YYYY-MM-DD. Указывается только если дата начисления операции отличается от даты создания. Нет
    is_periodic Boolean true, false Указывает нужно ли повторять данную операцию с заданной периодичностью. Игнорируется если is_splitted = true. Нет
    period String week, month, two_months, quarter, half_year, year Периодичность с которой повторяется операция. Игнорируется если is_splitted = true. Нет
    repetition_end_date String Дата, до которой нужно повторять операции с заданной периодичностью.
    В формате YYYY-MM-DD.
    Нет
    is_commitment Boolean true, false Указывает нужно ли учитывать операцию как обязательство. Игнорируется если is_splitted = true. Нет
    is_planned Boolean true

    Указывает является ли операция неподтвержденной.

    Для подтверждения операции воспользуйтесь этим методом.

    Нет
    is_splitted Boolean true, false

    Указывает нужно ли разбить операцию на несколько частей.

    В случае если редактируемая операция уже разбита, то при значении false произойдет отмена разбиения, а при true информация о разбиении обновится согласно передаваемому параметру parts.

    Нет
    parts String "[{"project": 1, "contractor": 1, "amount": 1000, "is_commitment": true, "related_date": "2019-01-01"}, ...]"

    JSON строка, которая представляет собой список объектов, в котором содержится информация о разбиении операции.

    Принимаются следующие параметры: amount, contractor, project, category, related_date. Параметры аналогичны тем, что используются при обычном создании операции. Параметр amount обязателен. Сумма параметров amount должна совпадать с суммой редактируемой операции.

    Если операция уже разбита на части, передача данного параметра заменяет данные о разбиении.

    Нет
    periodic_edit_type String
  • this — изменить только эту операцию
  • this-and-following — изменить эту и последующие операции
  • Флаг для повторяющихся операций. Нет
    Варианты ответов:
    В ответ на запрос будет возвращена 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

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

    message String

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

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

    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

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

    legal_entity* Number

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

    * будет проигнорирован, если передан параметр bank_account.

    contractor Number

    Идентификатор контрагента. Будут возвращены только операции по данному контрагенту.

    contractor_inn* Number

    ИНН контрагента. Будут возвращены только операции по контрагенту с указанным ИНН.

    * будет проигнорирован, если передан параметр contractor.

    project Number

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

    Также поддерживаются специальные значения: no_project - вернет только операции без проекта, any_project - вернет только операции с назначенным проектом.

    status String

    Статус операции: completed — выберет фактические операции, planned — выберет плановые операции, all — выберет все операции.

    owner_transfer String

    Фильтрует операции со статьями типа ввод или вывод денег.

    true — выберет только операции со статьями типа ввод или вывод денег, false — уберет такие операции из результата, all — выберет все операции.

    Значение по умолчанию — all.

    taxes String

    Фильтрует операции со статьей "Налоги и пошлины".

    true — выберет только операции со статьей "Налоги и пошлины", false — уберет такие операции из результата, all — выберет все операции.

    Значение по умолчанию — all.

    date_type String

    Указывает по какой дате сортировать операции.

    cashier — отфильтрует операции по фактической дате (date), accrual — отфильтрует операции по дате начисления (related_date).

    Значение по умолчанию — cashier.

    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

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

    Контрагенты

    Пример объекта контрагента, который является основной структурой данных для методов по контрагентам:
    
    {
        "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
    Получение списка всех неудаленных объектов контрагентов на аккаунте.
    Возможные параметры:
    Параметры не являются обязательными. При их отсутствии, соответствующая фильтрация не будет осуществляться и вернется список всех контрагентов.
    Параметр Тип Описание
    range
  • all — все время (по умолчанию)
  • 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, позволяет задать дату окончания желаемого периода.

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

    reduced Boolean (true, false)

    Параметр, отвечающий за ограничение количества выводимых параметров в ответе. Если true, то ответ не детализированный.

    q String

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

    inn Number

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

    with_balance Boolean (true, false)

    Исключает из выборки контрагентов с нулевым балансом. Если true, то в итоговой выборки будут контрагенты, с которыми сумма обязательств не равна 0.

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

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

    contractors Array[Object]

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

    recordsTotal Number

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

    recordsFiltered Number

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

    message String

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

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

    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

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

    recordsTotal Number

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

    recordsFiltered Number

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

    message String

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

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

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

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

    requisites Array

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

    recordsTotal Number

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

    recordsFiltered Number

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

    message String

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

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

    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

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

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

    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

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

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

    message* String

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

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

    errors Object

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

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

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

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

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

    message String

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

    Реквизиты

    Пример объекта реквизитов, который является основной структурой данных для методов по реквизитам:
    
    {
        "id": 1832,                                    // уникальный идентификатор
        "name": "Смолов Сергей Семенович",             // название юр. лица контрагента
        "inn": "123456789987",                         // ИНН контрагента
        "kpp": "123456789987",                         // КПП контрагента
        "correspondentAccount":,                       // корреспондентский счёт банка
        "bankName":,                                   // название банка
        "bankAccountNumber": "199991244578149123",     // номер счёта
        "bankCode": "045678",                          // БИК банка
        "address": "Комсомольский проспект, 10, 312",  // адрес
        "phoneNumber": "+79999999999",                 // номер телефона
        "email": "uralstroy@mail.ru",                  // email
        "website": "uralstroy.ru",                     // сайт
    }
    
    

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

    post
    https://api.adesk.ru/v1/requisites?api_token=your_api_token
    Добавляет новые реквизиты контрагента с указанными в запросе параметрами.
    Параметры (объект Form Data):
    Параметр Тип Описание Обязательный
    contractor Number id контрагента. Да
    name String Название юр. лица контрагента.
    Максимальная длина поля: 255 символов.
    Да
    inn String ИНН контрагента.
    Максимальная длина поля: 12 символов.
    Нет
    kpp String КПП контрагента.
    Максимальная длина поля: 12 символов.
    Нет
    bank_account_number String Номер счета контрагента.
    Максимальная длина поля: 30 символов.
    Нет
    bank_code String БИК банка контрагента.
    Максимальная длина поля: 11 символов.
    Нет
    bank_name String Название банка контрагента.
    Максимальная длина поля: 210 символов.
    Нет
    address String Адрес контрагента.
    Максимальная длина поля: 100 символов.
    Нет
    correspondent_account String Корреспондентский счёт банка контрагента.
    Максимальная длина поля: 64 символа.
    Нет
    Варианты ответов:
    В ответ на запрос будет возвращена JSON строка, содержащая следующие данные:
    Параметр Тип Описание
    success* Boolean

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

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

    message* String

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

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

    errors Object

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

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

    Объект реквизитов.

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

    Изменение реквизитов

    post
    https://api.adesk.ru/v1/requisites/<requisites_id>?api_token=your_api_token
    Изменяет реквизиты контрагента с указанными в запросе параметрами.
    Параметры (объект Form Data):
    Параметр Тип Описание Обязательный
    contractor Number id контрагента. Да
    name String Название юр. лица контрагента.
    Максимальная длина поля: 255 символов.
    Да
    inn String ИНН контрагента.
    Максимальная длина поля: 12 символов.
    Нет
    kpp String КПП контрагента.
    Максимальная длина поля: 12 символов.
    Нет
    bank_account_number String Номер счета контрагента.
    Максимальная длина поля: 30 символов.
    Нет
    bank_code String БИК банка контрагента.
    Максимальная длина поля: 11 символов.
    Нет
    bank_name String Название банка контрагента.
    Максимальная длина поля: 210 символов.
    Нет
    address String Адрес контрагента.
    Максимальная длина поля: 100 символов.
    Нет
    correspondent_account String Корреспондентский счёт банка контрагента.
    Максимальная длина поля: 64 символа.
    Нет
    Варианты ответов:
    В ответ на запрос будет возвращена JSON строка, содержащая следующие данные:
    Параметр Тип Описание
    success* Boolean

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

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

    message* String

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

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

    errors Object

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

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

    Объект реквизитов.

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

    Удаление реквизитов

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

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

    message String

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

    Вебхуки

    Пример объекта вебхука, который является основной структурой данных для методов по вебхукам:
    
    {
        "id": 1234,                             // уникальный идентификатор
        "description": "Действия с операциями", // краткое описание
        "url": "https://example.com/webhooks",  // URL, на который будут отправляться события
        "events": [                             // список отправляемых событий
            "transaction.created",
            "transaction.updated",
            ...
        ]
    }
    
    

    Список вебхуков

    get
    https://api.adesk.ru/v1/webhooks?api_token=your_api_token

    Получение списка всех неудаленных объектов вебхуков на аккаунте.

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

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

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

    webhooks* Array[Object]

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

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

    recordsTotal Number

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

    recordsFiltered Number

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

    message String

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

    Добавление вебхука

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

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

    Параметры (объект Form Data):
    Параметр Тип / Возможные значения Описание Обязательный
    url String URL для отправки событий. Да
    events Array[String]

    Список кодов событий для отправки.

    • transaction.created — операция создана
    • transaction.updated — операция изменена
    • transaction.deleted — операция удалена
    • transaction.confirmed — операция подтверждена
    • commitment.created — обязательство создано
    • commitment.deleted — обязательство удалено
    • contractor.created — контрагент создан
    • contractor.deleted — контрагент удален
    • project.created — проект создан
    • project.deleted — проект удален
    • project.finished — проект завершен
    Да
    description String Краткое описание вебхука. Нет
    Варианты ответов:
    В ответ на запрос будет возвращена JSON строка, содержащая следующие данные:
    Параметр Тип Описание
    success* Boolean

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

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

    webhook* Object

    Объект вебхука.

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

    errors Object

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

    
    "errors": {
        "url": [
            "Некорректный URL для уведомления."
        ],
        "events": [
            "Обязательное поле."
        ]
    }
    
    

    Изменение вебхука

    post
    https://api.adesk.ru/v1/webhook/<webhook_id>?api_token=your_api_token

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

    Параметры (объект Form Data):
    Параметр Тип / Возможные значения Описание Обязательный
    url String URL для отправки событий. Да
    events Array[String]

    Список кодов событий для отправки.

    • transaction.created — операция создана
    • transaction.updated — операция изменена
    • transaction.deleted — операция удалена
    • transaction.confirmed — операция подтверждена
    • commitment.created — обязательство создано
    • commitment.deleted — обязательство удалено
    • contractor.created — контрагент создан
    • contractor.deleted — контрагент удален
    • project.created — проект создан
    • project.deleted — проект удален
    • project.finished — проект завершен
    Да
    description String Краткое описание вебхука. Нет
    Варианты ответов:
    В ответ на запрос будет возвращена JSON строка, содержащая следующие данные:
    Параметр Тип Описание
    success* Boolean

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

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

    webhook* Object

    Объект вебхука.

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

    errors Object

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

    
    "errors": {
        "url": [
            "Некорректный URL для уведомления."
        ],
        "events": [
            "Обязательное поле."
        ]
    }
    
    

    Удаление вебхука

    post
    https://api.adesk.ru/v1/webhook/<webhook_id>/remove?api_token=your_api_token

    Удаление вебхука по идентификатору.

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

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

    message String

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

    Вебхуки операций

    События отправляются методом POST и ожидают ответ со статусом 200. При получении ответа с ошибочным статусом, событие будет доставляться повторно по следующему графику:

    • сразу
    • через 5 секунд
    • через 5 минут
    • через 30 минут
    • через 2 часа
    • через 5 часов
    • через 10 часов
    • еще через 10 часов
    Пример объекта операции, который является основной структурой данных для вебхуков операций:
    
    {
        "id": 1729,
        "type": 1,
        "amount": "10000.00",
        "description": "Закупка оборудования",
        "date": "2022-04-01",
        "relatedDate": "2022-04-04",
        "confirmAccrual": true,
        "isCommitment": false,
        "isPlanned": false,
        "isSplitted": false,
        "isTransfer": false,
        "bankAccount": {
            "id": 1,
            "type": 2,
            "name": "Счет 1",
            "bankCode": "",
            "bankName": "",
            "number": "11111111111111111111",
            "correspondentAccount": "",
            "currency": "RUR",
            "legalEntity": {
                "id": 1,
                "name": "ООО \"Ромашка\"",
                "fullName": "",
                "inn": "",
                "kpp": "",
                "registrationNumber": "",
                "address": "",
                "phoneNumber": ""
            }
        },
        "category": {
            "id": 17,
            "name": "Статья 1",
            "type": 1,
            "isArchived": false,
            "group": {
                "id": 2,
                "name": "Группа приходных статей",
                "type": 1
            }
        },
        "contractor": {
            "id": 42,
            "name": "Aguistin Heisman",
            "canonicalName": "aguistinheisman"
        },
        "project": {
            "id": 16,
            "name": "Тест"
        }
    }
    
    

    Операция создана

    Пример объекта события создания операции:
    
    {
        "eventTimestamp": "2022-04-12T10:02:24.703436+00:00", // дата и время события
        "eventType": "transaction.created",                   // тип события
        "eventId": "b3148c22-2625-4831-b136-0ef74b06d417",    // уникальный идентификатор события
        "data": [                                             // список объектов операций
            <объект операции>,
            ...
        ]
    }
    
    

    Операция изменена

    Пример объекта события изменения операции:
    
    {
        "eventTimestamp": "2022-04-12T10:02:24.703436+00:00", // дата и время события
        "eventType": "transaction.updated",                   // тип события
        "eventId": "b3148c22-2625-4831-b136-0ef74b06d417",    // уникальный идентификатор события
        "data": [                                             // список объектов операций
            <объект операции>,
            ...
        ]
    }
    
    

    Операция удалена

    Пример объекта события удаления операции:
    
    {
        "eventTimestamp": "2022-04-12T10:02:24.703436+00:00", // дата и время события
        "eventType": "transaction.deleted",                   // тип события
        "eventId": "b3148c22-2625-4831-b136-0ef74b06d417",    // уникальный идентификатор события
        "data": [                                             // список объектов операций
            <объект операции>,
            ...
        ]
    }
    
    

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

    Пример объекта события подтверждения плановой операции:
    
    {
        "eventTimestamp": "2022-04-12T10:02:24.703436+00:00", // дата и время события
        "eventType": "transaction.confirmed",                 // тип события
        "eventId": "b3148c22-2625-4831-b136-0ef74b06d417",    // уникальный идентификатор события
        "data": [                                             // список объектов операций
            <объект операции>,
            ...
        ]
    }
    
    

    Вебхуки обязательств

    События отправляются методом POST и ожидают ответ со статусом 200. При получении ответа с ошибочным статусом, событие будет доставляться повторно по следующему графику:

    • сразу
    • через 5 секунд
    • через 5 минут
    • через 30 минут
    • через 2 часа
    • через 5 часов
    • через 10 часов
    • еще через 10 часов
    Пример объекта обязательства, который является основной структурой данных для вебхуков обязательств:
    
    {
        "id": 41,
        "type": 1,
        "currency": "RUR",
        "amount": "34500.00",
        "description": "Прокладка кабелей",
        "date": "2022-10-19",
        "contractor": {
            "canonicalName": "ипмастероввг",
            "id": 4,
            "name": "ИП Мастеров В.Г."
        },
        "project": {
            "id": 8,
            "name": "Пионер"
        },
        "transaction": {
            "id": 1234
        }
    }
    
    

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

    Пример объекта события создания обязательства:
    
    {
        "eventTimestamp": "2022-10-19T11:28:44.294366+00:00", // дата и время события
        "eventType": "commitment.created",                    // тип события
        "eventId": "188c8346-b44f-4b70-b18b-4eabc347941a",    // уникальный идентификатор события
        "data": [                                             // список объектов обязательств
            <объект обязательства>,
            ...
        ]
    }
    
    

    Обязательство удалено

    Пример объекта события удаления обязательства:
    
    {
        "eventTimestamp": "2022-10-19T11:28:44.294366+00:00", // дата и время события
        "eventType": "commitment.deleted",                    // тип события
        "eventId": "188c8346-b44f-4b70-b18b-4eabc347941a",    // уникальный идентификатор события
        "data": [                                             // список объектов обязательств
            <объект обязательства>,
            ...
        ]
    }
    
    

    Вебхуки контрагентов

    События отправляются методом POST и ожидают ответ со статусом 200. При получении ответа с ошибочным статусом, событие будет доставляться повторно по следующему графику:

    • сразу
    • через 5 секунд
    • через 5 минут
    • через 30 минут
    • через 2 часа
    • через 5 часов
    • через 10 часов
    • еще через 10 часов
    Пример объекта контрагента, который является основной структурой данных для вебхуков контрагентов:
    
    {
        "id": 494,
        "name": "ООО «Заря»",
        "canonicalName": "ооозаря",
        "contactPerson": "Иванов И.И.",
        "email": "zarya@example.com",
        "phoneNumber": "+75551234567",
        "description": "Поставка расходных материалов",
        "category": {
            "id": 2,
            "name": "Подрядчики"
        },
        "requisites": []
    }
    
    

    Контрагент создан

    Пример объекта события создания контрагента:
    
    {
        "eventTimestamp": "2022-10-19T11:58:16.819707+00:00", // дата и время события
        "eventType": "contractor.created",                    // тип события
        "eventId": "b1b079de-055c-41f0-b6f8-037bf9f02592",    // уникальный идентификатор события
        "data": [                                             // список объектов контрагентов
            <объект контрагента>,
            ...
        ]
    }
    
    

    Контрагент удален

    Пример объекта события удаления контрагента:
    
    {
        "eventTimestamp": "2022-10-19T11:58:16.819707+00:00", // дата и время события
        "eventType": "contractor.deleted",                    // тип события
        "eventId": "b1b079de-055c-41f0-b6f8-037bf9f02592",    // уникальный идентификатор события
        "data": [                                             // список объектов контрагентов
            <объект контрагента>,
            ...
        ]
    }
    
    

    Вебхуки проектов

    События отправляются методом POST и ожидают ответ со статусом 200. При получении ответа с ошибочным статусом, событие будет доставляться повторно по следующему графику:

    • сразу
    • через 5 секунд
    • через 5 минут
    • через 30 минут
    • через 2 часа
    • через 5 часов
    • через 10 часов
    • еще через 10 часов
    Пример объекта проекта, который является основной структурой данных для вебхуков проектов:
    
    {
        "id": 15,
        "name": "Каслинская, 12б",
        "description": "Ремонт офиса на Каслинской, 12б",
        "category": {
            "id": 22,
            "name": "Ремонт офисов"
        }
    }
    
    

    Проект создан

    Пример объекта события создания проекта:
    
    {
        "eventTimestamp": "2022-10-19T12:05:10.374246+00:00", // дата и время события
        "eventType": "project.created",                       // тип события
        "eventId": "9a6e7412-9229-421e-93e2-512e8d116add",    // уникальный идентификатор события
        "data": [                                             // список объектов проектов
            <объект проекта>,
            ...
        ]
    }
    
    

    Проект удален

    Пример объекта события удаления проекта:
    
    {
        "eventTimestamp": "2022-10-19T12:05:10.374246+00:00", // дата и время события
        "eventType": "project.deleted",                       // тип события
        "eventId": "9a6e7412-9229-421e-93e2-512e8d116add",    // уникальный идентификатор события
        "data": [                                             // список объектов проектов
            <объект проекта>,
            ...
        ]
    }
    
    

    Проект завершен

    Пример объекта события завершения проекта:
    
    {
        "eventTimestamp": "2022-10-19T12:05:10.374246+00:00", // дата и время события
        "eventType": "project.finished",                      // тип события
        "eventId": "9a6e7412-9229-421e-93e2-512e8d116add",    // уникальный идентификатор события
        "data": [                                             // список объектов проектов
            <объект проекта>,
            ...
        ]
    }