API Calc service (v0.0.3)

Download OpenAPI specification:

Conditions

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

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

Authorizations:

Bearer

Request Body schema: application/json
required

unit required	string <uuid> Идентификатор единицы недвижимости (stock-service)
required	object (ClientDto)
status required	string <= 255 characters Статус заявки
crm_deal_id required	string <= 255 characters Идентификатор сделки из CRM
category required	string <uuid> Категория заявки
required	object (PaymentInfo)
fail_reason	string or null <uuid> Причина отказа
	object (CalculatePayment)
locked	boolean Default: false Запись закрыта от изменений
	Array of objects (ConditionBooking) Брони условия заявки
	Array of objects (ConditionDiscount) Скидки юнита
	Array of objects (ConditionOption) Опции юнита
	Array of objects (ShareEmployee) Сотрудники участники сделки
	Array of objects (ShareAgent) Риелторы участники сделки
	Array of objects (ConditionComment) Комментарии к заявке
	Array of objects (FileDto)

Responses

Request samples

Payload

Content type

application/json

{"unit": "96a6aa1e-fb68-45e6-a443-0913abfa47dd",
"client": {"first_name": "string",
"last_name": "string",
"second_name": "string",
"phone": "stringstrin",
"email": "user@example.com",
"birth_date": "2019-08-24T14:15:22Z"
},
"status": "string",
"crm_deal_id": "string",
"category": "86d23d13-9dbb-46f3-82d0-25253c7750c3",
"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": 1
},
"fail_reason": "98fd40f1-1a65-4fb7-81d5-dd37f84e8df7",
"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"
}
]
},
"locked": false,
"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"
}
],
"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
}
],
"condition_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 (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",
"active": true,
"unit": "96a6aa1e-fb68-45e6-a443-0913abfa47dd",
"owner": "534359f7-5407-4b19-ba92-c71c370022a5",
"client": {"first_name": "string",
"last_name": "string",
"second_name": "string",
"phone": "stringstrin",
"email": "user@example.com",
"birth_date": "2019-08-24T14:15:22Z"
},
"status": "string",
"crm_deal_id": "string",
"category": "86d23d13-9dbb-46f3-82d0-25253c7750c3",
"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": 1
},
"fail_reason": "98fd40f1-1a65-4fb7-81d5-dd37f84e8df7",
"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"
}
]
},
"locked": false,
"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"
}
],
"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
}
],
"condition_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> Первичный ключ, идентификатор записи
active	boolean Активность
unit	string <uuid> Идентификатор единицы недвижимости (stock-service)
	object (UpdateClientDto)
status	string <= 255 characters Статус заявки
crm_deal_id	string <= 255 characters Идентификатор сделки из CRM
category	string <uuid> Категория заявк
fail_reason	string or null <uuid> Причина отказа
	object (PaymentInfo)
	object (CalculatePayment)
locked	boolean Default: false Запись закрыта от изменений
	Array of objects (ConditionBooking) Брони условия заявки
	Array of objects (ConditionDiscount) Скидки юнита
	Array of objects (ConditionOption) Опции юнита
	Array of objects (ShareEmployee) Сотрудники участники сделки
	Array of objects (ShareAgent) Риелторы участники сделки
	Array of objects (ConditionComment) Комментарии к заявке
	Array of objects (FileDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"active": true,
"unit": "96a6aa1e-fb68-45e6-a443-0913abfa47dd",
"client": {"first_name": "string",
"last_name": "string",
"second_name": "string",
"phone": "stringstrin",
"email": "user@example.com",
"birth_date": "2019-08-24T14:15:22Z"
},
"status": "string",
"crm_deal_id": "string",
"category": "86d23d13-9dbb-46f3-82d0-25253c7750c3",
"fail_reason": "98fd40f1-1a65-4fb7-81d5-dd37f84e8df7",
"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": 1
},
"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"
}
]
},
"locked": false,
"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"
}
],
"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
}
],
"condition_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": "Запись удалена"
}

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

Authorizations:

Bearer

Request Body schema: application/json
required

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

Responses

Request samples

Payload

Content type

application/json

{"unit": "96a6aa1e-fb68-45e6-a443-0913abfa47dd",
"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"
}
]
}

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

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": "Запись удалена"
}

API Calc service (v0.0.3)

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

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

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

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