Перейти к содержанию

Финансовое планирование

API методы для модуля finplan

Заявки

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

GET /finplan/api/request/list

Метод позволяет получить список заявок.

curl 'https://{HOST}.platrum.ru/finplan/api/request/list' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}' \ 
    --data '{"finplans":["some_string","some_string"]}'

{
    "status": "success",
    "data": [
        {
            "id": 123,
            "user_final_accept_block": 123,
            "required_accept": [
                123,
                123
            ],
            "rejected_block": [
                123,
                123
            ],
            "progressed_blocks": [
                123,
                123
            ],
            "need_accept": [
                123,
                123
            ],
            "is_current_user_rejected": true,
            "is_need_accept_next": true,
            "history": [
                {
                    "id": 123,
                    "request_id": 123,
                    "author_id": "some_string",
                    "author_block_id": 123,
                    "type": "some_string",
                    "text": "some_string",
                    "creation_date": "2019-01-01 21:00:15"
                }
            ],
            "can_accept": true,
            "can_accept_final": true,
            "can_edit": true,
            "can_paid": true,
            "can_progress": true,
            "can_reject": true,
            "can_remove": true,
            "finplan": "some_string",
            "sum": 123,
            "sum_paid": 123,
            "currency_code": "some_string",
            "name": "some_string",
            "type": 123,
            "problem": "some_string",
            "solution": "some_string",
            "economic_justification": "some_string",
            "status": "some_string",
            "author_id": "some_string",
            "author_block_id": 123,
            "last_accept_users": "array",
            "last_accept_user_id": "some_string",
            "last_accept_block_id": 123,
            "reject_user_id": "some_string",
            "reject_block_id": 123,
            "reject_text": "some_string",
            "modification_date": "2019-01-01 21:00:15",
            "creation_date": "2019-01-01 21:00:15",
            "files": "array"
        },
        {
            "id": 123,
            "user_final_accept_block": 123,
            "required_accept": [
                123,
                123
            ],
            "rejected_block": [
                123,
                123
            ],
            "progressed_blocks": [
                123,
                123
            ],
            "need_accept": [
                123,
                123
            ],
            "is_current_user_rejected": true,
            "is_need_accept_next": true,
            "history": [
                {
                    "id": 123,
                    "request_id": 123,
                    "author_id": "some_string",
                    "author_block_id": 123,
                    "type": "some_string",
                    "text": "some_string",
                    "creation_date": "2019-01-01 21:00:15"
                }
            ],
            "can_accept": true,
            "can_accept_final": true,
            "can_edit": true,
            "can_paid": true,
            "can_progress": true,
            "can_reject": true,
            "can_remove": true,
            "finplan": "some_string",
            "sum": 123,
            "sum_paid": 123,
            "currency_code": "some_string",
            "name": "some_string",
            "type": 123,
            "problem": "some_string",
            "solution": "some_string",
            "economic_justification": "some_string",
            "status": "some_string",
            "author_id": "some_string",
            "author_block_id": 123,
            "last_accept_users": "array",
            "last_accept_user_id": "some_string",
            "last_accept_block_id": 123,
            "reject_user_id": "some_string",
            "reject_block_id": 123,
            "reject_text": "some_string",
            "modification_date": "2019-01-01 21:00:15",
            "creation_date": "2019-01-01 21:00:15",
            "files": "array"
        }
    ]
}
Параметр Описание Тип Значения
finplans Даты финпланирования array[string] -
Параметр Описание Тип Значения
id ID int -
user_final_accept_block Id блока, который финально согласовывает заявку int -
required_accept Id блоков, от которых требуется согласование заявки array[int] -
rejected_block Id блоков, которые ещё могут отклонить заявку array[int] -
progressed_blocks Id блоков, которые могут вернуть заявку в работу array[int] -
need_accept Блоки от которых ещё требуется согласование array[int] -
is_current_user_rejected Отклонил ли заявку текущий пользователь bool -
is_need_accept_next Текущий пользователь должен одобрить заявку bool -
history История array[request_history] -
can_accept Может ли текущий пользователь согласовать заявку bool -
can_accept_final Может ли текущий пользователь финально согласовать заявку bool -
can_edit Может ли текущий пользователь редактировать заявку bool -
can_paid Может ли текущий пользователь оплатить заявку bool -
can_progress Может ли текущий пользователь вернуть заявку в работу bool -
can_reject Может ли текущий пользователь отклонить заявку bool -
can_remove Может ли текущий пользователь удалить заявку bool -
finplan Дата финпланирования string -
sum Сумма заявки int -
sum_paid Оплаченная сумма заявки int -
currency_code Код валюты string -
name Название заявки string -
type Id типа транзакции int -
problem Описание проблемы string -
solution Описание решения string -
economic_justification Экономическое обоснование string -
status Статус заявки string progress/accept/reject/paid
author_id Id автора заявки string -
author_block_id Id блока автора заявки int -
last_accept_users Последний согласовавший сотрудник array -
last_accept_user_id Id последнего согласовавшего сотрудника string -
last_accept_block_id Id последнего согласовавшего блока int -
reject_user_id Id отклонившего сотрудника string -
reject_block_id Id отклонившего блока int -
reject_text Текст отклонения string -
modification_date Дата обновления date -
creation_date Дата создания date -
files Прикреплённые файлы array -

