21-11-2019 11:23

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

GET   /bs-core/main/contracts/{contractId}/balance/total/date/{date}

Метод возвращает балансовые остатки и общую сумму Итого по всем видам сумм без исключения.

Если нужно из Итого исключить дисконт и резервы, то в метод нужно передать дополнительный параметр "excludeReservesAndDiscountFromTotalAmount" со значением true. По умолчанию значение параметра "excludeReservesAndDiscountFromTotalAmount" равно false.

Запрос

GET /bs-core/main/contracts/10134803/balance/total/date/2018-01-15

или 

GET /bs-core/main/contracts/10134803/balance/total/date/2018-01-15?excludeReservesAndDiscountFromTotalAmount=true
Описание параметров
Параметр Обязателен Тип данных Описание
contractId R [int] Идентификатор контракта
date R [date] Дата на которую надо посчитать балансовые остатки. Дата в формате YYYY-MM-DD.

Ответ


                        {
    "status": "ok",
    "timestamp": 1516362634731,
    "data": [
        {
            "amountType": {
                "id": 101291,
                "name": "Основная",
                "account": null,
                "positiveBalance": true,
                "system": true,
                "repayable": true,
                "deletable": false
            },
            "issueDate": 1516362634730,
            "repaymentDate": 1516362634730,
            "inBalance": {
                "local": 4725,
                "foreign": 0
            },
            "outBalance": {
                "local": 0,
                "foreign": 0
            }
        },
        {
            "amountType": {
                "id": 101292,
                "name": "Процент",
                "account": null,
                "positiveBalance": true,
                "system": true,
                "repayable": true,
                "deletable": false
            },
            "issueDate": 1516362634730,
            "repaymentDate": 1516362634730,
            "inBalance": {
                "local": 142,
                "foreign": 0
            },
            "outBalance": {
                "local": 0,
                "foreign": 0
            }
        },
        {
            "amountType": {
                "id": 1012912,
                "name": "Дисконт",
                "account": null,
                "positiveBalance": null,
                "system": true,
                "repayable": false,
                "deletable": false
            },
            "issueDate": 1516362634730,
            "repaymentDate": 1516362634730,
            "inBalance": {
                "local": 1300,
                "foreign": 0
            },
            "outBalance": {
                "local": 0,
                "foreign": 0
            }
        },
        {
            "amountType": null,
            "issueDate": 1516362634730,
            "repaymentDate": 1516362634730,
            "inBalance": {
                "local": 4867,
                "foreign": 0
            },
            "outBalance": {
                "local": 0,
                "foreign": 0
            }
        }
    ]
}
                    
Описание параметров
Параметр Обязателен Тип данных Описание
amountType R [object] Объект с описанием вида суммы
amountType.id R [enum]

Идентификатор вида суммы

amountType.name R [string][50] Текстовое описание вида суммы (Соотвествия прописаны в параметре amountType.id)
amountType.account R [string][50] Счет по которому проводится этот вид сумм. В подавляющем большинстве случаев поле не заполняется.
amountType.positiveBalance R [bool] Признак того, что баланс по виду суммы - положительный (по нему не может быть начислений)
amountType.system R [bool] Признак того, что вид суммы является системным (если да - его нельзя удалять, использовать для коллекции сборов и т.п)
amountType.repayable R [bool] Признак того, является ли вид суммы погашаемым
amountType.deletable R [bool] Признак того, возможно ли удалять этот тип суммы
issueDate R [timestamp] Дата выдачи контракта, метка времени с миллисекундами
repaymentDate R [timestamp] Дата, по состоянию на которую считаются остатки в миллисекундах. Дата задается параметром запроса date
inBalance R [object] Сумма по балансу
inBalance.foreign R [float] Сумма в иностранной валюте (если есть мультивалютный учет). Если мультивалютный учет не используется - всегда 0.
inBalance.local R [float] Сумма в локальной валюте
outBalance R [object] Сумма "забаланс", при наличии забалансового учета.
outBalance.foreign R [float] Сумма в иностранной валюте (если есть мультивалютный учет). Если мультивалютный учет не используется - всегда 0.
outBalance.local R [float] Сумма в локальной валюте