Описание методов API сервиса ЭДО.МИГ24

{ "$schema": "http://json-schema.org/draft-04/schema#", "title": "ProviderUtd", "type": "object", "description": "Универсальный передаточный документ продавца", "additionalProperties": false, "properties": { "SubType": { "oneOf": [ { "type": "null" }, { "$ref": "#/definitions/DocumentTrackingType" } ] }, "FormatVersion": { "type": [ "null", "string" ] }, "CreationDateTime": { "type": [ "null", "string" ], "description": "Дата формирования файла обмена информации покупателя", "format": "date-time" }, "UID": { "type": [ "null", "string" ] }, "CreationRightReason": { "description": "Основание по которому субъект составил файл обмена", "oneOf": [ { "type": "null" }, { "$ref": "#/definitions/DocumentRequisites" } ] }, "Function": { "description": "Код функции УПД", "oneOf": [ { "type": "null" }, { "$ref": "#/definitions/FunctionCode" } ] }, "PrimaryDocName": { "type": [ "null", "string" ], "description": "Наименование первичного документа" }, "CreatorName": { "type": [ "null", "string" ], "description": "Наименование экономического субъекта продавца" }, "AdditionalStructureInfo": { "type": [ "null", "string" ], "description": "Информация о наличии структуры для анализа в автоматизированном режиме" }, "Invoice": { "description": "Сведения о счёт-фактуре\n ", "oneOf": [ { "type": "null" }, { "$ref": "#/definitions/Invoice" } ] }, "TableInvoice": { "description": "Сведения таблицы счета-фактуры", "oneOf": [ { "type": "null" }, { "$ref": "#/definitions/TableInvoice" } ] }, "Content": { "description": "Сведения об отгрузке товара(выполненных работ)", "oneOf": [ { "type": "null" }, { "$ref": "#/definitions/Content" } ] } }, "definitions": { "DocumentTrackingType": { "type": "integer", "description": "", "x-enumNames": [ "None", "Mark", "Pros" ], "enum": [ 0, 1, 2 ] }, "DocumentRequisites": { "type": "object", "description": "Реквизиты документа", "additionalProperties": false, "properties": { "Name": { "type": [ "null", "string" ], "description": "Наименование документа" }, "Number": { "type": [ "null", "string" ], "description": "Номер документа " }, "Date": { "type": [ "null", "string" ], "description": "Дата документа", "format": "date-time" }, "ExchangeDocumentId": { "type": [ "null", "string" ], "description": "Идентификатор файла обмена документа, подписанного первой стороной" }, "DocumentId": { "type": [ "null", "string" ], "description": "Идентификатор документа " }, "InfoSystemIdentifyingInfo": { "type": [ "null", "string" ], "description": "Идентифицирующая информация об информационной системе, в которой осуществляется хранение документа," }, "InfoSystemUrl": { "type": [ "null", "string" ], "description": "Сведения в формате URL об информационной системе, которая предоставляет техническую возможность получения информации о документе" }, "AdditionalInfo": { "type": [ "null", "string" ], "description": "Дополнительные сведения" }, "DocumentAuthorIdentifyingInfo": { "type": [ "array", "null" ], "description": "Идентифицирующие реквизиты экономических субъектов, составивших (сформировавших) документ", "items": { "$ref": "#/definitions/SubjectDetails" } } } }, "SubjectDetails": { "type": "object", "description": "Идентифицирующие реквизиты субъектов, в том числе составивших документ (ИдРекСостТип)", "additionalProperties": false, "properties": { "Type": { "description": "Тип идентифицирующих реквизитов экономических субъектов", "oneOf": [ { "$ref": "#/definitions/SubjectDetailsType" } ] }, "ForeignPerson": { "description": "Данные иностранной организации (иностранного гражданина),\nне состоящей(его) на учете в налоговых органах (ДаннИно)", "oneOf": [ { "type": "null" }, { "$ref": "#/definitions/ForeignPerson" } ] }, "ExecutiveAuthorityName": { "type": [ "null", "string" ], "description": "Краткое наименование органа исполнительной власти выдавшего документ (НаимОИВ)" }, "OrgInn": { "type": [ "null", "string" ], "description": "ИНН организации, состоящей на учете в налоговом органе (ИННЮЛ)" }, "PersonInn": { "type": [ "null", "string" ], "description": "ИНН физического лица, в том числе индивидуального предпринимателя (ИННФЛ)" } } }, "SubjectDetailsType": { "type": "integer", "description": "", "x-enumNames": [ "None", "ForeignSubjectInfo", "ExecutiveAuthorityName", "OrgInn", "PersonInn" ], "enum": [ 0, 1, 2, 3, 4 ] }, "ForeignPerson": { "type": "object", "description": "Информация об иностранном лице/организации", "additionalProperties": false, "properties": { "OrgName": { "type": [ "null", "string" ], "description": "Имя/наименование" }, "OtherInfo": { "type": [ "null", "string" ], "description": "Дополнительная информация" }, "Identifier": { "type": [ "null", "string" ], "description": "Идентификатор" }, "Status": { "description": "Идентификация статуса", "oneOf": [ { "type": "null" }, { "$ref": "#/definitions/PersonStatus" } ] }, "RegCountry": { "type": [ "null", "string" ], "description": "Страна регистрации иностранного лица" }, "RegCountryCode": { "type": [ "null", "string" ], "description": "Код страны" } } }, "PersonStatus": { "type": "integer", "description": "Идентификация статуса", "x-enumNames": [ "LegalPerson", "PhysicalPerson" ], "enum": [ 0, 1 ] }, "FunctionCode": { "type": "integer", "description": "Типы функции УПД", "x-enumNames": [ "Invoice", "UniversalTransportDocument", "PrimaryDocument", "RealizationDocument", "PurchasingDocument" ], "enum": [ 0, 1, 2, 3, 4 ] }, "Invoice": { "type": "object", "description": "Сведения о счете-фактуре", "additionalProperties": false, "properties": { "Okv": { "type": "string", "description": "Код ОКВ валюты" }, "ProviderInfo": { "type": [ "array", "null" ], "description": "Сведения о продавце", "items": { "$ref": "#/definitions/Member" } }, "CustomerInfo": { "type": [ "array", "null" ], "description": "Сведения о покупателе.", "items": { "$ref": "#/definitions/Member" } }, "AdditionalInfo": { "description": "Дополнительные сведения. Сведения об участниках факта хозяйственной жизни, основаниях и обстоятельствах его проведения", "oneOf": [ { "type": "null" }, { "$ref": "#/definitions/AdditionalInfo" } ] }, "Info": { "description": "Информационное поле", "oneOf": [ { "type": "null" }, { "$ref": "#/definitions/Info" } ] }, "Correction": { "description": "Информация об исправлении документа", "oneOf": [ { "type": "null" }, { "$ref": "#/definitions/BaseIdentifiedEntity" } ] }, "Number": { "type": [ "null", "string" ], "description": "Номер, в виде строки. Может иметь различные форматы" }, "Date": { "type": [ "null", "string" ], "description": "Дата", "format": "date-time" }, "ProviderCorrectionFileName": { "type": [ "null", "string" ], "description": "Имя файла обмена (информации продавца) исправляемого документа" }, "CustomerCorrectionFileName": { "type": [ "null", "string" ], "description": "Имя файла обмена (информации покупателя) исправляемого документа" }, "DocumentRequisitesList": { "type": [ "array", "null" ], "description": "Реквизиты документа об отгрузке товаров/услуг/прав, изменено в верссии 5.02", "items": { "$ref": "#/definitions/DocumentRequisites" } }, "CargoFrom": { "type": [ "array", "null" ], "description": "Сведения о грузоотправителе. Указывается, если грузоотправитель не совпадает с продавцом ", "items": { "$ref": "#/definitions/Member" } }, "CargoTo": { "type": [ "array", "null" ], "description": "Сведения о грузополучателе. Указывается, если грузополучатель не совпадает с покупателем ", "items": { "$ref": "#/definitions/Member" } }, "PayDocuments": { "type": [ "array", "null" ], "description": "Сведения о платёжно-расчётных документах", "items": { "$ref": "#/definitions/PayDocument" } } } }, "Member": { "type": "object", "description": "Информация используемая в документах о каком-либо участники документооборота ", "additionalProperties": false, "properties": { "Okpo": { "type": [ "null", "string" ], "description": "Код в ОКПО (общероссийский классификатор предприятий и организаций)" }, "OpfCode": { "type": [ "null", "string" ], "description": "Код по Общероссийскому классификатору организационно-правовых форм об организационно-правовой форме" }, "OpfFullName": { "type": [ "null", "string" ], "description": "Полное наименование организационно-правовой формы" }, "StructureSubdivision": { "type": [ "null", "string" ], "description": "Информация о структурном подразделении" }, "InfoForMember": { "type": [ "null", "string" ], "description": "Информация для участника документооборота" }, "ShortName": { "type": [ "null", "string" ], "description": "Краткое наименование участника" }, "IdInfo": { "description": "Сведения для идентификации участника", "oneOf": [ { "type": "null" }, { "$ref": "#/definitions/MemberIdentifier" } ] }, "Address": { "description": "Адрес", "oneOf": [ { "type": "null" }, { "$ref": "#/definitions/Address" } ] }, "Contact": { "description": "Контактные данные", "oneOf": [ { "type": "null" }, { "$ref": "#/definitions/Contact" } ] }, "BankRequisites": { "description": "Банковские реквизиты", "oneOf": [ { "type": "null" }, { "$ref": "#/definitions/BankRequisites" } ] }, "IsSame": { "type": "boolean", "description": "Флаг -- он же. Для полей, где может быть как информация об участнике, так и признак \"Он же\"" } } }, "MemberIdentifier": { "type": "object", "description": "Индентификационные данные участника документаоборота", "additionalProperties": false, "properties": { "Type": { "description": "Тип идентификационных данных. см MemberIdentifierType", "oneOf": [ { "$ref": "#/definitions/MemberIdentifierType" } ] }, "Person": { "description": "Данные. В зависимости от типа, будет возвращён конкретный тип данных.\nДля ФЛ -- Person,\nДля ИП -- Individual\nДля ЮЛ -- JuridicalPerson\n \nТребуется проверка типа прежде чем работать с экземпляром. ", "oneOf": [ { "type": "null" }, { "$ref": "#/definitions/JuridicalPerson" } ] }, "ForeignPerson": { "description": "Данные об участнике, если он является иностранным лицом/организацией", "oneOf": [ { "type": "null" }, { "$ref": "#/definitions/ForeignPerson" } ] } } }, "MemberIdentifierType": { "type": "integer", "description": "Типы идентификационных сведений участников документооборота. Используется в документах.", "x-enumNames": [ "Person", "Individual", "Juridical", "Foreign" ], "enum": [ 0, 1, 2, 3 ] }, "JuridicalPerson": { "type": "object", "description": "Данные о юридическом лице. Наследуются поля Individual", "additionalProperties": false, "properties": { "Inn": { "type": [ "null", "string" ], "description": "ИНН, В зависимости от контекста возвращает ИНН ФЛ, ИНН ИП или ИНН ЮЛ" }, "Requisites": { "type": [ "null", "string" ], "description": "Реквизиты свидетельства о государственной регистрации" }, "OtherInfo": { "type": [ "null", "string" ], "description": "Другая информация" }, "OgrnIp": { "type": [ "null", "string" ], "description": "ОГРНИП" }, "OgrnIpDate": { "type": [ "null", "string" ], "description": "Дата присвоения ОГРНИП", "format": "date-time" }, "AcceptanceGoodsReason": { "description": "Основание, по которому лицу или организации доверено принятие/передача/отгрузка товаров", "oneOf": [ { "type": "null" }, { "$ref": "#/definitions/DocumentRequisites" } ] }, "Status": { "type": [ "integer", "null" ], "description": "Идентификация статуса лица", "format": "int32" }, "Fio": { "description": "ФИО", "oneOf": [ { "type": "null" }, { "$ref": "#/definitions/Fio" } ] }, "OrgName": { "type": [ "null", "string" ], "description": "Наименование организации" }, "Kpp": { "type": [ "null", "string" ], "description": "Код КПП" }, "Position": { "type": [ "null", "string" ], "description": "Должность лица представляющегого организацию. Если имеется " }, "AcceptanceGoodsRightReason": { "description": "Основание полномочий представителя организации на принятие/отгрузку/передачу товаров", "oneOf": [ { "type": "null" }, { "$ref": "#/definitions/DocumentRequisites" } ] } } }, "Fio": { "type": "object", "description": "ФИО лица участника", "additionalProperties": false, "properties": { "FirstName": { "type": [ "null", "string" ], "description": "Имя" }, "MiddleName": { "type": [ "null", "string" ], "description": "Отчество" }, "LastName": { "type": [ "null", "string" ], "description": "Фамилия" } } }, "Address": { "type": "object", "description": "Адрес", "additionalProperties": false, "properties": { "GlnPlace": { "type": [ "null", "string" ], "description": "Глобальный номер места нахождения (GLN места)" }, "Type": { "description": "Тип адреса. Обозначает в каких полях содержится информация об адресе", "oneOf": [ { "type": "null" }, { "$ref": "#/definitions/AddressType" } ] }, "CountryCode": { "type": [ "null", "string" ], "description": "Код страны" }, "CountryName": { "type": [ "null", "string" ], "description": "Наименование страны" }, "AddresStr": { "type": [ "null", "string" ], "description": "Строковое представление адреса" }, "AddressRf": { "description": "Адрес субъекта РФ", "oneOf": [ { "type": "null" }, { "$ref": "#/definitions/AddressRf" } ] }, "AddressGar": { "description": "Адрес субъекта в виде ГАР", "oneOf": [ { "type": "null" }, { "$ref": "#/definitions/AddressGar" } ] } } }, "AddressType": { "type": "integer", "description": "Тип адреса, содержащегося в Address", "x-enumNames": [ "Full", "ByString", "ByGAR" ], "enum": [ 0, 1, 2 ] }, "AddressRf": { "type": "object", "description": "Адрес субъекта РФ", "additionalProperties": false, "properties": { "Index": { "type": [ "null", "string" ], "description": "Индекс" }, "CodeRegion": { "type": [ "null", "string" ], "description": "Код региона" }, "NameRegion": { "type": [ "null", "string" ], "description": "Наименование субъекта Российской Федерации" }, "District": { "type": [ "null", "string" ], "description": "Область/Республика/Край/Округ" }, "City": { "type": [ "null", "string" ], "description": "Город" }, "Settlement": { "type": [ "null", "string" ], "description": "Населённый пункт" }, "Street": { "type": [ "null", "string" ], "description": "Улица" }, "House": { "type": [ "null", "string" ], "description": "Дом" }, "Building": { "type": [ "null", "string" ], "description": "Корпус" }, "Apartment": { "type": [ "null", "string" ], "description": "Квартира" }, "Other": { "type": [ "null", "string" ], "description": "Иные сведения об адресе в Российской Федерации" } } }, "AddressGar": { "type": "object", "additionalProperties": false, "properties": { "Id": { "type": [ "null", "string" ], "description": "Уникальный номер адреса объекта адресации в государственном адресном реестре" }, "Index": { "type": [ "null", "string" ], "description": "Почтовый индекс" }, "Region": { "type": [ "null", "string" ], "description": "Субъект Российской Федерации (код)" }, "RegionName": { "type": "string", "description": "Наименование субъекта Российской Федерации" }, "MunicipalRegion": { "description": "Муниципальный район/ городской округ/ внутригородская территория города федерального значения/ муниципальный\nокруг/ федеральная территория", "oneOf": [ { "type": "null" }, { "$ref": "#/definitions/InfoValue" } ] }, "Settlment": { "description": "Городское поселение/ сельское поселение/ межселенная территория в составе муниципального района/ внутригородской\nрайон городского округа", "oneOf": [ { "type": "null" }, { "$ref": "#/definitions/InfoValue" } ] }, "City": { "description": "Населенный пункт (город, деревня, село и прочее)", "oneOf": [ { "type": "null" }, { "$ref": "#/definitions/InfoValue" } ] }, "ElementPlan": { "description": "Элемент планировочной структуры", "oneOf": [ { "type": "null" }, { "$ref": "#/definitions/InfoValue" } ] }, "ElementRoad": { "description": "Элемент улично-дорожной сети", "oneOf": [ { "type": "null" }, { "$ref": "#/definitions/InfoValue" } ] }, "LandId": { "type": [ "null", "string" ], "description": "Земельный участок (номер)" }, "Buildings": { "type": [ "array", "null" ], "description": "Здание (строение), сооружение/ объект незавершенного строительства", "items": { "$ref": "#/definitions/InfoValue" } }, "RoomOfBuilding": { "description": "Помещение в пределах здания (строения), сооружения/ машино-место", "oneOf": [ { "type": "null" }, { "$ref": "#/definitions/InfoValue" } ] }, "RoomOfApartment": { "description": "Помещение в пределах квартиры", "oneOf": [ { "type": "null" }, { "$ref": "#/definitions/InfoValue" } ] } } }, "InfoValue": { "type": "object", "additionalProperties": false, "properties": { "Name": { "type": "string" }, "Value": { "type": "string" } } }, "Contact": { "type": "object", "description": "Контактные данные", "additionalProperties": false, "properties": { "Other": { "type": [ "null", "string" ] }, "PhoneList": { "type": [ "array", "null" ], "items": { "type": "string" } }, "EmailList": { "type": [ "array", "null" ], "items": { "type": "string" } } } }, "BankRequisites": { "type": "object", "description": "Банковские реквизиты", "additionalProperties": false, "properties": { "AccountNumber": { "type": [ "null", "string" ], "description": "Номер счёта" }, "BankName": { "type": [ "null", "string" ], "description": "Наименование банка" }, "BIC": { "type": [ "null", "string" ], "description": "БИК" }, "CoreAccount": { "type": [ "null", "string" ], "description": "Кор. счёт" } } }, "AdditionalInfo": { "type": "object", "description": "Дополнительные сведения счёт-фактуры. Сведения об участниках ФХЖ, основаниях и обстоятельствах его проведения", "additionalProperties": false, "properties": { "ContractId": { "type": [ "null", "string" ], "description": "Номер/ гос контракта" }, "OkvName": { "type": [ "null", "string" ], "description": "Наименование ОКВ валюты" }, "ExchangeRates": { "type": [ "null", "number" ], "description": "Курс валют", "format": "decimal" }, "SpecialReasonCreationInvoice": { "description": "Специальные обстоятельства создания СФ, добавлено в верссии 5.02 ", "oneOf": [ { "type": "null" }, { "$ref": "#/definitions/SpecialReasonCreationInvoiceType" } ] }, "SpecialReasonCreationAdditionalInvoice": { "type": [ "null", "string" ], "description": "Специальные обстоятельства создания СЧФДОП, добавлено в верссии 5.02" }, "SpecialReasonCreationAdditionalDocuments": { "type": [ "null", "string" ], "description": "Специальные обстоятельства создания ДОП, добавлено в верссии 5.02" }, "ConditionGovPurchasesInfo": { "oneOf": [ { "type": "null" }, { "$ref": "#/definitions/ConditionGovPurchasesInfo" } ], "description": "Информация продавца об обстоятельствах закупок" }, "FactorInfo": { "description": "Сведения о факторе(участнике)", "oneOf": [ { "type": "null" }, { "$ref": "#/definitions/Member" } ] }, "PromiseTypes": { "type": [ "array", "null" ], "description": "Вид обязательств", "items": { "$ref": "#/definitions/InfoValue" } }, "DocumentRequisites": { "description": "Основание уступки денежного требования", "oneOf": [ { "type": "null" }, { "$ref": "#/definitions/DocumentRequisites" } ] }, "AccompanyingDocumentRequisites": { "type": [ "array", "null" ], "description": "Сведения о сопроводительных документах, уточняющих обстоятельства факт хозяйственной жизни", "items": { "$ref": "#/definitions/DocumentRequisites" } } } }, "CreationReasonType": { "type": "integer", "description": "Причины формирования счёт-фактуры", "x-enumNames": [ "RealizeGoods", "Payment", "RealizeOther", "CommissionerRealize", "CommissionerReturnGoods", "PrincipalPurchaseGoods", "PrincipalReturnGoods", "ReturnGoods" ], "enum": [ 0, 1, 2, 3, 4, 5, 6, 7 ] }, "SpecialReasonCreationInvoiceType": { "type": "integer", "description": "Специальные обстоятельства формирования счета-фактуры, применяемого при расчетах по налогу на добавленную стоимость", "x-enumNames": [ "RealizationGoods", "GetPay", "RealizationToManyClients", "TaxAgent", "ProviderDeclareTax", "ForForeign" ], "enum": [ 0, 1, 2, 3, 4, 5 ] }, "ConditionGovPurchasesInfo": { "type": "object", "description": "Информация продавца об обстоятельствах закупок", "additionalProperties": false, "properties": { "ContractNumber": { "type": "string", "description": "Номер государственного контракта" }, "ContractDate": { "type": [ "null", "string" ], "description": "Номер государственного контракта", "format": "date-time" }, "ProviderAccount": { "type": "string", "description": "Номер лицевого счета продавца" }, "BudgetCode": { "type": "string", "description": "Код по бюджетной классификации (продавец)" }, "TargetCode": { "type": "string", "description": "Код цели (продавец)" }, "TreasuryDepartmentCode": { "type": "string", "description": "Код территориального органа Федерального казначейства продавца" }, "TreasuryDepartmentName": { "type": "string", "description": "Наименование территориального органа Федерального казначейства продавца" } } }, "Info": { "type": "object", "additionalProperties": false, "properties": { "Id": { "type": [ "null", "string" ] }, "Values": { "type": [ "array", "null" ], "items": { "$ref": "#/definitions/InfoValue" } } } }, "BaseIdentifiedEntity": { "type": "object", "description": "Класс, содержащий базовые поля идентификаторов", "additionalProperties": false, "properties": { "Number": { "type": [ "null", "string" ], "description": "Номер, в виде строки. Может иметь различные форматы" }, "Date": { "type": [ "null", "string" ], "description": "Дата", "format": "date-time" } } }, "PayDocument": { "type": "object", "description": "Сведения о платёжно-расчётном документе. Наследуется от BaseIdentifiedEntity, содержит номер и дату.", "additionalProperties": false, "properties": { "Number": { "type": [ "null", "string" ], "description": "Номер, в виде строки. Может иметь различные форматы" }, "Date": { "type": [ "null", "string" ], "description": "Дата", "format": "date-time" }, "Sum": { "type": [ "null", "number" ], "description": "Сумма", "format": "decimal" } } }, "TableInvoice": { "type": "object", "description": "Сведения таблицы счета-фактуры", "additionalProperties": false, "properties": { "TotalWithoutTax": { "type": [ "null", "number" ], "description": "Всего к оплате, Стоимость товаров (работ, услуг), имущественных прав без налога - всего", "format": "decimal" }, "Total": { "type": [ "null", "number" ], "description": "Всего к оплате, Стоимость товаров (работ, услуг), имущественных прав с налогом - всего", "format": "decimal" }, "Tax": { "description": "Всего к оплате, Сумма налога, предъявляемая покупателю", "oneOf": [ { "type": "null" }, { "$ref": "#/definitions/Tax" } ] }, "Netto": { "type": [ "null", "number" ], "description": "Количество (масса нетто/ количество) - всего по документу", "format": "decimal" }, "Goods": { "type": [ "array", "null" ], "description": "Сведения об отгруженных товарах", "items": { "$ref": "#/definitions/Goods" } } } }, "Tax": { "type": "object", "description": "Сумма НДС", "additionalProperties": false, "properties": { "Value": { "type": [ "null", "number" ], "description": "Сумма НДС", "format": "decimal" }, "IsWithoutTax": { "type": "boolean", "description": "Без НДС" } } }, "Goods": { "type": "object", "description": "Сведения об отгруженных товарах", "additionalProperties": false, "properties": { "Okei": { "type": [ "null", "string" ], "description": "Код единицы измерения " }, "Volume": { "type": [ "null", "number" ], "description": "Количество (объем) ", "format": "decimal" }, "Price": { "type": [ "null", "number" ], "description": "Цена (тариф) за единицу измерения ", "format": "decimal" }, "Cost": { "type": [ "null", "number" ], "description": "Стоимость товаров (работ, услуг), имущественных прав с налогом - всего", "format": "decimal" }, "CostWithoutTax": { "type": [ "null", "number" ], "description": "Стоимость товаров (работ, услуг), имущественных прав без налога - всего", "format": "decimal" }, "Excise": { "description": "В том числе сумма акциза", "oneOf": [ { "type": "null" }, { "$ref": "#/definitions/Excise" } ] }, "Tax": { "description": "Сумма налога, предъявляемая покупателю ", "oneOf": [ { "type": "null" }, { "$ref": "#/definitions/Tax" } ] }, "Row": { "type": [ "integer", "null" ], "description": "Номер строки таблицы", "format": "int32" }, "Name": { "type": [ "null", "string" ], "description": "Наименование товара" }, "TaxRate": { "description": "Налоговая ставка", "oneOf": [ { "type": "null" }, { "$ref": "#/definitions/TaxRateType" } ] }, "CustomsDeclaration": { "type": [ "array", "null" ], "description": "Сведения о таможенной декларации", "items": { "$ref": "#/definitions/CustomsDeclaration" } }, "Info": { "type": [ "array", "null" ], "description": "Информационное поле факта хозяйственной жизни 2", "items": { "$ref": "#/definitions/InfoValue" } }, "AdditionalInfo": { "description": "Дополнительные сведения об отгруженных товарах", "oneOf": [ { "type": "null" }, { "$ref": "#/definitions/AdditionalGoodsInfo" } ] } } }, "Excise": { "type": "object", "additionalProperties": false, "properties": { "Value": { "type": [ "null", "number" ], "format": "decimal" }, "IsWithoutValue": { "type": "boolean" } } }, "TaxRateType": { "type": "integer", "description": "Налоговая ставка", "x-enumNames": [ "Zero", "Ten", "Twenty", "TenPerHundredTen", "TwentyPerHundredTwenty", "WithoutTax", "NotCalculation", "Five", "Seven", "NinePointNine", "SixteenPointSixtySeven", "FivePerHundredFive", "SevenPerHundredSeven" ], "enum": [ 0, 1, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 14 ] }, "CustomsDeclaration": { "type": "object", "description": "Сведения о таможенной декларации", "additionalProperties": false, "properties": { "Code": { "type": [ "null", "string" ] }, "Number": { "type": [ "null", "string" ] } } }, "AdditionalGoodsInfo": { "type": "object", "description": "Дополнительные сведения об отгруженных товарах", "additionalProperties": false, "properties": { "Detail": { "type": [ "null", "string" ], "description": "Характеристика/описание товара" }, "GoodsType": { "type": [ "null", "string" ], "description": "Сорт товара" }, "VendorCode": { "type": [ "null", "string" ], "description": "Артикул товара" }, "Code": { "type": [ "null", "string" ], "description": "Код товара" }, "GoodsTypeCode": { "type": [ "null", "string" ], "description": "Код вида товара" }, "Type": { "description": "Признак Товар/Работа/Услуга/Право/Иное", "oneOf": [ { "type": "null" }, { "$ref": "#/definitions/GoodsKind" } ] }, "SubType": { "type": [ "null", "string" ], "description": "Дополнительная информация о признаке " }, "CatalogCode": { "type": [ "null", "string" ], "description": "Код каталога" }, "Usints": { "type": [ "null", "string" ], "description": "Наименование единицы измерения " }, "ComplexCountryShortName": { "type": [ "array", "null" ], "description": "Краткое наименование страны происхождения товара (УПД 5.03)", "items": { "type": "string" } }, "Amount": { "type": [ "null", "number" ], "description": "Заказанное количество (количество надлежит отпустить)", "format": "decimal" }, "Series": { "type": [ "null", "string" ], "description": "Серия товара" }, "Gtin": { "type": [ "null", "string" ], "description": "Глобальный идентификационный номер товарной продукции" }, "ProductionCode": { "type": [ "null", "string" ], "description": "Код вида продукции" }, "OkdpCode": { "type": [ "null", "string" ], "description": "Код товара по ОКДП 2 / ОКПД 2 (опечатка в приказе)" }, "AdditionalOperationsDetail": { "type": [ "null", "string" ], "description": "Дополнительная информация к продукции по видам операций" }, "TrackGoodsInfo": { "type": [ "array", "null" ], "description": "Сведения о товаре, подлежащем прослеживаемости", "items": { "$ref": "#/definitions/TrackGoodsInfo" } }, "NumberIdentifiers": { "type": [ "array", "null" ], "description": "Номер средств идентификации товаров", "items": { "$ref": "#/definitions/NumberIdentifier" } }, "AdditionalGoodsDocuments": { "type": [ "array", "null" ], "description": "Сведения о сопроводительных документах по товару (работам, услугам и имущественным правам)", "items": { "$ref": "#/definitions/DocumentRequisites" } }, "TaxDepreciation": { "description": "Данные налогового учета в отношении расчета амортизации по передаваемому объекту", "oneOf": [ { "type": "null" }, { "$ref": "#/definitions/TaxAccount" } ] }, "TaxSumRecovery": { "description": "Сумма налога, восстановленного при передаче имущества, нематериальных активов и имущественных прав в качестве вклада в уставный капитал", "oneOf": [ { "type": "null" }, { "$ref": "#/definitions/Tax" } ] }, "GovSystemInfos": { "type": [ "array", "null" ], "description": "Дополнительные сведения о товаре, подлежащем идентификации и учету в государственной информационной системе", "items": { "$ref": "#/definitions/GoodsGovSystemInfo" } } } }, "GoodsKind": { "type": "integer", "description": "Признак Товар/Работа/Услуга/Право/Иное", "x-enumNames": [ "Estate", "Work", "Service", "EstateRight", "Other" ], "enum": [ 0, 1, 2, 3, 4 ] }, "TrackGoodsInfo": { "type": "object", "description": "Сведения о товаре, подлежащем прослеживаемости", "additionalProperties": false, "properties": { "Number": { "type": "string", "description": "Регистрационный номер партии товаров" }, "UnitsType": { "type": "string", "description": "Единица количественного учета товара" }, "UnitsName": { "type": "string", "description": "Наименование единицы количественного учета товара" }, "Amount": { "type": "number", "description": "Количество товара в единицах измерения прослеживаемого товара", "format": "decimal" }, "Other": { "type": "string", "description": "Дополнительный показатель для идентификации товаров" }, "CostWithoutTax": { "type": [ "null", "number" ], "description": "Стоимость товара, подлежащего прослеживаемости, без налога на добавленную стоимость", "format": "decimal" } } }, "NumberIdentifier": { "type": "object", "description": "Номер средств идентификации товаров ", "additionalProperties": false, "properties": { "Id": { "type": "string", "description": "Уникальный идентификатор транспортной упаковки" }, "Amount": { "type": [ "null", "string" ], "description": "Количество товара в единицах измерения маркированного товара средствами идентификации" }, "FactoryCode": { "type": [ "null", "string" ], "description": "Производственная партия (КОД)" }, "Kiz": { "type": [ "array", "null" ], "description": "Контрольный идентификационный знак", "items": { "type": "string" } }, "Number": { "type": [ "array", "null" ], "description": "Уникальный идентификатор вторичной (потребительской)/третичной (заводской, транспортной) упаковки", "items": { "type": "string" } } } }, "TaxAccount": { "type": "object", "additionalProperties": false, "properties": { "DepreciationGroup": { "type": [ "null", "string" ], "description": "Амортизационная группа" }, "KindCode": { "type": [ "null", "string" ], "description": "Код вида основных фондов" }, "UsefulLife": { "type": [ "null", "string" ], "description": "Установленный продавцом (передающей стороной) срок полезного использования, бывшего в употреблении основного средства " }, "ActualPeriod": { "type": [ "integer", "null" ], "description": "Фактический срок полезного использования продавцом (передающей стороной) бывшего в употреблении объекта основных средств ", "format": "int32" } } }, "GoodsGovSystemInfo": { "type": "object", "additionalProperties": false, "properties": { "Name": { "type": [ "null", "string" ], "description": "Наименование государственной информационной системы" }, "Unit": { "type": [ "null", "string" ], "description": "Учетная единица в государственной информационной системе" }, "Other": { "type": [ "null", "string" ], "description": "Иная информация о товаре, подлежащем учету в государственной информационной системе" }, "UnitIds": { "type": [ "array", "null" ], "description": "Идентификационный номер учетной единицы в государственной информационной системе", "items": { "type": "string" } } } }, "Content": { "type": "object", "description": "Содержание факта хозяйственной жизни 3 –\nсведения о факте отгрузки товаров (выполнения работ), передачи имущественных прав", "additionalProperties": false, "properties": { "Transfer": { "description": "Сведения о передаче (сдаче) товаров (результатов работ), имущественных прав", "oneOf": [ { "type": "null" }, { "$ref": "#/definitions/Transfer" } ] }, "Info": { "description": "Информационное поле факта хозяйственной жизни 3", "oneOf": [ { "type": "null" }, { "$ref": "#/definitions/Info" } ] } } }, "Transfer": { "type": "object", "additionalProperties": false, "properties": { "ContentType": { "type": [ "null", "string" ], "description": "Содержание операции" }, "Operation": { "type": [ "null", "string" ], "description": "Вид операции" }, "TransferDate": { "type": [ "null", "string" ], "description": "Дата отгрузки товаров", "format": "date-time" }, "StartDate": { "type": [ "null", "string" ], "description": "Дата начала периода оказания услуг ", "format": "date-time" }, "EndDate": { "type": [ "null", "string" ], "description": "Дата окончания периода оказания услуг ", "format": "date-time" }, "WithoutReasons": { "type": [ "boolean", "null" ], "description": "Без документа-основания отгрузки товаров (передачи результатов работ),\nпередачи имущественных прав (предъявления оказанных услуг)" }, "GoodsRealiseReasons": { "type": [ "array", "null" ], "description": "Основание отгрузки товаров (передачи результатов работ), передачи имущественных прав (предъявления оказанных услуг)", "items": { "$ref": "#/definitions/DocumentRequisites" } }, "ThingInfo": { "description": "Сведения о передаче вещи, изготовленной по договору подряда", "oneOf": [ { "type": "null" }, { "$ref": "#/definitions/ThingInfo" } ] }, "CargoAndTransfer": { "description": "Транспортировка и груз", "oneOf": [ { "type": "null" }, { "$ref": "#/definitions/CargoAndTransfer" } ] }, "TransferPerson": { "description": "Сведения о лице, передавшем товар (груз) ", "oneOf": [ { "type": "null" }, { "$ref": "#/definitions/TransferPerson" } ] } } }, "ThingInfo": { "type": "object", "additionalProperties": false, "properties": { "Date": { "type": [ "null", "string" ], "format": "date-time" }, "Info": { "type": "string" }, "AcceptedDocument": { "oneOf": [ { "type": "null" }, { "$ref": "#/definitions/DocumentRequisites" } ] } } }, "CargoAndTransfer": { "type": "object", "description": "Транспортировка и груз", "additionalProperties": false, "properties": { "Info": { "type": [ "null", "string" ], "description": "Сведения о транспортировке и грузе" }, "Inkoterms": { "type": [ "null", "string" ], "description": "Значение в соответствии с международными правилами толкования торговых терминов (далее – международные правила)" }, "IncotermsVersion": { "type": [ "null", "string" ], "description": "Версия международных правил" } } }, "TransferPerson": { "type": "object", "description": "Сведения о лице, принявшем товары (груз)", "additionalProperties": false, "properties": { "Type": { "$ref": "#/definitions/TransferPersonType" }, "Person": { "oneOf": [ { "type": "null" }, { "$ref": "#/definitions/JuridicalPerson" } ] } } }, "TransferPersonType": { "type": "integer", "description": "", "x-enumNames": [ "OtherOrganization", "Person", "Worker" ], "enum": [ 0, 1, 2 ] } } }

