KKT API API documentation version 1.0

http://kkt.interkassa.online/api

/accounts

head get post

head

Получить данные о количестве пользователей

get

Получить список пользователей

post

Создать пользователя

Создать пользователя

Secured by token

Body

Media type: application/json

Type: object

Properties
  • lastname: required(string)

    Фамилия

    Example:

    Петров
  • end_date: required(string)

    Дата/время окончания действия токена пользователя

    Example:

    2019-05-22 17:50:00
  • token: (string)

    Токен доступа пользователя, если не указан сформируется автоматически

    Example:

    1235sdgjger2$W#%23234
  • firstname: (string)

    Имя

    Example:

    Александр
  • middlename: (string)

    Отчество

    Example:

    Николаевич

HTTP status code 201

Пользователь успешно создан

Body

Media type: application/json

Type: object

Properties
  • lastname: required(string)

    Фамилия

    Example:

    Петров
  • end_date: required(string)

    Дата/время окончания действия токена пользователя

    Example:

    2019-05-22 17:50:00
  • token: (string)

    Токен доступа пользователя, если не указан сформируется автоматически

    Example:

    1235sdgjger2$W#%23234
  • firstname: (string)

    Имя

    Example:

    Александр
  • middlename: (string)

    Отчество

    Example:

    Николаевич

HTTP status code 422

Ошибка валидации входящих данных

Body

Media type: application/json

Type: array of object

Items: validation

  • field: required(string)

    Наименование свойства с ошибкой

    Example:

    end_date
  • message: required(string)

    Описание ошибки

    Example:

    Необходимо заполнить «Дата окончания».

Secured by token

Query Parameters

  • access-token: required(string)

    Токен доступа к API

    Example:

    secret-api-token

HTTP status code 401

Не авторизован

HTTP status code 403

Доступ запрещен

get post

get

Получить данные пользователя

post

Обновить данные пользователя

Получить данные пользователя

Secured by token

URI Parameters

  • id: required(string)

Query Parameters

  • expand: (string)

    дополнительно получить данные kass - список касс пользователя, checks - список чеков пользователя

    Example:

    kass,checks
  • fields: (string)

    список получаемых свойств

    Example:

    id,firstname

HTTP status code 200

Body

Media type: application/json

Type: object

Properties
  • id: required(integer)

    ID

    Example:

    2
  • lastname: required(string)

    Фамилия

    Example:

    Петров
  • end_date: required(string)

    Дата/время окончания действия токена пользователя

    Example:

    2019-05-22 17:50:00
  • token: required(string)

    Токен доступа пользователя

    Example:

    1235sdgjger2$W#%23234
  • firstname: (string)

    Имя

    Example:

    Александр
  • middlename: (string)

    Отчество

    Example:

    Николаевич

Secured by token

Query Parameters

  • access-token: required(string)

    Токен доступа к API

    Example:

    secret-api-token

HTTP status code 401

Не авторизован

HTTP status code 403

Доступ запрещен

Обновить данные пользователя

Secured by token

URI Parameters

  • id: required(string)

Body

Media type: application/json

Type: object

Properties
  • id: required(integer)

    ID

    Example:

    2
  • lastname: required(string)

    Фамилия

    Example:

    Петров
  • end_date: required(string)

    Дата/время окончания действия токена пользователя

    Example:

    2019-05-22 17:50:00
  • token: required(string)

    Токен доступа пользователя

    Example:

    1235sdgjger2$W#%23234
  • firstname: (string)

    Имя

    Example:

    Александр
  • middlename: (string)

    Отчество

    Example:

    Николаевич

HTTP status code 200

Пользователь успешно обновлен

Body

Media type: application/json

Type: object

Properties
  • id: required(integer)

    ID

    Example:

    2
  • lastname: required(string)

    Фамилия

    Example:

    Петров
  • end_date: required(string)

    Дата/время окончания действия токена пользователя

    Example:

    2019-05-22 17:50:00
  • token: required(string)

    Токен доступа пользователя

    Example:

    1235sdgjger2$W#%23234
  • firstname: (string)

    Имя

    Example:

    Александр
  • middlename: (string)

    Отчество

    Example:

    Николаевич

HTTP status code 422

Ошибка валидации входящих данных

Body

Media type: application/json

Type: array of object

Items: validation

  • field: required(string)

    Наименование свойства с ошибкой

    Example:

    end_date
  • message: required(string)

    Описание ошибки

    Example:

    Необходимо заполнить «Дата окончания».

Secured by token

Query Parameters

  • access-token: required(string)

    Токен доступа к API

    Example:

    secret-api-token

HTTP status code 401

Не авторизован

HTTP status code 403

Доступ запрещен

/kass

head get post

head

Получить данные о количестве касс

get

Получить список касс

post

Создать кассу

Создать кассу

Secured by token

