Сущности

Все сущности для API Pro.rent приведены в swagger-схеме. В этом разделе приведены расшифровки и комментарии к наиболее сложным из них.

ApiAttachment

Файл-приложение к другой сущности.

{
    id: Guid,
    url: string, // Ссылка на файл, readonly
    name: string, // Название Файла
    creator: ApiUserInfo, // Загрузивший файл пользователь, readonly
    createDate: DateTime // Дата и время создания, readonly
}

ApiContract

Содержит полную информацию о договоре. В договоре может быть от одного и более соглашений. Нулевое соглашение является основным договором.

{
    id: number,
    number?: string, // Номер договора, readonly
    date: Date, // Дата договора, readonly
    type: ContractType, // Тип договора
    period: { // Общий из всех соглашений период действия договора, readonly
        begin: Date,
        end: Date
    },
    state: ContractState, // Статус договора, readonly
    mainVersion: ApiContractVersion, // Соглашение-основной договор
    currentVersionInfo: ApiContractVersionInfo, // Краткая информация о текущем активном соглашении, readonly
    versions: ApiContractVersion[], // Все соглашения по договору, включая основное, readonly
    currency: Currency, // Валюта договора
    billingPeriod: BillingPeriod, / 
    paymentSchedule?: { // Условия оплаты
        type: ContractPaymentType, // Тип периода
        day: number, // День оплаты
        months: number, // Периодичность в месяцах
        advanceMonths?: number // Количество месяцев аванса
    },
    paymentTerms?: string, // Текстовое предсравление условий оплаты, readonly
    actMonths: number, // Периодичность выставления актов в месяцах
    ignoreInOccupation: boolean, // Учитывать или нет договор в заполняемости помещений
    notificationDays: number, // За сколько дней до окончания уведомлять ответственного и клиента
    warnings: ContractWarning, // Предупреждения по договору
    agreementCount: number, // Кол-во дополнительных соглашений
    debt: { // Долги по договору, readonly
        value: number, // Сумма долга
        currency: Currency // Валюта долга
    }[],
    advance: { // Неразнесенные авансы, readonly
        value: number, // Сумма аванса
        currency: Currency // Валюта аванса
    }[],
    responsibleId: number, // ID ответственного по договору сотрудника
    responsible: ApiEmployee, // Ответственный по договору сотрудник, readonly
    documentRuleId: number, // ID правила формирования счетов и актов
    documentRule: ApiDocumentRule, // Правило формирования счетов и актов, readonly
    autoInvoices: DocumentAutoMode, // Режим выставления счетов
    autoInvoicesTemplateId?: number, // ID шаблона для счетов
    autoInvoicesTemplate?: ApiTemplateInfo, // Шаблон для счетов, readonly
    autoActs: DocumentAutoMode, // Режим выставления актов,
    autoActsTemplateId?: number, // ID шаблона для актов
    autoActsTemplate?: ApiTemplateInfo, // Шаблон для актов, readonly
    externalLink?: { // Договор во внешнем источнике, например, AmoCRM и др.
        id: string, // ID во внешнем источнике
        name: string, // Название внешнего истояника
        url: string // Ссылка во внешнем источнике
    },
    oneCId?: Guid, // ID договора в 1С
    attachments: ApiAttachment[], // Приложенный к договору файлы
    createDate: DateTime, // Дата и время создания, readonly
    changeDate: DateTime // Дата и время последнего изменения, readonly
}

ApiContractVersion

Информация об одном соглашении договора. Если это нулевое соглашение, то информация об основном договоре.