Ревью

GET /finplan/api/request/review

Метод позволяет согласовать, финально согласовать, отклонить или вернуть заявку в работу.

curl 'https://{HOST}.platrum.ru/finplan/api/request/review' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}' \ 
    --data '{"id":123,"blockId":123,"rejectText":"some_string","requestIds":[123,123],"reviewType":"some_string"}'

{
    "status": "success",
    "data": [
        {
            "id": 123,
            "user_final_accept_block": 123,
            "required_accept": [
                123,
                123
            ],
            "rejected_block": [
                123,
                123
            ],
            "progressed_blocks": [
                123,
                123
            ],
            "need_accept": [
                123,
                123
            ],
            "is_current_user_rejected": true,
            "is_need_accept_next": true,
            "history": [
                {
                    "id": 123,
                    "request_id": 123,
                    "author_id": "some_string",
                    "author_block_id": 123,
                    "type": "some_string",
                    "text": "some_string",
                    "creation_date": "2019-01-01 21:00:15"
                }
            ],
            "can_accept": true,
            "can_accept_final": true,
            "can_edit": true,
            "can_paid": true,
            "can_progress": true,
            "can_reject": true,
            "can_remove": true,
            "finplan": "some_string",
            "sum": 123,
            "sum_paid": 123,
            "currency_code": "some_string",
            "name": "some_string",
            "type": 123,
            "problem": "some_string",
            "solution": "some_string",
            "economic_justification": "some_string",
            "status": "some_string",
            "author_id": "some_string",
            "author_block_id": 123,
            "last_accept_users": "array",
            "last_accept_user_id": "some_string",
            "last_accept_block_id": 123,
            "reject_user_id": "some_string",
            "reject_block_id": 123,
            "reject_text": "some_string",
            "modification_date": "2019-01-01 21:00:15",
            "creation_date": "2019-01-01 21:00:15",
            "files": "array"
        },
        {
            "id": 123,
            "user_final_accept_block": 123,
            "required_accept": [
                123,
                123
            ],
            "rejected_block": [
                123,
                123
            ],
            "progressed_blocks": [
                123,
                123
            ],
            "need_accept": [
                123,
                123
            ],
            "is_current_user_rejected": true,
            "is_need_accept_next": true,
            "history": [
                {
                    "id": 123,
                    "request_id": 123,
                    "author_id": "some_string",
                    "author_block_id": 123,
                    "type": "some_string",
                    "text": "some_string",
                    "creation_date": "2019-01-01 21:00:15"
                }
            ],
            "can_accept": true,
            "can_accept_final": true,
            "can_edit": true,
            "can_paid": true,
            "can_progress": true,
            "can_reject": true,
            "can_remove": true,
            "finplan": "some_string",
            "sum": 123,
            "sum_paid": 123,
            "currency_code": "some_string",
            "name": "some_string",
            "type": 123,
            "problem": "some_string",
            "solution": "some_string",
            "economic_justification": "some_string",
            "status": "some_string",
            "author_id": "some_string",
            "author_block_id": 123,
            "last_accept_users": "array",
            "last_accept_user_id": "some_string",
            "last_accept_block_id": 123,
            "reject_user_id": "some_string",
            "reject_block_id": 123,
            "reject_text": "some_string",
            "modification_date": "2019-01-01 21:00:15",
            "creation_date": "2019-01-01 21:00:15",
            "files": "array"
        }
    ]
}
Параметр Описание Тип Значения
id ID int -
blockId Id блока, который производит ревью int -
rejectText Причина отклонения заявки string -
requestIds Id заявок, по которым производится ревью array[int] -
reviewType Тип ревью string accept/accept_final/reject/progress
Параметр Описание Тип Значения
id ID int -
user_final_accept_block Id блока, который финально согласовывает заявку int -
required_accept Id блоков, от которых требуется согласование заявки array[int] -
rejected_block Id блоков, которые ещё могут отклонить заявку array[int] -
progressed_blocks Id блоков, которые могут вернуть заявку в работу array[int] -
need_accept Блоки от которых ещё требуется согласование array[int] -
is_current_user_rejected Отклонил ли заявку текущий пользователь bool -
is_need_accept_next Текущий пользователь должен одобрить заявку bool -
history История array[request_history] -
can_accept Может ли текущий пользователь согласовать заявку bool -
can_accept_final Может ли текущий пользователь финально согласовать заявку bool -
can_edit Может ли текущий пользователь редактировать заявку bool -
can_paid Может ли текущий пользователь оплатить заявку bool -
can_progress Может ли текущий пользователь вернуть заявку в работу bool -
can_reject Может ли текущий пользователь отклонить заявку bool -
can_remove Может ли текущий пользователь удалить заявку bool -
finplan Дата финпланирования string -
sum Сумма заявки int -
sum_paid Оплаченная сумма заявки int -
currency_code Код валюты string -
name Название заявки string -
type Id типа транзакции int -
problem Описание проблемы string -
solution Описание решения string -
economic_justification Экономическое обоснование string -
status Статус заявки string progress/accept/reject/paid
author_id Id автора заявки string -
author_block_id Id блока автора заявки int -
last_accept_users Последний согласовавший сотрудник array -
last_accept_user_id Id последнего согласовавшего сотрудника string -
last_accept_block_id Id последнего согласовавшего блока int -
reject_user_id Id отклонившего сотрудника string -
reject_block_id Id отклонившего блока int -
reject_text Текст отклонения string -
modification_date Дата обновления date -
creation_date Дата создания date -
files Прикреплённые файлы array -