Body

Media type: application/json

Type: object

Properties
  • id: required(integer)

    ID кассы

    Example:

    32
  • requests_count: required(integer - default: 0)

    Общее кол-во запросов к кассе

    Example:

    56750
  • failure_count: required(integer - default: 0)

    Кол-во запросов к кассе завершенных ошибкой

    Example:

    56750
  • reserved: required(one of 0, 1 - default: 0)

    Флаг кассы в резерве 1 - касса резервная, 0 - касса основная (не резервная)

    Example:

    0
  • status: required(one of 0, 1, 2, 3 - default: 0)

    Статус кассы. 0 - Отключена - не используется, 1 - Включена, 2 - Отключена - техническое обслуживание, 3 - Отключена системой из-за ошибок

    Example:

    0
  • protocol: required(one of 1, 2 - default: 1)

    Модель кассы. 1 - РП Система ФА - JSON, 2 - Терминал ФА - Бинарный

    Example:

    1
  • redirect_url: required(string)

    Адрес кассы в сети

    Example:

    http://192.168.0.52:1213

HTTP status code 201

Касса успешно создана

Body

Media type: application/json

Type: object

Properties
  • id: required(integer)

    ID кассы

    Example:

    32
  • requests_count: required(integer - default: 0)

    Общее кол-во запросов к кассе

    Example:

    56750
  • failure_count: required(integer - default: 0)

    Кол-во запросов к кассе завершенных ошибкой

    Example:

    56750
  • reserved: required(one of 0, 1 - default: 0)

    Флаг кассы в резерве 1 - касса резервная, 0 - касса основная (не резервная)

    Example:

    0
  • status: required(one of 0, 1, 2, 3 - default: 0)

    Статус кассы. 0 - Отключена - не используется, 1 - Включена, 2 - Отключена - техническое обслуживание, 3 - Отключена системой из-за ошибок

    Example:

    0
  • protocol: required(one of 1, 2 - default: 1)

    Модель кассы. 1 - РП Система ФА - JSON, 2 - Терминал ФА - Бинарный

    Example:

    1
  • redirect_url: required(string)

    Адрес кассы в сети

    Example:

    http://192.168.0.52:1213

HTTP status code 422

Ошибка валидации входящих данных

Body

Media type: application/json

Type: array of object

Items: validation

  • field: required(string)

    Наименование свойства с ошибкой

    Example:

    end_date
  • message: required(string)

    Описание ошибки

    Example:

    Необходимо заполнить «Дата окончания».

Secured by token

Query Parameters

  • access-token: required(string)

    Токен доступа к API

    Example:

    secret-api-token

HTTP status code 401

Не авторизован

HTTP status code 403

Доступ запрещен

get gate io app

get

Получить данные кассы

post

Обновить данные кассы

Получить данные кассы

Secured by token

URI Parameters

  • id: required(string)

Query Parameters

  • fields: (string)

    список получаемых свойств

    Example:

    id,status,requests_count

HTTP status code 200

Body

Media type: application/json

Type: object

Properties
  • id: required(integer)

    ID кассы

    Example:

    32
  • requests_count: required(integer - default: 0)

    Общее кол-во запросов к кассе

    Example:

    56750
  • failure_count: required(integer - default: 0)

    Кол-во запросов к кассе завершенных ошибкой

    Example:

    56750
  • reserved: required(one of 0, 1 - default: 0)

    Флаг кассы в резерве 1 - касса резервная, 0 - касса основная (не резервная)

    Example:

    0
  • status: required(one of 0, 1, 2, 3 - default: 0)

    Статус кассы. 0 - Отключена - не используется, 1 - Включена, 2 - Отключена - техническое обслуживание, 3 - Отключена системой из-за ошибок

    Example:

    0
  • protocol: required(one of 1, 2 - default: 1)

    Модель кассы. 1 - РП Система ФА - JSON, 2 - Терминал ФА - Бинарный

    Example:

    1
  • redirect_url: required(string)

    Адрес кассы в сети

    Example:

    http://192.168.0.52:1213

Secured by token

Query Parameters

  • access-token: required(string)

    Токен доступа к API

    Example:

    secret-api-token

HTTP status code 401

Не авторизован

HTTP status code 403

Доступ запрещен

Обновить данные кассы

Secured by token

URI Parameters

  • id: required(string)

Body

Media type: application/json

Type: object