{
"documentId": "ea6bb5a8-e2aa-4810-8e25-ee82ee4e77fc",
"document": {
"function": 2,
"creationDateTime": "2025-06-10T17:44:41",
"creatorName": "Общество с ограниченной ответственностью \"НТСсофт\"",
"invoice": {
"number": "УЦП105116",
"date": "2029-12-31T00:00:00",
"okv": "643",
"providerInfo": [{
"idInfo": {
"Type": 2,
"person": {
"orgName": "Общество с ограниченной ответственностью \"НТСсофт\"",
"inn": "6670237020"
}
}
}],
"customerInfo": [{
"idInfo": {
"Type": 2,
"person": {
"orgName": "ООО \"ОБ \"АКТИВ\"",
"inn": "4205187068"
}
}
}],
"additionalInfo": {
"okvName": "Российский рубль"
}
},
"tableInvoice": {
"total": 2100,
"totalWithoutTax": 2100,
"tax": {
"value": 0,
"isWithoutTax": true
},
"goods": [
{
"row": 1,
"name": "Расширение области применения сертификата ЭП (Росреестр)",
"volume": 1,
"cost": 100,
"costWithoutTax": 100,
"taxRate": 0,
"tax": {
"value": 0,
"isWithoutTax": true
}
},
{
"row": 2,
"name": "Выдача сертификата ЭП ГОСТ Р 34.10-2012 (Квалифицированный на 15 месяцев)",
"volume": 1,
"cost": 2000,
"costWithoutTax": 2000,
"taxRate": 0,
"tax": {
"value": 0,
"isWithoutTax": true
}
}
]
}
}

}