Оплата

POST /finplan/api/request/pay

Метод позволяет частично или полностью оплатить заявку.

curl 'https://{HOST}.platrum.ru/finplan/api/request/pay' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}' \ 
    --data '{"id":123,"full_payment":true,"payment_sum":123,"request_id":123}'

{
    "status": "success",
    "data": true
}
Параметр Описание Тип Значения
id ID int -
full_payment Оплатить заявку полностью bool -
payment_sum Сумма оплаты int -
request_id Id заявки int -

bool

Создание и обновление

POST /finplan/api/request/save

Метод позволяет создать новую или обновить существующую заявку.

curl 'https://{HOST}.platrum.ru/finplan/api/request/save' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}' \ 
    --data '{"id":123,"author_block_id":123,"can_edit":true,"economic_justification":"some_string","files":"array","finplan":"some_string","history":[{"id":123,"request_id":123,"author_id":"some_string","author_block_id":123,"type":"some_string","text":"some_string","creation_date":"2019-01-01 21:00:15"}],"name":"some_string","problem":"some_string","solution":"some_string","status":"some_string","sum":123,"type":123}'

{
    "status": "success",
    "data": {
        "id": 123,
        "user_final_accept_block": 123,
        "required_accept": [
            123,
            123
        ],
        "rejected_block": [
            123,
            123
        ],
        "progressed_blocks": [
            123,
            123
        ],
        "need_accept": [
            123,
            123
        ],
        "is_current_user_rejected": true,
        "is_need_accept_next": true,
        "history": [
            {
                "id": 123,
                "request_id": 123,
                "author_id": "some_string",
                "author_block_id": 123,
                "type": "some_string",
                "text": "some_string",
                "creation_date": "2019-01-01 21:00:15"
            }
        ],
        "can_accept": true,
        "can_accept_final": true,
        "can_edit": true,
        "can_paid": true,
        "can_progress": true,
        "can_reject": true,
        "can_remove": true,
        "finplan": "some_string",
        "sum": 123,
        "sum_paid": 123,
        "currency_code": "some_string",
        "name": "some_string",
        "type": 123,
        "problem": "some_string",
        "solution": "some_string",
        "economic_justification": "some_string",
        "status": "some_string",
        "author_id": "some_string",
        "author_block_id": 123,
        "last_accept_users": "array",
        "last_accept_user_id": "some_string",
        "last_accept_block_id": 123,
        "reject_user_id": "some_string",
        "reject_block_id": 123,
        "reject_text": "some_string",
        "modification_date": "2019-01-01 21:00:15",
        "creation_date": "2019-01-01 21:00:15",
        "files": "array"
    }
}
Параметр Описание Тип Значения
id ID int -
author_block_id Id блока автора заявки int -
can_edit Может ли текущий пользователь редактировать заявку bool -
economic_justification Экономическое обоснование string -
files Прикреплённые файлы array -
finplan Дата финпланирования string -
history История array[request_history] -
name Название заявки string -
problem Описание проблемы string -
solution Описание решения string -
status Статус заявки string progress/accept/reject/paid
sum Сумма заявки int -
type Id типа транзакции int -
Параметр Описание Тип Значения
id ID int -
user_final_accept_block Id блока, который финально согласовывает заявку int -
required_accept Id блоков, от которых требуется согласование заявки array[int] -
rejected_block Id блоков, которые ещё могут отклонить заявку array[int] -
progressed_blocks Id блоков, которые могут вернуть заявку в работу array[int] -
need_accept Блоки от которых ещё требуется согласование array[int] -
is_current_user_rejected Отклонил ли заявку текущий пользователь bool -
is_need_accept_next Текущий пользователь должен одобрить заявку bool -
history История array[request_history] -
can_accept Может ли текущий пользователь согласовать заявку bool -
can_accept_final Может ли текущий пользователь финально согласовать заявку bool -
can_edit Может ли текущий пользователь редактировать заявку bool -
can_paid Может ли текущий пользователь оплатить заявку bool -
can_progress Может ли текущий пользователь вернуть заявку в работу bool -
can_reject Может ли текущий пользователь отклонить заявку bool -
can_remove Может ли текущий пользователь удалить заявку bool -
finplan Дата финпланирования string -
sum Сумма заявки int -
sum_paid Оплаченная сумма заявки int -
currency_code Код валюты string -
name Название заявки string -
type Id типа транзакции int -
problem Описание проблемы string -
solution Описание решения string -
economic_justification Экономическое обоснование string -
status Статус заявки string progress/accept/reject/paid
author_id Id автора заявки string -
author_block_id Id блока автора заявки int -
last_accept_users Последний согласовавший сотрудник array -
last_accept_user_id Id последнего согласовавшего сотрудника string -
last_accept_block_id Id последнего согласовавшего блока int -
reject_user_id Id отклонившего сотрудника string -
reject_block_id Id отклонившего блока int -
reject_text Текст отклонения string -
modification_date Дата обновления date -
creation_date Дата создания date -
files Прикреплённые файлы array -