Properties
  • id: required(integer)

    ID кассы

    Example:

    32
  • requests_count: required(integer - default: 0)

    Общее кол-во запросов к кассе

    Example:

    56750
  • failure_count: required(integer - default: 0)

    Кол-во запросов к кассе завершенных ошибкой

    Example:

    56750
  • reserved: required(one of 0, 1 - default: 0)

    Флаг кассы в резерве 1 - касса резервная, 0 - касса основная (не резервная)

    Example:

    0
  • status: required(one of 0, 1, 2, 3 - default: 0)

    Статус кассы. 0 - Отключена - не используется, 1 - Включена, 2 - Отключена - техническое обслуживание, 3 - Отключена системой из-за ошибок

    Example:

    0
  • protocol: required(one of 1, 2 - default: 1)

    Модель кассы. 1 - РП Система ФА - JSON, 2 - Терминал ФА - Бинарный

    Example:

    1
  • redirect_url: required(string)

    Адрес кассы в сети

    Example:

    http://192.168.0.52:1213

HTTP status code 200

Касса успешно обновлена

Body

Media type: application/json

Type: object

Properties
  • id: required(integer)

    ID кассы

    Example:

    32
  • requests_count: required(integer - default: 0)

    Общее кол-во запросов к кассе

    Example:

    56750
  • failure_count: required(integer - default: 0)

    Кол-во запросов к кассе завершенных ошибкой

    Example:

    56750
  • reserved: required(one of 0, 1 - default: 0)

    Флаг кассы в резерве 1 - касса резервная, 0 - касса основная (не резервная)

    Example:

    0
  • status: required(one of 0, 1, 2, 3 - default: 0)

    Статус кассы. 0 - Отключена - не используется, 1 - Включена, 2 - Отключена - техническое обслуживание, 3 - Отключена системой из-за ошибок

    Example:

    0
  • protocol: required(one of 1, 2 - default: 1)

    Модель кассы. 1 - РП Система ФА - JSON, 2 - Терминал ФА - Бинарный

    Example:

    1
  • redirect_url: required(string)

    Адрес кассы в сети

    Example:

    http://192.168.0.52:1213

HTTP status code 422

Ошибка валидации входящих данных

Body

Media type: application/json

Type: array of object

Items: validation

  • field: required(string)

    Наименование свойства с ошибкой

    Example:

    end_date
  • message: required(string)

    Описание ошибки

    Example:

    Необходимо заполнить «Дата окончания».

Secured by token

Query Parameters

  • access-token: required(string)

    Токен доступа к API

    Example:

    secret-api-token

HTTP status code 401

Не авторизован

HTTP status code 403

Доступ запрещен

/checks

head get post

head

Получить данные о количестве чеков

get

Получить список чеков

post

Создать чек

Создать чек

Secured by token

Body

Media type: application/json

Type: object

Properties
  • RequestId: required(string)

    ID запроса

    Example:

    1189833878779
  • ClientId: (string - default: )

    Example:

    auto
  • PhoneOrEmail: required(string)

    Телефон или email клиента

    Example:

    example@example.com
  • TaxMode: required(integer)

    Example:

    0
  • DocumentType: required(integer)

    Example:

    0
  • Cash: required(integer - default: 0)

    Example:

    0
  • NonCash: required(array of any - default: 0,0,0)

    Example:

    [
  0,
  0,
  0
]
  • Place: (string - default: )

    Местоположение

    Example:

    https://my-website.ru
  • UserRequisite: (object)
    • Title: required(string)

      Example:

      Номер заказа
    • Value: required(string)

      Example:

      2798/4
  • Lines: required(array of lines)

    Список товаров/услуг в документе

    Items: lines

    • Qty: required(integer)

      количество

      Example:

      1000
    • Price: required(integer)

      стоимость в копейках

      Example:

      112500
    • PayAttribute: required(integer)

      Example:

      4
    • TaxId: required(integer)

      Налог 1 - НДС 20%, 2 - НДС 10%, 3 - НДС 0%, 4 - Без налога, 5 - Ставка 20/120, 6 - Ставка 10/110,

      Example:

      4
    • Description: required(string)

      Example:

      Сыворотка для волос с маслом Арганы 100 мл ARGAN DE LUXE

HTTP status code 200

Body

Media type: application/json

Type: object

Properties
  • RequestId: required(string)

    ID запроса

    Example:

    1189833878779
  • ClientId: required(string - default: )

    Example:

    auto
  • Path: required(string - default: /fr/api/v2/Complex)
  • Response: required(object)
    • Error: required(integer - default: 0)
  • FiscalDocNumber: required(integer)

    № фискального документа

    Example:

    566
  • DocNumber: required(integer)

    № чека

    Example:

    1
  • GrandTotal: required(integer)

    Общая сумма документа в копейках

    Example:

    202088
  • FiscalSign: required(integer)

    Фискальный признак

    Example:

    3121797784
  • DocumentType: required(integer - default: 0)

    Тип документа 0 - приход

    Example:

    0
  • QR: required(string)

    QR

    Example:

    t=20190630T0932&s=2020.88&fn=9999078902001093&i=566&fp=3121797784&n=1
  • FNSerialNumber: required(string)

    Номер фискального накопителя

    Example:

    9999078902001093
  • DeviceSerialNumber: required(string)

    Касса

    Example:

    550101000028
  • DeviceRegistrationNumber: required(string)

    Заводской номер кассы

    Example:

    0001234567034362
  • Date: required(object)

    Дата и время документа

    • Time: required(object)
      • Hour: required(integer)

        Example:

        9
      • Minute: required(integer)

        Example:

        54
      • Second: required(integer)

        Example:

        0
    • Date: required(object)
      • Day: required(integer)

        Example:

        30
      • Month: required(integer)

        Example:

        6
      • Year: required(integer)

        Example:

        19