{
    id: number,
    number?: string, // Номер
    date: Date, // Дата
    type: ContractVersionType, // Тип соглашения
    period: { // Период действия
        begin: Date,
        end: Date
    },
    endFinal: Date, // Переопределенная следующим соглашением дата окончания периода действия, readonly
    status: ContractState, // Статус соглашения
    signStatus: ContractSignStatus, // Статус подписания
    signStatusChangeError?: string, // Текст ошибки при блокировке изменения статуса подписания, readonly
    orgId: number, // ID основного исполнителя
    org: ApiContractorInfo, // Основной исполнитель, readonly
    orgBankAccountId?: number, // ID р/с основного исполнителя
    orgBankAccount?: ApiBankAccount, // Р/с основного исполнителя, readonly
    orgSignerId?: number, // ID подписанта основного исполнителя
    orgSigner?: ApiSigner, // Подписан основного исполнителя, readonly
    orgsAdditional: { // Дополнительные исполнители по договору
        contractorId: number, // ID исполнителя
        contractor: ApiContractorInfo, // Исполнитель, readonly
        bankAccountId?: number, // ID р/с исполнителя
        bankAccount?: ApiBankAccount, // Р/с исполнителя, readonly
        signerId?: number, // ID подписанта исполнителя
        signer?: ApiSigner, // Подписан исполнителя, readonly
        docBankAccountId?: number, // ID счёта исполнителя для счетов и актов
        docBankAccount?: ApiBankAccount, // Счёт исполнителя для счетов и актов, readonly
        docSignerId?: number, // ID подписанта исполнителя для счетов и актов
        docSigner?: ApiSigner, // Подписант исполнителя для счетов и актов, readonly
        share: number // Числитель доли исполнителя
    }[],
    orgShareBase?: number, // Знаменатель доли исполнителей, по умолчанию 10.000
    orgUtilityId: number, // ID исполнителя для выставления 100% переменной части
    orgUtility: ApiContractorInfo, // Исполнитель для выставления 100% переменной части, reaodnly
    clientId: number, // ID заказчика
    client: ApiContractorInfo, // Заказчик, readonly
    clientBankAccountId?: number, // ID р/с заказчика
    clientBankAccount?: ApiBankAccount, // Р/с заказчика, readonly
    clientSignerId?: number, // ID заказчика исполнителя
    clientSigner?: ApiSigner, // Подписан заказчика, readonly
    file: ApiDocumentFile, // Файл или шаблон
    warnings: ContractWarning, // Предупреждения по договору, readonly
    currency: Currency, // Валюта
    amount: number, // Стоимость по соглашению, readonly
    amountRooms: number, // Стоимость помещений, readonly
    amountServices: number, // Стоимость услуг, readonly
    amountIndexed: number, // Индексированная стоимость по соглашению, readonly
    amountRoomsIndexed: number, // Индексированная стоимость помещений, readonly
    amountServicesIndexed: number, // Индексированная стоимость услуг, readonly
    lines: ApiContractLine[], // Строки помещений и фиксированных услуг
    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?: ApiBankAccount, // Счёт основного исполнителя для счетов и актов, readonly
    docOrgSignerId?: number, // ID подписанта основного исполнителя для счетов и актов
    docOrgSigner?: ApiSigner, // Подписант основного исполнителя для счетов и актов, readonly
    docClientBankAccountId?: number, // ID счёта заказчика для счетов и актов
    docClientBankAccount?: ApiBankAccount, // Счёт заказчика для счетов и актов, readonly
    docClientSignerId?: number, // ID подписанта заказчика для счетов и актов
    docClientSigner?: ApiSigner, // Подписант заказчика для счетов и актов, readonly
    createDate: DateTime, // Дата и время создания, readonly
    changeDate: DateTime // Дата и время последнего изменения, readonly
}

ApiContractVersionInfo

Краткая информация о текущем активном соглашении договора.

{
    id: number,
    orgs: ApiContractorInfoWithShare[], // Исполнители
    client: ApiContractorInfo, // Заказчик
    amountRooms: number, // Стоимость помещений
    amountServices: number, // Стоимость услуг
    square: number, // Площадь
    hasHolidays: boolean, // Есть скидки
    buildings: ApiBuildingInfo[], // Объекты в соглашении
    utilities: UtilityType[], // Переменная часть
    createDate: DateTime, // Дата и время создания
    changeDate: DateTime // Дата и время последнего изменения
}

ApiContractLine

Строка договора с информацией о помещении или фиксированной услуге.

{
    id: number,
    isRoom: boolean, // Помещение или услуга
    name?: string, // Наименование
    roomId?: number, // ID помещения
    room?: ApiRoomTree, // Помещение, readonly
    serviceId?: number, // ID услуги
    service?: ApiService, // Услуга, readonly
    category?: DocumentLineCategory, // Категория строки
    quantity: number, // Количество
    unit?: string, // Единица измерения
    price: number, // Цена строки
    amount: number, // Сумма строки
    ndsPercent?: NdsPercent, // НДС %
    isAmountOnly: boolean // Не брать в расчет цену, а только сумму
}

ApiContractorInfo

Информация о контрагенте.

{
    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
}

ApiContractorInfoWithShare

Информация о контрагенте с долей.

{
    ...ApiContractorInfo
    share?: number, // Числитель доли
    shareBase?: number // Знаменатель доли
}

ApiBankAccount

Расчётный счёт.