Копирование в новый период

GET /finplan/api/request/copy

Создаёт копии указанных заявок в выбранный период

curl 'https://{HOST}.platrum.ru/finplan/api/request/copy' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}' \ 
    --data '{"requests":"array[request_with_additional_params]","finplan":"some_string"}'

{
    "status": "success",
    "data": [
        {
            "id": 123,
            "user_final_accept_block": 123,
            "required_accept": [
                123,
                123
            ],
            "rejected_block": [
                123,
                123
            ],
            "progressed_blocks": [
                123,
                123
            ],
            "need_accept": [
                123,
                123
            ],
            "is_current_user_rejected": true,
            "is_need_accept_next": true,
            "history": [
                {
                    "id": 123,
                    "request_id": 123,
                    "author_id": "some_string",
                    "author_block_id": 123,
                    "type": "some_string",
                    "text": "some_string",
                    "creation_date": "2019-01-01 21:00:15"
                }
            ],
            "can_accept": true,
            "can_accept_final": true,
            "can_edit": true,
            "can_paid": true,
            "can_progress": true,
            "can_reject": true,
            "can_remove": true,
            "finplan": "some_string",
            "sum": 123,
            "sum_paid": 123,
            "currency_code": "some_string",
            "name": "some_string",
            "type": 123,
            "problem": "some_string",
            "solution": "some_string",
            "economic_justification": "some_string",
            "status": "some_string",
            "author_id": "some_string",
            "author_block_id": 123,
            "last_accept_users": "array",
            "last_accept_user_id": "some_string",
            "last_accept_block_id": 123,
            "reject_user_id": "some_string",
            "reject_block_id": 123,
            "reject_text": "some_string",
            "modification_date": "2019-01-01 21:00:15",
            "creation_date": "2019-01-01 21:00:15",
            "files": "array"
        },
        {
            "id": 123,
            "user_final_accept_block": 123,
            "required_accept": [
                123,
                123
            ],
            "rejected_block": [
                123,
                123
            ],
            "progressed_blocks": [
                123,
                123
            ],
            "need_accept": [
                123,
                123
            ],
            "is_current_user_rejected": true,
            "is_need_accept_next": true,
            "history": [
                {
                    "id": 123,
                    "request_id": 123,
                    "author_id": "some_string",
                    "author_block_id": 123,
                    "type": "some_string",
                    "text": "some_string",
                    "creation_date": "2019-01-01 21:00:15"
                }
            ],
            "can_accept": true,
            "can_accept_final": true,
            "can_edit": true,
            "can_paid": true,
            "can_progress": true,
            "can_reject": true,
            "can_remove": true,
            "finplan": "some_string",
            "sum": 123,
            "sum_paid": 123,
            "currency_code": "some_string",
            "name": "some_string",
            "type": 123,
            "problem": "some_string",
            "solution": "some_string",
            "economic_justification": "some_string",
            "status": "some_string",
            "author_id": "some_string",
            "author_block_id": 123,
            "last_accept_users": "array",
            "last_accept_user_id": "some_string",
            "last_accept_block_id": 123,
            "reject_user_id": "some_string",
            "reject_block_id": 123,
            "reject_text": "some_string",
            "modification_date": "2019-01-01 21:00:15",
            "creation_date": "2019-01-01 21:00:15",
            "files": "array"
        }
    ]
}
Параметр Описание Тип Значения
requests Заявки, которые нужно дублировать array[request_with_additional_params] -
finplan Дата финпланирования string -
Параметр Описание Тип Значения
id ID int -
user_final_accept_block Id блока, который финально согласовывает заявку int -
required_accept Id блоков, от которых требуется согласование заявки array[int] -
rejected_block Id блоков, которые ещё могут отклонить заявку array[int] -
progressed_blocks Id блоков, которые могут вернуть заявку в работу array[int] -
need_accept Блоки от которых ещё требуется согласование array[int] -
is_current_user_rejected Отклонил ли заявку текущий пользователь bool -
is_need_accept_next Текущий пользователь должен одобрить заявку bool -
history История array[request_history] -
can_accept Может ли текущий пользователь согласовать заявку bool -
can_accept_final Может ли текущий пользователь финально согласовать заявку bool -
can_edit Может ли текущий пользователь редактировать заявку bool -
can_paid Может ли текущий пользователь оплатить заявку bool -
can_progress Может ли текущий пользователь вернуть заявку в работу bool -
can_reject Может ли текущий пользователь отклонить заявку bool -
can_remove Может ли текущий пользователь удалить заявку bool -
finplan Дата финпланирования string -
sum Сумма заявки int -
sum_paid Оплаченная сумма заявки int -
currency_code Код валюты string -
name Название заявки string -
type Id типа транзакции int -
problem Описание проблемы string -
solution Описание решения string -
economic_justification Экономическое обоснование string -
status Статус заявки string progress/accept/reject/paid
author_id Id автора заявки string -
author_block_id Id блока автора заявки int -
last_accept_users Последний согласовавший сотрудник array -
last_accept_user_id Id последнего согласовавшего сотрудника string -
last_accept_block_id Id последнего согласовавшего блока int -
reject_user_id Id отклонившего сотрудника string -
reject_block_id Id отклонившего блока int -
reject_text Текст отклонения string -
modification_date Дата обновления date -
creation_date Дата создания date -
files Прикреплённые файлы array -

