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

Финансовые транзакции

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

Транзакции

Создание

POST /fintransaction/api/transaction/create

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

curl 'https://{HOST}.platrum.ru/fintransaction/api/transaction/create' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}' \ 
    --data '{"type":"some_string","sum":123,"cashbox_id":123,"sum_charge":123,"sum_topup":123,"cashbox_id_charge":123,"cashbox_id_topup":123,"description":"some_string","user_id":"some_string","category_id":123,"project_id":123,"linked_transaction_id":123,"data":"map"}'
{
    "status": "success",
    "data": {
        "id": 123,
        "sum": 123,
        "cashbox_id": 123,
        "sum_charge": 123,
        "sum_topup": 123,
        "cashbox_id_charge": 123,
        "cashbox_id_topup": 123,
        "description": "some_string",
        "user_id": "some_string",
        "category_id": 123,
        "project_id": 123,
        "linked_transaction_id": 123,
        "data": "map",
        "creation_date": "2019-01-01 21:00:15",
        "update_date": "2019-01-01 21:00:15",
        "report_date": "2019-01-01 21:00:15",
        "delete_date": "2019-01-01 21:00:15"
    }
}
Параметр Описание Тип Значения
type Тип транзакций string in/out/move
sum Сумма (только для транзакций дохода и расхода) int -
cashbox_id ID кассы (только для транзакций дохода и расхода) int -
sum_charge Сумма списания (только для транзакций перемещения) int -
sum_topup Сумма пополнения (только для транзакций перемещения) int -
cashbox_id_charge ID кассы списания (только для транзакций перемещения) int -
cashbox_id_topup ID кассы пополнения (только для транзакций перемещения) int -
description Описание string -
user_id ID автора string -
category_id ID категории int -
project_id ID проекта int -
linked_transaction_id ID связанной транзакции (только для удаленной транзакции) int -
data Дополнительные данные map -
Параметр Описание Тип Значения
id int -
sum Сумма (только для транзакций дохода и расхода) int -
cashbox_id ID кассы (только для транзакций дохода и расхода) int -
sum_charge Сумма списания (только для транзакций перемещения) int -
sum_topup Сумма пополнения (только для транзакций перемещения) int -
cashbox_id_charge ID кассы списания (только для транзакций перемещения) int -
cashbox_id_topup ID кассы пополнения (только для транзакций перемещения) int -
description Описание string -
user_id ID автора string -
category_id ID категории int -
project_id ID проекта int -
linked_transaction_id ID связанной транзакции (только для удаленной транзакции) int -
data Дополнительные данные map -
creation_date Дата создания date -
update_date Дата обновления date -
report_date Дата отчета date -
delete_date Дата удаления date -

Обновление

POST /fintransaction/api/transaction/update

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

curl 'https://{HOST}.platrum.ru/fintransaction/api/transaction/update' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}' \ 
    --data '{"type":"some_string","sum":123,"cashbox_id":123,"sum_charge":123,"sum_topup":123,"cashbox_id_charge":123,"cashbox_id_topup":123,"description":"some_string","user_id":"some_string","category_id":123,"project_id":123,"linked_transaction_id":123,"data":"map"}'
{
    "status": "success",
    "data": {
        "id": 123,
        "sum": 123,
        "cashbox_id": 123,
        "sum_charge": 123,
        "sum_topup": 123,
        "cashbox_id_charge": 123,
        "cashbox_id_topup": 123,
        "description": "some_string",
        "user_id": "some_string",
        "category_id": 123,
        "project_id": 123,
        "linked_transaction_id": 123,
        "data": "map",
        "creation_date": "2019-01-01 21:00:15",
        "update_date": "2019-01-01 21:00:15",
        "report_date": "2019-01-01 21:00:15",
        "delete_date": "2019-01-01 21:00:15"
    }
}
Параметр Описание Тип Значения
type Тип транзакций string in/out/move
sum Сумма (только для транзакций дохода и расхода) int -
cashbox_id ID кассы (только для транзакций дохода и расхода) int -
sum_charge Сумма списания (только для транзакций перемещения) int -
sum_topup Сумма пополнения (только для транзакций перемещения) int -
cashbox_id_charge ID кассы списания (только для транзакций перемещения) int -
cashbox_id_topup ID кассы пополнения (только для транзакций перемещения) int -
description Описание string -
user_id ID автора string -
category_id ID категории int -
project_id ID проекта int -
linked_transaction_id ID связанной транзакции (только для удаленной транзакции) int -
data Дополнительные данные map -
Параметр Описание Тип Значения
id int -
sum Сумма (только для транзакций дохода и расхода) int -
cashbox_id ID кассы (только для транзакций дохода и расхода) int -
sum_charge Сумма списания (только для транзакций перемещения) int -
sum_topup Сумма пополнения (только для транзакций перемещения) int -
cashbox_id_charge ID кассы списания (только для транзакций перемещения) int -
cashbox_id_topup ID кассы пополнения (только для транзакций перемещения) int -
description Описание string -
user_id ID автора string -
category_id ID категории int -
project_id ID проекта int -
linked_transaction_id ID связанной транзакции (только для удаленной транзакции) int -
data Дополнительные данные map -
creation_date Дата создания date -
update_date Дата обновления date -
report_date Дата отчета date -
delete_date Дата удаления date -

