SHP API

Версия: 1.7.2

URL: https://hello.ka-ship.ru/api/v2/public/api/connection

Метод: POST

Заголовки:

token: ВАШ_ТОКЕН
Content-Type: application/json

Метод new

Метод передачи нового должника.

Описание полей:

Поле	Описание	Обязательное	Формат
id	ID должника на вашей стороне	Да	Произвольный
fio	ФИО	Да	Иванов Иван Иванович
birthdate	Дата рождения	Да	01.01.1990
phone1	Основной телефон	Да	71234567890
phone2	Дополнительный телефон	Нет	71234567890
home_phone	Домашний телефон	Нет	71234567890
email	Эл. Почта	Нет	ivanov@example.com
contact_persons.person1.phone	Номер телефона контактного лица	Нет	71234567891
contact_persons.person1.name	ФИО контактного лица	Нет	Иванова Анна Анатольевна
contact_persons.person1.who	Кем является контактное лицо?	Нет	Жена
work.place	Место работы	Нет	ООО ААА
work.position	Должность	Нет	Директор
work.work_phone	Рабочий телефон	Нет	71234567890
registration_address	Адрес регистрации	Нет	10011, г. Москва, ул. Пушкина, д. Колотушкина
loan_amount	Сумма займа	Нет	100120,53
payment_date	Дата платежа	Нет	01.05.2023
overdue_count	Кол-во дн. просрочки	Нет	20
debt_amount	Сумма задолженности	Нет	100120,53
debt_amount_exit	Сумма задолженности (для выхода из просрочки)	Нет	1001,53
contract_number	Номер договора	Нет	Произвольный
loan_term	Срок займа, дней	Нет	35
stop_work	Завершить работу	Да	Да/Нет
kpk	КПК	Нет	Тихвин-Кредит
top	ТОП	Нет	Аврора
percent	Проценты на сегодня	Нет	1355,00
singing	Пени на сегодня	Нет	2501,00
chv_today	ЧВ на сегодня	Нет	15233,00
overdue_amount_today	Сумма для выхода из просрочки на сегодня	Нет	777,33
expired_cvs	Просроченные ЧВ	Нет	51,03
remainder_OD_total	Остаток ОД ИТОГО	Нет	6023,84
overdue_OD	Просроченный ОД	Нет	2261,27
quid	УИД	Нет	432423fdsf534-666/i>
daily_peny	Пени в день	Нет	21,27
mandatory_penalties	Обязательные пени	Нет	350,00
daily_percent	Проценты в день	Нет	1,02
daily_chv	ЧВ в день	Нет	6,03
guarantors	Блок поручительи.
poruchitel1	Первый поручитель
poruchitel1.fio	ФИО	Да	Валентин Викторович Спасский
poruchitel1.phone	Телефон	Нет	71234567891
poruchitel1.contact_persons.person1.phone	Номер телефона контактного лица	Нет	79034897894
poruchitel1.contact_persons.person1.name	ФИО контактного лица	Нет	Михайлов Никита Германович
poruchitel1.contact_persons.person1.who	Кем является контактное лицо?	Нет	Муж
	Новые поля
graph	График платежей. Массив(см. в запросе)

❗contact_persons принимает максимум 3 person.

❗poruchitel только для метода new

❗graph только для метода new

❗daily_payment только для метода payment

Пример тела запроса:

❗Информация по контактным лицам месте работы поручителю графику должна быть строго в блоках:
contact_persons work poruchitel и graph
Контактные лица ➝ contact_persons
Место работы ➝ work
Поручитель ➝ poruchitel
График ➝ graph

