API Calc service (v0.1.0)

Download OpenAPI specification:

Orders

API заявок

Создать заявку

Authorizations:

Bearer

Request Body schema: application/json
required

status required	string <= 255 characters Текущий статус заявки
category required	string <uuid> Категория заявки (продажа, аренда и т.д.)
crm_deal_id	string <= 255 characters Идентификатор сделки во внешней CRM
responsible_user	string or null <uuid> Ответственный менеджер (auth-service)
required	object (ClientDto)
fail_reason	string or null <uuid> Причина отмены заявки
	Array of objects (OrderBooking) Брони по заявке
	Array of objects (ShareEmployee) Сотрудники-участники сделки
	Array of objects (ShareAgent) Агенты-участники сделки
observers	Array of strings <uuid> [ items <uuid > ] Наблюдатели (пользователи из AuthService)
	Array of objects (OrderComment) Комментарии к заявке
	Array of objects (FileDto) Документы заявки

Responses

Request samples

Payload

Content type

application/json

{"status": "string",
"category": "86d23d13-9dbb-46f3-82d0-25253c7750c3",
"crm_deal_id": "string",
"responsible_user": "8f6162d6-5944-4077-9348-c9ee6f0a304f",
"client": {"first_name": "string",
"last_name": "string",
"second_name": "string",
"phone": "stringstrin",
"email": "user@example.com",
"birth_date": "2019-08-24T14:15:22Z"
},
"fail_reason": "98fd40f1-1a65-4fb7-81d5-dd37f84e8df7",
"bookings": [{"booking": "4f77532b-f94f-4b4b-8113-25c90d5b5e8d"
}
],
"shares_employees": [{"employee": "582b6557-33f4-480f-b578-984bbca0a925",
"role": "543e2fa5-dae3-497f-aa96-e06da8fcb379",
"share": 0.1
}
],
"shares_agents": [{"agent": "6d59d480-e90a-459c-9eb4-b0c97a2cb4c6",
"role": "543e2fa5-dae3-497f-aa96-e06da8fcb379",
"share": 0.1
}
],
"observers": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"comments": [{"user": "76f62a58-5404-486d-9afc-07bded328704",
"comment": "string",
"type": "COMMENT_TYPE_INTERNAL"
}
],
"files": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "presentation",
"sort": 500
}
]
}

Response samples

201

Content type

application/json

{"item": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"message": "Запись успешно создана"
}

Получить заявку

Authorizations:

Bearer

Request Body schema: application/json
required

required	object (FilterOrdersDto)
required	object (PaginationDto)

Responses

Request samples

Payload

Content type

application/json

{"filter": {"filters": [{"property": "id",
"value": ["123e4567-e89b-12d3-a456-426614174000"
],
"operator": "IN"
}
]
},
"pagination": {"page": 1,
"limit": 10,
"order_by": "id",
"direction": "asc"
}
}

Response samples

200

Content type

application/json

{"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"status": "string",
"category": "86d23d13-9dbb-46f3-82d0-25253c7750c3",
"crm_deal_id": "string",
"owner": "534359f7-5407-4b19-ba92-c71c370022a5",
"responsible_user": "8f6162d6-5944-4077-9348-c9ee6f0a304f",
"client": {"first_name": "string",
"last_name": "string",
"second_name": "string",
"phone": "stringstrin",
"email": "user@example.com",
"birth_date": "2019-08-24T14:15:22Z"
},
"fail_reason": "98fd40f1-1a65-4fb7-81d5-dd37f84e8df7",
"current_condition": "8e6c568c-918a-41bf-a237-1e34ed5c9c43",
"conditions": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"bookings": [{"booking": "4f77532b-f94f-4b4b-8113-25c90d5b5e8d"
}
],
"shares_employees": [{"employee": "582b6557-33f4-480f-b578-984bbca0a925",
"role": "543e2fa5-dae3-497f-aa96-e06da8fcb379",
"share": 0.1
}
],
"shares_agents": [{"agent": "6d59d480-e90a-459c-9eb4-b0c97a2cb4c6",
"role": "543e2fa5-dae3-497f-aa96-e06da8fcb379",
"share": 0.1
}
],
"observers": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"comments": [{"user": "76f62a58-5404-486d-9afc-07bded328704",
"comment": "string",
"type": "COMMENT_TYPE_INTERNAL"
}
],
"files": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "presentation",
"sort": 500
}
]
}
],
"pagination": {"page": 1,
"limit": 10,
"page_count": 10,
"total_count": 100
}
}