Именование УПД
| Функция  | Именование документа |
| ---------- | -------------------- |
| **СЧФ**  | **Счет-Фактура**  |
| **СЧФДОП** | **УПД (СЧФДОП)**  |
| **ДОП**  | **УПД (ДОП)**    |
| **СвРК** | **УПД (СвРК)**   |
| **СвЗК** | **УПД (СвЗК)**   |

Именование УКД
| Функция | Именование документа |
|---|---|
| **КСЧФ** | **Корректировочный счет-фактура** |
| **КСЧФДИС** | **УКД (КСЧФДИС)** |
| **ДИС** | **УКД (ДИС)** |
| **СвИСРК** | **УКД (СвИСРК)** |
| **СвИСЗК** | **УКД (СвИСЗК)** |

- AddSenderSign - Сформировать подпись отправителя
- AddReceiptNotice - Сформировать извещение о получении 
- AddRecipientSign - Сформировать подпись получателя  
- AddCancellation - Сформировать Предложение об аннулировании (ПОА) 
- AddClarification - Сформировать Уведомление об уточнении (УоУ)
- AddCancellationAccept - Принять предложение об аннулировании
- AddCancellationRefuse- Отказаться от предложения об аннулировании
- AddSecondTitle - Сформировать 2 титул (УПД)

