Метод getDealInfoWithParams

Возвращает информацию о сделке с указанными параметрами.

Параметры

• ctx: app.Ctx
  Контекст приложения, содержащий информацию о текущем пользователе и окружении.

• id: (string | number)
  Идентификатор сделки, который может быть строкой или числом.

• params: DealInfoParams
  Объект с дополнительными параметрами для получения информации о сделке:

  • tags: (boolean) — если true, включить теги сделки.
  • customFields: (boolean) — если true, включить пользовательские поля сделки.

Возвращаемое значение

Метод возвращает Promise<DealInfo> — промис, который разрешается в объект типа DealInfo, представляющий информацию о сделке.

Свойства DealInfo

• id: number
  Идентификатор сделки.

• ACCOUNT_ID: number
  Идентификатор аккаунта.

• user_id: number
  Идентификатор пользователя, связанного со сделкой.

• updated_at: GcDateString
  Дата и время последнего обновления сделки.

• created_at: GcDateString
  Дата и время создания сделки.

• created_user_id: number
  Идентификатор пользователя, создавшего сделку.

• cost: number
  Стоимость сделки.

• currency: keyof typeof Currency
  Валюта сделки.

• status: keyof typeof DealStatus
  Статус сделки.

• is_payed: 1 | 0
  Флаг, указывающий, оплачена ли сделка (1 - да, 0 - нет).

• params: string
  Параметры сделки в формате JSON. Пример: {"source":"admin","payment_deadline_disabled":"0","payment_deadline":""}.

• title: string
  Заголовок сделки.

• number: number
  Номер сделки.

• foreign_code: string
  Внешний код сделки.

• manager_user_id: number | null
  Идентификатор менеджера, ответственного за сделку.

• partner_user_id: number | null
  Идентификатор партнера, связанного со сделкой.

• partner_code_id: number | null
  Идентификатор партнерского кода.

• payed_value: number
  Сумма оплаты по сделке.

• earned_value: number
  Сумма заработка по сделке.

• commission_value: number
  Сумма комиссии по сделке.

• payed_at: GcDateString | null
  Дата и время оплаты сделки.

• is_finished: 1 | 0
  Флаг, указывающий, завершена ли сделка (1 - да, 0 - нет).

• finished_at: GcDateString | null
  Дата и время завершения сделки.

• user_payed_money_value: number
  Сумма денег, оплаченная пользователем.

• client_deal_number: number
  Номер сделки клиента.

• cancel_reason_id: number | null
  Идентификатор причины отмены сделки.

• status_updated_at: GcDateString
  Дата и время последнего обновления статуса сделки.

• to_deposit_money_value: number
  Сумма денег, подлежащая депонированию.

• for_account_id: number | null
  Идентификатор аккаунта, для которого предназначена сумма депозита.

• positions: object[]
  Список позиций в сделке. Каждая позиция имеет следующие свойства:

  • offer_id: number
    Идентификатор предложения.

  • updated_at: GcDateString
    Дата и время последнего обновления позиции.

  • created_at: GcDateString
    Дата и время создания позиции.

  • quantity: number
    Количество.

  • title: string
    Название позиции.

  • price: number
    Цена за единицу.

  • currency: keyof typeof Currency
    Валюта.

  • order_pos: number
    Порядковый номер позиции в заказе.

  • user_product_id: number | null
    Идентификатор пользовательского продукта, связанного с позицией.

  • source_price: number
    Исходная цена.

  • start_at: GcDateString | null
    Дата и время начала действия позиции.

Пример использования

const dealInfo = await getDealInfoWithParams(ctx, 12345, { tags: true, customFields: false })
console.log(dealInfo)