API docs by Redocly

API Fin service (v0.3.13)

Download OpenAPI specification:

Base Prices

API цен

Создать цену

Authorizations:
Bearer
Request Body schema: application/json
required
unit
required
string <uuid>

Идентификатор единицы недвижимости (stock-service)

price_per_sq_m
required
number

Текущая цена за м2

fixed_price
number

Фиксированная цена (если есть)

reason_id
string <= 255 characters

Данные из 1с на основании которой применяется цена

Responses

Request samples

Content type
application/json
{
  • "unit": "96a6aa1e-fb68-45e6-a443-0913abfa47dd",
  • "price_per_sq_m": 5.23,
  • "fixed_price": 5.23,
  • "reason_id": "string"
}

Response samples

Content type
application/json
{
  • "item": {
    },
  • "message": "Запись успешно создана"
}

Получить цены

Authorizations:
Bearer
Request Body schema: application/json
required
required
object (FilterBasePricesDto)
required
object (PaginationDto)

Responses

Request samples

Content type
application/json
{
  • "filter": {
    },
  • "pagination": {
    }
}

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pagination": {
    }
}

Discounts

API скидок

Создать скидку

Authorizations:
Bearer
Request Body schema: application/json
required
id
required
string <uuid>

Первичный ключ, идентификатор записи

description
string <= 255 characters

Описание опции

required_comment
boolean
Default: false

Необходимость оставить комментарий при добавлении к квартире

exclusions
Array of strings <uuid> [ items <uuid > ]

Идентификаторы скидок, которые исключает данная скидки

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "description": "string",
  • "required_comment": false,
  • "exclusions": [
    ]
}

Response samples

Content type
application/json
{
  • "item": {
    },
  • "message": "Запись успешно создана"
}

Получить скидки

Authorizations:
Bearer
Request Body schema: application/json
required
required
object (FilterDiscountsDto)
required
object (PaginationDto)

Responses

Request samples

Content type
application/json
{
  • "filter": {
    },
  • "pagination": {
    }
}

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pagination": {
    }
}

Обновить скидку

Authorizations:
Bearer
Request Body schema: application/json
required
id
required
string <uuid>

Первичный ключ, идентификатор записи

active
boolean
Default: true

Активность

description
string

Описание опции

required_comment
boolean

Необходимость оставить комментарий при добавлении к квартире

exclusions
Array of strings <uuid> [ items <uuid > ]

Идентификаторы скидок, которые исключает данная скидки

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "active": true,
  • "description": "string",
  • "required_comment": true,
  • "exclusions": [
    ]
}

Response samples

Content type
application/json
{
  • "item": {
    },
  • "message": "Запись обновлена"
}

Удалить скидку (soft delete)

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

Content type
application/json
{
  • "item": {
    },
  • "message": "Запись удалена"
}

Unit Discount Condition

API условия скидок

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

Authorizations:
Bearer
Request Body schema: application/json
required
id
required
string <uuid>

Первичный ключ, идентификатор записи

unit
required
string <uuid>

Идентификатор единицы недвижимости (stock-service)

discount
required
string <uuid>

Идентификатор скидки (Discount)

Array of objects (CreateUnitConditionRuleDto)

Массив правил, которые будут учитываться при расчете

sum
number <double>

Сумма наценки

percent
number <double> [ 0 .. 1 ]

Процент наценки

sum_per_sq_m
number <double>

Сумма наценки за квадратный метр

reason_id
string <= 255 characters

Данные из 1с на основании которой применяется цена

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "unit": "96a6aa1e-fb68-45e6-a443-0913abfa47dd",
  • "discount": "051f603d-3535-4706-bbfc-038555738f07",
  • "rules": [
    ],
  • "sum": 10,
  • "percent": 0.1,
  • "sum_per_sq_m": 10,
  • "reason_id": "string"
}

Response samples

Content type
application/json
{
  • "item": {
    },
  • "message": "Запись успешно создана"
}

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

Authorizations:
Bearer
Request Body schema: application/json
required
required
object (FilterUnitDiscountConditionDto)
required
object (PaginationDto)

Responses

Request samples

Content type
application/json
{
  • "filter": {
    },
  • "pagination": {
    }
}

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pagination": {
    }
}

Обновить условие скидки

Authorizations:
Bearer
Request Body schema: application/json
required
id
required
string <uuid>

Первичный ключ, идентификатор записи

unit
string <uuid>

Идентификатор единицы недвижимости (stock-service)

discount
string <uuid>

Идентификатор скидки (Discount)

Array of objects (CreateUnitConditionRuleDto)

Массив правил, которые будут учитываться при расчете

sum
number <double>

Сумма наценки

percent
number <double> [ 0 .. 1 ]

Процент наценки

sum_per_sq_m
number <double>

Сумма наценки за квадратный метр

reason_id
string <= 255 characters

Данные из 1с на основании которой применяется цена

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "unit": "96a6aa1e-fb68-45e6-a443-0913abfa47dd",
  • "discount": "051f603d-3535-4706-bbfc-038555738f07",
  • "rules": [
    ],
  • "sum": 10,
  • "percent": 0.1,
  • "sum_per_sq_m": 10,
  • "reason_id": "string"
}

Response samples

Content type
application/json
{
  • "item": {
    },
  • "message": "Запись обновлена"
}

Удалить условие скидки (soft delete)

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

Content type
application/json
{
  • "item": {
    },
  • "message": "Запись удалена"
}

Получить скидки на момент времени

Authorizations:
Bearer
Request Body schema: application/json
required
required
object (FilterUnitDiscountConditionForDateDto)

Responses

Request samples

Content type
application/json
{
  • "filter": {
    }
}

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Options

API опций квартир

Создать опцию