Обновить заявку

Authorizations:

Bearer

Request Body schema: application/json
required

id required	string <uuid> Первичный ключ, идентификатор записи
status	string <= 255 characters Текущий статус заявки
category	string <uuid> Категория заявки (продажа, аренда и т.д.)
crm_deal_id	string <= 255 characters Идентификатор сделки во внешней CRM
responsible_user	string or null <uuid> Ответственный менеджер (auth-service)
	object (UpdateClientDto)
fail_reason	string or null <uuid> Причина отмены заявки
	Array of objects (OrderBooking) Брони по заявке
	Array of objects (ShareEmployee) Сотрудники-участники сделки
	Array of objects (ShareAgent) Агенты-участники сделки
observers	Array of strings <uuid> [ items <uuid > ] Наблюдатели (пользователи из AuthService)
	Array of objects (OrderComment) Комментарии к заявке
	Array of objects (FileDto) Документы заявки

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"status": "string",
"category": "86d23d13-9dbb-46f3-82d0-25253c7750c3",
"crm_deal_id": "string",
"responsible_user": "8f6162d6-5944-4077-9348-c9ee6f0a304f",
"client": {"first_name": "string",
"last_name": "string",
"second_name": "string",
"phone": "stringstrin",
"email": "user@example.com",
"birth_date": "2019-08-24T14:15:22Z"
},
"fail_reason": "98fd40f1-1a65-4fb7-81d5-dd37f84e8df7",
"bookings": [{"booking": "4f77532b-f94f-4b4b-8113-25c90d5b5e8d"
}
],
"shares_employees": [{"employee": "582b6557-33f4-480f-b578-984bbca0a925",
"role": "543e2fa5-dae3-497f-aa96-e06da8fcb379",
"share": 0.1
}
],
"shares_agents": [{"agent": "6d59d480-e90a-459c-9eb4-b0c97a2cb4c6",
"role": "543e2fa5-dae3-497f-aa96-e06da8fcb379",
"share": 0.1
}
],
"observers": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"comments": [{"user": "76f62a58-5404-486d-9afc-07bded328704",
"comment": "string",
"type": "COMMENT_TYPE_INTERNAL"
}
],
"files": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "presentation",
"sort": 500
}
]
}

Response samples

201

Content type

application/json

{"item": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"message": "Запись обновлена"
}

Удалить заявку

Authorizations:

Bearer

path Parameters

id

required

string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Responses

Response samples

201

Content type

application/json

{"item": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"message": "Запись удалена"
}

Conditions

API условий заявок

Создать условие заявки

Authorizations:

Bearer

Request Body schema: application/json
required

unit required	string <uuid> Идентификатор единицы недвижимости (stock-service)
required	object (PaymentInfo)
	object (CalculatePayment)
lock	boolean Default: false true = условие историческое (заменено новым), false = активное
order	string or null <uuid> Идентификатор заявки, к которой привязано условие (null = самостоятельный расчёт)
	Array of objects (ConditionDiscount) Скидки юнита
	Array of objects (ConditionOption) Опции юнита
	Array of objects (FileDto) Документы условия (КП, график платежей)

Responses

Request samples

Payload

Content type

application/json

{"unit": "96a6aa1e-fb68-45e6-a443-0913abfa47dd",
"payment_info": {"type": "FULL_PAYMENT",
"date_from": "2019-08-24T14:15:22Z",
"date_to": "2019-08-24T14:15:22Z",
"initial_payment": 0.1,
"initial_payment_percent": 100
},
"calculate_payment": {"final_price": 0.1,
"final_price_with_components": 0.1,
"final_price_with_components_and_all_discounts": 0.1,
"calculate_table_rows": [{"date": "2019-08-24T14:15:22Z",
"row_price": 0.1,
"row_payment_type": "FEDERAL_MATERNITY_CAPITAL",
"price_per_sq_m": 0.1,
"fixed_price": false
}
],
"overpayment": 0.1
},
"lock": false,
"order": "93b532b3-a125-4cd2-9b71-9996b1e164ce",
"condition_discounts": [{"unit_discount_condition": "61c02777-491b-42c9-a9e7-bb40298bc757",
"comment": "string"
}
],
"condition_options": [{"unit_option_condition": "c4a60f7b-41b5-48ca-801f-9a026d90bd61",
"comment": "string"
}
],
"files": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "presentation",
"sort": 500
}
]
}

Response samples

201

Content type

application/json

{"item": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"message": "Запись успешно создана"
}

Получить условия заявки

