• KB Home
  • SME API
  • SME API: SMS
  • Получение данных учётной записи клиента (account)

Получение данных учётной записи клиента (account)

Метод, описанный в этой статье, предназначен только для SME.

В результате выполнения запроса возвращается JSON-объект с данными учетной записи клиента (см. ниже) и код ответа 200 ОК. В случае неуспешного выполнения запроса возвращается один из стандартных кодов ошибок.

URL-адрес подключения

Для получения данных клиента выполняется GET-запрос на URL-адрес: https://sms.edna.ru/connector_sme/api/account

Параметры запроса

Формально запрос без параметров, но необходимо передать APIKey клиента в заголовке запроса X-API-KEY.

Формат ответа

В ответ на запрос возвращается JSON-объект с данными клиента

{
    "code": "edna",
    "name": "ООО ОСК",
    "email": "info@edna.ru",
    "contractNumber": "5757",
    "contractDate": "2014-07-17",
    "inn": 7705658056,
    "createdAt": "2014-07-17T12:00:00.000Z",
    "active": true,
    "balance": "1000000.00"
}

Параметры ответа

ПараметрТип данныхОписание
codestring (required)Кодовое обозначение клиента
namestring (optional)Имя/название клиента
emailstring (optional)Email-адрес клиента
contractNumberstring (optional)Номер договора с клиентом
contractDatestring (optional)Дата заключения договора в формате ГГГГ-ММ-ДД
innstring (optional)ИНН клиента
createdAtstring (required)Дата и время создания учетной записи, например, 2014-07-17T12:00:00.000Z. Дата и время, разделенные буквой Т. «00.000» — количество секунд и миллисекунд. «Z» — означает время по UTC
activeboolean (required)Учетная запись: true – активна, false – заблокирована
balancestring (optional)Количество денег (в рублях) на счету клиента