Удаление

POST /fintransaction/api/transaction/delete

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

curl 'https://{HOST}.platrum.ru/fintransaction/api/transaction/delete' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}' \ 
    --data '{"ids":"int[]","type":"some_string"}'
{
    "status": "success",
    "data": true
}
Параметр Описание Тип Значения
ids Id удаляемых транзакций int[] -
type Тип транзакций string in/out/move

bool

Типы транзакций

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

GET /fintransaction/api/category/list

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

curl 'https://{HOST}.platrum.ru/fintransaction/api/category/list' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}'
{
    "status": "success",
    "data": [
        {
            "id": 123,
            "name": "some_string",
            "transaction_type": "some_string",
            "block_id": 123,
            "parent_id": 123,
            "is_archived": true,
            "last_editor_id": "some_string",
            "author_id": "some_string",
            "creation_date": "2019-01-01 21:00:15"
        },
        {
            "id": 123,
            "name": "some_string",
            "transaction_type": "some_string",
            "block_id": 123,
            "parent_id": 123,
            "is_archived": true,
            "last_editor_id": "some_string",
            "author_id": "some_string",
            "creation_date": "2019-01-01 21:00:15"
        }
    ]
}

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

Параметр Описание Тип Значения
id ID int -
name Название категории string -
transaction_type Тип транзакций string -
block_id Id блока int -
parent_id Id родительского типа int -
is_archived Является ли архивной bool -
last_editor_id Id последнего редактора string -
author_id Id автора string -
creation_date Дата создания date -

Создание

POST /fintransaction/api/category/create

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

curl 'https://{HOST}.platrum.ru/fintransaction/api/category/create' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}' \ 
    --data '{"id":123,"transaction_type":"some_string","name":"some_string","block_id":123,"parent_id":123}'
{
    "status": "success",
    "data": {
        "id": 123,
        "name": "some_string",
        "transaction_type": "some_string",
        "block_id": 123,
        "parent_id": 123,
        "is_archived": true,
        "last_editor_id": "some_string",
        "author_id": "some_string",
        "creation_date": "2019-01-01 21:00:15"
    }
}
Параметр Описание Тип Значения
id ID int -
transaction_type Тип транзакций string -
name Название типа string -
block_id Id блока int -
parent_id Id родительского типа int -
Параметр Описание Тип Значения
id ID int -
name Название категории string -
transaction_type Тип транзакций string -
block_id Id блока int -
parent_id Id родительского типа int -
is_archived Является ли архивной bool -
last_editor_id Id последнего редактора string -
author_id Id автора string -
creation_date Дата создания date -

Обновление

POST /fintransaction/api/category/update

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

curl 'https://{HOST}.platrum.ru/fintransaction/api/category/update' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}' \ 
    --data '{"id":123,"name":"some_string","block_id":123,"parent_id":123}'
{
    "status": "success",
    "data": {
        "id": 123,
        "name": "some_string",
        "transaction_type": "some_string",
        "block_id": 123,
        "parent_id": 123,
        "is_archived": true,
        "last_editor_id": "some_string",
        "author_id": "some_string",
        "creation_date": "2019-01-01 21:00:15"
    }
}
Параметр Описание Тип Значения
id ID int -
name Название типа string -
block_id Id блока int -
parent_id Id родительского типа int -
Параметр Описание Тип Значения
id ID int -
name Название категории string -
transaction_type Тип транзакций string -
block_id Id блока int -
parent_id Id родительского типа int -
is_archived Является ли архивной bool -
last_editor_id Id последнего редактора string -
author_id Id автора string -
creation_date Дата создания date -

Удаление

POST /fintransaction/api/category/archive

Метод позволяет удалить (или заархивировать, при наличии транзакций этого типа) существующий тип транзакций.

curl 'https://{HOST}.platrum.ru/fintransaction/api/category/archive' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}' \ 
    --data '{"id":123,"name":"some_string","block_id":123,"parent_id":123}'
{
    "status": "success",
    "data": true
}
Параметр Описание Тип Значения
id ID int -
name Название типа string -
block_id Id блока int -
parent_id Id родительского типа int -

bool