{
    id: number,
    status: ItemStatus, // Статус
    expiry?: Date, // Срок действия
    currency: Currency, // Валюта
    number: string, // Номер р/с
    bik: string, // Идентификационный код банка
    bankName: string, // Название банка
    corr?: string, // Корр. счёт
    comment?: string, // Комментарий
    createDate: DateTime, // Дата и время создания, readonly
    changeDate: DateTime // Дата и время последнего изменения, readonly
}

ApiDocumentFile

Информация о файле документа.

{
    templateId?: number, // ID шаблона
    template?: ApiTemplateInfo, // Шаблон
    fileId?: Guid, // ID файла
    name?: string, // Наименование файла
    urlDocx?: string, // Ссылка на DOCX файл
    urlPdf?: string, // Ссылка на PDF файл
    urlPdfWithActs?: string // Ссылка на PDF с актами п/п
}

ApiDocumentRule

Правило формирования счетов и актов по договору.

{
    id: number,
    name, string, // Наименование
    status: ItemStatus, // Статус
    lineMode: DocumentLineMode, // Тип срок в счетах и актах
    lineContract: boolean, // Включать номер договора в каждую строку
    invoiceSurchargeDays?: number, // Выставлять счета на доплату
    attachments: boolean, // Прикладывать акты РСО арендаторам
    usageCount: number, // Кол-во договоров с этим правилом
    createDate: DateTime, // Дата и время создания, readonly
    changeDate: DateTime // Дата и время последнего изменения, readonly
}

ApiEmployee

Информация о сотруднике.

{
    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?: ApiFileInfo, // Аватар пользователя
    managerCount: number, // Кол-во секиций, где сотрудник управляющий, readonly
    responsibleCount: number, // Кол-во договоров, где сотрудник ответсвенный, readonly
    createDate: DateTime, // Дата и время создания, readonly
    changeDate: DateTime, // Дата и время последнего изменения, readonly
    activityDate: DateTime, // Дата и время последней активности, readonly
    lockoutEnd?: DateTime // Дата и время срока блокировки пользователя, readonly
}

ApiFileInfo

Информация о файле в системе.

{
    id: Guid,
    url: string // Ссылка на файл, readonly
}

ApiPayment

Денежная операция.

{
    id: number,
    type: PaymentType, // Тип платежа
    number?: string, // Номер
    date: Date, // Дата
    orgId: number, // ID исполнителя
    org: ApiContractorInfo, // Исполнитель, readonly
    orgBankAccountId?: number, // ID р/с исполнителя
    orgBankAccount?: ApiBankAccount, // Р/с исполнителя, readonly
    clientId: number, // ID заказчика
    client: ApiContractorInfo, // Заказчик, readonly
    clientBankAccountId?: number, // ID р/с заказчика
    clientBankAccount?: ApiBankAccount, // Р/с заказчика, readonly
    currency: Currency, // Валюта платежа
    amount: number, // Сумма платежа
    amountConnected: number, // Разнесенная сумма, readonly
    purpose?: string, // Назначение платежа
    comment?: string, // Комментарий
    createDate: DateTime, // Дата и время создания, readonly
    changeDate: DateTime // Дата и время последнего изменения, readonly
}

ApiSigner

Подписант контрагента.

{
    id: number,
    status: ItemStatus, // Статус
    expiry?: Date, // Срок действия
    name: string, // ФИО
    nameGenitive?: string, // ФИО в родительном падеже
    position?: string, // Должность
    positionGenitive?: string, // Должность в родительном падеже
    actsOnTheBasisOf?: string, // Действует на основании
    signName?: string, // Имя для подписи
    signFile?: ApiFileInfo, // Файл подписи
    createDate: DateTime, // Дата и время создания, readonly
    changeDate: DateTime // Дата и время последнего изменения, readonly
}

ApiTemplateInfo

Информация о шаблоне документа.

{
    id: number,
    name: string, // Наименование
    type: TemplateType, // Тип
    status: ItemStatus, // Статус
    expiry?: Date, // Срок действия
    file: ApiFileInfo, // Основной файл
    fileVatInvoice?: ApiFileInfo, // Файл счёта-фактуры для типа акта
    createDate: DateTime, // Дата и время создания, readonly
    changeDate: DateTime // Дата и время последнего изменения, readonly
}

ApiUserInfo

Информация о пользователе.

{
    id: number,
    email: string,
    displayName: string, // Отображаемое имя
    avatar?: ApiFileInfo // Аватар пользователя
}