26-08-2020 10:47

Метод получение балансовых остатков потраншно по видам сумм по кредитной линии

GET   bs-core/main/collateral-lines/{CollateralLineId}/balance/date/{date}

Метод позволяет получить балансовый остаток потраншно по видам сумм по кредитной линии. Если в запросе указать /date/yyyy-mm-dd , то получаем в ответе баланс на указанную дату.

Запрос

GET /bs-core/main/collateral-lines/43/balance

ИЛИ

GET /bs-core/main/collateral-lines/43/balance/date/2020-08-26
Описание параметров
Нет описанных параметров

Ответ


                        {
    "status": "ok",
    "timestamp": 1598428034690,
    "data": [
        {
            "amountType": {
                "id": 101291,
                "name": "Основная",
                "account": null,
                "positiveBalance": true,
                "system": true,
                "repayable": true,
                "deletable": false
            },
            "issueDate": "2020-08-14",
            "repaymentDate": "2020-09-14",
            "inBalance": {
                "local": 10413.99,
                "foreign": 0.0
            },
            "outBalance": {
                "local": 0.0,
                "foreign": 0.0
            },
            "byContracts": [
                {
                    "contractId": 699,
                    "inBalance": {
                        "local": 3672.96,
                        "foreign": 0.0
                    },
                    "outBalance": {
                        "local": 0.0,
                        "foreign": 0.0
                    }
                },
                {
                    "contractId": 701,
                    "inBalance": {
                        "local": 1468.28,
                        "foreign": 0.0
                    },
                    "outBalance": {
                        "local": 0.0,
                        "foreign": 0.0
                    }
                },
                {
                    "contractId": 702,
                    "inBalance": {
                        "local": 5272.75,
                        "foreign": 0.0
                    },
                    "outBalance": {
                        "local": 0.0,
                        "foreign": 0.0
                    }
                }
            ]
        },
        {
            "amountType": {
                "id": 101291,
                "name": "Основная",
                "account": null,
                "positiveBalance": true,
                "system": true,
                "repayable": true,
                "deletable": false
            },
            "issueDate": "2020-08-17",
            "repaymentDate": "2020-09-17",
            "inBalance": {
                "local": 1055.66,
                "foreign": 0.0
            },
            "outBalance": {
                "local": 0.0,
                "foreign": 0.0
            },
            "byContracts": [
                {
                    "contractId": 700,
                    "inBalance": {
                        "local": 1055.66,
                        "foreign": 0.0
                    },
                    "outBalance": {
                        "local": 0.0,
                        "foreign": 0.0
                    }
                }
            ]
        },
        {
            "amountType": {
                "id": 101291,
                "name": "Основная",
                "account": null,
                "positiveBalance": true,
                "system": true,
                "repayable": true,
                "deletable": false
            },
            "issueDate": "2020-09-14",
            "repaymentDate": "2020-10-14",
            "inBalance": {
                "local": 14738.19,
                "foreign": 0.0
            },
            "outBalance": {
                "local": 0.0,
                "foreign": 0.0
            },
            "byContracts": [
                {
                    "contractId": 699,
                    "inBalance": {
                        "local": 5274.85,
                        "foreign": 0.0
                    },
                    "outBalance": {
                        "local": 0.0,
                        "foreign": 0.0
                    }
                },
                {
                    "contractId": 701,
                    "inBalance": {
                        "local": 2108.76,
                        "foreign": 0.0
                    },
                    "outBalance": {
                        "local": 0.0,
                        "foreign": 0.0
                    }
                },
                {
                    "contractId": 702,
                    "inBalance": {
                        "local": 7354.58,
                        "foreign": 0.0
                    },
                    "outBalance": {
                        "local": 0.0,
                        "foreign": 0.0
                    }
                }
            ]
        },
        {
            "amountType": {
                "id": 101291,
                "name": "Основная",
                "account": null,
                "positiveBalance": true,
                "system": true,
                "repayable": true,
                "deletable": false
            },
            "issueDate": "2020-09-17",
            "repaymentDate": "2020-10-17",
            "inBalance": {
                "local": 1472.36,
                "foreign": 0.0
            },
            "outBalance": {
                "local": 0.0,
                "foreign": 0.0
            },
            "byContracts": [
                {
                    "contractId": 700,
                    "inBalance": {
                        "local": 1472.36,
                        "foreign": 0.0
                    },
                    "outBalance": {
                        "local": 0.0,
                        "foreign": 0.0
                    }
                }
            ]
        },
        {
            "amountType": {
                "id": 101291,
                "name": "Основная",
                "account": null,
                "positiveBalance": true,
                "system": true,
                "repayable": true,
                "deletable": false
            },
            "issueDate": "2020-10-14",
            "repaymentDate": "2020-11-14",
            "inBalance": {
                "local": 18211.16,
                "foreign": 0.0
            },
            "outBalance": {
                "local": 0.0,
                "foreign": 0.0
            },
            "byContracts": [
                {
                    "contractId": 699,
                    "inBalance": {
                        "local": 6446.78,
                        "foreign": 0.0
                    },
                    "outBalance": {
                        "local": 0.0,
                        "foreign": 0.0
                    }
                },
                {
                    "contractId": 701,
                    "inBalance": {
                        "local": 2577.16,
                        "foreign": 0.0
                    },
                    "outBalance": {
                        "local": 0.0,
                        "foreign": 0.0
                    }
                },
                {
                    "contractId": 702,
                    "inBalance": {
                        "local": 9187.22,
                        "foreign": 0.0
                    },
                    "outBalance": {
                        "local": 0.0,
                        "foreign": 0.0
                    }
                }
            ]
        },
        {
            "amountType": {
                "id": 101291,
                "name": "Основная",
                "account": null,
                "positiveBalance": true,
                "system": true,
                "repayable": true,
                "deletable": false
            },
            "issueDate": "2020-10-17",
            "repaymentDate": "2020-11-17",
            "inBalance": {
                "local": 1839.35,
                "foreign": 0.0
            },
            "outBalance": {
                "local": 0.0,
                "foreign": 0.0
            },
            "byContracts": [
                {
                    "contractId": 700,
                    "inBalance": {
                        "local": 1839.35,
                        "foreign": 0.0
                    },
                    "outBalance": {
                        "local": 0.0,
                        "foreign": 0.0
                    }
                }
            ]
        },
        {
            "amountType": {
                "id": 101291,
                "name": "Основная",
                "account": null,
                "positiveBalance": true,
                "system": true,
                "repayable": true,
                "deletable": false
            },
            "issueDate": "2020-11-14",
            "repaymentDate": "2020-12-14",
            "inBalance": {
                "local": 24622.99,
                "foreign": 0.0
            },
            "outBalance": {
                "local": 0.0,
                "foreign": 0.0
            },
            "byContracts": [
                {
                    "contractId": 699,
                    "inBalance": {
                        "local": 8791.34,
                        "foreign": 0.0
                    },
                    "outBalance": {
                        "local": 0.0,
                        "foreign": 0.0
                    }
                },
                {
                    "contractId": 701,
                    "inBalance": {
                        "local": 3514.54,
                        "foreign": 0.0
                    },
                    "outBalance": {
                        "local": 0.0,
                        "foreign": 0.0
                    }
                },
                {
                    "contractId": 702,
                    "inBalance": {
                        "local": 12317.11,
                        "foreign": 0.0
                    },
                    "outBalance": {
                        "local": 0.0,
                        "foreign": 0.0
                    }
                }
            ]
        },
        {
            "amountType": {
                "id": 101291,
                "name": "Основная",
                "account": null,
                "positiveBalance": true,
                "system": true,
                "repayable": true,
                "deletable": false
            },
            "issueDate": "2020-11-17",
            "repaymentDate": "2020-12-17",
            "inBalance": {
                "local": 2465.87,
                "foreign": 0.0
            },
            "outBalance": {
                "local": 0.0,
                "foreign": 0.0
            },
            "byContracts": [
                {
                    "contractId": 700,
                    "inBalance": {
                        "local": 2465.87,
                        "foreign": 0.0
                    },
                    "outBalance": {
                        "local": 0.0,
                        "foreign": 0.0
                    }
                }
            ]
        },
        {
            "amountType": {
                "id": 101291,
                "name": "Основная",
                "account": null,
                "positiveBalance": true,
                "system": true,
                "repayable": true,
                "deletable": false
            },
            "issueDate": "2020-12-14",
            "repaymentDate": "2021-01-14",
            "inBalance": {
                "local": 31504.53,
                "foreign": 0.0
            },
            "outBalance": {
                "local": 0.0,
                "foreign": 0.0
            },
            "byContracts": [
                {
                    "contractId": 699,
                    "inBalance": {
                        "local": 11170.6,
                        "foreign": 0.0
                    },
                    "outBalance": {
                        "local": 0.0,
                        "foreign": 0.0
                    }
                },
                {
                    "contractId": 701,
                    "inBalance": {
                        "local": 4465.59,
                        "foreign": 0.0
                    },
                    "outBalance": {
                        "local": 0.0,
                        "foreign": 0.0
                    }
                },
                {
                    "contractId": 702,
                    "inBalance": {
                        "local": 15868.34,
                        "foreign": 0.0
                    },
                    "outBalance": {
                        "local": 0.0,
                        "foreign": 0.0
                    }
                }
            ]
        },
        {
            "amountType": {
                "id": 101291,
                "name": "Основная",
                "account": null,
                "positiveBalance": true,
                "system": true,
                "repayable": true,
                "deletable": false
            },
            "issueDate": "2020-12-17",
            "repaymentDate": "2021-01-17",
            "inBalance": {
                "local": 3166.76,
                "foreign": 0.0
            },
            "outBalance": {
                "local": 0.0,
                "foreign": 0.0
            },
            "byContracts": [
                {
                    "contractId": 700,
                    "inBalance": {
                        "local": 3166.76,
                        "foreign": 0.0
                    },
                    "outBalance": {
                        "local": 0.0,
                        "foreign": 0.0
                    }
                }
            ]
        },
        {
            "amountType": {
                "id": 101291,
                "name": "Основная",
                "account": null,
                "positiveBalance": true,
                "system": true,
                "repayable": true,
                "deletable": false
            },
            "issueDate": "2021-01-14",
            "repaymentDate": "2021-02-14",
            "inBalance": {
                "local": 20509.14,
                "foreign": 0.0
            },
            "outBalance": {
                "local": 0.0,
                "foreign": 0.0
            },
            "byContracts": [
                {
                    "contractId": 699,
                    "inBalance": {
                        "local": 14643.47,
                        "foreign": 0.0
                    },
                    "outBalance": {
                        "local": 0.0,
                        "foreign": 0.0
                    }
                },
                {
                    "contractId": 701,
                    "inBalance": {
                        "local": 5865.67,
                        "foreign": 0.0
                    },
                    "outBalance": {
                        "local": 0.0,
                        "foreign": 0.0
                    }
                }
            ]
        }
    ]
}
                    