Удаление

POST /finplan/api/request/remove

Метод позволяет удалить заявку.

curl 'https://{HOST}.platrum.ru/finplan/api/request/remove' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}' \ 
    --data '{"requestIds":[123,123]}'

{
    "status": "success",
    "data": true
}
Параметр Описание Тип Значения
requestIds Id заявок, которые нужно удалить array[int] -

bool

Настройки

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

GET /finplan/api/settings/list

Метод позволяет получить список настроек.

curl 'https://{HOST}.platrum.ru/finplan/api/settings/list' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}'

{
    "status": "success",
    "data": {
        "id": 123,
        "manager_blocks": "array",
        "skip_blocks": "array",
        "creation_date": "2019-01-01 21:00:15",
        "second_level_is_visible": true
    }
}

Без параметров.

Параметр Описание Тип Значения
id ID int -
manager_blocks Должности которые финально утверждают заявки, учитывая порядок. Последним указывается та должность, кто финально принимает заявки. array -
skip_blocks Должности которые не должны отображаться в цепочке принятия заявок. array -
creation_date Дата создания date -
second_level_is_visible Cоздавать заявки только на самый верхний уровень категорий расхода. bool -

Создание

POST /finplan/api/settings/save

Метод позволяет создать настройки.

curl 'https://{HOST}.platrum.ru/finplan/api/settings/save' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}' \ 
    --data '{"id":123,"manager_blocks":"array","skip_blocks":"array","creation_date":"2019-01-01 21:00:15","second_level_is_visible":true}'

{
    "status": "success",
    "data": true
}
Параметр Описание Тип Значения
id ID int -
manager_blocks Должности которые финально утверждают заявки, учитывая порядок. Последним указывается та должность, кто финально принимает заявки. array -
skip_blocks Должности которые не должны отображаться в цепочке принятия заявок. array -
creation_date Дата создания date -
second_level_is_visible Cоздавать заявки только на самый верхний уровень категорий расхода. bool -

bool