Authorizations:

Bearer

Request Body schema: application/json
required

required	object (FilterConditionsDto)
required	object (PaginationDto)

Responses

Request samples

Payload

Content type

application/json

{"filter": {"filters": [{"property": "id",
"value": ["123e4567-e89b-12d3-a456-426614174000"
],
"operator": "IN"
}
]
},
"pagination": {"page": 1,
"limit": 10,
"order_by": "id",
"direction": "asc"
}
}

Response samples

200

Content type

application/json

{"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"unit": "96a6aa1e-fb68-45e6-a443-0913abfa47dd",
"payment_info": {"type": "FULL_PAYMENT",
"date_from": "2019-08-24T14:15:22Z",
"date_to": "2019-08-24T14:15:22Z",
"initial_payment": 0.1,
"initial_payment_percent": 100
},
"calculate_payment": {"final_price": 0.1,
"final_price_with_components": 0.1,
"final_price_with_components_and_all_discounts": 0.1,
"calculate_table_rows": [{"date": "2019-08-24T14:15:22Z",
"row_price": 0.1,
"row_payment_type": "FEDERAL_MATERNITY_CAPITAL",
"price_per_sq_m": 0.1,
"fixed_price": false
}
],
"overpayment": 0.1
},
"lock": false,
"order": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"status": "string",
"category": "86d23d13-9dbb-46f3-82d0-25253c7750c3",
"crm_deal_id": "string",
"owner": "534359f7-5407-4b19-ba92-c71c370022a5",
"responsible_user": "8f6162d6-5944-4077-9348-c9ee6f0a304f",
"client": {"first_name": "string",
"last_name": "string",
"second_name": "string",
"phone": "stringstrin",
"email": "user@example.com",
"birth_date": "2019-08-24T14:15:22Z"
},
"fail_reason": "98fd40f1-1a65-4fb7-81d5-dd37f84e8df7",
"current_condition": "8e6c568c-918a-41bf-a237-1e34ed5c9c43",
"conditions": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"bookings": [{"booking": "4f77532b-f94f-4b4b-8113-25c90d5b5e8d"
}
],
"shares_employees": [{"employee": "582b6557-33f4-480f-b578-984bbca0a925",
"role": "543e2fa5-dae3-497f-aa96-e06da8fcb379",
"share": 0.1
}
],
"shares_agents": [{"agent": "6d59d480-e90a-459c-9eb4-b0c97a2cb4c6",
"role": "543e2fa5-dae3-497f-aa96-e06da8fcb379",
"share": 0.1
}
],
"observers": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"comments": [{"user": "76f62a58-5404-486d-9afc-07bded328704",
"comment": "string",
"type": "COMMENT_TYPE_INTERNAL"
}
],
"files": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "presentation",
"sort": 500
}
]
},
"condition_discounts": [{"unit_discount_condition": "61c02777-491b-42c9-a9e7-bb40298bc757",
"comment": "string"
}
],
"condition_options": [{"unit_option_condition": "c4a60f7b-41b5-48ca-801f-9a026d90bd61",
"comment": "string"
}
],
"files": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "presentation",
"sort": 500
}
]
}
],
"pagination": {"page": 1,
"limit": 10,
"page_count": 10,
"total_count": 100
}
}

Обновить условие заявки

Authorizations:

Bearer

Request Body schema: application/json
required

id required	string <uuid> Первичный ключ, идентификатор записи
unit	string <uuid> Идентификатор единицы недвижимости (stock-service)
	object (PaymentInfo)
	object (CalculatePayment)
lock	boolean Default: false true = условие историческое (заменено новым), false = активное
order	string or null <uuid> Идентификатор заявки, к которой привязано условие (null = самостоятельный расчёт)
	Array of objects (ConditionDiscount) Скидки юнита
	Array of objects (ConditionOption) Опции юнита
	Array of objects (FileDto) Документы условия (КП, график платежей)

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"unit": "96a6aa1e-fb68-45e6-a443-0913abfa47dd",
"payment_info": {"type": "FULL_PAYMENT",
"date_from": "2019-08-24T14:15:22Z",
"date_to": "2019-08-24T14:15:22Z",
"initial_payment": 0.1,
"initial_payment_percent": 100
},
"calculate_payment": {"final_price": 0.1,
"final_price_with_components": 0.1,
"final_price_with_components_and_all_discounts": 0.1,
"calculate_table_rows": [{"date": "2019-08-24T14:15:22Z",
"row_price": 0.1,
"row_payment_type": "FEDERAL_MATERNITY_CAPITAL",
"price_per_sq_m": 0.1,
"fixed_price": false
}
],
"overpayment": 0.1
},
"lock": false,
"order": "93b532b3-a125-4cd2-9b71-9996b1e164ce",
"condition_discounts": [{"unit_discount_condition": "61c02777-491b-42c9-a9e7-bb40298bc757",
"comment": "string"
}
],
"condition_options": [{"unit_option_condition": "c4a60f7b-41b5-48ca-801f-9a026d90bd61",
"comment": "string"
}
],
"files": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "presentation",
"sort": 500
}
]
}