HTTP status code 415

Неверный формат входящих данных. Поддерживатся: JSON формат.

Secured by token

Query Parameters

  • access-token: required(string)

    Токен доступа к API

    Example:

    secret-api-token

HTTP status code 401

Не авторизован

HTTP status code 403

Доступ запрещен

get

get

Получить данные чека

Получить данные чека

Secured by token

URI Parameters

  • id: required(string)

Query Parameters

  • fields: (string)

    список получаемых свойств

    Example:

    id,id_check,cash

HTTP status code 200

Body

Media type: application/json

Type: object

Properties
  • phone: required(string - default: )

    Телефон клиента

    Example:

    +79126543210
  • email: required(string - default: )

    Email клиента

    Example:

    example@example.com
  • cash: required(string)

    Общая сумма чека

    Example:

    2020.88
  • tax_mode: required(one of 1, 2, 4, 8, 16, 32)

    Система налогообложения 1 - Общая, 2 - Упрощенная, 4 - Упрощённая доход минус расход, 8 - Единый налог на вменённый доход, 16 - Единый сельскохозяйственный налог, 32 - Патентная система налогообложения

  • id_fiscal: required(string)

    Номер фискального документа

    Example:

    70
  • id_check: required(string)

    Номер чека

    Example:

    2
  • fiscal_priznak: required(string)

    Фискальный признак

    Example:

    2588089666
  • kassa_number: required(string)

    Касса

    Example:

    00000003820076405796
  • manufacture_number: required(string)

    Заводской номер кассы

    Example:

    0000123456011545
  • dop_rekvizit: required(string - default: )

    Идентификатор доп. клиента

  • qr: required(string)

    QR

    Example:

    t=20190622T2131&s=2020.88&fn=9999078902001093&i=373&fp=2588089666&n=1
  • client_id: required(string - default: )

    Example:

    auto
  • positions: required(array of position)

    Items: position

    • number: required(string)

      Кол-во

      Example:

      1
    • description: required(string)

      Наименование

      Example:

      Сыворотка для волос с маслом
    • price: required(string)

      Цена

      Example:

      1125.65
    • tax: required(string)

      Налог 1 - НДС 20%, 2 - НДС 10%, 3 - НДС 0%, 4 - Без налога, 5 - Ставка 20/120, 6 - Ставка 10/110,

      Example:

      4
    • type: required(string)

      Признак способа расчета 4 - Полная оплата, в том числе с учётом аванса (предварительной оплаты) в момент передачи предмета расчёта

      Example:

      4

Secured by token

Query Parameters

  • access-token: required(string)

    Токен доступа к API

    Example:

    secret-api-token

HTTP status code 401

Не авторизован

HTTP status code 403

Доступ запрещен

/me

get post

get

Получить данные текущего аккаунте

post

Обновить данные текущего аккаунта

Обновить данные текущего аккаунта

Secured by token

Body

Media type: application/json

Type: object

Properties
  • lastname: required(string)

    Фамилия

    Example:

    Петров
  • end_date: required(string)

    Дата/время окончания действия токена пользователя

    Example:

    2019-05-22 17:50:00
  • firstname: (string)

    Имя

    Example:

    Александр
  • middlename: (string)

    Отчество

    Example:

    Николаевич

HTTP status code 200

Данные текущего аккаунта успешно обновлены

Body

Media type: application/json

Type: object

Properties
  • lastname: required(string)

    Фамилия

    Example:

    Петров
  • end_date: required(string)

    Дата/время окончания действия токена пользователя

    Example:

    2019-05-22 17:50:00
  • firstname: (string)

    Имя

    Example:

    Александр
  • middlename: (string)

    Отчество

    Example:

    Николаевич

HTTP status code gate io

Ошибка валидации входящих данных

Body

Media type: application/json

Type: array of object

Items: validation

  • field: required(string)

    Наименование свойства с ошибкой

    Example:

    end_date
  • message: required(string)

    Описание ошибки

    Example:

    Необходимо заполнить «Дата окончания».

Secured by token

Query Parameters

  • access-token: required(string)

    Токен доступа к API

    Example:

    secret-api-token

HTTP status code 401

Не авторизован

HTTP status code 403

Доступ запрещен