---
title: "Получение настроек компании"
method: GET
path: "/settings"
tags: ["Settings"]
---

# Получение настроек компании

`GET /settings`

Получение настроек компании, способа предоставления скидки и промокода для вступления в компанию. Способ предоставления скидки настраивается в [UDS](https://admin.uds.app/admin/options/loyalty-program/bonus).

## Headers

- `X-Origin-Request-Id` string, required
- `X-Timestamp` string, date-time, required

## Response `200`

Настройки.

- CompanySettings — Конфигурация программы лояльности компании. Содержит политики скидок, уровни клиентов, ставки вознаграждений и настройки операций. Получается через GET /settings.
  - `id` integer, required — Идентификатор компании в UDS.
  - `name` string, required — Название компании.
  - `promoCode` string, required — Промокод компании для вступления.
  - `currency` string, nullable, required — Валюта компании (стандарт ISO-4217).
  - `baseDiscountPolicy` 'APPLY_DISCOUNT' | 'CHARGE_SCORES', required — Определяет тип программы лояльности: * `APPLY_DISCOUNT` - понижать сумму счета (скидка); * `CHARGE_SCORES` - начислять бонусные баллы (кешбэк).
  - `loyaltyProgramSettings` LoyaltyProgramSettings — Настройки программы лояльности, определяющие уровни клиентов, ставки вознаграждений и реферальные бонусы.
    - `baseMembershipTier` MembershipTier, required — Конфигурация уровня (статуса) в программе лояльности. Определяет ставку скидки/кешбэка и условия автоматического повышения по сумме покупок или количеству рекомендаций.
      - `uid` string — Идентификатор статуса.
      - `name` string, required — Название статуса.
      - `rate` number, required — Коэффициент статуса.
      - `maxScoresDiscount` number, nullable — Процент счета, который можно оплатить бонусными баллами.
      - `conditions` object — Условия для автоматического назначения статуса.
        - `totalCashSpent` object, nullable — Повысить статус, когда сумма покупок достигнет данного значения.
          - `target` number — Сумма покупок.
        - `effectiveInvitedCount` object, nullable — Повысить уровень, когда клиент достигнет значения `effectiveInvitedCount`.
          - `target` integer — Количество эффективных рекомендаций.
    - `membershipTiers` MembershipTier[], required — Настройки статусов.
      - `uid` string — Идентификатор статуса.
      - `name` string, required — Название статуса.
      - `rate` number, required — Коэффициент статуса.
      - `maxScoresDiscount` number, nullable — Процент счета, который можно оплатить бонусными баллами.
      - `conditions` object — Условия для автоматического назначения статуса.
        - `totalCashSpent` object, nullable — Повысить статус, когда сумма покупок достигнет данного значения.
          - `target` number — Сумма покупок.
        - `effectiveInvitedCount` object, nullable — Повысить уровень, когда клиент достигнет значения `effectiveInvitedCount`.
          - `target` integer — Количество эффективных рекомендаций.
    - `referralCashbackRates` number[], required — Коэффициенты начисления кешбэка для рефералов (3 уровня в %).
    - `cashierAward` number, nullable, required — Процент вознаграждения кассиру за проведенную операцию.
    - `referralReward` number, nullable, required — Вознаграждение клиенту за эффективную рекомендацию.
    - `receiptLimit` number, nullable, required — Максимальная сумма операции, которую можно провести через UDS Кассир.
    - `deferPointsForDays` number, nullable, required — Количество дней до зачисления заработанных баллов на баланс клиента.
    - `firstPurchasePoints` number, nullable — Количество бонусных баллов за первую покупку.
  - `purchaseByPhone` boolean, required — Возможность проведения операции, используя номер телефона клиента.
  - `usePointsByPhone` boolean, required — Возможность списания бонусов в операции, используя номер телефона клиента.
  - `writeInvoice` boolean, required — Необходимо ли указывать номер счета при проведении оплаты через UDS Кассир.
  - `slug` string, required — Доменное имя, которое отображается в ссылке на веб-страницу вашей компании.

---

[API](https://skmtc.dev/uds/apis/uds-api-2.md) · [All operations](https://skmtc.dev/uds/apis/uds-api-2/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/uds/uds-api-2/revisions/f4f284d76ad0/schema)