Сущности
Last updated
Last updated
Все сущности для API Pro.rent приведены в . В этом разделе приведены расшифровки и комментарии к наиболее сложным из них.
Файл-приложение к другой сущности.
{
id: Guid,
url: string, // Ссылка на файл, readonly
name: string, // Название Файла
creator: , // Загрузивший файл пользователь, readonly
createDate: DateTime // Дата и время создания, readonly
}Содержит полную информацию о договоре. В договоре может быть от одного и более соглашений. Нулевое соглашение является основным договором.
{
id: number,
number?: string, // Номер договора, readonly
date: Date, // Дата договора, readonly
type: , // Тип договора
period: { // Общий из всех соглашений период действия договора, readonly
begin: Date,
end: Date
},
state: , // Статус договора, readonly
mainVersion: , // Соглашение-основной договор
currentVersionInfo: , // Краткая информация о текущем активном соглашении, readonly
versions: [], // Все соглашения по договору, включая основное, readonly
currency: , // Валюта договора
billingPeriod: , /
paymentSchedule?: { // Условия оплаты
type: , // Тип периода
day: number, // День оплаты
months: number, // Периодичность в месяцах
advanceMonths?: number // Количество месяцев аванса
},
paymentTerms?: string, // Текстовое предсравление условий оплаты, readonly
actMonths: number, // Периодичность выставления актов в месяцах
ignoreInOccupation: boolean, // Учитывать или нет договор в заполняемости помещений
notificationDays: number, // За сколько дней до окончания уведомлять ответственного и клиента
warnings: , // Предупреждения по договору
agreementCount: number, // Кол-во дополнительных соглашений
debt: { // Долги по договору, readonly
value: number, // Сумма долга
currency: // Валюта долга
}[],
advance: { // Неразнесенные авансы, readonly
value: number, // Сумма аванса
currency: // Валюта аванса
}[],
responsibleId: number, // ID ответственного по договору сотрудника
responsible: , // Ответственный по договору сотрудник, readonly
documentRuleId: number, // ID правила формирования счетов и актов
documentRule: , // Правило формирования счетов и актов, readonly
autoInvoices: , // Режим выставления счетов
autoInvoicesTemplateId?: number, // ID шаблона для счетов
autoInvoicesTemplate?: , // Шаблон для счетов, readonly
autoActs: , // Режим выставления актов,
autoActsTemplateId?: number, // ID шаблона для актов
autoActsTemplate?: , // Шаблон для актов, readonly
externalLink?: { // Договор во внешнем источнике, например, AmoCRM и др.
id: string, // ID во внешнем источнике
name: string, // Название внешнего истояника
url: string // Ссылка во внешнем источнике
},
oneCId?: Guid, // ID договора в 1С
attachments: [], // Приложенный к договору файлы
createDate: DateTime, // Дата и время создания, readonly
changeDate: DateTime // Дата и время последнего изменения, readonly
}Информация об одном соглашении договора. Если это нулевое соглашение, то информация об основном договоре.
{
id: number,
number?: string, // Номер
date: Date, // Дата
type: , // Тип соглашения
period: { // Период действия
begin: Date,
end: Date
},
endFinal: Date, // Переопределенная следующим соглашением дата окончания периода действия, readonly
status: , // Статус соглашения
signStatus: , // Статус подписания
signStatusChangeError?: string, // Текст ошибки при блокировке изменения статуса подписания, readonly
orgId: number, // ID основного исполнителя
org: , // Основной исполнитель, readonly
orgBankAccountId?: number, // ID р/с основного исполнителя
orgBankAccount?: , // Р/с основного исполнителя, readonly
orgSignerId?: number, // ID подписанта основного исполнителя
orgSigner?: , // Подписан основного исполнителя, readonly
orgsAdditional: { // Дополнительные исполнители по договору
contractorId: number, // ID исполнителя
contractor: , // Исполнитель, readonly
bankAccountId?: number, // ID р/с исполнителя
bankAccount?: , // Р/с исполнителя, readonly
signerId?: number, // ID подписанта исполнителя
signer?: , // Подписан исполнителя, readonly
docBankAccountId?: number, // ID счёта исполнителя для счетов и актов
docBankAccount?: , // Счёт исполнителя для счетов и актов, readonly
docSignerId?: number, // ID подписанта исполнителя для счетов и актов
docSigner?: , // Подписант исполнителя для счетов и актов, readonly
share: number // Числитель доли исполнителя
}[],
orgShareBase?: number, // Знаменатель доли исполнителей, по умолчанию 10.000
orgUtilityId: number, // ID исполнителя для выставления 100% переменной части
orgUtility: , // Исполнитель для выставления 100% переменной части, reaodnly
clientId: number, // ID заказчика
client: , // Заказчик, readonly
clientBankAccountId?: number, // ID р/с заказчика
clientBankAccount?: , // Р/с заказчика, readonly
clientSignerId?: number, // ID заказчика исполнителя
clientSigner?: , // Подписан заказчика, readonly
file: , // Файл или шаблон
warnings: , // Предупреждения по договору, readonly
currency: , // Валюта
amount: number, // Стоимость по соглашению, readonly
amountRooms: number, // Стоимость помещений, readonly
amountServices: number, // Стоимость услуг, readonly
amountIndexed: number, // Индексированная стоимость по соглашению, readonly
amountRoomsIndexed: number, // Индексированная стоимость помещений, readonly
amountServicesIndexed: number, // Индексированная стоимость услуг, readonly
lines: [], // Строки помещений и фиксированных услуг
holidays: ApiContractHoliday[], // Скидки
utilities: ApiContractUtility[], // Строки переменной часть
meters: ApiContractMeter[], // Строки счетчиков для переменной части
acts: ApiContractAct[], // Настройки актов п/п
indexings: ApiContractIndexing[], // Индексации по документу, readonly
buildings: ApiBuildingInfo[], // Объекты в соглашении, readonly
deposit?: number, // Сумма депозита
recoveryCost?: number, // Сумма восстановительного платежа
penaltyPercent?: number, // Пени %
indexingAuto?: boolean, // Индексация, ручная или автоматическая
indexingDate?: number, // Минимальная дата индексации
indexingMonths?: number, // Периодичность индексации
indexingPercent?: number, // Максимальный процент индексации
indexingNotifyDays?: number, // Срок уведомления об индексации
indexingTerms?: string, // Текстовое представление условий индексации, readonly
terminationOrgDays?: number, // Период расторжения исполнителем
terminationClientDays?: number, // Период расторжения заказчиком
roomPurpose?: string, // Назначение помещений
conditions?: string, // Дополнительные условия
comment?: string, // Комментарий
notifyActivationDays?: number, // За сколько дней до начала уведомлять ответсвенного и клиента
approveLink?: { // Согласование документа во внешнем источнике
id: string, // ID во внешнем источнике
name: string, // Название внешнего истояника
url: string // Ссылка во внешнем источнике
},
docOrgBankAccountId?: number, // ID счёта основного исполнителя для счетов и актов
docOrgBankAccount?: , // Счёт основного исполнителя для счетов и актов, readonly
docOrgSignerId?: number, // ID подписанта основного исполнителя для счетов и актов
docOrgSigner?: , // Подписант основного исполнителя для счетов и актов, readonly
docClientBankAccountId?: number, // ID счёта заказчика для счетов и актов
docClientBankAccount?: , // Счёт заказчика для счетов и актов, readonly
docClientSignerId?: number, // ID подписанта заказчика для счетов и актов
docClientSigner?: , // Подписант заказчика для счетов и актов, readonly
createDate: DateTime, // Дата и время создания, readonly
changeDate: DateTime // Дата и время последнего изменения, readonly
}Краткая информация о текущем активном соглашении договора.
{
id: number,
orgs: [], // Исполнители
client: , // Заказчик
amountRooms: number, // Стоимость помещений
amountServices: number, // Стоимость услуг
square: number, // Площадь
hasHolidays: boolean, // Есть скидки
buildings: ApiBuildingInfo[], // Объекты в соглашении
utilities: [], // Переменная часть
createDate: DateTime, // Дата и время создания
changeDate: DateTime // Дата и время последнего изменения
}Строка договора с информацией о помещении или фиксированной услуге.
{
id: number,
isRoom: boolean, // Помещение или услуга
name?: string, // Наименование
roomId?: number, // ID помещения
room?: ApiRoomTree, // Помещение, readonly
serviceId?: number, // ID услуги
service?: ApiService, // Услуга, readonly
category?: , // Категория строки
quantity: number, // Количество
unit?: string, // Единица измерения
price: number, // Цена строки
amount: number, // Сумма строки
ndsPercent?: , // НДС %
isAmountOnly: boolean // Не брать в расчет цену, а только сумму
}Информация о контрагенте.
{
id: number,
isOrganization: boolean, // Может быть исполнителем или нет
type: ContractorType, // Тип
country: Country, // Страна
fullName: string, // Полное наименование
shortName: string, // Краткое наименование
inn?: string, // Идентификационный номер в стране
email?: string, // Email для реквизитов
isSimpleTaxSystem: boolean, // Применяет УСН
createDate: DateTime, // Дата и время создания, readonly
changeDate: DateTime // Дата и время последнего изменения, readonly
}Информация о контрагенте с долей.
{
...
share?: number, // Числитель доли
shareBase?: number // Знаменатель доли
}Расчётный счёт.
{
id: number,
status: , // Статус
expiry?: Date, // Срок действия
currency: , // Валюта
number: string, // Номер р/с
bik: string, // Идентификационный код банка
bankName: string, // Название банка
corr?: string, // Корр. счёт
comment?: string, // Комментарий
createDate: DateTime, // Дата и время создания, readonly
changeDate: DateTime // Дата и время последнего изменения, readonly
}Информация о файле документа.
{
templateId?: number, // ID шаблона
template?: ApiTemplateInfo, // Шаблон
fileId?: Guid, // ID файла
name?: string, // Наименование файла
urlDocx?: string, // Ссылка на DOCX файл
urlPdf?: string, // Ссылка на PDF файл
urlPdfWithActs?: string // Ссылка на PDF с актами п/п
}Правило формирования счетов и актов по договору.
{
id: number,
name, string, // Наименование
status: , // Статус
lineMode: , // Тип срок в счетах и актах
lineContract: boolean, // Включать номер договора в каждую строку
invoiceSurchargeDays?: number, // Выставлять счета на доплату
attachments: boolean, // Прикладывать акты РСО арендаторам
usageCount: number, // Кол-во договоров с этим правилом
createDate: DateTime, // Дата и время создания, readonly
changeDate: DateTime // Дата и время последнего изменения, readonly
}Информация о сотруднике.
{
id: number,
email: string,
emailConfirmed: boolean, // Email подтвержден, readonly
displayName: string, // Отображаемое имя, readonly
firstName: string, // Имя
middleName?: string, // Отчество
lastName: string, // Фамилия
position?: string, // Должность
pemissions: SubPermission, // Параметры доступа в аккаунте
adminPermissions: AdminPermission, // Параметры доступа администратора
phone?: string, // Телефон
phoneConfirmed: boolean, // Телефон подтвержден, readonly
avatar?: , // Аватар пользователя
managerCount: number, // Кол-во секиций, где сотрудник управляющий, readonly
responsibleCount: number, // Кол-во договоров, где сотрудник ответсвенный, readonly
createDate: DateTime, // Дата и время создания, readonly
changeDate: DateTime, // Дата и время последнего изменения, readonly
activityDate: DateTime, // Дата и время последней активности, readonly
lockoutEnd?: DateTime // Дата и время срока блокировки пользователя, readonly
}Информация о файле в системе.
{
id: Guid,
url: string // Ссылка на файл, readonly
}Денежная операция.
{
id: number,
type: , // Тип платежа
number?: string, // Номер
date: Date, // Дата
orgId: number, // ID исполнителя
org: , // Исполнитель, readonly
orgBankAccountId?: number, // ID р/с исполнителя
orgBankAccount?: , // Р/с исполнителя, readonly
clientId: number, // ID заказчика
client: , // Заказчик, readonly
clientBankAccountId?: number, // ID р/с заказчика
clientBankAccount?: , // Р/с заказчика, readonly
currency: , // Валюта платежа
amount: number, // Сумма платежа
amountConnected: number, // Разнесенная сумма, readonly
purpose?: string, // Назначение платежа
comment?: string, // Комментарий
createDate: DateTime, // Дата и время создания, readonly
changeDate: DateTime // Дата и время последнего изменения, readonly
}Подписант контрагента.
{
id: number,
status: , // Статус
expiry?: Date, // Срок действия
name: string, // ФИО
nameGenitive?: string, // ФИО в родительном падеже
position?: string, // Должность
positionGenitive?: string, // Должность в родительном падеже
actsOnTheBasisOf?: string, // Действует на основании
signName?: string, // Имя для подписи
signFile?: ApiFileInfo, // Файл подписи
createDate: DateTime, // Дата и время создания, readonly
changeDate: DateTime // Дата и время последнего изменения, readonly
}Информация о шаблоне документа.
{
id: number,
name: string, // Наименование
type: , // Тип
status: , // Статус
expiry?: Date, // Срок действия
file: , // Основной файл
fileVatInvoice?: , // Файл счёта-фактуры для типа акта
createDate: DateTime, // Дата и время создания, readonly
changeDate: DateTime // Дата и время последнего изменения, readonly
}Информация о пользователе.
{
id: number,
email: string,
displayName: string, // Отображаемое имя
avatar?: // Аватар пользователя
}