Response samples

201

Content type

application/json

{"item": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"message": "Запись обновлена"
}

Удалить условие заявки

Authorizations:

Bearer

path Parameters

id

required

string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Responses

Response samples

201

Content type

application/json

{"item": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"message": "Запись удалена"
}

Расчитать заявку

Authorizations:

Bearer

Request Body schema: application/json
required

unit required	string <uuid> Идентификатор единицы недвижимости (stock-service)
	object (PaymentInfo)
	object (CalculatePayment)
	Array of objects (OrderBooking) Брони условия заявки
	Array of objects (ConditionDiscount) Скидки юнита
	Array of objects (ConditionOption) Опции юнита

Responses

Request samples

Payload

Content type

application/json

{"unit": "96a6aa1e-fb68-45e6-a443-0913abfa47dd",
"payment_info": {"type": "FULL_PAYMENT",
"date_from": "2019-08-24T14:15:22Z",
"date_to": "2019-08-24T14:15:22Z",
"initial_payment": 0.1,
"initial_payment_percent": 100
},
"calculate_payment": {"final_price": 0.1,
"final_price_with_components": 0.1,
"final_price_with_components_and_all_discounts": 0.1,
"calculate_table_rows": [{"date": "2019-08-24T14:15:22Z",
"row_price": 0.1,
"row_payment_type": "FEDERAL_MATERNITY_CAPITAL",
"price_per_sq_m": 0.1,
"fixed_price": false
}
],
"overpayment": 0.1
},
"condition_bookings": [{"booking": "4f77532b-f94f-4b4b-8113-25c90d5b5e8d"
}
],
"condition_discounts": [{"unit_discount_condition": "61c02777-491b-42c9-a9e7-bb40298bc757",
"comment": "string"
}
],
"condition_options": [{"unit_option_condition": "c4a60f7b-41b5-48ca-801f-9a026d90bd61",
"comment": "string"
}
]
}

Response samples

201

Content type

application/json

{"final_price": 0.1,
"final_price_with_components": 0.1,
"final_price_with_components_and_all_discounts": 0.1,
"calculate_table_rows": [{"date": "2019-08-24T14:15:22Z",
"row_price": 0.1,
"row_payment_type": "FEDERAL_MATERNITY_CAPITAL",
"price_per_sq_m": 0.1,
"fixed_price": false
}
],
"overpayment": 0.1
}

Создать категорию заявки

Authorizations:

Bearer

Request Body schema: application/json
required

title required	string [ 1 .. 255 ] characters Наименование категории
slug	string [ 1 .. 255 ] characters Машинное наименование категории
comment	string [ 1 .. 255 ] characters Комментарии

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"slug": "string",
"comment": "string"
}

Response samples

201

Content type

application/json

{"item": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"message": "Запись успешно создана"
}

Получить категории заявки

Authorizations:

Bearer

Request Body schema: application/json
required

required	object (FilterCategoriesDto)
required	object (PaginationDto)

Responses

Request samples

Payload

Content type

application/json

{"filter": {"filters": [{"property": "id",
"value": ["123e4567-e89b-12d3-a456-426614174000"
],
"operator": "IN"
}
]
},
"pagination": {"page": 1,
"limit": 10,
"order_by": "id",
"direction": "asc"
}
}

Response samples

200

Content type

application/json

{"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"active": true,
"title": "string",
"slug": "string",
"comment": "string"
}
],
"pagination": {"page": 1,
"limit": 10,
"page_count": 10,
"total_count": 100
}
}

Обновить категорию заявки

Authorizations:

Bearer

Request Body schema: application/json
required

id required	string <uuid> Первичный ключ, идентификатор записи
active	boolean Активность
title	string [ 1 .. 255 ] characters Наименование категории
slug	string [ 1 .. 255 ] characters Машинное наименование категории
comment	string [ 1 .. 255 ] characters Комментарии

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"active": true,
"title": "string",
"slug": "string",
"comment": "string"
}