{
    "action": "new",
    "data": {
        "id": "116",
        "fio": "Иванов Иван Иванович",
        "birthdate": "01.01.1990",
        "phone1": "71234567890",
        "phone2": "73216543210",
        "home_phone": "71112223344",
        "email": "ivanov@example.com",
        "contact_persons": {
            "person1" : {
                "phone": "71234567891",
                "name": "Иванова Анна Анатольевна",
                "who": "Жена"
            },
            "person2" : {
                "phone": "71234567892",
                "name": "Иванова Ирина Ивановна",
                "who": "Сестра"
            },
            "person3" : {
                "phone": "71234567893",
                "name": "Иванов Игорь Иванович",
                "who": "Брат"
            }
        },
        "work" : {
            "place": "ООО ААА",
            "position": "Директор",
            "work_phone": "71234567890"
        },
        "registration_address": "10011, г. Москва, ул. Пушкина, д. Колотушкина",
        "loan_amount": 1000,
        "payment_date": "01.05.2023",
        "overdue_count": "20",
        "debt_amount": 500,
        "debt_amount_exit": 20,
        "contract_number": "ABC-123 от 12.05.2024",
        "loan_term": "35",
        "stop_work": "Нет",

        "kpk" : "Тихвин-Кредит",
        "top" : "Аврора",
        "percent" : 1355.00,
        "singing" : 2501.00,
        "chv_today" : 15233.00,
        "overdue_amount_today" : 777.33,
        "expired_cvs" : 51.32,
        "remainder_OD_total" : 6023.84,
        "overdue_OD" : 2261.27,

        "daily_peny" : 21.27,
        "daily_percent" : 1.02,
        "daily_chv" : 6.03,

        "mandatory_penalties" : 3500.55,
  
        "graph": [
            {
                "date": "2025-06-03",
                "od": "1841.62",
                "percent": "31",
                "member_fee": "2076",
                "payment": "3948.62",
                "loan_left": "0"
            },
            {
                "date": "2022-08-22",
                "od": "1084",
                "percent": "663",
                "member_fee": "1736992",
                "payment": "2739",
                "loan_left": "37936"
            }
        ],

        "guarantors": {
            "poruchitel1" : {
                "fio" : "Виктор Курский",
                "phone" : "71234567891",
    
                "contact_persons": {
                    "person1" : {
                        "phone": "71234567891",
                        "name": "Курская Татьяна Анатольевна",
                        "who": "Жена"
                    },
                    "person2" : {
                        "phone": "71234567892",
                        "name": "Дробыш Мария Ивановна",
                        "who": "Сестра"
                    }
                }
            },

            "poruchitel2" : {
                "fio" : "Михаил Бишевич",
                "phone" : "71239067891",
    
                "contact_persons": {
                    "person1" : {
                        "phone": "71234567891",
                        "name": "Таюрскя Аглая Васильевна",
                        "who": "Сестра"
                    },
                    "person2" : {
                        "phone": "71234567892",
                        "name": "Дробыш Мария Ивановна",
                        "who": "Брат"
                    }
                }
            }
        },
       
        "quid" : "321321fdsfsf-dfdgd-432432"
    }
}

Метод upd

Метод обновления информации ранее переданного должника.

❗Информация по контактным лицам месте работы должна быть строго в блоках:
contact_persons work
Контактные лица ➝ contact_persons
Место работы ➝ work

Описание полей:

Такие же как в методе new.

Пример тела запроса:

{
    "action": "upd",
    "data": {
        "id": "116",
        "fio": "Иванов Иван Иванович",
        "birthdate": "01.01.1990",
        "phone1": "71234567890",
        "phone2": "73216543210",
        "home_phone": "71112223344",
        "email": "ivanov@example.com",
        "contact_persons": {
            "person1" : {
                "phone": "71234567891",
                "name": "Иванова Анна Анатольевна",
                "who": "Жена"
            },
            "person2" : {
                "phone": "71234567892",
                "name": "Иванова Ирина Ивановна",
                "who": "Сестра"
            },
            "person3" : {
                "phone": "71234567893",
                "name": "Иванов Игорь Иванович",
                "who": "Брат"
            }
        },
        "work" : {
            "place": "ООО ААА",
            "position": "Директор",
            "work_phone": "71234567890"
        },
        "registration_address": "10011, г. Москва, ул. Пушкина, д. Колотушкина",
        "loan_amount": 1000,
        "payment_date": "01.05.2023",
        "overdue_count": "20",
        "debt_amount": 500,
        "debt_amount_exit": 20,
        "loan_term": "35",
        "stop_work": "Нет",

        "kpk" : "Тихвин-Кредит",
        "top" : "Аврора",
        "percent" : 1355.00,
        "singing" : 2501.00,
        "chv_today" : 15233.00,
        "overdue_amount_today" : 777.33,
        "expired_cvs" : 51.01,
        "remainder_OD_total" : 6023.84,
        "overdue_OD" : 2261.27,

        "daily_peny" : 21.27,
        "daily_percent" : 1.02,
        "daily_chv" : 6.03,

        "mandatory_penalties" : 3500.55,

        "guarantors": {
            "poruchitel1" : {
                "fio" : "Виктор Курский",
                "phone" : "71234567891",
    
                "contact_persons": {
                    "person1" : {
                        "phone": "71234567891",
                        "name": "Курская Татьяна Анатольевна",
                        "who": "Жена"
                    },
                    "person2" : {
                        "phone": "71234567892",
                        "name": "Дробыш Мария Ивановна",
                        "who": "Сестра"
                    }
                }
            },

            "poruchitel2" : {
                "fio" : "Михаил Бишевич",
                "phone" : "71239067891",
    
                "contact_persons": {
                    "person1" : {
                        "phone": "71234567891",
                        "name": "Таюрскя Аглая Васильевна",
                        "who": "Сестра"
                    },
                    "person2" : {
                        "phone": "71234567892",
                        "name": "Дробыш Мария Ивановна",
                        "who": "Брат"
                    }
                }
            }
        },
    }
}