Authorizations:
Bearer
Request Body schema: application/json
required
id
required
string <uuid>

Первичный ключ, идентификатор записи

type
required
string
Enum: "OPTION_TYPE_FACING" "OPTION_TYPE_FURNITURE" "OPTION_TYPE_OTHER"

Тип опции

description
string <= 255 characters

Описание опции

exclusions
Array of strings <uuid> [ items <uuid > ]

Идентификаторы опций, которые исключает данная опция

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "OPTION_TYPE_FACING",
  • "description": "string",
  • "exclusions": [
    ]
}

Response samples

Content type
application/json
{
  • "item": {
    },
  • "message": "Запись успешно создана"
}

Получить опцию

Authorizations:
Bearer
Request Body schema: application/json
required
required
object (FilterOptionsDto)
required
object (PaginationDto)

Responses

Request samples

Content type
application/json
{
  • "filter": {
    },
  • "pagination": {
    }
}

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pagination": {
    }
}

Обновить опцию

Authorizations:
Bearer
Request Body schema: application/json
required
id
required
string <uuid>

Первичный ключ, идентификатор записи

active
boolean
Default: true

Активность

type
string
Enum: "OPTION_TYPE_FACING" "OPTION_TYPE_FURNITURE" "OPTION_TYPE_OTHER"

Тип опции

description
string

Описание опции

used_by_default
boolean
Default: false

Использовать опцию по умолчанию

exclusions
Array of strings <uuid> [ items <uuid > ]

Идентификаторы опций, которые исключает данная опция

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "active": true,
  • "type": "OPTION_TYPE_FACING",
  • "description": "string",
  • "used_by_default": false,
  • "exclusions": [
    ]
}

Response samples

Content type
application/json
{
  • "item": {
    },
  • "message": "Запись обновлена"
}

Удалить опцию (soft delete)

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

Content type
application/json
{
  • "item": {
    },
  • "message": "Запись удалена"
}

Unit Option Condition

API условия опций единиц недвижимости

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

Authorizations:
Bearer
Request Body schema: application/json
required
id
required
string <uuid>

Первичный ключ, идентификатор записи

unit
required
string <uuid>

Идентификатор единицы недвижимости (stock-service)

option
required
string <uuid>

Идентификатор опции (Option)

Array of objects (CreateUnitConditionRuleDto)

Массив правил, которые будут учитываться при расчете

sum
number <double>

Сумма наценки

percent
number <double> [ 0 .. 1 ]

Процент наценки

sum_per_sq_m
number <double>

Сумма наценки за квадратный метр

reason_id
string <= 255 characters

Данные из 1с на основании которой применяется цена

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "unit": "96a6aa1e-fb68-45e6-a443-0913abfa47dd",
  • "option": "e7c2432c-b004-45c5-a282-bcaf6d903541",
  • "rules": [
    ],
  • "sum": 10,
  • "percent": 0.1,
  • "sum_per_sq_m": 10,
  • "reason_id": "string"
}

Response samples

Content type
application/json
{
  • "item": {
    },
  • "message": "Запись успешно создана"
}

Получить условия

Authorizations:
Bearer
Request Body schema: application/json
required
required
object (FilterUnitOptionConditionDto)
required
object (PaginationDto)

Responses

Request samples

Content type
application/json
{
  • "filter": {
    },
  • "pagination": {
    }
}

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pagination": {
    }
}

Обновить условие

Authorizations:
Bearer
Request Body schema: application/json
required
id
required
string <uuid>

Первичный ключ, идентификатор записи

unit
string <uuid>

Идентификатор единицы недвижимости (stock-service)

option
string <uuid>

Идентификатор опции (Option)

Array of objects (CreateUnitConditionRuleDto)

Массив правил, которые будут учитываться при расчете

sum
number <double>

Сумма наценки

percent
number <double> [ 0 .. 1 ]

Процент наценки

sum_per_sq_m
number <double>

Сумма наценки за квадратный метр

reason_id
string <= 255 characters

Данные из 1с на основании которой применяется цена

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "unit": "96a6aa1e-fb68-45e6-a443-0913abfa47dd",
  • "option": "e7c2432c-b004-45c5-a282-bcaf6d903541",
  • "rules": [
    ],
  • "sum": 10,
  • "percent": 0.1,
  • "sum_per_sq_m": 10,
  • "reason_id": "string"
}

Response samples

Content type
application/json
{
  • "item": {
    },
  • "message": "Запись обновлена"
}

Удалить условие скидки (soft delete)

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

Content type
application/json
{
  • "item": {
    },
  • "message": "Запись удалена"
}

Получить опции на момент времени

Authorizations:
Bearer
Request Body schema: application/json
required
required
object (FilterUnitOptionConditionForDateDto)

Responses

Request samples

Content type
application/json
{
  • "filter": {
    }
}

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Commercial Offer

API коммерческих предложений

Получить КП

Authorizations:
Bearer
Request Body schema: application/json
required
required
Array of objects (UnitDataDto)
required
object (ManagerDto)

Данные менеджера, указанные в шапке КП.

phone
required
string = 12 characters

Телефон клиента/заказчика КП. Формат "+79123456789".

name
required
string [ 1 .. 255 ] characters

Имя клиента/заказчика КП.

email
string or null <email>
agency_name
string [ 1 .. 255 ] characters

Название агенства

show_developer
boolean or null

Показывать ли в КП ссылку/блок застройщика.

show_facing
boolean or null

Отображать "Отделка включена".

Responses

Request samples

Content type
application/json
{
  • "units": [
    ],
  • "manager": {
    },
  • "phone": "+79123456789",
  • "name": "Иван Иванов",
  • "email": "ivan@example.com",
  • "agency_name": "string",
  • "show_developer": true,
  • "show_facing": true
}