Response samples

201

Content type

application/json

{"item": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"message": "Запись обновлена"
}

Удалить категорию заявки

Authorizations:

Bearer

path Parameters

id

required

string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Responses

Response samples

201

Content type

application/json

{"item": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"message": "Запись удалена"
}

Fail Reasons

API причин отказа

Создать причину

Authorizations:

Bearer

Request Body schema: application/json
required

title required	string [ 1 .. 255 ] characters Наименование категории
category required	string <uuid> Идентификатор категории
slug	string [ 1 .. 255 ] characters Машинное наименование категории
comment	string [ 1 .. 255 ] characters Комментарии

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"category": "86d23d13-9dbb-46f3-82d0-25253c7750c3",
"slug": "string",
"comment": "string"
}

Response samples

201

Content type

application/json

{"item": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"message": "Запись успешно создана"
}

Получить причины

Authorizations:

Bearer

Request Body schema: application/json
required

required	object (FilterFailReasonsDto)
required	object (PaginationDto)

Responses

Request samples

Payload

Content type

application/json

{"filter": {"filters": [{"property": "id",
"value": ["123e4567-e89b-12d3-a456-426614174000"
],
"operator": "IN"
}
]
},
"pagination": {"page": 1,
"limit": 10,
"order_by": "id",
"direction": "asc"
}
}

Response samples

200

Content type

application/json

{"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"active": true,
"category": "86d23d13-9dbb-46f3-82d0-25253c7750c3",
"title": "string",
"slug": "string",
"comment": "string"
}
],
"pagination": {"page": 1,
"limit": 10,
"page_count": 10,
"total_count": 100
}
}

Обновить причину

Authorizations:

Bearer

Request Body schema: application/json
required

id required	string <uuid> Первичный ключ, идентификатор записи
active	boolean Активность
category	string <uuid> Идентификатор категории
title	string <= 255 characters Наименование категории
slug	string <= 255 characters Машинное наименование категории
comment	string [ 1 .. 255 ] characters Комментарии

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"active": true,
"category": "86d23d13-9dbb-46f3-82d0-25253c7750c3",
"title": "string",
"slug": "string",
"comment": "string"
}

Response samples

201

Content type

application/json

{"item": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"message": "Запись обновлена"
}

Удалить причину

Authorizations:

Bearer

path Parameters

id

required

string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Responses

Response samples

201

Content type

application/json

{"item": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"message": "Запись удалена"
}

Payment Constraints

API ограничений программ оплаты

Получить ограничения программ оплаты

Authorizations:

Bearer

Request Body schema: application/json
required

required	object (FilterPaymentConstraintsDto)
required	object (PaginationDto)

Responses

Request samples

Payload

Content type

application/json

{"filter": {"filters": [{"property": "id",
"value": ["123e4567-e89b-12d3-a456-426614174000"
],
"operator": "IN"
}
]
},
"pagination": {"page": 1,
"limit": 10,
"order_by": "id",
"direction": "asc"
}
}

Response samples

200

Content type

application/json

{"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"active": true,
"payment_type": "FULL_PAYMENT",
"special_payment_type": "FEDERAL_MATERNITY_CAPITAL",
"date_from_min_offset_value": 10,
"date_from_min_offset_unit": "OFFSET_UNIT_DAY",
"date_from_max_offset_value": 0,
"date_from_max_offset_unit": "OFFSET_UNIT_DAY",
"date_to_min_rule": "NONE",
"date_to_max_offset_value": 0,
"date_to_max_offset_unit": "OFFSET_UNIT_DAY",
"initial_payment_min_percent": 0.1,
"initial_payment_max_percent": 0.1,
"allowed_payment_types": ["FULL_PAYMENT"
]
}
],
"pagination": {"page": 1,
"limit": 10,
"page_count": 10,
"total_count": 100
}
}

Payment Rules

API правил программ оплаты

Создать правило

Authorizations:

Bearer

Request Body schema: application/json
required