- Pending, - Ожидание доп. действий
- Success, - Действие успешно выподнено
- Failed, - Возникла ошибка при выполении дейстия
- SigningExpected - Требуется выполнить подписания

Такую подпись хеш мы ожидаем на входе
https://docs.cryptopro.ru/cades/reference/cadescom/cadescom_class/rawsignature

пример с плагином
https://cpdn.cryptopro.ru/content/cades/plugin-samples-raw-signature.html

{
"eventId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"ownerAbonent": {
"code": "2JF-31951960-A0D6-4BAE-855A-DC1C9AF464F9",
"name": "ООО \"Святые моторы\"",
"inn": "1234567891",
"kpp": "667001007",
"orgId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"counteragentAbonent": {
"code": "2JF2ec37dd241684c2a8511af7db4c94000",
"name": "ООО \"НТСсофт\"",
"inn": "667001002",
"kpp": "667001002",
"orgId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"creationDateTime": "2025-02-06T10:54:01.716Z"
}

"EventId": "7636b319-5cfd-45e1-a75d-a8d0ef4577ff",
"Id": "f13c4ae9-f2e6-4c0f-b2be-f6d75b89305c",
"Type": 1,
"SenderAbonentCode": "2JF-31951960-A0D6-4BAE-855A-DC1C9AF464F9",
"SenderName": "ООО \"Святые моторы\"",
"SenderInn": "1234567891",
"SenderKpp": "667001007",
"RecipientAbonentCode": "2JF2ec37dd241684c2a8511af7db4c94000",
"RecipientName": "ООО \"НТСсофт\"",
"RecipientInn": "6670237020",
"RecipientKpp": "667001002",
"Comment": "Здравствуйте! Приглашаем вас к документообороту.",
"InternalComment": "",
"Status": 3,
"CreationDateTime": "2025-02-06T10:17:01.870624Z"

