schema_definitions.yml

---
info:
  version: '2.0'
  title: Nebula API v2
  description: |-
    OpenApi-like definition for receipt schema with extensions and additions
    Подробнее про поля имеет смысл смотреть в Приказ ФНС России от 21.03.2017 N ММВ-7-20/229@ (ред. от 22.10.2018)
    "Об утверждении дополнительных реквизитов фискальных документов и форматов фискальных документов,
    обязательных к использованию" (Зарегистрировано в Минюсте России 13.04.2017 N 46361)
    (с изм. и доп., вступ. в силу с 01.01.2019)

anyOf:
  - "$ref": "#definitions/CheckDocumentCreate[CheckContent]"
  - "$ref": "#definitions/CheckDocumentCreate[CorrectionContent]"

definitions:
  CheckDocumentCreate[CheckContent]:
    type: object
    properties:
      id:
        title: Идентификатор документа
        description: должен быть уникален в пределах организации.
        type: string
        minLength: 1
        maxLength: 64
      inn:
        title: ИНН организации
        description: ИНН организации, для которой пробивается чек
        type: string
        minLength: 10
        maxLength: 12
      group:
        title: Группа устройств
        description: Группа устройств, с помощью которых будет пробит чек
        type: string
        minLength: 1
        maxLength: 32
        nullable: true
      key:
        title: Название ключа проверки
        description: |-
          Название ключа который должен быть использован для проверки подписи
          Для клиентов используется их ИНН, для партнеров и платежных агентов код с маской 301****
        type: string
        minLength: 1
        maxLength: 32
      content:
        title: Содержимое документа
        "$ref": "#/definitions/CheckContent"
      callbackUrl:
        description: URL для отправки результатов обработки чека POST запросом
        type: [string, "null"]
        maxLength: 1024


  CheckContent:
    type: object
    properties:
      type:
        x-tag-id: 1054
        title: Признак расчета
        type: integer
        x-enum:
          income:
            val: 1
            title: Приход
          income_return:
            val: 2
            title: Возврат прихода
          expense:
            val: 3
            title: Расход
          expense_return:
            val: 4
            title: Возврат расхода
      positions:
        title: Список предметов расчета
        x-tag-id: 1059
        type: array
        items:
          "$ref": "#/definitions/CheckPosition"
      checkClose:
        "$ref": "#/definitions/CheckClose"
        title: Параметры закрытия чека
      customerContact:
        title: Контакт покупателя
        description: Телефон или электронный адрес покупателя
        x-tag-id: 1008
        type: string
      agentType:
        format: byte
        x-tag-id: 1057
        x-todo: DRY value 1222?
        title: Признак агента
        description: |-
          Битовое поле, где номер бита обозначает,
          что оказывающий услугу покупателю (клиенту) пользователь является
          соответствующим агентом
        x-comment: |-
          Кассовый чек(БСО) может содержать реквизиты «признак агента» (тег 1057),
          только если отчет о регистрации и(или) текущий отчет о перерегистрации
          содержит реквизит «признак агента» (тег 1057), имеющий значение, идентичное
          значению реквизита «признак агента» (тег 1057) кассового чека.
        type: integer
        x-bitfield:
          bank_agent:
            bit: 0
            title: банковский платежный агент
            print: БАНК. ПЛ. АГЕНТ
          bank_subagent:
            bit: 1
            title: банковский платежный субагент
            print: БАНК. ПЛ. СУБАГЕНТ
          payment_agent:
            bit: 2
            title: платежный агент
            print: ПЛ. АГЕНТ
          payment_subagent:
            bit: 3
            title: платежный субагент
            print: ПЛ. СУБАГЕНТ
          attorney:
            bit: 4
            title: поверенный
            print: ПОВЕРЕННЫЙ
          comissioner:
            bit: 5
            title: комиссионер
            print: КОМИССИОНЕР
          other:
            bit: 6
            title: иной агент
            print: АГЕНТ

      #DRY: AgentInfo один-в-один, тут они указываются если одинаковы для всех позиций
      paymentTransferOperatorPhoneNumbers:
        title: Телефон оператора перевода
        x-tag-id: 1075
        x-todo: Тут поля из AgentInfo as-is, разобраться и мб DRY
        type: array
        items:
          type: string
      paymentAgentOperation:
        title: Операция платежного агента
        description: наименование операции банковского платежного агента или банковского платежного субагента
        x-tag-id: 1044
        type: string
      paymentAgentPhoneNumbers:
        title: Телефон платежного агента
        x-tag-id: 1073
        type: array
        items:
          type: string
      paymentOperatorPhoneNumbers:
        title: Телефон оператора по приему платежей
        x-tag-id: 1074
        type: array
        items:
          type: string
      paymentOperatorName:
        title: Наименование оператора перевода
        x-tag-id: 1026
        type: string
      paymentOperatorAddress:
        title: Адрес оператора перевода
        x-tag-id: 1005
        type: string
      paymentOperatorINN:
        title: ИНН оператора перевода
        x-tag-id: 1016
        type: string
      # / AgentInfo

      supplierPhoneNumbers:
        title: Телефон поставщика
        x-tag-id: 1171
        type: array
        items:
          type: string
      additionalUserAttribute:
        "$ref": "#/definitions/AdditionalUserAttribute"
        title: Дополнительный реквизит пользователя
        x-tag-id: 1084
      automatNumber:
        title: Номер автомата
        description: |-
          должен входить в состав кассового чека (БСО) при применении ККТ в автоматическом устройстве для расчетов
          и может не включаться в состав кассового чека (БСО) при передаче кассового чека (БСО) ОФД в электронной форме в случае,
          если указанный реквизит был передан ОФД ранее в составе отчета о регистрации или отчета об изменении параметров регистрации
        x-tag-id: 1036
        type: string
      settlementAddress:
        title: Адрес расчетов
        x-tag-id: 1009
        type: string
      settlementPlace:
        title: Место расчетов
        x-tag-id: 1187
        type: string
      additionalAttribute:
        title: Дополнительный реквизит чека (БСО)
        description: определяется ФНС
        x-tag-id: 1192
        type: string
      customer:
        title: Покупатель (клиент)
        x-tag-id: 1227
        type: string
      customerINN:
        title: ИНН покупателя (клиента)
        x-tag-id: 1228
        type: string
      cashier:
        title: Кассир
        x-tag-id: 1021
        type: string
      cashierINN:
        title: ИНН кассира
        x-tag-id: 1203
        type: string
      senderEmail:
        title: Адрес электронной почты отправителя чека
        x-tag-id: 1117
        type: string


  CheckPosition:
    title: Предмет расчета
    x-tag-id: 1059
    type: object
    properties:
      quantity:
        format: double
        title: Количество предмета расчета
        x-tag-id: 1023
        type: number
        x-comment: до 6 знаков после точки
      price:
        format: double
        title: Цена за единицу
        description: Цена за единицу предмета расчета с учетом скидок и наценок
        x-comment: до 2 знаков после точки
        x-tag-id: 1079
        type: number
      totalSum:
        format: double
        x-tag-id: 1043
        x-unknown: в документации нет, считается автоматом?
        title: Стоимость предмета расчета
        description: Стоимость предмета расчета с учетом скидок и наценок
        x-comment: |-
          Значение реквизита «стоимость предмета расчета с учетом скидок и наценок» (тег 1043)
          должно быть равно произведению значения реквизита
          «цена за единицу предмета расчета с учетом скидок и наценок» (тег 1079),
          умноженному на значение реквизита «количество предмета расчета» (тег 1023).

          В случае если вычисление значения реквизита «стоимость предмета расчета
          с учетом скидок и наценок» (тег 1043) осуществляется с использованием внешнего
          калькулирующего устройства и включается в состав кассового чека (БСО) на основании
          результатов, вычисленных этими калькулирующим устройством,
          значение реквизита «стоимость предмета расчета с учетом скидок и наценок» (тег 1043),
          вычисленного внешним калькулирующим устройством, не должно отличаться от значения реквизита
          «стоимость предмета расчета с учетом скидок и наценок» (тег 1043),
          вычисленного путем умножения значения реквизита
          «цена за единицу предмета расчета с учетом скидок и наценок» (тег 1079)
          на значение реквизита «количество предмета расчета» (тег 1023),
          больше, чем на 1 копейку.
        type: number
      tax:
        title: Ставка НДС
        x-tag-id: 1199
        type: integer
        x-enum:
          vat_18:
            val: 1
            title: ставка НДС 18% (старая, теперь 20)
          vat_20:
            val: 1
            title: ставка НДС 20%
          vat_10:
            val: 2
            title: ставка НДС 10%
          vat_18_118:
            val: 3
            title: ставка НДС расч. 18/118 (старая)
          vat_20_120:
            val: 3
            title: ставка НДС расч. 20/120
          vat_10_110:
            val: 4
            title: ставка НДС расч. 10/110
          vat_0:
            val: 5
            title: ставка НДС 0%
          vat_not_charged:
            val: 6
            title: НДС не облагается
      text:
        title: Наименование предмета расчета
        x-tag-id: 1030
        type: string
        maxLength: 128
      paymentMethodType:
        x-tag-id: 1214
        title: Признак способа расчета
        type: integer
        x-enum:
          prepay_full:
            val: 1
            title: Предоплата 100%
          prepay_partial:
            val: 2
            title: Частичная предоплата
          advance:
            val: 3
            title: Аванс
          full:
            val: 4
            title: Полный расчет
          partial_credit:
            val: 5
            title: Частичный расчет и кредит
          credit:
            val: 6
            title: Передача в кредит
          credit_payment:
            val: 7
            title: Оплата кредита

      paymentSubjectType:
        x-tag-id: 1212
        title: Признак предмета расчета
        type: integer
        nullable: true
        x-comment: если null, то считается что "товар"
        x-enum:
          goods:
            val: 1
            title: Товар
          excised_goods:
            val: 2
            title: Подакцизный товар
          work:
            val: 3
            title: Работа
          service:
            val: 4
            title: Услуга
          gambling_bet:
            val: 5
            title: Ставка азартной игры
          gambling_win:
            val: 6
            title: Выигрыш азартной игры
          lottery_ticket:
            val: 7
            title: Лотерейный билет
          lottery_win:
            val: 8
            title: Выигрыш лотереи
          intellectual:
            val: 9
            title: Предоставление РИД
            x-comment: РИД = результат интеллектуальной деятельности
          payment:
            val: 10
            title: Платеж
          comission:
            val: 11
            title: Агентское вознаграждение
          composite:
            val: 12
            title: Составной предмет расчета
          other:
            val: 13
            title: Иной предмет расчета
      nomenclatureCode:
        title: Код товарной номенклатуры
        description: |-
          base64 строка
          Данные в массиве представлены в виде строки, в которой:
            первые 4 байта –код справочника;
            последующие 8 байт – код группы товаров;
            последние 20 байт – код идентификации товара
        x-tag-id: 1162
        type: string
        nullable: true
        format: byte
        minLength: 1
        maxLength: 32
      supplierINN:
        title: ИНН поставщика
        x-tag-id: 1226
        type: string
      supplierInfo:
        "$ref": "#/definitions/SupplierInfo"
        title: Данные поставщика
        nullable: true
        x-tag-id: 1224
      agentType:
        x-tag-id: 1222
        x-todo: DRY 1057?
        title: Признак агента по предмету расчета
        description: |-
          Битовое поле, где номер бита обозначает, что оказывающий услугу покупателю (клиенту)
          пользователь является агентом
        type: integer
        x-bitfield:
          bank_agent:
            bit: 0
            title: банковский платежный агент
            description: |-
              юридическое лицо, не являющееся кредитной организацией, или индивидуальный предприниматель,
              которые привлекаются кредитной организацией в целях осуществления отдельных банковских операций. См. 161ФЗ
          bank_subagent:
            bit: 1
            title: банковский платежный субагент
            description: |-
              юридическое лицо, не являющееся кредитной организацией, или индивидуальный предприниматель,
              которые привлекаются банковским платежным агентом в целях осуществления отдельных банковских операций.
          payment_agent:
            bit: 2
            title: платежный агент
            description: |-
              юридическое лицо или индивидуальный предприниматель,
              осуществляющие деятельность по приёму платежей физических лиц (клиентов),
              в соответствии с договором, заключённым с поставщиком или с оператором по приёму платежей.
          payment_subagent:
            bit: 3
            title: платежный субагент
          attorney:
            bit: 4
            title: поверенный
          comissioner:
            bit: 5
            title: комиссионер
          other:
            bit: 6
            title: иной агент
      agentInfo:
        "$ref": "#/definitions/AgentInfo"
        title: Данные агента
        x-tag-id: 1223
      unitOfMeasurement:
        title: Единица измерения предмета расчета
        x-tag-id: 1197
        type: string
      additionalAttribute:
        title: Дополнительный реквизит предмета расчета
        description: определяется ФНС
        x-tag-id: 1191
        type: string
      manufacturerCountryCode:
        title: Код страны происхождения товара
        x-tag-id: 1230
        type: string
      customsDeclarationNumber:
        title: Номер таможенной декларации
        x-tag-id: 1231
        type: string
      excise:
        format: double
        title: Акциз
        x-tag-id: 1229
        type: number

  CheckClose:
    type: object
    properties:
      payments:
        title: Оплаты
        type: array
        items:
          "$ref": "#/definitions/CheckPayment"
      taxationSystem:
        x-tag-id: 1055
        title: Система налогообложения
        type: integer
        x-enum:
          common:
            val: 0
            title: Общая, ОСН
            print: ОСН
          simplified:
            val: 1
            title: Упрощенная доход, УСН доход
            print: УСН доход
          simplified_difference:
            val: 2
            title: Упрощенная доход минус расход, УСН доход - расход
            print: УСН доход - расход
          envd:
            val: 3
            title: Единый налог на вмененный доход, ЕНВД
            print: ЕНВД
          esn:
            val: 4
            title: Единый сельскохозяйственный налог, ЕСН
            print: ЕСН
          patent:
            val: 5
            title: Патентная система налогообложения, Патент
            print: Патент

  AdditionalUserAttribute:
    title: Дополнительный реквизит пользователя
    x-tag-id: 1084
    type: object
    properties:
      name:
        title: Наименование
        description: Наименование дополнительного реквизита пользователя
        x-tag-id: 1085
        type: string
      value:
        title: Значение
        description: Значение дополнительного реквизита пользователя
        x-tag-id: 1086
        type: string

  SupplierInfo:
    title: Данные поставщика
    x-tag-id: 1224
    type: object
    properties:
      phoneNumbers:
        title: Телефон поставщика
        description: можно не указывать, если совпадает с 1171 в самом чеке
        x-tag-id: 1171
        type: array
        items:
          type: string
      name:
        title: Наименование поставщика
        description: получатель средств для платежных агентов, принципал для агентов
        x-tag-id: 1225
        type: string

  AgentInfo:
    title: Данные агента
    x-tag-id: 1223
    type: object
    properties:
      paymentTransferOperatorPhoneNumbers:
        title: Телефон оператора перевода
        description: Для оператора по переводу денежных средств
        x-tag-id: 1075
        type: array
        items:
          type: string
      paymentAgentOperation:
        title: Операция платежного агента
        description: наименование операции банковского платежного агента или банковского платежного субагента
        x-tag-id: 1044
        type: string
      paymentAgentPhoneNumbers:
        title: Телефон платежного агента
        x-tag-id: 1073
        type: array
        items:
          type: string
      paymentOperatorPhoneNumbers:
        title: Телефон оператора по приему платежей
        description: При осуществлении деятельности платежного агента и платежного субагента
        x-tag-id: 1074
        type: array
        items:
          type: string
      paymentOperatorName:
        title: Наименование оператора перевода
        description: для банковских платежных [суб]агентов
        x-tag-id: 1026
        type: string
      paymentOperatorAddress:
        title: Адрес оператора перевода
        description: для банковских платежных [суб]агентов
        x-tag-id: 1005
        type: string
      paymentOperatorINN:
        title: ИНН оператора перевода
        description: для банковских платежных [суб]агентов
        x-tag-id: 1016
        type: string


  CheckPayment:
    type: object
    properties:
      type:
        type: integer
        title: Тип оплаты
        x-enum:
          cash:
            val: 1
            title: сумма по чеку наличными
            print: Наличными
            x-tag-id: 1031
          card:
            val: 2
            title: сумма по чеку электронными
            print: Безналичными
            x-tag-id: 1081
          prepaid:
            val: 14
            title: сумма по чеку предоплатой(зачетом аванса и (или) предыдущих платежей)
            print: Предварительная оплата(аванс)
            x-tag-id: 1215
          credit:
            val: 15
            title: сумма по чеку постоплатой(в кредит)
            print: Последующая оплата(кредит)
            x-tag-id: 1216
          counterclaim:
            val: 16
            title: сумма по чеку(БСО) встречным предоставлением
            print: Иная форма оплаты
            x-tag-id: 1217
      amount:
        format: double
        x-comment: точность до 2 знаков после запятой, попадает в тег поля по значению type (1031,1081,1215,1216,1217)
        title: Сумма оплаты
        type: number


  ValidationErrors:
    type: object
    properties:
      errors:
        type: array
        items:
          type: string


  CheckDocumentCreate[CorrectionContent]:
    type: object
    x-todo: DRY CheckDocumentCreate[CheckContent] is exactly the same, but has different content field
    properties:
      id:
        type: string
      inn:
        type: string
      group:
        type: string
      key:
        type: string
      content:
        "$ref": "#/definitions/CorrectionContent"
      callbackUrl:
        description: URL для отправки результатов обработки чека POST запросом
        type: [string, "null"]
        maxLength: 1024



  CorrectionContent:
    type: object
    properties:
      correctionType:
        title: Тип коррекции
        x-tag-id: 1173
        type: integer
        x-enum:
          manual:
            val: 0
            title: Самостоятельно
          prescribed:
            val: 1
            title: По предписанию
      type:
        title: Признак расчета
        x-tag-id: 1054
        type: integer
        x-enum:
          income:
            val: 1
            title: Приход
          expense:
            val: 3
            title: Расход
      description:
        title: Описание коррекции
        x-tag-id: 1177
        type: string
      causeDocumentDate:
        format: date-time
        title: Дата документа основания для коррекции
        x-tag-id: 1178
        x-comment: В данном реквизите время всегда указывать, как 00:00:00
        type: string
      causeDocumentNumber:
        title: Номер документа основания для коррекции
        x-tag-id: 1179
        type: string

      totalSum:
        format: double
        title: Сумма расчета, указанного в чеке (БСО)
        x-tag-id: 1020
        type: number

      automatNumber:
        title: Номер автомата
        x-comment: Только для вендинга
        x-tag-id: 1036
        type: string
      settlementAddress:
        title: Адрес расчетов
        x-comment: Только для вендинга
        x-tag-id: 1009
        type: string
      settlementPlace:
        title: Место расчетов
        x-comment: Только для вендинга
        x-tag-id: 1187
        type: string

      cashSum:
        x-name: sum_cash
        title: Сумма по чеку (БСО) наличными
        format: double
        x-tag-id: 1031
        type: number
      eCashSum:
        x-name: sum_card
        format: double
        title: Сумма по чеку (БСО) электронными
        x-tag-id: 1081
        type: number
      prepaymentSum:
        x-name: sum_prepaid
        format: double
        title: Сумма по чеку (БСО) предоплатой
        description: Сумма по чеку (БСО) предоплатой (зачетом аванса и (или) предыдущих платежей)
        x-tag-id: 1215
        type: number
      postpaymentSum:
        x-name: sum_credit
        format: double
        title: Сумма по чеку (БСО) постоплатой
        description: Сумма по чеку (БСО) постоплатой (в кредит)
        x-tag-id: 1216
        type: number
      otherPaymentTypeSum:
        x-name: sum_counterclaim
        format: double
        title: Сумма по чеку (БСО) встречным предоставлением
        x-tag-id: 1217
        type: number

      tax1Sum:
        title: Сумма НДС чека по ставке 20%
        x-comment: осторожно, номера в названии поля не соответствуют значениям в CheckPosition.tax
        x-tag-id: 1102
        x-alias: vat_20
        type: number
        format: double
      tax2Sum:
        title: Сумма НДС чека по ставке 10%
        x-tag-id: 1103
        x-alias: vat_10
        type: number
        format: double
      tax3Sum:
        format: double
        title: Сумма расчета по чеку с НДС по ставке 0%
        x-tag-id: 1104
        x-alias: vat_0
        type: number
      tax4Sum:
        format: double
        title: Сумма расчета по чеку без НДС
        x-tag-id: 1105
        x-alias: vat_not_charged
        type: number
      tax5Sum:
        format: double
        title: Сумма НДС чека по расч. ставке 20/120
        x-tag-id: 1106
        x-alias: vat_20_120
        type: number
      tax6Sum:
        format: double
        title: Сумма НДС чека по расч. ставке 10/110
        x-tag-id: 1107
        x-alias: vat_10_110
        type: number
      taxationSystem:
        type: integer
        x-todo: DRY
        title: Применяемая система налогообложения
        x-tag-id: 1055
        x-enum:
          common:
            val: 0
            title: Общая, ОСН
          simplified:
            val: 1
            title: Упрощенная доход, УСН доход
          simplified_difference:
            val: 2
            title: Упрощенная доход минус расход, УСН доход - расход
          envd:
            val: 3
            title: Единый налог на вмененный доход, ЕНВД
          esn:
            val: 4
            title: Единый сельскохозяйственный налог, ЕСН
          patent:
            val: 5
            title: Патентная система налогообложения, Патент
      cashier:
        title: Кассир
        x-tag-id: 1021
        type: string
      cashierINN:
        title: ИНН кассира
        x-tag-id: 1203
        type: string

  CheckStatusViewModel[CheckContent]:
    type: object
    properties:
      id:
        title: Идентификатор документа
        type: string
      deviceSN:
        title: Заводской номер устройства пробившего чек
        type: string
      deviceRN:
        title: Регистрационный номер устройства пробившего чек
        type: string
      fsNumber:
        title: Номер фискального накопителя
        type: string
      ofdName:
        title: Наименование ОФД
        type: string
      ofdWebsite:
        title: Web-сайт ОФД
        type: string
      ofdinn:
        title: ИНН ОФД
        type: string
      fnsWebsite:
        title: Web-сайт ФНС
        type: string
      companyINN:
        title: ИНН пользователя
        type: string
      companyName:
        title: Наименование пользователя
        type: string
      documentNumber:
        title: Номер ФД
        format: int64
        type: integer
      shiftNumber:
        title: Номер смены
        format: int32
        type: integer
      documentIndex:
        title: Номер чека за смену
        format: int32
        type: integer
      processedAt:
        title: Время регистрации фискального документа в ФН
        description: Время регистрации фискального документа в ФН, ISO8601
        format: date-time
        type: string
      content:
        title: Содержимое документа
        "$ref": "#/definitions/CheckContent"
      change:
        title: Сдача
        format: double
        type: number
      fp:
        title: Фискальный признак
        type: string
      callbackUrl:
        description: URL для отправки результатов обработки чека POST запросом
        type: [string, "null"]
        maxLength: 1024



  CheckStatusViewModel[CorrectionContent]:
    type: object
    properties:
      id:
        type: string
        maxLength: 64
      deviceSN:
        title: Заводской номер устройства пробившего чек
        type: string
        maxLength: 20
      deviceRN:
        title: Регистрационный номер устройства пробившего чек
        type: string
        maxLength: 20
      fsNumber:
        title: Номер фискального накопителя
        type: string
      ofdName:
        title: Наименование ОФД
        type: string
        maxLength: 256
      ofdWebsite:
        title: Web-сайт ОФД
        type: string
      ofdinn:
        title: ИНН ОФД
        type: string
      fnsWebsite:
        title: Web-сайт ФНС
        type: string
        maxLength: 256
      companyINN:
        title: ИНН пользователя
        type: string
        maxLength: 12
      companyName:
        title: Наименование пользователя
        type: string
        maxLength: 256
      documentNumber:
        title: Номер ФД
        type: integer
        format: int64
      shiftNumber:
        title: Номер смены
        type: integer
        format: int32
      documentIndex:
        title: Номер чека за смену
        format: int32
        type: integer
      processedAt:
        title: Время регистрации фискального документа в ФН
        description: Время регистрации фискального документа в ФН, ISO8601
        format: date-time
        type: string
      content:
        title: Содержимое документа
        "$ref": "#/definitions/CorrectionContent"
      change:
        x-unknown: Сдача?
        format: double
        type: number
      fp:
        title: Фискальный признак
        type: string
        maxLength: 10
      callbackUrl:
        description: URL для отправки результатов обработки чека POST запросом
        type: [string, "null"]
        maxLength: 1024