Документация Связаться с нами Стать разработчиком Мегаплана

Финансы

Список счетов

URI: /BumsFinApiV01/RealAccount/list.api|xml

Поле Тип Описание
Id integer Код метки
Name string Название
Currency object(Id, Name) Валюта
Account object(Id, Name) Счет
Debit integer Дебит
Credit integer Кредит
Balance integer Баланс
Category object(Id, Name) Категория

Выходные данные

{
    "status": {
        "code": "ok",
        "message": null
    },
    "data": {
        "items": [
            {
                "Id": 1,
                "Name": "Счёт в банке",
                "Currency": {
                    "Id": 1,
                    "Name": "Рубли"
                },
                "Account": {
                    "Id": 11,
                    "Name": "Расчётный счёт"
                },
                "Debit": "12312",
                "Credit": "111.11",
                "Balance": "12200.89",
                "OperatorsSelector": "all",
                "Category": {
                    "Id": 1000011,
                    "Name": "Расчётный счёт"
                }
            }
            ...
        ]
    }
}

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

URI: /BumsFinApiV01/OperationType/list.api|xml

Поле Тип Описание
Id integer ID типа операции
Name string Название типа операции

Выходные данные

{
    "status": {
        "code": "ok",
        "message": null
    },
    "data": {
        "OperationTypes": [
            {
                "Id": 1,
                "Name": "Дать в долг"
            },
            {
                "Id": 2,
                "Name": "Закупка товара"
            },
            {
                "Id": 3,
                "Name": "Капвложение"
            },
            {
                "Id": 4,
                "Name": "Операционный расход"
            }
            ...
        ]
    }
}

Список операций

URI: /BumsFinApiV01/Operation/list.api|xml

Выходные данные

{
    "status": {
        "code": "ok",
        "message": null
    },
    "data": {
        "items": [
            {
                "Id": 1,
                "Number": "1",
                "Sum": {
                    "Value": 12312,
                    "Currency": "руб.",
                    "CurrencyId": 1,
                    "CurrencyAbbreviation": "RUR",
                    "Rate": 1
                },
                "Date": "2016-11-29 18:44:00",
                "SecondarySum": {
                    "Value": 0,
                    "Currency": "руб.",
                    "CurrencyId": 1,
                    "CurrencyAbbreviation": "RUR",
                    "Rate": 1
                },
                "Status": "opened",
                "Description": "",
                "ControlDate": "2016-11-10",
                "RealAccount": {
                    "Id": 1,
                    "Name": "Счёт в банке"
                },
                "Contractor": {
                    "Id": 1000001,
                    "Name": "ООО \"Наша Компания\""
                },
                "State": "completed",
                "TimeCreated": "2016-11-29 18:44:47",
                "TimeUpdated": "2016-11-29 19:00:25",
                "UserCreated": {
                    "Id": 1000075,
                    "Name": "User Name"
                },
                "UserUpdated": {
                    "Id": 1000075,
                    "Name": "User Name"
                },
                "Transactions": [
                    {
                        "Id": 1
                    }
                ],
                "FinBalance": "-12200.89",
                "Kind": "income",
                "OperationType": {
                    "Id": 9,
                    "Name": "Нам отдали долг"
                },
                "Balance": "-12312",
                "ComBalance": "0",
                "DocumentNumber": "",
                "FullNumber": "P291116001",
                "Category": {
                    "Id": 1000017,
                    "Name": "Operation"
                }
            }
            ...
        ]
    }
}

Карточка операции

URI: /BumsFinApiV01/Operation/card.api|xml

Входные данные

Параметр Тип Описание
Id integer ID операции

Выходные данные

{
    "status": {
        "code": "ok",
        "message": null
    },
    "data": {
        "item": {
            "Id": 2,
            "Number": "2",
            "Sum": {
                "Value": 111.11,
                "Currency": "руб.",
                "CurrencyId": 1,
                "CurrencyAbbreviation": "RUR",
                "Rate": 1
            },
            "Date": "2016-11-29 19:00:00",
            "SecondarySum": {
                "Value": 0,
                "Currency": "руб.",
                "CurrencyId": 1,
                "CurrencyAbbreviation": "RUR",
                "Rate": 1
            },
            "Status": "closed",
            "Description": "",
            "ControlDate": "2016-11-29",
            "RealAccount": {
                "Id": 1,
                "Name": "Счёт в банке"
            },
            "Contractor": {
                "Id": 1000001,
                "Name": "ООО \"Наша Компания\""
            },
            "State": "completed",
            "TimeCreated": "2016-11-29 19:00:25",
            "TimeUpdated": "2016-11-29 19:00:25",
            "UserCreated": {
                "Id": 1000075,
                "Name": "User Name"
            },
            "UserUpdated": {
                "Id": 1000075,
                "Name": "User Name"
            },
            "Transactions": [{
                "Id": 2
            }],
            "FinBalance": "0",
            "Kind": "expense",
            "OperationType": {
                "Id": 5,
                "Name": "Погашение долгов"
            },
            "Balance": "111.11",
            "ComBalance": "0",
            "DocumentNumber": "",
            "FullNumber": "C291116002",
            "Category": {
                "Id": 1000017,
                "Name": "Operation"
            }
        }
    }
}

Создание/редактирование операции

URI: /BumsFinApiV01/Operation/save.api|xml

Входные данные

Параметр Тип Описание Примечание
Id integer ID операции Если не указан, то будет создана новая операция
Model[OperationType] integer ID типа операции  
Model[Sum] object(Value, Currency) Сумма  
Model[SecondarySum] object(Value, Currency) Дополнительная сумма  
Model[RealAccount] integer ID расчетного счета  
Model[Contractor] integer ID клиента  
Model[Invoice] integer ID счета  
Model[Date] datetime Время операции  
Model[ControlDate] datetime Контрольное время  

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

URI: /BumsFinApiV01/Operation/delete.api|xml

Входные данные

Параметр Тип Описание
Id integer ID операции