Примеры ответов:

Список статусов:

200 - данные переданы успешно
409 - данный должник уже имеется в системе
404 - такого должника нет в системе
500 - внутренняя ошибка API


{
    "status" : 200,
    "message": "true"
}

{
    "status" : 200,
    "message": "Add new debt: `{id}`"
}

{
    "status": 500,
    "error": "Empty ID"
}

{
    "status": 500,
    "error": "Empty fio"
}

{
    "status": 500,
    "error": "Empty phone1"
}

{
    "status": 500,
    "error": "Incorrect format email"
}

{
    "status": 500,
    "error": "Incorrect format birthdate"
}

Метод payment

Блок ежедневных платежей. Оплата раскладывается по некоторым позициям.

Описание полей:

Поле	Описание	Обязательное	Формат
id	ID-должника (guid)	Да	5555-6666-9399
loan	Договор	Да	115541-2А41 от 12.01.2024
daily_payment.payment_date	Дата платежа	Да	2024-04-01
daily_payment.payment_sum	Сумма платежа	Да	5000
daily_payment.debt_balance	Сумма задолженности (для выхода из просрочки)	Нет	4122
daily_payment.remainder_od_total	Остаток по ОД	Нет	334.55
daily_payment.singing	Пени	Нет	393.2
daily_payment.percent	Процент	Нет	661
daily_payment.membership_fee	Членский взнос	Нет	112

Пример тела запроса:

                        
                        {
                            "action": "payment",
                            "data": {
                                "id" : "5555-6666-9399",
                                "loan" : "115541-2А41 от 12.01.2024",
                                
                                "daily_payment" : { 
                                    "payment_date" : "2024-07-07",
                                    "payment_sum" : 5000,
                                    "debt_balance" : 4122,
                                    "remainder_od_total" : 334.55,
                                    "singing" : 393.2,
                                    "percent" : 661,
                                    "membership_fee" : 112
                                }
                            }
                        }

Метод grafic

Описание полей:

Поле	Описание	Обязательное	Формат
id	ID-должника(guid)	Да	5555-6666-9399
loan	Договор	Да	115541-2А41 от 12.01.2024
type	Тип	Да	postponement
graph	График	Да

Пример тела запроса:

                    
                        {
                            "action": "grafic",
                            "data": {
                                "id": "5555-6666-9399",
                                "loan": "115541-2А41 от 12.01.2024",
                                "type": "postponement",
                                "graph": [
                                    {
                                        "date": "2024-07-03",
                                        "od": "1533.2",
                                        "percent": "345",
                                        "member_fee": "2473.8",
                                        "payment": "4352",
                                        "loan_left": "19466.8"
                                    },
                                ]
                            }
                        }

Примеры ошибок

При добавлении данный должник присутствует в системе:

                     
                    Current debtor `{id}` is exists'

При обновлении такого должника нет в системе:

                              
                    This is debtor `{id}` not found