Описание параметров
Параметр Обязателен Тип данных Описание
amountType М [object]

Объект с описанием вида суммы

amountType.id М [enum]

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

amountType.name М [string]

Текстовое описание вида суммы (Соотвествия прописаны в параметре amountType.id)

amountType.account М [string]

Счет по которому проводится этот вид сумм. В подавляющем большинстве случаев поле не заполняется.

amountType.positiveBalance М [bool]

Признак того, что баланс по виду суммы - положительный (по нему не может быть начислений)

amountType.system М [bool]

Признак того, что вид суммы является системным (если да - его нельзя удалять, использовать для коллекции сборов и т.п)

amountType.repayable М [bool]

Признак того, является ли вид суммы погашаемым

amountType.deletable М [bool]

Признак того, возможно ли удалять этот тип суммы

issueDate М [timestamp]

Дата выдачи контракта, метка времени с миллисекундами

repaymentDate М [timestamp]

Дата, по состоянию на которую считаются остатки в миллисекундах. Дата задается параметром запроса date

inBalance М [float]

Сумма по балансу

inBalance.foreign М [float]

Сумма в иностранной валюте (если есть мультивалютный учет). Если мультивалютный учет не используется - всегда 0.

inBalance.local М [float]

Сумма в локальной валюте

outBalance М [object]

Сумма "забаланс", при наличии забалансового учета.

outBalance.foreign М [float]

Сумма в иностранной валюте (если есть мультивалютный учет). Если мультивалютный учет не используется - всегда 0.

outBalance.local М [float]

Сумма в локальной валюте