---
# System prepended metadata

title: Получение списка договоров клиента
tags: [arithmetic-integration, tranche]

---

---
tags: arithmetic-integration,tranche
title: Получение списка договоров клиента
---

# Получение списка договоров клиента

Получает все договоры клиента по совокупности номера телефона и даты рождения. Если передан также паспорт, то для поиска используется именно паспорт.
Если клиент найден - возвращает все найденные договоры и данные платежей по ним, иначе - пустой список json.

## 1. Запрос выполнения операции

### Request --->

#### URL:
Стандартный, [см. шаблон обращения](/NIkubqRkR5STebBQd8690g?book#URL)

#### Headers:
* **apikey**: ==[apikey](/NIkubqRkR5STebBQd8690g?both#URL)==
* **Content-type**: application/json; charset=utf-8
* **Mq-Jrb-Exchange**: PersonalAccount
* **Mq-Jrb-Routing-key**: account
* **Mq-Jrb-Operation**: PersonContracts
* **Mq-Jrb-Object**: ==phone==

:::info
:::spoiler Описание полей
==phone==: номер телефона клиента, 10 цифр, без "+7" или "8"
:::

#### Body:
```json
{
    "personal_account": "XXXXXXXXX",
    "surname": "Фамилия",
    "name": "Имя",
    "patronymic": "Отчество",
    "gender": "мужской"/"женский",
    "passport_series": "1234",
    "passport_number": "123456",
    "phone": "9999999999",
    "birthdate": "yyyy-MM-dd"
}
```

:::info
:::spoiler Описание полей
- **personal_account**: принадлежность личного кабинета(lk_arifmetika, lk_give_money)
- **gender**: пол, 2 варианта:
    - "мужской"
    - "женский"
- **passport_series**: серия паспорта РФ, строка, 4 цифр
- **passport_number**: номер паспорта РФ, строка, 6 цифр
- **phone**: номер телефона, строка, 10 цифр, без "+7" или "8"
- **birthdate**: дата рождения, строка даты в формате ISO
:warning: Сочетания минимальных наборов:
    - **phone** + **birthdate**
    - **passport_series** + **passport_number** + **birthdate**
Однако желательны все поля
:::

:::success
:::spoiler Пример
```json
{
    "personal_account": "lk_arifmetika",
    "surname": "Иванов",
    "name": "Пётр",
    "patronymic": "Сидорович",
    "gender": "мужской",
    "passport_series": "1234",
    "passport_number": "123456",
    "phone": "9131234567",
    "birthdate": "1985-12-01"
}
```
:::

---
### Response <---

Стандартный, [см. шаблон обращения](/NIkubqRkR5STebBQd8690g?view#Response-lt—)

---

## 2. Получение результата

### Request --->
Стандартный, [см. шаблон обращения](/NIkubqRkR5STebBQd8690g?view#URL1)

### Response <---

#### Headers:
* **Content-type**: application/json; charset=utf-8
* **Mq-Jrb-Id**: ==[id](/NIkubqRkR5STebBQd8690g?view#Headers3)==
* **Mq-Jrb-Id-Result**: ==[id-result](/NIkubqRkR5STebBQd8690g?view#Headers3)==

#### Body:
```json=
{
    "contracts_restruct":
        [
            {
                "contract_num": "А99АААА999999999",
                "restructuring_relevance_date": "yyyy-MM-dd",
                "restructuring_status": "НаПроверке",
                "restructuring_id": "d6f0d95c-57e2-421a-8251-be659399c200",
                "restructuring_num": "БОНвОР00530000000001"
            },
            ...
        ],
    "contracts":
        [
            {
                "type": "Installments"/"СonsumerLoan"/"IndividualOffer"/"Partner"/"TargetLoan",
                "base_source": "xxxxxxxxxxxx",
                "contract_num": "А99АААА999999999",
                "contract_date": "yyyy-MM-dd",
                "contract_sum": 999999.00,
                "payment_receiver": "999999999999",
                "status": "хххххххххххххх",
                "categories": [
                    "tranche",
                    "transfer"
                ],
                "tranche": {
                  "available_number": 5,
                  "available_at": "yyyy-MM-dd", 
                  "term": "",
                  "sum": 999999.00,
                  "rate_daily": 9.00,
                  "rate_annual": 999.00,
                  "tranche_num": "хххххххххххххх",
                  "status": "process"/"overdue"/"suspended"/"available",
                  "insurance_available": true/false
                },
                "transfer": {
                    "type": "ОтказЗачисленияПроцессингом",
                    "description": "Недостаточно средств на счете",
                    "available_actions": [
                        "cancellation"
                    ]
                },
                "repay_before": "yyyy-MM-dd",
                "repayment_date": "yyyy-MM-dd",
                "penalty": 999999.00,
                "total_balance": 999999.00,
                "main_debt_balance": 999999.00,
                "interest_balance": 999999.00,
                "total_overdue": 999999.00,
                "main_debt_overdue": 999999.00,
                "interest_overdue": 999999.00,
                "date_planned_payment": "yyyy-MM-dd",
                "total_planned_payment": 999999.00,
                "main_debt_planned_payment": 999999.00,
                "interest_planned_payment": 999999.00,
                "interest_planned_payment_today": 999999.00,
                "total_today_sum": 999999.00
            },
            ...
        ],
    "payment_systems"{
        "pays":{
            "Инн организации": {
                "system":"xxxxxx",
                "bank_code":"xxxxxx"
            },
            ...
        },
        "loans":"xxxxx"
    }
```

:::info
:::spoiler Описание полей
Договоры по которым существуют актуальные заявки на реструктуризацию
- **contract_num**: номер договора, строка до 20 символов
- **restructuring_relevance_date**: дата актуальности заявки, до истечения которой локумент должен быть пописан клиентом, строка даты в формате ISO
- **restructuring_status**: статус заявки на реструктуризацию, строка
- **restructuring_id**: уникальный идентификатор документа "заявка на реструктуризацию", строка 36 символов
- **restructuring_num**: номер заявки, строка до 20 символов


Выданным договор считается со статусами: active,completed,expired

- **type**: тип договора, строка, допустимые значения:
    - "Installments": рассрочка
    - "СonsumerLoan": потребительский займ
    - "IndividualOffer": индивидуальное предложение
    - "Partner": договор партнёрства
    - "TargetLoan": целевой займ
- **base_source**: база источник, строка до 20 символов
- **contract_num**: номер договора, строка до 20 символов
- **contract_date**: дата договора, строка даты в формате ISO
- **contract_sum**: исходная сумма договора (:warning:без учёта обменов/возвратов, если это договор рассрочки), число (15,2)
- **payment_receiver**: ИНН организации получателя платежа, строка(12), потребуется при отправке оплаты
- **status**: текущий статус исполнения договора, допустимые значения:
    - "in_process": заявка в процессе оформления (доступно продолжение в паре с categories.site_contract, без него неактивный, так как дооформлять можно только договора созданные в ЛКК) для торговых точек стоит ввести отдельную категорию для отображения с пояснением по обращению в ТТ для продолжения оформления
    - "client_rejection": отказ со стороны клиента (статус "Отказан" в Рассрочке)
    - "denied": отказ со стороны компании (статус "Скоринг: отказано", "Скоринг: отказано сотрудником", "Не согласован")
    - "active": действующий, непогашенный подписанный и выданный договор
    - "completed": закрыт, исполнен; подписанный выданный договор с остатком <= 0
    - "expired": просроченный; подписанный выданный договор с остатком > 0 и имеющейся текущей просроченной задолженностью
    - "transfer_process": Договор находится в стадии перечисления денежных средств
    - "transfer_not_success": перевод денежных средств прошел неудачно, требуются действия от пользователя
    - "latent": cкрытый, внешне не проявляющийся.
    - "on_check": договор на согласовании.(можно не ориентироваться на категорию, так как это состояние не имеет действий и будет отображаться с каким-то пояснением согласно ТЗ)

- **categories** - список категорий, к которым относится договор, может быть пустым или отсутствовать вОвсе, если договор не относится ни к какой категории; допустимы следующие значений категорий:
    - "tranche" - признак, что данный договор является траншем,
    - "site_contract" - признак, что данный договор оформлен в ЛК(не транш)
    - "site_contract_cc" - признак, что данный договор оформлен в ЛК через КЦ(не транш)
    - "transfer" - признак, стадия выдачи займа
 - **transfer**: набор данных по оформлению договора на стадии выдачи
    - **type**: тип ошибки выдачи(дополнительный параметр, служебный)
    - **description-error**: описание (дополнительный параметр, служебный),
    - **description**: описание ситуации для надписи в списке договоров,
    - **available_actions**: доступные действия для договора
         - **cancellation**: отмена договора
         - **change_card**: смена карты
- **tranche** - набор настроек для транша,:warning: присутствует в договорах займа и предложениях имеющих возможность оформления повторного займа или оформления транша по предложению 
    - **available_number**: количество доступных траншей по предложению (Число),
    - **available_at**: транши доступны до (тип дата), 
    - **term**: срок действия транша - условие транша (Строка),
    - **sum**: сумма транша - условие транша (Число),
    - **rate_daily**: процентная ставка транша в день - условие транша (Число),
    - **rate_annual**: годовая процентная ставка транша - условие транша (Число),
    - **tranche_num**: номер оформляемого транша,
    - **insurance_available**: признак наличия у оформляемого транша страховки,
    - **status**: статус предложения (Строка): 
      - "process" - в процессе оформления (возможны: активное продолжение оформления и отмена), 
      - "overdue" - просроченный (возможны: отмена), 
      - "suspended" - отложенный,так как оформлляется транш по другому предложению (возможны: неактивное отображение кнопки по получению займа), 
      - "available" - доступный для оформления (возможны: активное получение займа).
- **repay_before**: "Вернуть до", плановая дата последнего платежа платежа по договору, для погашенного договора будет пустой - равна ""
- **repayment_date**: "Дата погашения", дата фактического погашения договора - день, когда полная задолженность по договору стала менее или равна 0, для открытого договора пустая - равна ""
- **penalty**: сумма штрафов по договору на сегодня, число (15,2); :warning:включает только штрафы/пени/госпошлину
- **total_balance**: *полный* остаток задолженности по договору (основной долг, проценты, штрафы и прочие виды задолженности на текущую дату), число (15,2), состоит из сумм:
    - **main_debt_balance**: остаток осн. долга на сегодня
    - **interest_balance**: остаток процентов на сегодня
    - **penalty**: см. выше
- **total_overdue**: текущая просроченная задолженность на сегодня;:warning: включает *только* просроченные осн. долг, проценты, штрафы; НЕ включает *никакие* плановые суммы, число (15,2), состоит из сумм:
    - **main_debt_overdue**: просроченный осн. долг на сегодня
    - **interest_overdue**: просроченные проценты на сегодня
    - **penalty**: см. выше
- **date_planned_payment**: дата ближайшего планового платежа, строка даты в формате ISO; :warning:если прошёл последний плановый платёж по графику, то значение будет равно ""
- **total_planned_payment**: сумма ближайшего планового платежа на его дату, включает: текущий осн. долг ближайшего планового платежа и проценты, которые будут начислены к дате планового платежа (учитывается, что часть осн. долга планового платежа может быть уже погашена ранее), число (15,2); :warning:не включает сумму просроченной задолженности, если прошёл последний плановый платёж по графику, то сумма будет равна 0, состоит из сумм:
    - **main_debt_planned_payment**: осн. долг ближайшего планового платежа на его дату (учитывается, что часть осн. долга планового платежа может быть погашена ранее)
    - **interest_planned_payment**: проценты ближайшего планового платежа, т.е. которые уже начислены на плановый платёж сейчас, плюс те, что *будут* начислены к дате планового платежа
- **total_today_sum**: сумма платежа на сегодня, включает: просроченные осн. долг и проценты, начисленные на сегодня штрафы, сумму осн. долга ближайшего планового платежа, проценты ближайшего планового платежа, накопившиеся на сегодня, число (15,2), состоит из сумм:
    - **main_debt_overdue**: см. выше
    - **interest_overdue**: см. выше
    - **penalty**: см. выше
    - **main_debt_planned_payment**: см. выше
    - **interest_planned_payment_today**: проценты ближайшего планового платежа, которые начислены на *сегодня*

- **payment_systems** - структура с информацией о платежных системах
    - **pays** - данные о платежных системах для проведения оплат
        - Инн организации - инн организации из параметра договора payment_receiver
        - **system** - имя платежной системы,
        - **bank_code** - идентификатор платежной системы
    - **loans** - имя платежной системы для выдачи займов
 
:::

:::danger
:::spoiler Пример тела ответа, если договоров у клиента **нет**
```json
[]
```
:::

:::success
:::spoiler Пример тела ответа, если **найдены** договоры клиента: с просрочкой
```json
[
    {
        "type": "ConsumerLoan",
        "base_source": "ххххххххххх",
        "contract_num": "З20УфАР123456789",
        "contract_date": "2020-02-17",
        "contract_sum": 10000,
        "payment_receiver": "5410059568",
        "status": "active",
        "repay_before": "2020-08-17",
        "repayment_date": "",
        "penalty": 5,
        "total_balance": 9625,
        "main_debt_balance": 8333,
        "interest_balance": 1287,
        "total_overdue": 2759,
        "main_debt_overdue": 1667,
        "interest_overdue": 1087,
        "date_planned_payment": "2020-05-17",
        "total_planned_payment": 2666,
        "main_debt_planned_payment": 1667,
        "interest_planned_payment": 999,
        "interest_planned_payment_today": 200,
        "total_today_sum": 4626
    }
]
```
:::

:::success
:::spoiler Пример тела ответа, если **найдены** договоры клиента: закрытые и открытые без просрочки 
```json
[
	{
        "type": "Installments",
        "base_source": "ххххххххххх",
        "contract_num": "Р20ПмОР123456789",
        "contract_date": "2020-03-04",
        "contract_sum": 3213,
        "payment_receiver": "5407249872",
        "status": "active",
        "repay_before": "2020-06-04",
        "repayment_date": "",
        "penalty": 0,
        "total_balance": 1820,
        "main_debt_balance": 1820,
        "interest_balance": 0,
        "total_overdue": 0,
        "main_debt_overdue": 0,
        "interest_overdue": 0,
        "date_planned_payment": "2020-05-04",
        "total_planned_payment": 749,
        "main_debt_planned_payment": 749,
        "interest_planned_payment": 0,
        "interest_planned_payment_today": 0,
        "total_today_sum": 749
    },
	{
        "type": "ConsumerLoan",
        "base_source": "ххххххххххх",
        "contract_num": "З20ПмАР123456789",
        "contract_date": "2020-02-11",
        "contract_sum": 50000,
        "payment_receiver": "5410059568",
        "status": "transfer_not_success",
         "categories": [
            "transfer"
        ],
        "transfer": {
            "type": "ОтказЗачисленияПроцессингом",
            "description": "Недостаточно средств на счете",
            "available_actions": [
                "cancellation"
            ]
        },
        "repay_before": "2021-03-11",
        "repayment_date": "",
        "penalty": 0,
        "total_balance": 0,
        "main_debt_balance": 0,
        "interest_balance": 0,
        "total_overdue": 0,
        "main_debt_overdue": 0,
        "interest_overdue": 0,
        "date_planned_payment": "2020-05-11",
        "total_planned_payment": 0,
        "main_debt_planned_payment": 0,
        "interest_planned_payment": 0,
        "interest_planned_payment_today": 0,
        "total_today_sum": 0
    },
	{
        "type": "TargetLoan",
        "base_source": "ххххххххххх",
        "contract_num": "З19ПмАР123456789",
        "contract_date": "2019-07-18",
        "contract_sum": 3213,
        "status": "active",
         "categories": [],
        "repay_before": "",
        "repayment_date": "2019-09-18",
        "penalty": 0,
         "total_balance": 1820,
        "main_debt_balance": 1820,
        "interest_balance": 0,
        "total_overdue": 0,
        "main_debt_overdue": 0,
        "interest_overdue": 0,
        "date_planned_payment": "2020-05-04",
        "total_planned_payment": 749,
        "main_debt_planned_payment": 749,
        "interest_planned_payment": 0,
        "interest_planned_payment_today": 0,
        "total_today_sum": 749
    },
    {
        "type": "ConsumerLoan",
        "base_source": "ххххххххххх",
        "contract_num": "З19ПмАР123456789",
        "contract_date": "2019-07-18",
        "contract_sum": 20000,
        "status": "active",
         "categories": [
            "tranche"
        ],
        "tranche":{
          "term": "5 месяцев",
          "sum": 20000,
          "rate_daily": 5,
          "rate_annual": 225,
          "available_number": 5,
          "available_at": "2021-02-26T00:00:00",
          "status": "suspended",
          "insurance_available": true
        },
        "repay_before": "",
        "repayment_date": "2019-09-18",
        "penalty": 0,
        "total_balance": 0,
        "main_debt_balance": 0,
        "interest_balance": 0,
        "total_overdue": 0,
        "main_debt_overdue": 0,
        "interest_overdue": 0,
        "date_planned_payment": "",
        "total_planned_payment": 0,
        "main_debt_planned_payment": 0,
        "interest_planned_payment": 0,
        "interest_planned_payment_today": 0,
        "total_today_sum": 0
    },
    "payment_systems": {
    "pays": {
        "5410059568": {
            "bank_code": "arifmetika",
            "system": "ЦФТ"
        }
    },
    "loans": ""
    }
    
]
```
:::

---
