API для работы с сервисом СФЕРА Курьер (версия 130.0) - часть 4

 

  Главная      Книги - Разные     API для работы с сервисом СФЕРА Курьер (версия 130.0)

 

поиск по сайту            правообладателям  

 

   

 

   

 

содержание      ..     2      3      4      5     ..

 

 

 

API для работы с сервисом СФЕРА Курьер (версия 130.0) - часть 4

 

 

[
{
"id": 7368574,
"documentType": 11,
"roamingStatus": 0,
"statusDate": "2019-08-29T17:12:36"
},
{
"id": 7368575,
"documentType": 1,
"roamingStatus": 6,
"statusDate": "2019-08-29T17:13:36"
},
{
"id": 7368576,
"documentType": 4,
"roamingStatus": 6,
"statusDate": "2019-08-29T17:14:07"
},
{
"id": 7368583,
"documentType": 13,
"roamingStatus": 0,
"statusDate": "2019-08-29T17:24:32"
},
{
"id": 7368586,
"documentType": 4,
"roamingStatus": 6,
"statusDate": "2019-08-29T17:25:29"
}
]
300
DocumentRouteEditSimpleModel
Упрощённая модель редактирования маршрута документа.
Элемент
Тип
Размер
Описание
DocumentId
long
Идентификатор документа.
Stages
Stage[]
-
Этапы маршрута.
participant
Participant
-
Сторона документооборота (направление маршрута).
Document.EditDocumentRoute
Примеры
<DocumentRouteEditSimpleModel xmlns="http://schemas.datacontract.org/2004/07/Korus.Eds.Api">
<DocumentId>XXXXXXX</DocumentId>
<Participant>Sender</Participant>
<Stages>
<Stage>
<IsMandatory>true</IsMandatory>
<Number>1</Number>
<Period>5</Period>
<RoleId>5</RoleId>
<UserId>66747</UserId>
</Stage>
<Stage>
<IsMandatory>true</IsMandatory>
<Number>2</Number>
<Period>5</Period>
<RoleId>5</RoleId>
<UserId>66747</UserId>
</Stage>
</Stages>
</DocumentRouteEditSimpleModel>
{
"documentId": "XXXXXXX",
"stages": [
{
"isMandatory": false,
"number": 1,
"period": 5,
"roleId": 4
},
{
"isMandatory": true,
"number": 2,
"period": 5,
"roleId": 5,
"UserId": "66747"
}
],
"participant": 1
}
301
302
DocumentRouteStage
Этап маршрута согласования документа.
Свойство
Тип
Обязательность
Размер
Описание
Id
Int64
Идентификатор этапа маршрута.
RoleId
Int32
Идентификатор роли пользователя на маршруте.
Number
Int32
Номер этапа в маршруте.
IsMandatory
Boolean
Признак обязательности подписи.
IsVisible
Boolean
Признак видимость этапа другой стороне.
Sequence
Int32
Номер последовательности.
RoleName
String
Наименование роли.
Side
Participant
Код стороны.
Period
Int32
Срок согласования (в рабочих днях).
PeriodDate
DateTime?
Срок согласования (в рабочих днях).
UserId
Int32?
Идентификатор пользователя.
UserLogin
String
Логин пользователя.
UserName
String
Описание пользователя (имя).
Signed
DateTime?
Дата подписания документа.
IsUserEditable
Boolean
Признак возможности смены пользователя.
IsEditable
Boolean
Признак возможности редактирования этапа.
ProcessedById
Int32?
Идентификатор пользователя, который обработал маршрут.
ProcessedByLogin
String
Логин пользователя, который обработал маршрут.
ProcessedByUsername
String
ФИО пользователя, который обработал маршрут.
Document.DocumentRoute
Примеры
<DocumentRouteStage>
<Id>3036</Id>
<RoleId>4</RoleId>
<Number>1</Number>
<IsMandatory>true</IsMandatory>
<IsVisible>true</IsVisible>
<Sequence>1</Sequence>
<RoleName></RoleName>
<Side>Sender</Side>
<Period>2</Period>
<PeriodDate p3:nil="true" xmlns:p3="http://www.w3.org/2001/XMLSchema-instance" />
<UserId p3:nil="true" xmlns:p3="http://www.w3.org/2001/XMLSchema-instance" />
<Signed p3:nil="true" xmlns:p3="http://www.w3.org/2001/XMLSchema-instance" />
<IsUserEditable>false</IsUserEditable>
<IsEditable>false</IsEditable>
<ProcessedById>XXXXX</ProcessedById>
<ProcessedByLogin>XXXXXXXXXX</ProcessedByLogind>
<ProcessedByUsername>XXXXXXXXXX</ProcessedByUsername>
</DocumentRouteStage>
303
304
DocumentSearchArguments
Аргументы поиска.
Элемент
Тип данных
Обязательный
Размер
Описание
Number
string
-
1-255
Номер документа, можно использовать символы * и ?
Date
DateRange
-
-
Интервал даты документа
Created
DateRange
-
-
Интервал даты создания документа
ContractNumber
string
-
1-255
Номер договора, можно использовать символы * и ?
ContractDate
DateRange
-
-
Интервал даты договора
TypeId
number
-
-
Идентификатор типа документа
StatusForSenderId
number
-
-
Идентификатор статуса документа для отправителя.
StatusForReceiverId
number
-
-
Идентификатор статуса документа для получателя.
FirstCompanyId
number
-
-
Идентификатор организации - участника ЭДО (условно первый клиент).
FirstCompanySide
Participant
-
-
Сторона ЭДО условно первого участника ЭДО.
SecondCompanyId
number
-
-
Идентификатор организации - участника ЭДО (условно второй клиент).
FileName
string
-
-
Имя файла документа.
Document.SearchByParams
Примеры
<DocumentSearchArguments>
<Number>123456</Number>
<Date>
<From>2013-02-01T00:00:00</From>
<To>2013-03-01T00:00:00</To>
<FromExclusive>false</FromExclusive>
<ToExclusive>false</ToExclusive>
</Date>
<TypeId>1</TypeId>
</DocumentSearchArguments>
{
"Number":"123456",
"Date":
{
"From": "2013-01-31T20:00:00Z",
"To": "2013-02-28T20:00:00Z",
"FromExclusive": false,
"ToExclusive": false
},
"Created":null,
"ContractNumber": null,
"ContractDate": null,
"TypeId": null
}
305
DocumentSign
ЭП документа.
Элемент
Тип данных
Описание
Id
long
Идентификатор подписи
CertificateId
long
Идентификатор СКП пользователя
UserId
int
Идентификатор пользователя подписавшего документ
Image
byte[]
Образ подписи
Signed
DiteTime
Дата формирования ЭП
ClientId
long
Идентификатор контрагента
AbonentCode
string
Идентификатор участника ЭДО
MchdUuid
string
Идентификатор МЧД
MchdAccessMode
string
Сведения об информационной системе, осуществляющей хранение МЧД
MchdFileName
string
Название файла МЧД
MchdFile
byte[]
Содержимое файла МЧД
MchdSignature
byte[]
Содержимое файла подписи МЧД
MchdInn
string
Инн доверителя
Chain
List<SignatureMchdIdentify>
Цепочка МЧД
Document.GetSignatures
Примеры
<DocumentSign>
<Id>XXX</Id>
<CertificateId>XXXX</CertificateId>
<UserId>XXX</UserId>
<Image>MIIHCgYJKoZIhvcNAQcCoIIG+zCCB...QS==</Image>
<Signed>2012-10-02</Signed>
<ClientId>XXX</ClientId>
<AbonentCode>Code</AbonentCode>
<MchdUuid>MchdUuid</MchdUuid>
<MchdAccessMode>https://
</MchdAccessMode>
<MchdFileName>MchdFileName</MchdFileName>
<MchdFile>MIIHCgYJKoZIhvcNAQcCoIIG+zCCB...QS==</MchdFile>
<MchdInn>12345678901</MchdInn>
<MchdSignature>MIIHCgYJKoZIhvcNAQcCoIIG+zCCB...QS==</MchdSignature>
</DocumentSign>
306
{
id: XXX,
certificateId: XXXX,
userId: XXX,
image: "MIIHCgYJKoZIhvcNAQcCoIIG+zCCB...QS==",
signed:"2012-10-02",
clientId: XXX,
abonentCode: "Code",
mchdUuid: "MchdUuid",
mchdInn: "12345678901",
mchdAccessMode: "https://
",
chain
:
[
{
mchdUuid: " .",
mchdAccessMode: "https://
",
mchdInn: "12345678901"
}
]
}
{
id: XXX,
certificateId: XXXX,
userId: XXX,
image: "MIIHCgYJKoZIhvcNAQcCoIIG+zCCB...QS==",
signed:"2012-10-02",
clientId: XXX,
abonentCode: "Code",
mchdFileName: "MchdFileName",
mchdFile: "MIIHCgYJKoZIhvcNAQcCoIIG+zCCB...QS==",
mchdSignature: "MIIHCgYJKoZIhvcNAQcCoIIG+zCCB...QS=="
chain: [
{
mchdFileName: "MchdFileName",
mchdFile: "MIIHCgYJKoZIhvcNAQcCoIIG+zCCB...QS==",
mchdSignature: "MIIHCgYJKoZIhvcNAQcCoIIG+zCCB...QS==",
mchdInn: "12345678901"
}
]
}
307
DocumentSigner
Информация о подписанте документа.
Элемент
Тип данных
Описание
Обязательность
Комментарии
Inn
string
ИНН организации /
-
Обязателен, если SignerType=Organization
индивидуального
/Individual
предпринимателя.
Registratio
string
Реквизиты свидетельства
-
Обязателен, если SignerType=Individual,
nRequisites
о государственной
для остальных типов - не указывается
регистрации ИП (только
для ИП).
SignerType
SignerType
Тип подписанта
-
Необязателен, начиная с версии сервиса
(компании).
122.0. Заполняется только
для документов типа УПД по формату
приказа № ММВ-7-15/820@
Person
Person
Персональные данные
+
владельца подписи.
Title
string
Должность подписанта.
-
Обязателен, если SignerType=Organization,
для остальных типов - не указывается
Uuid
string
Идентификатор МЧД
+-
Размер 36
выбранной для
подписания квитанции
Обязателен, если указываем сведения о
доверенности(MchdData)
StartDate
Date
Дата начала действия
+-
Дата в формате ГГГГ-ММ-ДД
МЧД выбранной для
подписания квитанции
Обязателен, если указываем сведения о
доверенности(MchdData)
InternalRe
string
Внутренний
-
Размер 1-50
gistrationN
регистрационный номер
umber
доверенности
Может быть заполнен, если указываем свед
ения о доверенности(MchdData)
InternalRe
Date
Дата внутренней
-
Дата в формате ГГГГ-ММ-ДД
gistrationD
регистрации
ate
Может быть заполнен, если указываем свед
ения о доверенности(MchdData)
MchdViewT
Способ представления
+-
Обязателен, если указываем сведения о
ype
"File" - если МЧД передается
доверенности(MchdData)
в виде файла совместно с
файлом квитанции и файлом
подписи.
"Meta" - если МЧД
передается в виде
метаданных.
"Paper" - если доверенность
бумажная.
AccessMode
string
URL реестра, выдавшего
Обязательно,
Может быть заполнен, если указываем свед
доверенность
если MchdViewType
ения о доверенности(MchdData)
= "Meta"
Document.ChangeSigner v.2
Примеры
308
/2004/07/Korus.Eds.Api">
<InternalRegistrationDate>2023-09-13</InternalRegistrationDate>
<InternalRegistrationNumber>1</InternalRegistrationNumber>
<MchdViewType>Meta</MchdViewType>
<StartDate>2023-09-13</StartDate>
<Uuid>xxe4f2df-bce7-xxxa-bb0e-xxfxxxxxbde3</Uuid>
<Inn>sample string 1</Inn>
<Person>
<FirstName>sample string 2</FirstName>
<LastName>sample string 1</LastName>
<MiddleName>sample string 3</MiddleName>
</Person>
<RegistrationRequisites>sample string 2</RegistrationRequisites>
<SignerType>Individual</SignerType>
<Title>sample string 3</Title>
</DocumentSigner>
{
"inn": "2635105850",
"registrationRequisites": "sample string 2",
"signerType": 1,
"title": "",
"person": {
"LastName": "C",
"FirstName": "",
"MiddleName": ""
},
"InternalRegistrationDate": "2023-04-12",
"InternalRegistrationNumber": "1",
"MchdViewType": "Paper",
"StartDate": "2023-09-13",
"Uuid": "0b582292-5457-41ed-873f-ed0c59681e04",
}
309
DocumentSignerInfo
Информация о подписанте.
Элемент
Тип
Описание
Обязательность
Комментарии
данных
Signer
InfoSigner
Подписант документа
-
В случае, если данный элемент отсутствует в запросе, при формировании
титула данные автоматически заполняются данными текущего
пользователя - SignerType, Inn, Name, RegistrationRequisites, Person, Title.
SignerAuth
SignerAuth
Информация о полномочиях
-+
Обязательно только для документа по формату приказа № ММВ-7-15/820@
ority
ority
подписанта
SignatureT
string
Тип подписи.
-
Используется для документа по формату приказа № ЕД-7-26/970@.
ype
Принимает значение:
Принимает значение:
1 - усиленная квалифицированная электронная подпись |
2 - простая электронная подпись |
3 - усиленная неквалифицированная электронная подпись.
Значения “2” и “3” применяются, если иное не предусмотрено
законодательством Российской Федерации
SigningDate
DateTime
Дата подписания документа
-
Используется для документа по формату приказа № ЕД-7-26/970@.
AuthorityM
string
Способ подтверждения полномочий
+
Используется для документа по формату приказа № ЕД-7-26/970@.
ethod
представителя на подписание
документа
Принимает значение:
1 - в соответствии с данными, содержащимися в электронной подписи |
2 - в соответствии с доверенностью в электронной форме в
машиночитаемом виде, если представление доверенности осуществляется
посредством включения в каждый пакет электронных документов,
подписываемых представителем |
3 - в соответствии с доверенностью в электронной форме в
машиночитаемом виде, если представление доверенности осуществляется
из информационной системы. При этом необходимая информация для
запроса доверенности из информационной системы, указана в электронном
документе |
4 - в соответствии с доверенностью в электронной форме в
машиночитаемом виде, если представление доверенности осуществляется
из информационной системы. При этом необходимая информация для
запроса доверенности из информационной системы представляется
способом, отличным от указания в электронном документе |
5 - в соответствии с доверенностью в форме документа на бумажном
носителе |
6 - иное
MchdFile
MchdFile
Сведения о доверенности в
-
Используется для документа по формату приказа № ЕД-7-26/970@.
электронной форме в
машиночитаемом виде,
Заполняется если не указан MchdPaper
используемой для подтверждения
полномочий представителя
MchdPaper
MchdPaper
Сведения о доверенности в форме
-
Используется для документа по формату приказа № ЕД-7-26/970@.
документа на бумажном носителе,
используемой для подтверждения
Заполняется если не указан MchdFile
полномочий представителя
Document.AcceptTitle v.2/UniversalDocumentAcceptInfo,
Document.CreateInvoice/ Invoice
Примеры
310
{
"SignatureType": "1",
"SigningDate": "2024-03-14",
"AuthorityMethod": "1",
"Signer": {
"Title": "",
"Person": {
"LastName": "",
"FirstName": "",
"MiddleName": "",
"MchdFile": {
"SingleNumber": "9ffXXXXX-ba4a-XXXX-90ce-442f265c8709",
"AttorneyDate": "2022-03-25",
"InformationSystem": "https://mchd-test.esphere.ru/"
}
}
}
}
]
311
DocumentType
Тип документа.
Элемент
Тип данных
Обязательный
Размер
Описание
Id
integer
-
-
Идентификатор типа документа.
DocumentTypeCode
string
-
-
Код типа документа.
Name
string
-
-
Наименование типа документа.
SenderSignatureRequired
bool
-
-
Необходимость подписи отправителя.
ReceiverSignatureRequired
bool
-
-
Необходимость подписи получателя.
TypeDocument v.2,
TypeDocument.Code v.2,
TypeDocument.Id v.2
Примеры
/07/Korus.Eds.Api">
<DocumentTypeCode>sample string 2</DocumentTypeCode>
<Id>1</Id>
<Name>sample string 3</Name>
<ReceiverSignatureRequired>true</ReceiverSignatureRequired>
<SenderSignatureRequired>true</SenderSignatureRequired>
</DocumentType>
{
"id": 1,
"documentTypeCode": "sample string 2",
"name": "sample string 3",
"senderSignatureRequired": true,
"receiverSignatureRequired": true
}
312
DocumentTypeClientRelationApi
Тип документа для взаимосвязи.
Свойство
Тип
Обязательность
Размер
Описание
Id
Int32
Идентификатор типа документа.
Code
String
Код типа документа.
Name
String
Наименование типа документа.
Dictionary.ContractorDocumentTypes/ContractorDocumentTypes
Примеры
<?xml version="1.0" encoding="utf-16"?>
<DocumentTypeClientRelation>
<Id>74</Id>
<Code>ACT</Code>
<Name> </Name>
</DocumentTypeClientRelation>
313
DzoDeal
Данные сделки ДЗО.
Элемент
Тип данных
Описание
Id
integer
Идентификатор сделки
DealType
DzoDealType
Вид сделки
1 - Bundle
2 - Прямая продажа
DealUid
string
Уникальный идентификатор сделки
ExternalClientUid
string
Идентификатор клиента во внешней системе
AgreementId
integer
Идентификатор договора.
Status
DzoDealState
Статус сделки
Amount
decimal?
Стоимость сделки
Примеры
{
"id": 1,
"dealType": 1,
"dealUid": "sample string 2",
"externalClientUid": "sample string 3",
"agreementId": 1,
"status": 0,
"amount": 1.0
}
/Korus.Eds.Api">
<AgreementId>1</AgreementId>
<Amount>1</Amount>
<DealType>Bundle</DealType>
<DealUid>sample string 2</DealUid>
<ExternalClientUid>sample string 3</ExternalClientUid>
<Id>1</Id>
<Status>New</Status>
</DzoDeal>
314
DzoDealDraft
Информация для создания сделки ДЗО.
Элемент
Тип данных
Описание
DealUid
string
Уникальный идентификатор сделки
ProductKindCode
string
Код вида продукта
DealType
DzoDealType
Вид сделки
1 - Bundle
2 - Прямая продажа
Number
string
Номер сделки
StartDate
DateTime?
Дата начала сделки
EndDate
DateTime?
Дата конца сделки
ClientId
long
Идентификатор клиента
Amount
decimal?
Стоимость сделки
File
FileContent
Файл договора
ExternalClientUid
string
Идентификатор клиента во внешней системе
Services
Dictionary<string, string>
Список кодов и стоимости услуг
Примеры
{
"dealUid": "d37fa3d2daf74f079474151ecf445994",
"productKindCode": "TEST1",
"dealType": 1,
"number": "4",
"startDate": null,
"endDate": null,
"clientId": 1,
"amount": 200.0,
"file": null,
"externalClientUid": "EXT_CLIENT_ID",
"services": {
"SERVICE1": 42.50,
"SERVICE2": null
}
}
315
DzoDealService
Список услуг сделки ДЗО.
Элемент
Тип данных
Описание
Id
integer
Идентификатор услуги
Code
string
Код услуги
Name
string
Наименование услуги
Amount
decimal?
Стоимость услуги
Примеры
[
{
"id": 1,
"code": "sample string 2",
"name": "sample string 3",
"amount": 1.0
},
{
"id": 1,
"code": "sample string 2",
"name": "sample string 3",
"amount": 1.0
}
]
<ArrayOfDzoDealService xmlns:i="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://schemas. datacontract.org/2004/07/Korus.Eds.Api">
<DzoDealService>
<Amount>1</Amount>
<Code>sample string 2</Code>
<Id>1</Id>
<Name>sample string 3</Name>
</DzoDealService>
<DzoDealService>
<Amount>1</Amount>
<Code>sample string 2</Code>
<Id>1</Id>
<Name>sample string 3</Name>
</DzoDealService>
</ArrayOfDzoDealService>
316
DzoDealUpdateData
Данные для обновления сделки ДЗО.
Элемент
Тип данных
Описание
State
DzoDealState
Новый статус
Date
DateTime
Дата и время смены статуса
Comment
string
Комментарий к смене статуса
Примеры
{
"dealUid": "sample string 1",
"data": [
{
"state": 0,
"date": "2020-08-12T17:06:10.0077806+03:00",
"comment": "sample string 2"
},
{
"state": 0,
"date": "2020-08-12T17:06:10.0077806+03:00",
"comment": "sample string 2"
}
]
}
<DzoDealBatchUpdateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://schemas. datacontract.org/2004/07/Korus.Eds.Api">
<Data>
<DzoDealUpdateData>
<Comment>sample string 2</Comment>
<Date>2020-08-12T17:06:10.0077806+03:00</Date>
<State>New</State>
</DzoDealUpdateData>
<DzoDealUpdateData>
<Comment>sample string 2</Comment>
<Date>2020-08-12T17:06:10.0077806+03:00</Date>
<State>New</State>
</DzoDealUpdateData>
</Data>
<DealUid>sample string 1</DealUid>
</DzoDealBatchUpdateRequest>
317
DzoDealUpdateRequest
Модель запроса обновления статуса сделки ДЗО.
Элемент
Тип данных
Описание
DealId
long
Идентификатор сделки
State
DzoDealState
Новый статус
Date
DateTime
Дата и время смены статуса
Comment
string
Комментарий к смене статуса
Примеры
{
"dealId": 4,
"state": 1,
"date": "2019-10-01T17:39:32.6009398+03:00",
"comment": ""
}
<DzoDealUpdateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://schemas.datacontract. org/2004/07/Korus.Eds.Api">
<Comment>sample string 3</Comment>
<Date>2020-08-12T16:45:29.2756193+03:00</Date>
<State>New</State>
<DealUid>sample string 1</DealUid>
</DzoDealUpdateRequest>
318
ExceptionDetails
Информация о серверном исключении.
Элемент
Тип данных
Описание
ErrorNumber
string
Номер ошибки
Message
string
Текст сообщения об ошибке
Dictionary.UserCertificate
Примеры
<exception errorNumber="ER-12101">ER-12101:
.</exception>
{"errorNumber":"ER-12101","message":"ER-12101:
."}
319
ExternalServiceData
Информация о данных внешнего сервиса.
Элемент
Тип данных
Обязательный
Описание
ServiceName
string
-
Наименование сервиса
ServiceCode
string
-
Код сервиса
Data
string
-
Данные сервиса
ClientId
integer
-
Идентификатор клиента
Document.ExternalServices v.2
Примеры
<ArrayOfExternalServiceData xmlns:i="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://schemas. datacontract.org/2004/07/Korus.Eds.Api">
<ExternalServiceData>
<ClientId>4</ClientId>
<Data>sample string 3</Data>
<ServiceCode>sample string 2</ServiceCode>
<ServiceName>sample string 1</ServiceName>
</ExternalServiceData>
<ExternalServiceData>
<ClientId>4</ClientId>
<Data>sample string 3</Data>
<ServiceCode>sample string 2</ServiceCode>
<ServiceName>sample string 1</ServiceName>
</ExternalServiceData>
</ArrayOfExternalServiceData>
[
{
"serviceName": "sample string 1",
"serviceCode": "sample string 2",
"data": "sample string 3",
"clientId": 4
},
{
"serviceName": "sample string 1",
"serviceCode": "sample string 2",
"data": "sample string 3",
"clientId": 4
}
]
320
FileContent
Содержимое документа.
Элемент
Тип элемента
Размер
Описание
Обязательность
Filename
string
1-255
Имя документа
+
MimeType
string
1-255
Mime тип содержимого файла
+
Content
Collection of byte
-
Содержимое документа
+
Document.AddAttachment,
Document.AddBatch/DocumentBatch/DocumentCard,
Document.Attachment,
Document.CreateAvoidanceRequest v.2,
Document.CreateAvoidanceRequestClarificationNotice v.2,
Document.CreateCorrectionInvoice,
Document.CreateInvoice,
Document.List/Document,
Document.Pdf,
Document.Pdf v.2,
Document.Card/Document
Document.Card v.2/Document,
Document.Content,
Document.Content v.2,
Document.Details/Document,
Document.DocumentProtocol,
Ticket.CreateAcceptenceCertificateAcceptTicket,
Ticket.CreateClarification,
Ticket.CreateReply,
Ticket.CreateTorg12AcceptTicket,
Tickets.Ticket/TicketDetails,
Tickets.Tickets/TicketDetails,
Document.GetPdfByTaskId v.2
Примеры
321
<Content>
<Content>QEA=</Content>
<MimeType>sample string 2</MimeType>
<Filename>sample string 1</Filename>
</Content>
{
"filename": "sample string 1",
"mimeType": "sample string 2",
"content": "QEA="
}
322
FilterField
Свойства фильтра.
Элемент
Тип данных
Обязательный
Размер
Описание
Logic
string
-
Логика фильтра.
Filters
Filters
-
Значения фильтра.
v2.0.client,
RelationRequest.ListRequest v.2
Примеры
323
Filters
Свойства фильтра.
Элемент
Тип данных
Обязательный
Размер
Описание
Field
string
-
Поле фильтра.
Operator
string
-
Логический оператор.
Value
string
-
Значение фильтра.
v2.0.client/FilterField,
RelationRequest.ListRequest v.2/FilterField
Примеры
324
FindAbonentByRuleRequest
Запрос на поиск правила адресования.
Элемент
Тип
Описание
Обязательность
Комментарий
DocumentTypeCode
string
Код типа документа
+
Inn
string
ИНН организации
+
Kpp
string
КПП организации
-
Parameters
StringKeyValue
Список параметров маршрутизации.
-
Примеры
<FindAbonentByRuleRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://schemas. datacontract.org/2004/07/Korus.Eds.Api.AddressRules">
<DocumentTypeCode>sample string 1</DocumentTypeCode>
<Inn>sample string 2</Inn>
<Kpp>sample string 3</Kpp>
<d2p1:StringKeyValue>
<d2p1:Key>sample string 1</d2p1:Key>
<d2p1:Value>sample string 2</d2p1:Value>
</d2p1:StringKeyValue>
<d2p1:StringKeyValue>
<d2p1:Key>sample string 1</d2p1:Key>
<d2p1:Value>sample string 2</d2p1:Value>
</d2p1:StringKeyValue>
</Parameters>
</FindAbonentByRuleRequest>
{
"documentTypeCode": "sample string 1",
"inn": "sample string 2",
"kpp": "sample string 3",
"parameters": [
{
"key": "sample string 1",
"value": "sample string 2"
},
{
"key": "sample string 1",
"value": "sample string 2"
}
]
}
325
FindAbonentByRuleResponse
Набор ключ-значение (ИДучЭДО - идентификатор правила).
Элемент
Тип данных
Обязательный
Размер
Описание
RuleId
integer
-
-
Идентификатор правила
Company
Company
-
-
Данные о компании
При указании списка дополнительных свойств:
Примеры
<FindAbonentByRuleResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://schemas. datacontract.org/2004/07/Korus.Eds.Api">
<Company>
<CompanyType>Individual</CompanyType>
<FirstName>sample string 7</FirstName>
<FullName>sample string 5</FullName>
<Id>3</Id>
<Inn>sample string 9</Inn>
<Kpp>sample string 10</Kpp>
<LastName>sample string 6</LastName>
<MiddleName>sample string 8</MiddleName>
<Name>sample string 4</Name>
<RegistrationRequisites>sample string 12</RegistrationRequisites>
<RegistryNumber>sample string 11</RegistryNumber>
<Code>sample string 2</Code>
<OperatorCode>sample string 1</OperatorCode>
</Company>
<RuleId>1</RuleId>
</FindAbonentByRuleResponse>
{
"ruleId": 1,
"company": {
"operatorCode": "sample string 1",
"code": "sample string 2",
"id": 3,
"companyType": 0,
"name": "sample string 4",
"fullName": "sample string 5",
"lastName": "sample string 6",
"firstName": "sample string 7",
"middleName": "sample string 8",
"inn": "sample string 9",
"kpp": "sample string 10",
"registryNumber": "sample string 11",
"registrationRequisites": "sample string 12"
}
}
326
FolderFilter
Элемент
Тип данных
Обязательный
Размер
Описание
ClientId
long
-
1-46
Идентификатор клиента (отправителя или получателя)
From
DateTime
-
-
Начальная дата
To
DateTime
-
-
Конечная дата
Folder
DocumentFolder
+
-
Идентификатор папки(требуется передавать value)
Примеры
XML
<FolderFilter>
<ClientId>1</ClientId>
<From>2012-12-01</From>
<To>2012-12-20</To>
<Folder>Draft</Folder>
</FolderFilter>
JSON
{ ClientId: 1, From: "2012-12-01", to: "2012-12-20", folder: "Draft" }
327
ForeignAddress
Адрес местонахождения за пределами Российской Федерации.
Элемент
Тип данных
Обязательный
Размер
Описание
CountryCode
string
+
3
Код страны
Address
string
+
1-1000
Строка адреса
v2.0.client.{clientId}.address.legal/Address,
Document.CreateCorrectionInvoice/BuyerSeller/Address,
Document.CreateInvoice/ Invoice/Consignee/Address,
Document.CreateInvoice/Invoice/BuyerSeller/Address
Примеры
/2004/07/Korus.Eds.Api.Forms">
<CountryCode>sample string 3</CountryCode>
<Address>sample string 35</Address>
</ForeignAddress>
{
"countryCode": "sample string 3",
"address": "sample string 35"
}
328
GARAdress
Адрес в соответствии с государственным адресным реестром, указанный в Едином государственном реестре юридических лиц
/почтовый адрес/адрес места жительства/регистрации по месту жительства (по месту пребывания) индивидуального
предпринимателя, указанный в Едином государственном реестре индивидуальных предпринимателей (реквизиты адреса на
территории Российской Федерации).
Элемент
Тип
Обязательный
Размер
Описание
данных
UniqueNumber
string
+
36
Уникальный номер адреса объекта адресации в государственном адресном реестре
в виде 36-разрядного GUED
Zip
string
-
6
Индекс
RegionCode
string
+
2
Код региона
RegionName
string
+
1-50
Наименование субъекта Российской Федерации
DictrictView
string
-
1
Муниципальный район/ городской округ/ внутригородская территория города
федерального значения/ муниципальный округ/ федеральная территория
DictrictName
string
-
1-255
SettlementView
string
-
1-50
Населенный пункт (город, деревня, село и прочее)
SettlementNa
string
-
1-255
me
StructureElem
string
-
1-50
Элемент планировочной структуры
entView
StructureElem
string
-
1-255
entName
RoadElement
string
-
1-50
Элемент улично-дорожной сети
View
RoadElement
string
-
1-255
Name
LandPlot
string
-
1-50
Земельный участок (номер)
BuildingView
string
-
1-50
Здание (строение), сооружение/ объект незавершенного строительства
BuildingNumb
string
-
1-255
er
SpaceView
string
-
1-50
Помещение в пределах здания (строения), сооружения/ машино-место
SpaceNumber
string
-
1-255
RoomView
string
-
1-50
Помещение в пределах квартиры
RoomNumber
string
-
1-255
v2.0.client.{clientId}.address.legal/Address,
Document.CreateCorrectionInvoice/BuyerSeller/Address,
Document.CreateInvoice/ Invoice/Consignee/Address,
Document.CreateInvoice/Invoice/BuyerSeller/Address
Примеры
329
Group
Описание групп.
Свойство
Тип
Обязательность
Размер
Описание
Id
Int32
+
Идентификатор роли.
Name
String
Наименование роли.
Description
String
Описание группы.
Active
bool
Признак активности.
IsDeleted
Boolean
Признак удаленной роли/группы.
IsSystem
Boolean
Признак системной роли/группы.
IsHavePrivilegeForGrant
bool
Признак наличия у текущего пользователя привилегии для назначения
группы.
UserCount
long
Количество пользователей в группе.
Примеры
<Group>
<Id>0</Id>
<Name>Group1</Name>
<Description>null</Description>
<Active>true</Active>
<IsDeleted>false</IsDeleted>
<IsSystem>false</IsSystem>
<IsHavePrivilegeForGrant>true</IsHavePrivilegeForGrant>
<UserCount>2</UserCount>
</Group>
330
HandoverInfo
Данные сделки ДЗО.
Элемент
Тип
Описание
данных
HandoverDesc
string
Содержание операции. Указывается, например, «Товары переданыª, «Результаты работ сдалª,
ription
«Услуги оказаны в полном объемеª или другое.
HandoverDate
DateTme
Дата отгрузки товаров (передачи результатов работ), передачи имущественных прав
(предъявления оказанных услуг).
Reason
OperationR
Основание отгрузки товаров(передачи результатов работ), передачи имущественных прав
eason[]
(предъявления оказанных услуг).
Примеры
331
IndividualSignerInfo
IndividualSignerInfo / ИП
Элемент
Тип
Размер
Обязательность
Описание
XPath
Inn
string
12
+
ИНН индивидуального предпринимателя
/Файл/Документ/Подписант/ИП
/@ИННФЛ
RegistrationRequi
string
1-100
-
Реквизиты свидетельства о государственной
/Файл/Документ/Подписант/ИП
sites
регистрации ИП
/@СвГосРегИП
OtherInfo
string
1-255
-
Иные сведения, идентифицирующие
/Файл/Документ/Подписант/ИП
физическое лицо
/@ИныеСвед
Person
Person
+
Фамилия, Имя, Отчество
/Файл/Документ/Подписант/ИП
/ФИО
Ticket.CreatePriRasxAdditionalInfoTicket/ PriRasxAdditionalInfo/ SignerInfo
Примеры
{
"Inn": "914283167454",
"OtherInfo": " ",
"Person":
{
"LastName": "XXXXXXX",
"FirstName": "XXXXXXX",
"MiddleName": "XXXXXXX"
}
}
332
INFAdress
Адрес, указанный в Едином государственном реестре юридических лиц/почтовый адрес/адрес места жительства/регистрации по
месту жительства (по месту пребывания) индивидуального предпринимателя, указанный в Едином государственном реестре
индивидуальных предпринимателей (информация об адресе, в том числе об адресе за пределами территории Российской
Федерации)
Элемент
Тип данных
Обязательный
Размер
Описание
CountryCode
string
+
3
Код страны
CountryName
string
+
1-255
Наименование страны
Address
string
+
1-1000
Адрес
v2.0.client.{clientId}.address.legal/Address,
Document.CreateCorrectionInvoice/BuyerSeller/Address,
Document.CreateInvoice/ Invoice/Consignee/Address,
Document.CreateInvoice/Invoice/BuyerSeller/Address
Примеры
333
Info
Info / Информационное поле, Идентификатор + Значение
Элемент
Тип
Размер
Обязательность
Описание
XPath
Id
string
1-50
+
Идентификатор информационного
/Файл/Документ/СвИтПрием/ИнфПол/ТекстИнф
поля
/@Идентиф
Value
string
1-2000
+
Значение информационного поля
/Файл/Документ/СвИтПрием/ИнфПол/ТекстИнф
/@Значен
Ticket.CreatePriRasxAdditionalInfoTicket/ PriRasxAdditionalInfo/ AcceptanceValuesInformation
Примеры
{
"Id": "150",
"Value": ""
}
334
InfoField
Информационное поле документа
Элемент
Тип
Обязательный
Размер
Описание
данных
Id
string
-
36
Идентификатор файла информационного поля(GUID)
Text
string
-
1-2000
Текстовая информация.
Данное поле используется только при преобразовании в счёт-фактуру (ЭСФ) формата
5.01. Для ЭСФ формата 5.02 и УПД/УКД необходимо заполнять поле "TextInfo"
TextInfo
TextInfo[]
-
-
Данная структура используется только при преобразовании в ЭСФ формата 5.02 и УПД
/УКД. Для ЭСФ формата 5.01 необходимо заполнять поле "Text".
Также структура используется для формирования Дополнительных сведений к
документу PRIRASXPRIN
Document.CreateCorrectionInvoice/CorrectionInvoice,
Document.CreateInvoice/ Invoice,
Ticket.CreatePriRasxAdditionalInfoTicket v.2/ PriRasxAdditionalInfo/ AcceptanceValuesInformation
Примеры
<Invoice>
<Id>330bd1ae-0c2f-4d27-8c2d-0968e521dada</Id>
<Text>test</Text>
</Invoice>
{id: "330bd1ae-0c2f-4d27-8c2d-0968e521dada", text: "test"}
335
InfoSigner
Подписант документа.
Элемент
Тип
Описание
Обязательность
Комментарии
Inn
string
ИНН ЮЛ/ИП/ФЛ
Обязателен, если
SignerType=ЮЛ/ИП
Name
string
Краткое наименование организации
Заполняется, если
SignerType=ЮЛ
Person
Person
ФИО владельца подписи
+
RegistrationRequisit
string
Реквизиты свидетельства о государственной
Заполняется, если
es
регистрации ИП
SignerType=ИП
SignerType
SignerType
Тип компании
+
Title
string
Должность подписанта
Обязателен, если
SignerType=ЮЛ
Document.AcceptTitle
v.2/UniversalDocumentAcceptInfo/DocumentSignerInfo,
Document.CreateInvoice/ Invoice/DocumentSignerInfo
Примеры
<Signer>
<Inn>1234567890</Inn>
<Name> </Name>
<Person>
<LastName></LastName>
<FirstName></FirstName>
<MiddleName></MiddleName>
</Person>
<SignerType>Organization</SignerType>
<Title></Title>
</Signer>
<Signer>
<Inn>771600795354</Inn>
<Name> . .</Name>
<Person>
<FirstName></FirstName>
<LastName></LastName>
<MiddleName></MiddleName>
</Person>
<RegistrationRequisites>123</RegistrationRequisites>
<SignerType>Individual</SignerType>
</Signer>
336
Invoice
Счет-фактура.
Структура документа типа UPD_SF по формату приказа № ММВ-7-15/820@ или приказа № ЕД-7-26/970@ зависит от значений во
входных параметрах FormatVersion, FormatCode и Date.
если значение FormatVersion не передано и Date больше или равно 31.12.2019, то для FormatCode по умолчанию
указывается значение 1115131, UPD_SF формируется по формату приказа № ММВ-7-15/820@.
если FormatVersion = 5.01, то вне зависимости от Date для FormatCode по умолчанию указывается значение 1115131, UP
D_SF формируется по формату приказа № ММВ-7-15/820@.
если FormatVersion = 5.02 и Date больше или равно 08.03.2024, то для FormatCode по умолчанию указывается значение
1115131, UPD_SF формируется по формату приказа № ЕД-7-26/970@.
При этом в зависимости от формата необходимо передавать соответствующие данные структуры данных Invoice.
Элемент
Тип
Обязательный
Размер
Описание
данных
FormatVer
string
-
4
Допустимые значения 5.01 или 5.02, если не указано, то используется 5.01.
sion
Атрибут к элементу <Invoice>.
Id
string
-
1-255
Идентификатор файла.
Идентификатор файла, должен быть сформирован в соответствии с требованиями
формата ФНС, если не указан формируется автоматически.
Допустимые маски имени файла: ON_SCHFDOPPR, ON_NSCHFDOPPR,
ON_NSCHFDOPPRMARK, ON_NSCHFDOPPRPROS
FormatCode
string
-
1-7
Код Формата Документа.
Допустимые значения: 1115131
Атрибут к элементу <Invoice>.
ProductGro
ProductGr
-
-
Группы товаров. Заполняется только для документов типа УПД по формату приказа №
up
oup
ЕД-7-26/970@
Number
string
+
1-1000
Порядковый номер счет-фактуры
Date
DateTime
+
10
Дата составления счет-фактуры
CurrencyC
string
+
3
Валюта: Код в соответствии с ОКВ
ode
Correction
string
-
1-3
Исправление: №. Принимает значения от 1 и более.
Number
Если необходимо передать в документ Дефис вместо номера исправления, то передать
null в CorrectionNumber
Невозможно передать без CorrectionDate
Correction
DateTime
-
10
Исправление: Дата. Дата в формате ДД.ММ.ГГГГ
Date
Если необходимо передать в документ Дефис вместо даты исправления, то передать
null в CorrectionDate
Невозможно передать без CorrectionNumber
Seller
BuyerSell
+
-
Сведения о продавце
er
Shipper
Shipper
-
-
Грузоотправитель и его адрес
Consignee
ShipperCo
-
-
Грузополучатель и его адрес
nsignee
Payments
PaymentI
-
-
Сведения о платежно-расчетном документе, не более 10 элементов.
nfo[]
Buyer
BuyerSell
+
-
Сведения о покупателе
er
337
Info
InfoField
-
-
Информационное поле документа
Rows
InvoiceRo
+
-
Сведения о товаре (работе, услуге)
w[]
shipmentD
shipment
+
-
Документы об отгрузке
ocumentRe
Document
quisites
Requisites
[]
Document
Document
-
-
Информация о подписанте
SignerInfo
SignerInf
o[]
IdContract
string
-
1-255
Идентификатор государственного контракта:
Для УПД по формату приказа 155/176, длина значения 1-255 символов
Для УПД по формату приказа 820 длина значения 20-25 символов.
Circumsta
Circumsta
-
1
Обстоятельства формирования счет-фактуры, применяемого при расчетах по налогу на
ncesInvoic
ncesInvoi
добавленную стоимость Элемент принимает следующие значения: Для
eFormation
ceFormati
<Функция>=СЧФ:
on
0 - Информации нет, не сериализуется;
1 - счет-фактура, выставляемый при реализации товаров (работ, услуг), передаче
имущественных прав;
2 - счет-фактура, выставляемый при получении оплаты, частичной оплаты в счет
предстоящих поставок товаров (выполнения работ, оказания услуг), передачи
имущественных прав;
3 - счет-фактура, применяемый в случае реализации комиссионером (агентом,
экспедитором, застройщиком или заказчиком, выполняющим функции застройщика)
двум и более покупателям (приобретения у двух и более продавцов) товаров (работ,
услуг), имущественных прав от своего имени
UID
string
-
1-1000
Уникальный идентификатор документа
Дополнительная информация:
Чтобы передать null в элемент XML, необходимо указать к элементу xsi:nil="true", а в корневом элементе указать namespace:
Document.CreateInvoice
Примеры
<Invoice FormatVersion="5.01" FormatCode="1115131">
<Number>XXX</Number>
<Date>2019-12-12</Date>
<CurrencyCode>XXX</CurrencyCode>
<ProductGroup>
<N4>1</N4>
<N5>0</N5>
<N6>0</N6>
</ProductGroup>
<Seller>
<IdentificationInfo>
<Organization>
<Name>XXXXXXXXXX</Name>
<Inn>XXXXXXXXXX</Inn>
<Kpp>XXXXXXXXX</Kpp>
</Organization>
</IdentificationInfo>
<Address>
<Local>
338
<RegionCode>XX</RegionCode>
<RegionName>XXXXXXXXXXXXXXXXXXXXX</RegionName>
</Local>
</Address>
</Seller>
<Shipper>
<IsSame>true</IsSame>
</Shipper>
<Consignee>
<Name>
<OrganizationName>XXXXXXXXXX</OrganizationName>
</Name>
<Address>
<Local>
<RegionCode>XX</RegionCode>
<RegionName>XXXXXXXXXXXXXXXXXXXXX</RegionName>
</Local>
</Address>
</Consignee>
<Payments>
<PaymentInfo>
<Number>456789</Number>
<Date>2012-12-01</Date>
</PaymentInfo>
</Payments>
<Buyer>
<IdentificationInfo>
<Organization>
<Name>XXXXXXXXXX</Name>
<Inn>XXXXXXXXXX</Inn>
<Kpp>XXXXXXXXX</Kpp>
</Organization>
</IdentificationInfo>
<Address>
<Local>
<RegionCode>XX</RegionCode>
<RegionName>XXXXXXXXXXXXXXXXXXXXX</RegionName>
</Local>
</Address>
</Buyer>
<Info>
<TextInfo Id="1" Value=" 1" />
<TextInfo Id="2" Value=" 2" />
</Info>
<Rows>
<Row>
<Name></Name>
<Unit>018</Unit>
<Amount>5</Amount>
<Price>10</Price>
<NetSum>8</NetSum>
<TotalSum>12</TotalSum>
<VatType>118</VatType>
<VatSum>18</VatSum>
<TextInfo Id="1" Value=" 1" />
</Row>
</Rows>
<shipmentDocumentRequisites>
<shipmentDocumentRequisites>
<shipmentDocumentTitle></shipmentDocumentTitle>
<shipmentDocumentNumber>123</shipmentDocumentNumber>
<shipmentDocumentDate>2012-12-01</shipmentDocumentDate>
</shipmentDocumentRequisites>
</shipmentDocumentRequisites>
<IdContract> XXXXXXXXXX</IdContract>
</Invoice>
{
339
FormatVersion: "5.01",
FormatCode: "1115131",
number: "XXX",
date: "2019-12-12",
currencyCode: "XXX",
"ProductGroup": {
"N4": "1",
"N5": "0",
"N6": "0"
},
seller: {
identificationInfo: {
organization: {
name: "XXXXXXXXXX",
inn: "XXXXXXXXXX",
kpp: "XXXXXXXXX"
}
},
address: {
local: {
regionCode: "78",
regionName: "XXXXXXXXXXXXXXXXXXXXX"
}
}
},
shipper: {
isSame: "true"
},
consignee: {
name: {
organizationName: "XXXXXXXXXX"
},
address: {
local: {
regionCode: "XX",
regionName: "XXXXXXXXXXXXXXXXXXXXX"
}
}
},
payments: {
paymentInfo: {
number: "456789",
date: "2012-12-01"
}
},
buyer: {
identificationInfo: {
organization: {
name: "XXXXXXXXXX",
inn: "XXXXXXXXXX",
kpp: "XXXXXXXXX"
}
},
address: {
local: {
regionCode: "XX",
regionName: "XXXXXXXXXXXXXXXXXXXXX"
}
}
},
rows: [{
name: "",
unit: "018",
amount: 5,
price: 10,
netsum: 8,
totalsum: 12,
vattype: "18",
info: "test"
}],
shipmentDocumentRequisites:[{
340
shipmentDocumentTitle: "",
shipmentDocumentNumber: "123",
shipmentDocumentDate: "2019-12-12T14:58:30.972Z"
}]
idcontract: "
34567890"
}
341
InvoiceRow
Строка сведений о товаре (работе, услуге) в счет-фактуре.
Элемент
Тип данных
Обязательный
Размер
Описание
Name
string
+
1-2000
Наименование товара
Unit
string
-
3
Kод единицы измерения:
Если при создании УПД по формату приказа 820 создать Дефис
вместо единицы измерения, то передать null
Amount
decimal
-
N(26,11)
Количество (объем)
Price
decimal
-
N(26,11)
Цена (тариф) за единицу измерения
NetSum
decimal
-
N(19,2)
Стоимость товаров без налога. Обязателен, если Date 01.07.2017 (т.
к. тип документа - УПД.СЧФ)
TotalSum
decimal
+
N(19,2)
Стоимость товаров с налогом.
Если при создании УПД по формату приказа 820 создать Дефис
вместо Стоимости товаров с налогом, то передать null
Info
string
-
1-2000
Информационное поле строки
ExciseSum
decimal
-
N(19, 2)
В том числе сумма акциза
VatType
string
+
1-7
Налоговая ставка*.
VatSum
decimal
-
N(19,2)
Сумма налога, предъявляемая покупателю. Обязателен, если Date
01.07.2017 (т.к. тип документа - УПД.СЧФ)
CountryCode
string[]
-
3
Цифровой код страны происхождения товара.
CustomDeclaration
string[]
-
1-27
Номер таможенной декларации
TextInfo
TextInfo[]
-
-
Данная структура используется только при преобразовании в ЭСФ
формата 5.02 и УПД/УКД.
TraceableProducts
TraceableProductInf
-
-
Сведения о товаре, подлежащем прослеживаемости.
ormation[]
ProductIdentificatio
ProductIdentificatio
-
-
Номер средств идентификации товаров.
nNumbers
nNumber[]
При формировании счёта-фактуры в формате 5.02, необходимо, что бы количество элементов CountryCode и CustomDec
laration было одинаковым.
*Налоговая ставка указывается в виде:
0%
110%
118%
120%
10/110
118/118
120/120
без НДС
НДС исчисляется налоговым агентом
Дополнительная информация:
Чтобы передать null в элемент XML, необходимо указать к элементу xsi:nil="true", а в корневом элементе указать namespace:
Document.CreateInvoice/ Invoice
342
Примеры
<InvoiceRow>
<Name></Name>
<Unit>018</Unit>
<Amount>5</Amount>
<Price>10</Price>
<NetSum>8</NetSum>
<TotalSum>12</TotalSum>
<VatType>18</VatType>
<Info>test</Info>
</InvoiceRow>
{name: "", unit: "018", amount: "5", price: "10", netsum: "8", totalsum: "12", vattype: "18", info: "test"}
343
KeyValueObject
Объект для хранения пар значений.
Элемент
Тип данных
Обязательный
Размер
Описание
Key
long
+
-
Ключ элемента.
Value
string
+
-
Значение элемента.
Document.Add/DocumentCard,
Document.AddBatch/DocumentBatch/DocumentCard,
Document.List/ApiDocumentFilter,
Document.Attributes
Примеры
<KeyValueObject>
<Key>2</Key>
<Value> 2</Value>
</KeyValueObject>
344
LocalAddress
Адрес, указанный в Едином государственном реестре юридических лиц/почтовый адрес/адрес регистрации по месту жительства
(по месту пребывания) индивидуального предпринимателя, указанный в Едином государственном реестре индивидуальных
предпринимателей (реквизиты адреса на территории Российской Федерации).
Элемент
Тип данных
Обязательный
Размер
Описание
Zip
string
-
6
Индекс
RegionCode
string
+
2
Код региона
RegionName
string
+
1-50
Наименование субъекта Российской Федерации
District
string
-
1-50
Район
City
string
-
1-50
Город
Locality
string
-
1-50
Населенный пункт
Street
string
-
1-50
Улица
House
string
-
1-20
Дом
Building
string
-
1-20
Корпус
Flat
string
-
1-20
Квартира
v2.0.client.{clientId}.address.legal/Address,
Document.CreateCorrectionInvoice/BuyerSeller/Address,
Document.CreateInvoice/ Invoice/Consignee/Address,
Document.CreateInvoice/Invoice/BuyerSeller/Address
Примеры
/07/Korus.Eds.Api.Forms">
<Building>sample string 8</Building>
<City>sample string 4</City>
<District>sample string 3</District>
<Flat>sample string 9</Flat>
<House>sample string 7</House>
<Locality>sample string 5</Locality>
<RegionCode>sample string 2</RegionCode>
<RegionName>sample string 9</RegionName>
<Street>sample string 6</Street>
<Zip>sample string 1</Zip>
</LocalAddress>
{
"zip": "sample string 1",
"regionCode": "sample string 2",
"regionName": "sample string 9",
"district": "sample string 3",
"city": "sample string 4",
"locality": "sample string 5",
"street": "sample string 6",
"house": "sample string 7",
345
"building": "sample string 8",
"flat": "sample string 9"
}
346
LogicalMessages
Логическое сообщение в транспортной квитанции от ЦРПТ
Элемент
Тип
Описание
technologicalTicketId
string
Идентификатор технологической квитанции (ИдТК)
logicalMessageIdExternal
string
Идентификатор ЛС внешний
logicalMessageIdInternal
string
Идентификатор ЛС внутренний
documentId
string
Идентификатор Документа
fileId
string
Идентификатор Файла
Document.TransportTicket
Примеры
"logicalMessages": [
{
"technologicalTicketId": "UINT04TXMNGR00000000000000004335-1096",
"logicalMessageIdExternal": "1b9e4d1c96274b24b73a492b3563db80",
"logicalMessageIdInternal": "UUD00000000000000000012-0710",
"fileId": "ON_NSCHFDOPPRMARK_2BK-2465310432-62289_2BK-7713026678-62288_20200727_C1043DD0-7F54-
41D5- B738-350098DA22D4",
"documentId": "fa9db0efd9f743b48e1d66386c5338f1"
},
{
"technologicalTicketId": "UINT04TXMNGR00000000000000004335-1097",
"logicalMessageIdExternal": "3501e5fc8b734dfd96abdfa9fd3857d9",
"logicalMessageIdInternal": "UUD00000000000000000012-0712",
"fileId": "ON_NSCHFDOPPRMARK_2BK-2465310432-62289_2BK-7713026678-62288_20200727_ABA64592-0D69-
4DEF- A1E8-0628AEE7C7A1",
"documentId": "9da0a0d5a86f4a85aeb8ea2b1a3a9de8"
}
]
347
LogonResponse
Авторизационный токен для входа в систему.
Авторизационный токен требуется передавать в заголовке всех последующих запросов
Элемент
Тип данных
Размер
Описание
Token
string
Авторизационный токен
Logon,
LogonByApiKey
Примеры
<LogonResponse>
<Token>15FAA504AD7A39074557A1ED96419D70C436402D08AFD897890CA5E...C9F6</Token>
</LogonResponse>
{ token: "15FAA504AD7A39074557A1ED96419D70C436402D08AFD897890CA5E...C9F6" }
348
LongKeyValue
Объект для хранения пар значений дополнительных свойств документа.
Элемент
Тип данных
Обязательный
Размер
Описание
Key
long
+
-
Ключ элемента.
Value
string
+
-
Значение элемента.
При указании списка дополнительных свойств:
XML
<ArrayOfStringKeyValue xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.
datacontract.org/2004/07/Korus.Eds.Api">
<StringKeyValue>
<Key>1</Key>
<Value>sample string 1</Value>
</StringKeyValue>
<StringKeyValue>
<Key>2</Key>
<Value>sample string 2</Value>
</StringKeyValue>
</ArrayOfStringKeyValue>
JSON
[
{
"key": "1",
"value": "sample string 1"
},
{
"key": "2",
"value": "sample string 2"
}
]
349
MchdData
Сведения о доверенности.
Элемент
Тип данных
Обязательный
Размер
Описание
Uuid
string
+
36
Идентификатор МЧД выбранной
для подписания квитанции
StartDate
Date
+
Дата в
Дата начала действия
формате
МЧД выбранной для
ГГГГ-ММ-ДД
подписания квитанции
InternalRegis
string
-
1-50
Внутренний регистрационный
trationNumber
номер доверенности
InternalRegis
Date
-
Дата в
Дата внутренней регистрации
trationDate
формате ГГГГ
-ММ-ДД
MchdViewType
+
Способ представления
"File" - если МЧД передается в виде файла
совместно с файлом квитанции и файлом
подписи.
"Meta" - если МЧД передается в виде
метаданных.
"Paper" - если доверенность бумажная.
AccessMode
string
Обязательно,
URL реестра, выдавшего
если MchdViewType =
доверенность
"Meta"
Ticket.CreateReply
Ticket.CreateClarification
Tickets.CreateClarificationNotice
Document.CreateAvoidanceRequestClarificatio
Примеры
/Korus.Eds.Api">
<InternalRegistrationDate>2023-09-13</InternalRegistrationDate>
<InternalRegistrationNumber>1</InternalRegistrationNumber>
<MchdViewType>Meta</MchdViewType>
<StartDate>2023-09-13</StartDate>
<Uuid>63e4f2df-bce7-427a-bb0e-84f21565bde3</Uuid>
</MchdData>
<MchdData>
<InternalRegistrationDate>2023-09-13</InternalRegistrationDate>
<InternalRegistrationNumber>1</InternalRegistrationNumber>
<MchdViewType>Meta</MchdViewType>
<StartDate>2023-09-13</StartDate>
<Uuid>63e4f2df-bce7-427a-bb0e-84f21565bde3</Uuid>
</MchdData>
350
{
"InternalRegistrationDate": "2023-04-12",
"InternalRegistrationNumber": "1",
"MchdViewType": "File",
"StartDate": "2023-09-13",
"Uuid": "0b582292-5457-41ed-873f-ed0c59681e04"
}
351
MchdFile
Сведения о доверенности в электронной форме в машиночитаемом виде, используемой для подтверждения полномочий
представителя.
Элемент
Тип
Размер
Обязательность
Описание
данных
SingleNum
string
36
+
Единый регистрационный номер доверенности
ber
AttorneyD
DateTime
10
+
Дата совершения (выдачи) доверенности
ate
Informatio
string
1-500
+
Идентифицирующая информация об информационной системе, в которой
nSystem
осуществляется хранение доверенности, необходимая для запроса информации из
информационной системы
352
MchdPaper
Сведения о доверенности в форме документа на бумажном носителе, используемой для подтверждения полномочий
представителя.
Элемент
Тип данных
Размер
Обязательность
Описание
InternalNumber
string
1-50
+
Внутренний номер доверенности
AttorneyDate
DateTime
10
+
Дата совершения (выдачи) доверенности
353
OperationReason
Основание корректировки.
Элемент
Тип
Описание
данных
DocumentNa
string
Наименование документа - основания. При отсутствии указывается: Отсутствует.
me
DocumentDate
DateTime
Дата документа - основания.
DocumentNumb
string
Номер документа - основания. При отсутствии документа-основания указывается "Без документа-
er
основания".
354
OrganizationSignerInfo
OrganizationSignerInfo / ЮЛ
Элемент
Тип
Размер
Обязательность
Описание
XPath
Inn
string
10
+
ИНН организации
/Файл/Документ/Подписант/ЮЛ
/@ИННЮЛ
OrganizationN
string
1-1000
-
Наименование полное
/Файл/Документ/Подписант/ЮЛ
ame
/@НаимОрг
Title
string
1-128
+
Должность подписанта
/Файл/Документ/Подписант/ЮЛ
/@Должн
Person
Person
+
Фамилия, Имя, Отчество
/Файл/Документ/Подписант/ЮЛ
/ФИО
OtherInfo
string
1-255
-
Иные сведения, идентифицирующие
/Файл/Документ/Подписант/ЮЛ
юридическое лицо
/@ИныеСвед
В частности, может быть указана страна при
отсутствии КодСтр
Ticket.CreatePriRasxAdditionalInfoTicket/ PriRasxAdditionalInfo/ SignerInfo
Примеры
{
"Inn": "914283167454",
"OrganizationName": "XXXXXXXXXX",
"Title": "",
"OtherInfo": " ",
"Person":
{
"LastName": "XXXXXXXXXX",
"FirstName": "XXXXXXXXXX",
"MiddleName": "XXXXXXXXXX"
}
}
355
PackageCard
Сведения о составе пакета документов - карточка.
Элемент
Тип данных
Описание
Обязательность
Id
integer
Идентификатор пакета.
-
Name
string
Наименование пакета.
-
IsSendSync
boolean
Признак одновременной отправки получателю документов пакета.
-
Documents
Collection of PackageDocument
Сведения о документах пакета.
-
Document.PackageDetails v.2
Примеры
/07/Korus.Eds.Api">
<Documents>
<PackageDocument>
<Actions>None</Actions>
<Comment>sample string 13</Comment>
<ContractDate>2017-01-18T15:28:57.725875+03:00</ContractDate>
<ContractNumber>sample string 15</ContractNumber>
<Created>2017-01-18T15:28:57.725875+03:00</Created>
<Date>2017-01-18T15:28:57.725875+03:00</Date>
<Description>sample string 6</Description>
<DocumentTypeCode>sample string 3</DocumentTypeCode>
<Filename>sample string 14</Filename>
<Id>1</Id>
<IsDocflowCompleted>true</IsDocflowCompleted>
<NetSum>1</NetSum>
<Number>sample string 4</Number>
<ReceiveDate>2017-01-18T15:28:57.725875+03:00</ReceiveDate>
<ReceiverId>10</ReceiverId>
<RemainingDays>1</RemainingDays>
<SendDate>2017-01-18T15:28:57.725875+03:00</SendDate>
<SenderId>9</SenderId>
<Status>None</Status>
<StatusChanged>2017-01-18T15:28:57.725875+03:00</StatusChanged>
<StatusName>sample string 7</StatusName>
<TotalSum>1</TotalSum>
<TypeId>2</TypeId>
<VatSum>1</VatSum>
</PackageDocument>
<PackageDocument>
<Actions>None</Actions>
<Comment>sample string 13</Comment>
<ContractDate>2017-01-18T15:28:57.725875+03:00</ContractDate>
<ContractNumber>sample string 15</ContractNumber>
<Created>2017-01-18T15:28:57.725875+03:00</Created>
<Date>2017-01-18T15:28:57.725875+03:00</Date>
<Description>sample string 6</Description>
<DocumentTypeCode>sample string 3</DocumentTypeCode>
<Filename>sample string 14</Filename>
<Id>1</Id>
<IsDocflowCompleted>true</IsDocflowCompleted>
<NetSum>1</NetSum>
<Number>sample string 4</Number>
<ReceiveDate>2017-01-18T15:28:57.725875+03:00</ReceiveDate>
<ReceiverId>10</ReceiverId>
356
<RemainingDays>1</RemainingDays>
<SendDate>2017-01-18T15:28:57.725875+03:00</SendDate>
<SenderId>9</SenderId>
<Status>None</Status>
<StatusChanged>2017-01-18T15:28:57.725875+03:00</StatusChanged>
<StatusName>sample string 7</StatusName>
<TotalSum>1</TotalSum>
<TypeId>2</TypeId>
<VatSum>1</VatSum>
</PackageDocument>
</Documents>
<Id>1</Id>
<IsSendSync>true</IsSendSync>
<Name>sample string 2</Name>
</PackageCard>
{
"id": 1,
"name": "sample string 2",
"isSendSync": true,
"documents": [
{
"id": 1,
"typeId": 2,
"documentTypeCode": "sample string 3",
"number": "sample string 4",
"date": "2017-01-18T15:28:57.725875+03:00",
"description": "sample string 6",
"status": 0,
"statusName": "sample string 7",
"statusChanged": "2017-01-18T15:28:57.725875+03:00",
"sendDate": "2017-01-18T15:28:57.725875+03:00",
"senderId": 9,
"receiverId": 10,
"isDocflowCompleted": true,
"actions": 0,
"remainingDays": 1,
"receiveDate": "2017-01-18T15:28:57.725875+03:00",
"created": "2017-01-18T15:28:57.725875+03:00",
"comment": "sample string 13",
"filename": "sample string 14",
"netSum": 1.0,
"vatSum": 1.0,
"totalSum": 1.0,
"contractNumber": "sample string 15",
"contractDate": "2017-01-18T15:28:57.725875+03:00"
},
{
"id": 1,
"typeId": 2,
"documentTypeCode": "sample string 3",
"number": "sample string 4",
"date": "2017-01-18T15:28:57.725875+03:00",
"description": "sample string 6",
"status": 0,
"statusName": "sample string 7",
"statusChanged": "2017-01-18T15:28:57.725875+03:00",
"sendDate": "2017-01-18T15:28:57.725875+03:00",
"senderId": 9,
"receiverId": 10,
"isDocflowCompleted": true,
"actions": 0,
"remainingDays": 1,
"receiveDate": "2017-01-18T15:28:57.725875+03:00",
"created": "2017-01-18T15:28:57.725875+03:00",
"comment": "sample string 13",
"filename": "sample string 14",
"netSum": 1.0,
"vatSum": 1.0,
357
"totalSum": 1.0,
"contractNumber": "sample string 15",
"contractDate": "2017-01-18T15:28:57.725875+03:00"
}
]
}
358
PackageCardAdmin
Сведения о пакете документов - карточка (для администратора системы).
Элемент
Тип данных
Описание
Обязательность
Id
integer
Идентификатор пакета.
-
Name
string
Наименование пакета.
-
IsSendSync
boolean
Признак одновременной отправки получателю документов пакета.
-
Documents
Collection of PackageDocumentAdmin
Сведения о документах пакета.
-
359
PackageDocument
Сведения о документе пакета.
Элемент
Тип
Описание
Размер
Обязательность
Id
integer
Идентификатор документа.
-
TypeId
integer
Идентификатор типа документа.
-
DocumentTypeCode
string
Код типа документов, мы используем как код формы.
-
Number
string
Номер документа.
-
Date
date
Дата документа.
-
Description
string
Описание документа.
-
Status
DocumentStatus
Статус документа.
-
StatusName
string
Наименование статуса документа (для текущего пользователя).
-
StatusChanged
date
Дата смены статуса.
-
SendDate
date
Дата отправки(выставления) документа.
-
SenderId
integer
Идентификатор отправителя.
-
ReceiverId
integer
Идентификатор получателя.
-
IsDocflowCompleted
boolean
Признак завершенности документооборота.
-
Actions
Actions
Маска доступных действий с документом.
-
RemainingDays
integer
Количество оставшихся дней для обработки документа.
-
ReceiveDate
date
Дата получения документа.
-
Created
date
Дата создания документа.
-
Comment
string
Комментарий к документу.
-
Filename
string
Имя файла вложения.
-
NetSum
decimal number
Сумма без НДС.
-
VatSum
decimal number
Сумма НДС.
-
TotalSum
decimal number
Сумма с НДС.
-
ContractNumber
string
Номер договора.
-
ContractDate
date
Дата договора.
-
Document.PackageDetails v.2/PackageCard
Примеры
360
PackageDocumentAdmin
Сведения о документе пакета для администратора системы.
Элемент
Тип
Описание
Размер
Id
integer
Идентификатор документа.
TypeId
integer
Идентификатор типа документа.
DocumentTypeCode
string
Код типа документов, мы используем как код формы.
Number
string
Номер документа.
Date
date
Дата документа.
Description
string
Описание документа.
SendDate
date
Дата отправки(выставления) документа.
SenderId
integer
Идентификатор отправителя.
SenderName
string
Краткое наименование отправителя документа.
SenderInn
string
ИНН отправителя.
SenderKpp
string
КПП отправителя.
ReceiverId
integer
Идентификатор получателя.
ReceiverName
string
Краткое наименование получателя документа.
ReceiverInn
string
ИНН получателя.
ReceiverKpp
string
КПП получателя.
ReceiveDate
date
Дата получения документа.
Created
date
Дата создания документа.
Filename
string
Имя файла вложения.
NetSum
decimal number
Сумма без НДС.
VatSum
decimal number
Сумма НДС.
TotalSum
decimal number
Сумма с НДС.
ContractNumber
string
Номер договора.
ContractDate
date
Дата договора.
SenderStatus
DocumentStatus
Статус документа для отправителя.
SenderStatusChangeDate
date
Дата смены статуса на стороне отправителя.
SenderStatusName
string
Наименование статуса документа для отправителя.
ReceiverStatus
DocumentStatus
Статус документа для получателя.
ReceiverStatusChangeDate
date
Дата смены статуса на стороне получателя.
ReceiverStatusName
string
Наименование статуса документа для получателя.
IsSenderDocflowCompleted
boolean
Признак завершенности документооборота отправителя.
IsReceiverDocflowCompleted
boolean
Признак завершенности документооборота получателя.
361
PaymentInfo
Информация о платежно-расчетном документе.
Элемент
Тип данных
Обязательный
Размер
Описание
Number
string
+
1-20
Номер платежно-расчетного документа
Date
DateTime
+
10
Дата составления платежно-расчетного документа
Sum
decimal
-
N(17,2)
Сумма платежно-расчетного документа
17 символов до, 2 после запятой
Document.CreateInvoice/ Invoice
Примеры
<PaymentInfo>
<Number>456789</Number>
<Date>2012-12-01</Date>
</PaymentInfo>
{ number: "456789", date: "2012-12-01" }
362
PaymentOrderStatusInfo
Информация о статусе платежного поручения.
Элемент
Тип данных
Описание
DocExtId
string
Внешний идентификатор документа.
Status
Integer
Статус платежного поручения.
363
Person
Персональные данные.
Элемент
Тип данных
Обязательность
Описание
LastName
string (60)
+
Фамилия
FirstName
string (60)
+
Имя
MiddleName
string (60)
-
Отчество
Document.AcceptTitle
v.2/UniversalDocumentAcceptInfo/DocumentSignerInfo/InfoSigner,
Document.ChangeSigner v.2/DocumentSigner,
Document.CreateInvoice/ Invoice/DocumentSignerInfo/InfoSigner,
Document.GetSignatureDetails/SignatureDetails,
Ticket.CreateAcceptenceCertificateAcceptTicket/AcceptanceCertificateAcceptInfo/Signer,
Ticket.CreateAcceptenceCertificateAcceptTicket/AcceptanceCertificateAcceptInfo/Warrant/WarrantIssuer,
Ticket.CreateAcceptenceCertificateAcceptTicket/AcceptanceCertificateAcceptInfo/Warrant/WarrantSubject,
Ticket.CreateTorg12AcceptTicket/Torg12AcceptInfo/Signer,
Dictionary.UserInfo/User,
Helper.UserList/UserDetails
Ticket.CreatePriRasxAdditionalInfoTicket/ PriRasxAdditionalInfo/ SignerInfo/ PhysicalSignerInfo,
Ticket.CreatePriRasxAdditionalInfoTicket/ PriRasxAdditionalInfo/ SignerInfo/ IndividualSignerInfo,
Ticket.CreatePriRasxAdditionalInfoTicket/ PriRasxAdditionalInfo/ SignerInfo/ OrganizationSignerInfo
Примеры
<Person>
<LastName>XXXXXXXXXX</LastName>
<FirstName>XXXXXXXXXX</FirstName>
<MiddleName>XXXXXXXXXX</MiddleName>
</Person>
{LastName: "XXXXXXXXXX", FirstName: "XXXXXXXXXX", MiddleName: "XXXXXXXXXX"}
364
PersonName
Значения персональных данных.
Элемент
Тип данных
Обязательный
Размер
Описание
LastName
string
+
1-60
Фамилия персоны
FirstName
string
+
1-60
Имя персоны
MiddleName
string
-
1-60
Отчество персоны
Document.CreateCorrectionInvoice/CorrectionInvoice/BuyerSeller,
Document.CreateInvoice/ Invoice/Consignee,
Document.CreateInvoice/Invoice/BuyerSeller
Примеры
<PersonName>
<LastName>XXXXXXXXXX</LastName>
<FirstName>XXXXXXXXXX</FirstName>
<MiddleName>XXXXXXXXXX</MiddleName>
</PersonName>
{LastName: "XXXXXXXXXX", FirstName: "XXXXXXXXXX", MiddleName: "XXXXXXXXXX"}
365
PhysicalSignerInfo
PhysicalSignerInfo / Физическое Лицо
Элемент
Тип
Размер
Обязательность
Описание
XPath
Inn
string
12
-
ИНН физического лица
/Файл/Документ/Подписант/ФЛ
/@ИННФЛ
OtherInfo
string
1-255
-
Иные сведения, идентифицирующие
/Файл/Документ/Подписант/ФЛ
физическое лицо
/@ИныеСвед
Person
Person
+
Фамилия, имя, отчество
/Файл/Документ/Подписант/ФЛ/ФИО/
Ticket.CreatePriRasxAdditionalInfoTicket/ PriRasxAdditionalInfo/ SignerInfo
Примеры
{
"Inn": "XXXXXXXXXXXX",
"OtherInfo": " ",
"Person":
{
"LastName": "XXXXXXXXXX",
"FirstName": "XXXXXXXXXX",
"MiddleName": "XXXXXXXXXX"
}
}
366
ProductGroup
Группы товаров
Элемент
Тип данных
Обязательный
Размер
Описание
N4
string
-
1
Принимает значения: "0", "1"
N5
string
-
1
Принимает значения: "0", "1"
N6
string
-
1
Принимает значения: "0", "1"
Document.CreateInvoice
Примеры
"ProductGroup":
{
"N4": "1",
"N5": "0",
"N6": "0"
}
367
ProductIdentificationNumber
Сведения о маркировке товара.
Элемент
Тип
Обязательный
Размер
Описание
данных
TransportPackagin
string
-
1-255
Уникальный идентификатор транспортной упаковки
gGuid
CheckMarks
string[]
-
1-255
Контрольный идентификационный знак (КИЗ)
PackagingGuids
string[]
-
1-255
Уникальный идентификатор вторичной (потребительской)/третичной
(заводской, транспортной) упаковки
Дополнительные условия:
Обязательно передавать один из элементов: TransportPackagingGuid или CheckMarks или PackagingGuids.
В одном элементе ProductIdentificationNumbers не могут быть переданы одновременно CheckMarks и PackagingGuids.
Document.CreateInvoice/ Invoice
Примеры
<ProductIdentificationNumbers TransportPackagingGuid="
">
<CheckMarks>
</CheckMarks>
</ProductIdentificationNumbers>
"ProductIdentificationNumbers": [{
"TransportPackagingGuid": "
",
"CheckMarks": " "
}]
368
Relation
Взаимосвязи клиента.
Элемент
Тип данных
Размер
Описание
Id
long
-
Идентификатор взаимосвязи
ParticipantId
long
-
Идентификатор клиента второй стороны
ParticipantName
long
-
Наименование клиента второй стороны
Status
RelationRequestStatust
-
Идентификатор статуса взаимосвязи
IsActiveRelation
bool
-
Признак активности взаимосвязи
IsDefaultSettings
bool
-
Признак использования настроек по умолчанию
SenderDocumentTypes
ClientRelationDocumentType[]
-
Список текущих(исходящих) типов документов
ReceiverDocumentTypes
ClientRelationDocumentType[]
-
Список входящих типов документов
IsAllSenderSelected
bool
-
Признак активности всех исходящих типов документов
IsAllReceiverSelected
bool
-
Признак активности всех входящих типов документов
DateLastChange
date
-
Дата последней модификации взаимосвязи
Login
string
-
Логин пользователя, последнего редактировавшего взаимосвязь
LastChangeUserId
long
-
Идентификатор пользователя, последнего редактировавшего взаимосвязь
LastChangeUser
string
-
ФИО пользователя, последнего редактировавшего взаимосвязь
EdiCodeClient
string
-
ИдУчЭДО отправителя
EdiCodeParticipant
string
-
ИдУчЭДО второй стороны
Примеры
<?xml version="1.0" encoding="UTF-8" ?> <AddStandard>true</AddStandard> <Merge>false</Merge>
<Relation>
<IsActiveRelation>true</IsActiveRelation>
<Id>0</Id>
<IsDefaultSettings>true</IsDefaultSettings>
<IsAllReceiverSelected>true</IsAllReceiverSelected>
<IsAllSenderSelected>true</IsAllSenderSelected>
<ReceiverDocumentTypes>
<Id>1604</Id>
<IsEdiCodeDefault>true</IsEdiCodeDefault>
<IsDefaultSelected>false</IsDefaultSelected>
<IsSelected>true</IsSelected>
<Name>qaauto_doc10</Name>
</ReceiverDocumentTypes>
<SenderDocumentTypes>
<Id>1604</Id>
<IsEdiCodeDefault>true</IsEdiCodeDefault>
<IsDefaultSelected>false</IsDefaultSelected>
<IsSelected>true</IsSelected>
<Name>qaauto_doc10</Name>
</SenderDocumentTypes>
<ParticipantId>1625</ParticipantId>
<Status>0</Status>
</Relation>
</UniversalDocumentAcceptInfo>>
369
{
"AddStandard": true,
"Merge": false,
"Relation": {
"Id": 0,
"ParticipantId": 1625,
"Status": 0,
"IsActiveRelation": true,
"IsDefaultSettings": true,
"SenderDocumentTypes": [
{
"Name": "qaauto_doc10",
"IsSelected": true,
"IsDefaultSelected": false,
"IsEdiCodeDefault": true,
"Id": 1604
}
],
"ReceiverDocumentTypes": [
{
"Name": "qaauto_doc10",
"IsSelected": true,
"IsDefaultSelected": false,
"IsEdiCodeDefault": true,
"Id": 1604
}
],
"IsAllSenderSelected": true,
"IsAllReceiverSelected": true,
}
}
370
RelationAssertRequest
Модель запроса редактирования взаимосвязи клиента.
Элемент
Тип данных
Размер
Описание
AddStandard
bool
-
Признак добавления стандартных типов документов, при создании взаимосвязи.
Merge
bool
-
Признак слияния с существующими настройками по типам документов.
Relation
Relation
-
Взаимосвязь клиента.
Примеры
XML
JSON
371
RelationEvent
Информация о событии по взаимосвязи.
Элемент
Тип
Описание
Обязательность
id
long
Идентификатор события
+
eventType
CorrelationEventType
Тип события
+
date
date
Дата изменения статуса взаимосвязи
+
correlationId
long
ID взаимосвязи
+
ediCode
string
ИдУчЭДО контрагента (с которым установлена взаимосвязь)
-
CorrelationEvent.Events v.2.0
Примеры
372
RelationInfo
Информация по взаимосвязи.
Элемент
Тип данных
Обязательность
Описание
RelationId
integer
+
Идентификатор взаимосвязи (запроса)
ClientId
integer
+
Идентификатор контрагента
Inn
string
+
ИНН контрагента
Kpp
string
-
КПП контрагента
EdiCode
string
+
Код участника ЭДО контрагента, на который установлена
взаимосвязь
ShortName
string
+
Краткое наименование контрагента
SenderDocumentTypes
RelationInfoDocumentType
[]
-
Список исходящих типов документов
ReceiverDocumentTypes
RelationInfoDocumentType
[]
-
Список входящих типов документов
RelationCorrelated v.2
Примеры
"relationId": 1132682,
"clientId": XXXX,
"inn": "XXXXXXXXXX",
"kpp": "XXXXXXXXX",
"ediCode": "TST-5249137210-26985",
"shortName": " \"XXXXXXX\"",
"senderDocumentTypes": [
{
"id": 71,
"code": "ACTADD",
"name": "
( )"
},
{
"id": 2552,
"code": "MX1",
"name": "
( MX1 )"
},
{
"id": 1606,
"code": "FEES_REGISTER_INVESTMENT",
"name": "
(-)"
},
{
"id": 49,
"code": "BILL",
"name": ""
},
{
"id": 1785,
"code": "UCD_DIC",
"name": ".
( ,
),
"
},
{
"id": 1784,
"code": "UCD_CSF",
373
"name": ".
-"
},
{
"id": 1786,
"code": "UCD_CSF_DIC",
"name": ".
-
( ,
),
"
},
{
"id": 1764,
"code": "UPD_DOP",
"name": ".
( ),
(
)"
},
{
"id": 1644,
"code": "UPD_SF",
"name": ". -"
},
{
"id": 1765,
"code": "UPD_SF_DOP",
"name": ". -
( ),
(
)"
}
],
"receiverDocumentTypes": [
{
"id": 71,
"code": "ACTADD",
"name": "
( )"
},
{
"id": 2552,
"code": "MX1",
"name": "
( MX1 )"
},
{
"id": 1606,
"code": "FEES_REGISTER_INVESTMENT",
"name": "
(-)"
},
{
"id": 49,
"code": "BILL",
"name": ""
},
{
"id": 1785,
"code": "UCD_DIC",
"name": ".
( ,
),
"
},
{
"id": 1784,
"code": "UCD_CSF",
"name": ".
-"
},
{
"id": 1786,
"code": "UCD_CSF_DIC",
"name": ".
-
( ,
),
"
},
{
"id": 1764,
"code": "UPD_DOP",
"name": ".
( ),
(
)"
},
{
"id": 1644,
"code": "UPD_SF",
"name": ". -"
},
{
"id": 1765,
374
"code": "UPD_SF_DOP",
"name": ". -
( ),
(
}
)"
]
}
]
375
RelationInfoDocumentType
Информация о типах документов по взаимосвязи.
Элемент
Тип данных
Обязательность
Описание
Id
integer
+
Идентификатор типа документа
Code
string
+
Код типа документа
Name
string
+
Наименование типа документа
RelationCorrelated v.2, RelationInfo
Примеры
{
"id": 1786,
"code": "UCD_CSF_DIC",
"name": ".
-
( ,
),
"
}
376
RelationRequest
Взаимосвязи клиента.
Элемент
Тип
Размер
Описание
Комментарий
ReceiverId
long?
-
Идентификатор клиента получателя запроса.
ReceiverName
string
-
Наименование клиента получателя запроса.
ReceiverKpp
string
-
КПП клиента получателя запроса.
ReceiverInn
string
+
ИНН клиента получателя запроса.
Contacts
string
-
Контактные данные клиента получателя запроса.
Email
string
-
Электронный адрес клиента получателя запроса.
OperatorCode
string
-
Идентификатор оператора ЭДО.
AbonentCode
string
-
Идентификатор участника ЭДО.
RelationRequest.AddRequest v.2
Примеры
/2004/07/Korus.Eds.Api">
<AbonentCode>sample string 7</AbonentCode>
<Contacts>sample string 4</Contacts>
<Email>sample string 5</Email>
<OperatorCode>sample string 6</OperatorCode>
<ReceiverId>1</ReceiverId>
<ReceiverInn>sample string 3</ReceiverInn>
<ReceiverKpp>sample string 2</ReceiverKpp>
<ReceiverName>sample string 1</ReceiverName>
</RelationRequest>
{
"receiverId": 1,
"receiverName": "sample string 1",
"receiverKpp": "sample string 2",
"receiverInn": "sample string 3",
"contacts": "sample string 4",
"email": "sample string 5",
"operatorCode": "sample string 6",
"abonentCode": "sample string 7"
}
377
RelationRequestDetails
Детальные данные взаимосвязи клиента.
Элемент
Тип
Описание
Комментарии
Id
long
Идентификатор взаимосвязи (запроса)
IsLocal
boolean
Признак наличия прямого ИдУчЭДО у
Null - новый контрагент; False - нет прямого ИдУчЭДО; True -
получателя запроса
есть прямой ИдУчЭДО
SenderName
string
Наименование клиента отправителя запроса
SenderKpp
string
КПП клиента отправителя запроса
SenderInn
string
ИНН клиента отправителя запроса
Side
RelationRequest
Направление запроса
Side
Status
RelationRequest
Идентификатор статуса
Status
StatusName
string
Наименование статуса
Date
date
Дата создания запроса
AcceptionDa
date
Дата принятия запроса
te
UserId
long
Идентификатор пользователя принявшего
запрос
UserName
string
ФИО пользователя принявшего запрос
Login
string
Логин пользователя принявшего запрос
IsOneCHub
boolean
Признак взаимосвязи 1С
ReceiverId
long
Идентификатор клиента получателя запроса
EdiCodeSen
string
Идентификатор участника ЭДО клиента
der
EdiCodeRec
string
Идентификатор участника ЭДО получателя
eiver
ReceiverNa
string
Наименование клиента получателя запроса
me
ReceiverKpp
string
КПП клиента получателя запроса
ReceiverInn
string
ИНН клиента получателя запроса
Contacts
string
Контактные данные клиента получателя
запроса
Email
string
Электронный адрес клиента получателя
запроса
OperatorCo
string
Код оператора ЭДО получателя запроса
de
AbonentCode
string
Идентификатор участника ЭДО получателя
запроса
RelationRequest.ListRequest v.2
Примеры
378
<ArrayOfRelationRequestDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.
datacontract.org/2004/07/Korus.Eds.Api">
<RelationRequestDetails>
<AbonentCode>sample string 17</AbonentCode>
<Contacts>sample string 14</Contacts>
<EdiCodeReceiver>sample string 10</EdiCodeReceiver>
<EdiCodeSender>sample string 9</EdiCodeSender>
<Email>sample string 15</Email>
<OperatorCode>sample string 16</OperatorCode>
<ReceiverId>1</ReceiverId>
<ReceiverInn>sample string 13</ReceiverInn>
<ReceiverKpp>sample string 12</ReceiverKpp>
<ReceiverName>sample string 11</ReceiverName>
<AcceptionDate>2022-11-28T17:11:01.0831676+03:00</AcceptionDate>
<Date>2022-11-28T17:11:01.0831676+03:00</Date>
<Id>1</Id>
<IsLocal>true</IsLocal>
<IsOneCHub>true</IsOneCHub>
<Login>sample string 7</Login>
<SenderInn>sample string 4</SenderInn>
<SenderKpp>sample string 3</SenderKpp>
<SenderName>sample string 2</SenderName>
<Side>None</Side>
<Status>None</Status>
<StatusName>sample string 5</StatusName>
<UserId>1</UserId>
<UserName>sample string 6</UserName>
<IsOneCHub>false</IsOneCHub>
</RelationRequestDetails>
<RelationRequestDetails>
<AbonentCode>sample string 17</AbonentCode>
<Contacts>sample string 14</Contacts>
<EdiCodeReceiver>sample string 10</EdiCodeReceiver>
<EdiCodeSender>sample string 9</EdiCodeSender>
<Email>sample string 15</Email>
<OperatorCode>sample string 16</OperatorCode>
<ReceiverId>1</ReceiverId>
<ReceiverInn>sample string 13</ReceiverInn>
<ReceiverKpp>sample string 12</ReceiverKpp>
<ReceiverName>sample string 11</ReceiverName>
<AcceptionDate>2022-11-28T17:11:01.0831676+03:00</AcceptionDate>
<Date>2022-11-28T17:11:01.0831676+03:00</Date>
<Id>1</Id>
<IsLocal>true</IsLocal>
<IsOneCHub>true</IsOneCHub>
<Login>sample string 7</Login>
<SenderInn>sample string 4</SenderInn>
<SenderKpp>sample string 3</SenderKpp>
<SenderName>sample string 2</SenderName>
<Side>None</Side>
<Status>None</Status>
<StatusName>sample string 5</StatusName>
<UserId>1</UserId>
<UserName>sample string 6</UserName>
<IsOneCHub>false</IsOneCHub>
</RelationRequestDetails>
</ArrayOfRelationRequestDetails>
[
{
"id": 1,
"isLocal": true,
"senderName": "sample string 2",
"senderKpp": "sample string 3",
"senderInn": "sample string 4",
"side": 0,
"status": 0,
"statusName": "sample string 5",
"date": "2022-11-28T17:11:01.0831676+03:00",
"acceptionDate": "2022-11-28T17:11:01.0831676+03:00",
"userId": 1,
"userName": "sample string 6",
"login": "sample string 7",
"isOneCHub": true,
"receiverId": 1,
"ediCodeSender": "sample string 9",
"ediCodeReceiver": "sample string 10",
379
"receiverName": "sample string 11",
"receiverKpp": "sample string 12",
"receiverInn": "sample string 13",
"contacts": "sample string 14",
"email": "sample string 15",
"operatorCode": "sample string 16",
"abonentCode": "sample string 17",
"isOneCHub": false
},
{
"id": 1,
"isLocal": true,
"senderName": "sample string 2",
"senderKpp": "sample string 3",
"senderInn": "sample string 4",
"side": 0,
"status": 0,
"statusName": "sample string 5",
"date": "2022-11-28T17:11:01.0831676+03:00",
"acceptionDate": "2022-11-28T17:11:01.0831676+03:00",
"userId": 1,
"userName": "sample string 6",
"login": "sample string 7",
"isOneCHub": true,
"receiverId": 1,
"ediCodeSender": "sample string 9",
"ediCodeReceiver": "sample string 10",
"receiverName": "sample string 11",
"receiverKpp": "sample string 12",
"receiverInn": "sample string 13",
"contacts": "sample string 14",
"email": "sample string 15",
"operatorCode": "sample string 16",
"abonentCode": "sample string 17",
"isOneCHub": false
}
]
ReceiverClientGroup
380
Role
Описание ролей.
Свойство
Тип
Обязательность
Размер
Описание
Id
Int32
+
Идентификатор роли.
Name
String
Наименование роли.
Description
String
Описание роли.
Helper.RoleList,
Helper.GroupList,
Helper.UserList/UserDetails,
User.AddUser/ApiUser
Примеры
<Role>
<Id>0</Id>
<Name>Role1</Name>
<Description>null</Description>
</Role>
381
RoleFilter
Фильтр поиска по ролям.
Элемент
Тип данных
Обязательный
Описание
UserId
integer
-
Идентификатор пользователя.
Privileges
string[]
-
Список кодов привилегий
Примеры
<RoleFilter
xmlns="http://schemas.datacontract.org/2004/07/Korus.Eds.Api">
<UserId>19524</UserId>
<Privileges
xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>company.admin</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</Privileges>
</RoleFilter>
382
RoleWithPrivilege
Роль пользователя с привилегиями.
Элемент
Тип данных
Описание
Id
long
Идентификатор роли.
Name
string
Наименование роли.
Description
string
Описание роли.
IsEditable
bool
Признак доступности роли для редактирования.
IsHavePrivilegeForGrant
bool
Признак доступности редактирования/назначения роли текущему пользователю.
Privileges
Privilege[]
Список привилегий, включённых в данную роль.
383
PriRasxAdditionalInfo
Упрощенная модель Дополнительных сведений документа.
Элемент
Тип
Обязательность
Описание
AcceptanceValuesInformation
AcceptanceValuesInformation
+
Сведения по итогам приемки ценностей
Signers
List<SignerInfo>
+
Сведения о лице, подписывающем документ в электронном
виде
Ticket.CreatePriRasxAdditionalInfoTicket v.2
Примеры
{
"AcceptanceValuesInformation":
{
"Date": "2020-02-04",
"AcceptanceValuesInformationContent": " ",
"Info":
{
"TextInfo": [
{
"Id": "150",
"Value": "11111"
}
]
}
},
"Signers": [
{
"Individual":
{
"Inn": "XXXXXXXXXXXX",
"RegistrationRequisites": "XXXXXXXXXX",
"OtherInfo": " ",
"Person":
{
"LastName": "XXXXXXXXXX",
"FirstName": "XXXXXXXXXX",
"MiddleName": "XXXXXXXXXX"
}
},
"PowersArea": "21",
"SignerStatus": "1",
"PowersBase": " ",
"OrganizationPowersBasement": " 32"
}
]
}
384
Privilege
Модель привилегии пользователя.
Элемент
Тип данных
Описание
Id
long
Идентификатор привилегии.
ParentId
long
Идентификатор родительской привилегии.
Name
string
Наименование привилегии.
ShortName
string
Краткое наименование привилегии.
GroupId
long
Идентификатор группы.
GroupName
string
Наименование группы.
IsAvailable
bool
Признак доступности привилегии для назначения.
RoleWithPrivilege
385
SearchResult
Информация о результатах поиска.
Элемент
Тип данных
Обязательный
Размер
Описание
Id
long
+
-
Идентификатор объекта
Description
string
+
-
Наименование результата поисковой задачи
Status
DocumentStatus
-
-
Статус документа
TypeCode
string
+
2-7
Коды типов документов: SF, CSF, ACCOUNT
StatusName
string
-
-
Наименование статуса
Created
date
-
-
Дата создания документа
Document.SearchByParams
SearchByParams
Примеры
<SearchResult>
<Id>XXXXX</Id>
<Description>- sd
13.11.2013</Description>
<Status>Prepared</Status>
<TypeCode>SF</TypeCode>
<StatusName></StatusName>
<Created>2013-11-13T15:31:18</Created>
</SearchResult>
{
"id":XXXXX,
"description":"- sd
13.11.2013",
"status": "Prepared",
"typecode": "SF",
"statusname: "",
"created: "2013-11-13T15:31:18"
}
386
SetUserGroupRequest
Формат запроса добавления пользователя в группу.
Элемент
Тип данных
Размер
Описание
Обязательность
GroupId
integer
-
Идентификатор группы
+
ClientId
integer
-
Идентификатор компании
-
User.AddGroup v.2
387
SetUserRoleRequest
Формат запроса добавления роли пользователю.
Элемент
Тип данных
Размер
Описание
Обязательность
RoleId
integer
-
Идентификатор роли
+
ClientId
integer
-
Идентификатор компании
-
User.AddRole v.2
388
ShipmentDocumentRequisites
Документ об отгрузке.
Элемент
Тип
Описание
Размер
Обязательность
shipmentDocumentTitle
string
Наименование документа об отгрузке
1-255
+
shipmentDocumentNumber
string
Номер документа об отгрузке
1-255
+
shipmentDocumentDate
datetime
Дата документа об отгрузке
-
Document.CreateInvoice/ Invoice
Примеры
"shipmentDocumentRequisites":
[
{
"shipmentDocumentTitle": "string",
"shipmentDocumentNumber": "string",
"shipmentDocumentDate": "2021-08-05T14:58:30.972Z"
}
]
389
Shipper
Информация о грузоотправителе.
Элемент
Тип данных
Размер
Описание
Shipper
ShipperConsignee
-
Грузоотправитель и его адрес
IsSame
bool
+
Признак того, что указано "он же". Только для Shipper
IsSame - Если true, то адрес совпадает с отправителем.
Document.CreateInvoice/ Invoice
Примеры
<Shipper>
<IsSame>true</IsSame>
</Shipper>
{ IsSame: "true"}
390
Signature
Электронная подпись.
Элемент
Тип элемента
Обязательный
Описание
Uuid
string
Универсальный идентификатор подписи.
Content
byte[]
+
Содержимое контейнера с подписью.
SignerCode
string
Идентификатор участника ЭДО сформировавшего подпись.
MchdUuid
string
- *
Идентификатор МЧД.
MchdAccessMode
string
- *
Сведения об информационной системе, осуществляющей хранение МЧД
MchdInn
string
- *
Инн доверителя
MchdFileName
string
- *
Название файла МЧД
MchdFile
byte[]
- *
Содержимое файла МЧД
MchdSignature
byte[]
- *
Содержимое файла подписи МЧД
Chain
List<SignatureMchdIdentify>
-
Цепочка МЧД
* - При передаче данных по МЧД нужно передать либо MchdUuid c MchdAccessMode и MchdInn, либо данные по файлам
(MchdFileName, MchdFile, MchdSignature)
** - MchdInn не обязательный параметр при передаче. В случае отсутствия будет использован ИНН компании текущего
пользователя.
Document.AcceptAvoidanceRequest v.2,
Document.Add/DocumentCard,
Document.AddBatch/DocumentBatch/DocumentCard,
Tickets.Ticket/TicketDetails,
Tickets.Tickets/TicketDetails
Примеры
<Signature>
<Content>MIIETTCCA/qgAwIBAgIKKEwQmQAAAAAAejAKBgYqhQMCAgMFADCBsDEfMB0GCSqG
OQ==</Content>
<Uuid>bcfe55d048e0470
50f83660d</Uuid>
<SignerCode>2BK234
</SignerCode>
<MchdUuid>20982e92-dd6e-44cc-ae8f-ba8377031ae4</MchdUuid>
<MchdInn>12345678901</MchdInn>
<Chain>
<SignatureMchdIdentify>
<MchdUuid>51e7cc0c-0fae-4744-ba52-7e4fd12496ba</MchdUuid>
<MchdInn>12345678901</MchdInn>
</SignatureMchdIdentify>
<SignatureMchdIdentify>
<MchdUuid>23d2750b-f780-43d3-bec0-6cab6ba5ca7a</MchdUuid>
<MchdInn>12345678901</MchdInn>
</SignatureMchdIdentify>
</Chain>
</Signature>
391
<Signature>
<Content>MIIETTCCA/qgAwIBAgIKKEwQmQAAAAAAejAKBgYqhQMCAgMFADCBsDEfMB0GCSqG
OQ==</Content>
<Uuid>bcfe55d048e0470
50f83660d</Uuid>
<SignerCode>2BK234
</SignerCode>
<MchdFileName>q1w2e3.xml</MchdFileName>
<MchdFile>AEWDESCAECAw==</MchdFile>
<MchdSignature>AASWEDFWECAw==</MchdSignature>
<Chain>
<SignatureMchdIdentify>
<MchdFileName>q1w2e3.xml</MchdFileName>
<MchdFile>AEWDESCAECAw==</MchdFile>
<MchdSignature>AASWEDFWECAw==</MchdSignature>
</SignatureMchdIdentify>
<SignatureMchdIdentify>
<MchdFileName>q1w2e3.xml</MchdFileName>
<MchdFile>AEWDESCAECAw==</MchdFile>
<MchdSignature>AASWEDFWECAw==</MchdSignature>
</SignatureMchdIdentify>
</Chain>
</Signature>
{
"Content":
"MIIETTCCA/qgAwIBAgIKKEwQmQAAAAAAejAKBgYqhQMCAgMFADCBsDEfMB0GCSqG
OQ==", "Uuid":
"bcfe55d048e04702a
850f83660d",
"SignerCode": "2BK234
",
"MchdUuid" : "32C690E7-E83C-4E9D-8DC5-5B551C9D377C",
"MchdAccessMode": "https://
"
"Chain": [
{
"MchdUuid": "51e7cc0c-0fae-4744-ba52-7e4fd12496ba",
"MchdAccessMode": "https://mchd-test.esphere.ru/"
},
{
"MchdUuid": "23d2750b-f780-43d3-bec0-6cab6ba5ca7a",
"MchdAccessMode": "https://mchd-test.esphere.ru/"
}
]
}
{
"Content":
"MIIETTCCA/qgAwIBAgIKKEwQmQAAAAAAejAKBgYqhQMCAgMFADCBsDEfMB0GCSqG
OQ==", "Uuid":
"bcfe55d048e04702a
850f83660d",
"SignerCode": "2BK234
",
"MchdFileName": "q1w2e3.xml",
"MchdFile": "AEWDESCAECAw==",
"MchdSignature": "AASWEDFWECAw"
"Chain": [
{
"MchdFileName": "ON_EMCHD_20240206_51e7cc0c-0fae-4744-ba52-
7e4fd12496ba.xml", "MchdFile":
"PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiID8+PNCU0L7Q",
"MchdSignature": "MIIJkwYJKoZIhvcNAQcCoIIJhDCCCYACAQExDjAMBggqhQMHAQECA"
},
{
"MchdFileName": "ON_EMCHD_20240109_23d2750b-f780-43d3-bec0-
6cab6ba5ca7a.xml", "MchdFile":
"PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiID8+DQo8", "MchdSignature":
"TUlJSmZnWUpLb1pJaHZjTkFRY0NvSUlKYnpDQ0NXc0N"
}
/Korus.Eds.Api">
<Content>MIIETTCCA/qgAwIBAgIKKEwQmQAAAAAAejAKBgYqhQMCAgMFADCBsDEfMB0GCSqG
OQ==</Content>
<Uuid>bcfe55d048e0470
5850f83660d</Uuid>
<SignerCode>2BK234
</SignerCode>
</Signature>
392
Так же элемент " Uuid " возможно передавать как параметр в адресе /api/v2.0/.../
/?
uuid=98E28E011A6624CB2CFC7571F3B59B9AE7D61456
393
SignatureDetails
Данные сертификата пользователя из подписи.
Элемент
Тип элемента
Обязательный
Описание
Title
string
+
Должность подписанта.
Person
Person
+
Информация о подписанте.
Organization
string
+
Организация подписанта.
Ogrn
string
+
ОГРН подписанта.
Inn
string
+
ИНН подписанта.
Begin
DateTime
+
Дата начала срока действия активного сертификата.
End
DateTime
+
Дата окончания срока действия активного сертификата.
Thumbprint
string
+
Отпечаток сертификата.
Image
byte[]
+
Содержимое сертификата.
Document.GetSignatureDetails
Примеры
<SignatureDetails>
<Title></Title>
<Person>
<LastName>XXXXXXXXXX</LastName>
<FirstName>XXXXXXXXXX</FirstName>
<MiddleName>XXXXXXXXXX</MiddleName>
</Person>
<Organization>XXXXXXXXXX</Organization>
<Ogrn>XXXXXXXXXXXXX</Ogrn>
<Inn>XXXXXXXXXX</Inn>
<Begin>2012-11-26T15:49:00+04:00</Begin>
<End>2013-11-26T15:58:00+04:00</End>
<Thumbprint>7731153BB8811FF4558
F3E4D507</Thumbprint>
<Image>MIIESjCCA/egAwIBAgIKRQbH4gADAAADSzAKBgYqhQMCAgMFADCBsDEfMB0GCSqG..hZEYRg==</Image>
<SignatureDetails>
{
"id": 123,
"subject": "T= , CN=
, OU=..., OID.1.2.643.3.141.1.1=2222222222, OID.1.2.643.3.141.1.2=1234",
"person": { "lastName": "XXXXXXXXXX", "firstName": "XXXXXXXXXX", "middleName": "XXXXXXXXXX"
}, "organization": "XXXXXXXXXX"
"ogrn": "XXXXXXXXXXXXX",
"inn": "XXXXXXXXXX"
"begin": "2012-11-26T15:49:00+04:00",
"end": "2013-11-26T15:58:00+04:00",
"thumbprint": "7731153BB8811FF455836A
BF3E4D507",
"image": "MIIESjCCA/egAwIBAgIKRQbH4gADAAADSzAKBgYqhQMCAgMFADCBsDEfMB0GCSqG..hZEYRg=="
}
394
SignatureWithTicket
Подпись с квитанцией.
Элемент
Тип элемента
Обязательный
Описание
Uuid
string
-
Универсальный идентификатор подписи, не требуется при добавлении
подписи.
Content
byte[]
+
Сформированная пользователем ЭЦП.
SignerCode
string
-
Идентификатор участника ЭДО сформировавшего подпись (добавляется
автоматически).
MchdUuid
string
- *
Идентификатор МЧД.
MchdInn
string
- * **
Инн доверителя
MchdAccessMo
string
- *
Сведения об информационной системе, осуществляющей хранение МЧД
de
MchdFileName
string
- *
Название файла МЧД
MchdFile
byte[]
- *
Содержимое файла МЧД
MchdSignature
byte[]
- *
Содержимое файла подписи МЧД
TicketType
TransportDocumentType
-
Тип дополнительной квитанции (не используется).
Ticket
SignedContent
-
Содержимое дополнительной квитанции (не используется).
Chain
List<SignatureMchdIdentify
-
Цепочка МЧД
>
* - При передаче данных по МЧД нужно передать либо MchdUuid c MchdAccessMode и MchdInn, либо данные по файлам
(MchdFileName, MchdFile, MchdSignature)
** - MchdInn не обязательный параметр при передаче. В случае отсутствия будет использован ИНН компании текущего
пользователя.
Document.Sign
Примеры
<?xml version="1.0"?>
<SignatureWithTicket>
<Uuid>b33dd4715c4649
3e7ed7523b953</Uuid>
<SignerCode>SIGNER</SignerCode>
<Content>AAECAw==</Content>
<MchdUuid>20982e92-dd6e-44cc-ae8f-ba8377031ae4</MchdUuid>
<MchdInn>12345678901</MchdInn>
<Chain>
<SignatureMchdIdentify>
<MchdUuid>51e7cc0c-0fae-4744-ba52-7e4fd12496ba</MchdUuid>
<MchdInn>12345678901</MchdInn>
</SignatureMchdIdentify>
<SignatureMchdIdentify>
<MchdUuid>23d2750b-f780-43d3-bec0-6cab6ba5ca7a</MchdUuid>
<MchdInn>12345678901</MchdInn>
</SignatureMchdIdentify>
</Chain>
</SignatureWithTicket>
395
<?xml version="1.0"?>
<SignatureWithTicket>
<Uuid>b33dd4715c4649
3e7ed7523b953</Uuid>
<SignerCode>SIGNER</SignerCode>
<Content>AAECAw==</Content>
<MchdFileName>q1w2e3.xml</MchdFileName>
<MchdFile>AEWDESCAECAw==</MchdFile>
<MchdSignature>AASWEDFWECAw==</MchdSignature>
<Chain>
<SignatureMchdIdentify>
<MchdFileName>q1w2e3.xml</MchdFileName>
<MchdFile>AEWDESCAECAw==</MchdFile>
<MchdSignature>AASWEDFWECAw==</MchdSignature>
</SignatureMchdIdentify>
<SignatureMchdIdentify>
<MchdFileName>q1w2e3.xml</MchdFileName>
<MchdFile>AEWDESCAECAw==</MchdFile>
<MchdSignature>AASWEDFWECAw==</MchdSignature>
</SignatureMchdIdentify>
</Chain>
</SignatureWithTicket>
{
"Uuid": "bcfe55d048e04702a
850f83660d",
"Content": "MIIETTCCA/qgAwIBAgIKKEwQmQAAAAAAejAKBgYqhQMCAgMFADCBsDEfMB0GCSqG
OQ==",
"SignerCode": "2BK234
",
"MchdUuid": "32C690E7-E83C-4E9D-8DC5-5B551C9D377C",
"MchdAccessMode": "https://
",
"MchdInn": "12345678901",
"Chain": [
{
"MchdUuid": "51e7cc0c-0fae-4744-ba52-7e4fd12496ba",
"MchdAccessMode": "https://mchd-test.esphere.ru/",
"MchdInn": "12345678901",
},
{
"MchdUuid": "23d2750b-f780-43d3-bec0-6cab6ba5ca7a",
"MchdAccessMode": "https://mchd-test.esphere.ru/",
"MchdInn": "12345678901",
}
]
}
{
"Uuid": "bcfe55d048e04702a
850f83660d",
"Content": "MIIETTCCA/qgAwIBAgIKKEwQmQAAAAAAejAKBgYqhQMCAgMFADCBsDEfMB0GCSqG
OQ==",
"SignerCode": "2BK234
",
"MchdFileName": "q1w2e3.xml",
"MchdFile": "AEWDESCAECAw==",
"MchdSignature": "AASWEDFWECAw",
"Chain": [
{
"MchdFileName": "ON_EMCHD_20240206_51e7cc0c-0fae-4744-ba52-
7e4fd12496ba.xml", "MchdFile":
"PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiID8+PNCU0L7Q",
"MchdSignature": "MIIJkwYJKoZIhvcNAQcCoIIJhDCCCYACAQExDjAMBggqhQMHAQECA"
},
{
"MchdFileName": "ON_EMCHD_20240109_23d2750b-f780-43d3-bec0-
6cab6ba5ca7a.xml", "MchdFile":
"PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiID8+DQo8", "MchdSignature":
"TUlJSmZnWUpLb1pJaHZjTkFRY0NvSUlKYnpDQ0NXc0N"
}
]
}
396
SignedContent
Информация о квитанции.
Элемент
Тип элемента
Размер
Обязательность
Описание
Filename
string
1-255
-
Имя документа
MimeType
string
1-255
-
Mime тип содержимого файла
Content
byte[]
-
-
Содержимое квитанции в кодировке base64
Signature
byte[]
-
+
Подписанное содержимое квитанции
MchdUuid
string
36
- *
Идентификатор МЧД.
MchdInn
string
-
- * **
Инн доверителя
MchdAccessMode
string
- *
Сведения об информационной системе, осуществляющей
хранение МЧД
MchdFileName
string
1-255
- *
Название файла МЧД
MchdFile
byte[]
-
- *
Содержимое файла МЧД
MchdSignature
byte[]
-
- *
Содержимое файла подписи МЧД
Chain
List<SignatureMchdIdentify
-
-
Цепочка МЧД
>
* - При передаче данных по МЧД нужно передать либо MchdUuid c MchdAccessMode, либо данные по файлам
(MchdFileName, MchdFile, MchdSignature)
** - MchdInn не обязательный параметр при передаче. В случае отсутствия будет использован ИНН компании текущего
пользователя.
Document.Accept,
Document.AvoidanceRequest v.2,
Document.RejectAvoidanceRequest v.2,
Document.RequestClarification,
Ticket.Add
Примеры
/2004/07/Korus.Eds.Api">
<Content>...</Content>
<Filename>...</Filename>
<MimeType>application/xml</MimeType>
<Signature>...</Signature>
<MchdUuid>20982e92-dd6e-44cc-ae8f-ba8377031ae4</MchdUuid>
<MchdInn>12345678901</MchdInn>
<Chain>
<SignatureMchdIdentify>
<MchdUuid>51e7cc0c-0fae-4744-ba52-7e4fd12496ba</MchdUuid>
<MchdInn>12345678901</MchdInn>
</SignatureMchdIdentify>
<SignatureMchdIdentify>
<MchdUuid>23d2750b-f780-43d3-bec0-6cab6ba5ca7a</MchdUuid>
<MchdInn>12345678901</MchdInn>
</SignatureMchdIdentify>
397
</Chain>
</SignedContent>
/2004/07/Korus.Eds.Api">
<Content>...</Content>
<Filename>...</Filename>
<MimeType>application/xml</MimeType>
<Signature>...</Signature>
<MchdFileName>q1w2e3.xml</MchdFileName>
<MchdFile>AEWDESCAECAw==</MchdFile>
<MchdSignature>AASWEDFWECAw==</MchdSignature>
<Chain>
<SignatureMchdIdentify>
<MchdFileName>q1w2e3.xml</MchdFileName>
<MchdFile>AEWDESCAECAw==</MchdFile>
<MchdSignature>AASWEDFWECAw==</MchdSignature>
</SignatureMchdIdentify>
<SignatureMchdIdentify>
<MchdFileName>q1w2e3.xml</MchdFileName>
<MchdFile>AEWDESCAECAw==</MchdFile>
<MchdSignature>AASWEDFWECAw==</MchdSignature>
</SignatureMchdIdentify>
</Chain>
</SignedContent>
{
"content": "MIIETTCCA/qgAwIBAgIKKEwQmQAAAAAAejAKBgYqhQMCAgMFADCBsDEfMB0GCSqG
OQ==",
"filename": "ON_SFAKT_1BK000012345678901_1BK000798546712397_20120601_693EAC6F-
-
C150BAD00E35.
xml",
"mimeType": "text/xml",
"signature":
"MIIETTCCA/qgAwBAgIKKEwAejAKBgYqhQMCMFADCBDEfMB0GCSqG
OQ==", "MchdUuid":
"32C690E7-E83C-4E9D-8DC5-5B551C9D377C",
"MchdInn": "12345678901",
"MchdAccessMode": "https://
",
"Chain": [
{
"MchdUuid": "51e7cc0c-0fae-4744-ba52-7e4fd12496ba",
"MchdAccessMode": "https://mchd-test.esphere.ru/",
"MchdInn": "12345678901"
},
{
"MchdUuid": "23d2750b-f780-43d3-bec0-6cab6ba5ca7a",
"MchdAccessMode": "https://mchd-test.esphere.ru/",
"MchdInn": "12345678901"
}
]
}
{
"content": "MIIETTCCA/qgAwIBAgIKKEwQmQAAAAAAejAKBgYqhQMCAgMFADCBsDEfMB0GCSqG
OQ==",
"filename": "ON_SFAKT_1BK000012345678901_1BK000798546712397_20120601_693EAC6F-
-C150BAD00E35.
xml",
"mimeType": "text/xml",
"signature": "MIIETTCCA/qgAwBAgIKKEwAejAKBgYqhQMCMFADCBDEfMB0GCSqG
OQ==",
"MchdFileName": "q1w2e3.xml",
"MchdFile": "AEWDESCAECAw==",
"MchdSignature": "AASWEDFWECAw",
"Chain": [
{
"MchdFileName": "ON_EMCHD_20240206_51e7cc0c-0fae-4744-ba52-7e4fd12496ba.xml",
"MchdFile": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiID8+PNCU0L7Q",
"MchdSignature": "MIIJkwYJKoZIhvcNAQcCoIIJhDCCCYACAQExDjAMBggqhQMHAQECA"
},
{
"MchdFileName": "ON_EMCHD_20240109_23d2750b-f780-43d3-bec0-6cab6ba5ca7a.xml",
398
"MchdFile": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiID8+DQo8",
"MchdSignature": "TUlJSmZnWUpLb1pJaHZjTkFRY0NvSUlKYnpDQ0NXc0N"
}
]
}
399

 

 

 

 

 

 

 

содержание      ..     2      3      4      5     ..