id required	string <uuid> Первичный ключ, идентификатор записи
house required	string <uuid> Идентификатор дома (stock-service)
unit_type required	string Enum: "UNIT_TYPE_APARTMENT" "UNIT_TYPE_OFFICE" "UNIT_TYPE_PARKING" "UNIT_TYPE_PANTRY" "UNIT_TYPE_ROOM" Тип единицы строительства
min_initial_payment_percent	number or null <double> [ 0 .. 100 ] Минимальный % первоначального взноса для применения правила
percent_index	number or null <double> [ 0 .. 100 ] Коэффициент удорожания за месяц (%)
count_month	integer or null >= 1 Минимальный срок рассрочки (в месяцах) для применения правила
max_count_month	integer or null Максимальное количество строк в графике платежей (0 = без ограничения)
month_start_indexed	integer or null >= 1 Номер месяца, начиная с которого применяется удорожание (включительно)
date_start_payment	string or null <date-time> Дата, раньше которой нельзя начать платежи по графику
date_start_indexed	string or null <date-time> Дата, начиная с которой применяется удорожание
max_date_payment	string or null <date-time> Крайняя допустимая дата последнего платежа

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"house": "9db7b961-0525-428d-a3d3-65ea4393c911",
"unit_type": "UNIT_TYPE_APARTMENT",
"min_initial_payment_percent": 100,
"percent_index": 100,
"count_month": 1,
"max_count_month": 0,
"month_start_indexed": 1,
"date_start_payment": "2019-08-24T14:15:22Z",
"date_start_indexed": "2019-08-24T14:15:22Z",
"max_date_payment": "2019-08-24T14:15:22Z"
}

Response samples

201

Content type

application/json

{"item": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"message": "Запись успешно создана"
}

Получить правила

Authorizations:

Bearer

Request Body schema: application/json
required

required	object (FilterPaymentRulesDto)
required	object (PaginationDto)

Responses

Request samples

Payload

Content type

application/json

{"filter": {"filters": [{"property": "id",
"value": ["123e4567-e89b-12d3-a456-426614174000"
],
"operator": "IN"
}
]
},
"pagination": {"page": 1,
"limit": 10,
"order_by": "id",
"direction": "asc"
}
}

Response samples

200

Content type

application/json

{"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"active": true,
"house": "9db7b961-0525-428d-a3d3-65ea4393c911",
"unit_type": "UNIT_TYPE_APARTMENT",
"min_initial_payment_percent": 0.1,
"percent_index": 0.1,
"count_month": 0,
"max_count_month": 0,
"month_start_indexed": 0,
"date_start_payment": "2019-08-24T14:15:22Z",
"date_start_indexed": "2019-08-24T14:15:22Z",
"max_date_payment": "2019-08-24T14:15:22Z"
}
],
"pagination": {"page": 1,
"limit": 10,
"page_count": 10,
"total_count": 100
}
}

Обновить правило

Authorizations:

Bearer

Request Body schema: application/json
required

id required	string <uuid> Первичный ключ, идентификатор записи
min_initial_payment_percent	number or null <double> [ 0 .. 100 ] Минимальный % первоначального взноса для применения правила
percent_index	number or null <double> [ 0 .. 100 ] Коэффициент удорожания за месяц (%)
count_month	integer or null >= 1 Минимальный срок рассрочки (в месяцах) для применения правила
max_count_month	integer or null Максимальное количество строк в графике платежей (0 = без ограничения)
month_start_indexed	integer or null >= 1 Номер месяца, начиная с которого применяется удорожание (включительно)
date_start_payment	string or null <date-time> Дата, раньше которой нельзя начать платежи по графику
date_start_indexed	string or null <date-time> Дата, начиная с которой применяется удорожание
max_date_payment	string or null <date-time> Крайняя допустимая дата последнего платежа

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"min_initial_payment_percent": 100,
"percent_index": 100,
"count_month": 1,
"max_count_month": 0,
"month_start_indexed": 1,
"date_start_payment": "2019-08-24T14:15:22Z",
"date_start_indexed": "2019-08-24T14:15:22Z",
"max_date_payment": "2019-08-24T14:15:22Z"
}

Response samples

201

Content type

application/json

{"item": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"message": "Запись обновлена"
}

Удалить правило

Authorizations:

Bearer

path Parameters

id

required

string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Responses

Response samples

201

Content type

application/json

{"item": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"message": "Запись удалена"
}

API Calc service (v0.1.0)

Orders

Создать заявку

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Получить заявку

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Обновить заявку

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Удалить заявку

Authorizations:

path Parameters

Responses

Response samples

Conditions

Создать условие заявки

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Получить условия заявки

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Обновить условие заявки

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Удалить условие заявки

Authorizations:

path Parameters

Responses

Response samples

Расчитать заявку

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Categories

Создать категорию заявки

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Получить категории заявки

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Обновить категорию заявки

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Удалить категорию заявки

Authorizations:

path Parameters

Responses

Response samples

Fail Reasons

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required