"eventId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"hasError": true,
"errorMessage": "string",
"fileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"documentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"

"EventId": "afc26dcb-4c0f-4e47-a0f8-c372ba5f09b4",
"PackageId": "e03b2fd0-47a7-4c05-b5a3-4d5e987c6631",
"StatusId": 2,
"Status": "Delivered",
"StatusName": "Ожидается извещение о получении",
"UpdateDateTime": "2025-02-06T10:46:33.3464515Z",
"Properties": {
"recipientPackageGroupLink": "https://test-edo.ntssoft.ru/package-groups/913ccca5-520c-40a3-b595-b52c8d4c0962"

"EventId": "bd6b4ab3-abf9-46f2-bd8d-a2003ccb4ca3",
"PackageId": "e03b2fd0-47a7-4c05-b5a3-4d5e987c6631",
"StatusId": 6,
"Status": "Sent",
"StatusName": "Отправлен",
"UpdateDateTime": "2025-02-06T10:46:23.0531275Z",
"Properties": {}

"EventId": "8576f390-34b8-4b72-bf00-8b4421a6b596",
"PackageId": "e03b2fd0-47a7-4c05-b5a3-4d5e987c6631",
"StatusId": 7,
"Status": "SendingExpected",
"StatusName": "Ожидается отправление",
"UpdateDateTime": "2025-02-06T10:46:20.7436065Z",
"Properties": {}

"EventId": "9b99d7ab-3252-4e2c-9cd4-b3cb53cb163d",
"PackageId": "e03b2fd0-47a7-4c05-b5a3-4d5e987c6631",
"StatusId": 1,
"Status": "New",
"StatusName": "Новый",
"UpdateDateTime": "2025-02-06T10:45:58.6559084Z",
"Properties": {}

"EventId": "2dcaeb7b-ca55-4db4-afe1-4c36451c2fc5",
"Id": "1a58fefd-1cde-487c-a5b1-24a2e72bfbc2",
"PackageId": "6811724d-162e-47d3-afb1-5899e6a9cf5a",
"PackageFileId": "f9c70b92-26a7-49c5-b53e-596af3987b56",
"PackageSignatureId": "aef380dc-a930-42b9-b6a2-246924b0cfe8",
"CreationDateTime": "2025-08-11T09:37:29.2552603Z",
"ModificationDateTime": "2025-08-11T09:37:30.4283061Z",
"Status": 3,
"StatusString": "Проверка пройдена"

"eventId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"sharedFileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"signatureUserFileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"signerOrgUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"creationDateTime": "2025-08-11T09:52:16.618Z"

Модель
public class CounteragentCreatedMQEvent
{
  public AbonentInfo? OwnerAbonent { get; set; }
  public AbonentInfo? CounteragentAbonent { get; set; }
  public DateTime CreationDateTime { get; set; }
}

AbonentInfo
public class AbonentInfo
{
  public string? Code { get; set; }
  public string? Name { get; set; }
  public string? Inn { get; set; }
  public string? Kpp { get; set; }
  public Guid? OrgId { get; set; }
}

JSON
{
    "ownerAbonent": {
      "code": "XXXce465b3591a54b5592db8888e144170e",
      "name": "ИП Тестови Тест Тестович",
      "inn": "689710200167",
      "kpp": "",
      "orgId": "ce465b35-91a5-4b55-92db-8888e144170e" },
    "counteragentAbonent": {
      "code": "2JF2ec37dd241684c2a8511af7db4c94000",
      "name": "ООО \"НТСсофт\"",
      "inn": "6670237020",
      "kpp": "667001002",
      "orgId": "2ec37dd2-4168-4c2a-8511-af7db4c94000" },
    "creationDateTime": "2024-07-31T10:21:45.5135224Z"
}

Модель
public class CounteragentDeletedMQEvent
{
  public AbonentInfo? OwnerAbonent { get; set; }
  public AbonentInfo? CounteragentAbonent { get; set; }
  public DateTime CreationDateTime { get; set; }
}

JSON
{
    "ownerAbonent": {
      "code": "XXXce465b3591a54b5592db8888e144170e",
      "name": "ИП Тестови Тест Тестович",
      "inn": "689710200167",
      "kpp": "",
      "orgId": "ce465b35-91a5-4b55-92db-8888e144170e" },
    "counteragentAbonent": {
      "code": "2JF2ec37dd241684c2a8511af7db4c94000",
      "name": "ООО \"НТСсофт\"",
      "inn": "6670237020",
      "kpp": "667001002",
      "orgId": "2ec37dd2-4168-4c2a-8511-af7db4c94000" },
    "creationDateTime": "2024-07-31T10:21:45.5135224Z"
}

Модель
public class CounteragentRequestStatusChangedMQEvent
{
  public Guid Id { get; set; }
  public CounteragentRequestType Type { get; set; }
  public string SenderAbonentCode { get; set; }
  public string? SenderName { get; set; }
  public string? SenderInn { get; set; }
  public string? SenderKpp { get; set; }
  public string RecipientAbonentCode { get; set; }
  public string? RecipientName { get; set; }
  public string? RecipientInn { get; set; }
  public string? RecipientKpp { get; set; }
  public string? Comment { get; set; }
  public string? InternalComment { get; set; }
  public CounteragentRequestStatus Status { get; set; }
  public DateTime? CreationDateTime { get; set; }
}

JSON
{
  "id": "c9d473a0-fb02-4812-8731-b7be9c814b0b",
  "type": "RoamingOutgoing",
  "senderAbonentCode": "2JF2ec37dd241684c2a8511af7db4c94000",
  "senderName": "ООО \"НТСсофт\"",
  "senderInn": "6670237020",
  "senderKpp": "667001002",
  "recipientAbonentCode": "XXXce465b3591a54b5592db8888e144170e",
  "recipientName": null,
  "recipientInn": null,
  "recipientKpp": null,
  "comment": "Здравствуйте! Приглашаем вас к документообороту.",
  "internalComment": null,
  "status": "Sent",
  "creationDateTime": ""2024-07-31T10:21:45.5135224Z""
}

Модель
public class PackageStatusUpdatedMQEvent
{
  public Guid PackageId { get; set; }
  public int StatusId { get; set; }
  public string Status { get; set; }
  public string? StatusName { get; set; }
  public DateTime UpdateDateTime { get; set; }
}

JSON
{
  "packageId": "30eccbd7-f413-496b-887d-f31f0704da38",
  "statusId": 1,
  "status": "New",
  "statusName": "Новый",
  "updateDateTime": "2024-06-18T12:23:43.974839Z"
}

Модель
public class CompletedDraftVisualizationMQEvent
{
  public bool HasError { get; set; }
  public string? ErrorMessage { get; set; }
  public Guid? FileId { get; set; }
  public Guid DocumentId { get; set; }
}

JSON
{
  "hasError": false,
  "errorMessage": null,
  "fileId": "34f62417-2c49-43a3-af36-3d3ac11ea198",
  "documentId": "17995a25-42e3-4778-ba5c-22eee2e95be1"
}