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

ApiUser

Класс, описывающий нового пользователя, добавляемого через API.

Свойство

Тип

Обязательность

Размер

Описание

LastName

String (60)

Фамилия пользователя.

FirstName

String (60)

Имя пользователя.

MiddleName

String (60)

Отчество пользователя.

String (80)

Логин пользователя.

Password

String (255)

Пароль пользователя.

Title

String (128)

Должность подписанта.

String (255)

E-mail пользователя.

PasswordExpirationInterval

Int32?

-(по умолчанию null)

Срок действия пароля (null - срок неограничен).

IsActive

Boolean

-(по умолчанию false)

Признак активизации пользователя.

Certificate

byte[]

Сертификат пользователя.

Roles

Role[]

Список функциональных ролей пользователя.

Groups

Role[]

Список групп пользователя (для обмена документами).

User.AddUser

Примеры

<?xml version="1.0" encoding="utf-8"?>

<FirstName>XXXXX</FirstName>

<LastName>XXXXXX</LastName>

<MiddleName>XXXXXXXX</MiddleName>

<Login>XXXXXXXXXX</Login>

<Password>XXXXXX</Password>

<Email>XXX_XXX_X@XXXXXXX</Email>

<Certificate>MIIJX.../8z7f5iPRS+EvIHIgeI/dhw</Certificate>

<Roles>

<Role>

</Role>

<Role>

</Role>

<Role>

</Role>

</Roles>

<Role>

</Role>

<Role>

</Role>

<Role>

219

BuyerSeller

Продавец/Покупатель.

Элемент

Тип данных

Обязательный

Описание

IdentificationInfo

BuyerSellerRequisites

Идентификационные сведения

Address

Сведения об адресе

BuyerSellerRequisites

В BuyerSellerRequisites должно быть выбрано одно значение.

Элемент

Тип данных

Описание

Organization

Сведения об организации

Individual

Сведения об индивидуальном предпринимателе

Foreignorganization

Сведения об иностранной организации

Privateindividual

Сведения о физическом лице

Organization

Элемент

Тип данных

Обязательный

Размер

Описание

Name

string

1-1000

Наименование организации

Inn

string

ИНН организации

Kpp

string

КПП организации

Individual

Элемент

Тип данных

Обязательный

Размер

Описание

Name

PersonName

Наименование организации

Inn

string

ИНН организации

Foreignorganization

Элемент

Тип

Обязательный

Размер

Описание

данных

Status

string

Идентификация статуса.

Принимает значение:

ИО - иностранная организация

ИГ - иностранный гражданин

CountryCo

string

Код страны

CountryNa

string

1-255

Наименование страны.

Принимает значение в соответствии с

Общероссийским классификатором стран мира (ОКСМ)

Name

string

1-1000

Наименование иностранной организации полное/Фамилия, имя, отчество (при

наличии) иностранного гражданина

Privateindividual

224

Элемент

Тип данных

Обязательный

Размер

Описание

Inn

string

ИНН физического лица

Status

string

Идентификация статуса.

Принимает значение:

0 - лицо, являющееся покупателем при розничной продаже;

1 - иное

FIO

ФИО

Lastname

string

1-60

Фамилия

Firstname

string

1-60

Имя

Patronymic

string

1-60

Отчество

Document.CreateCorrectionInvoice/CorrectionInvoice,

Document.CreateInvoice/Invoice

Примеры

<Name>XXXXXXXXXXX"</Name>

<Inn>XXXXXXXXXX</Inn>

<Kpp>XXXXXXXXX</Kpp>

</Organization>

</IdentificationInfo>

<Local>

</Local>

</Address>

</BuyerSeller>

{ IdentificationInfo: {Organization: {Name: "XXXXXXXXXXX", Inn: "XXXXXXXXXX", Kpp: "XXXXXXXXX"}}, Address:

{Local: {RegionCode: "78", RegionName: "-"}}}

225

CardsInfo

Информация для получения детальных данных по документам.

Элемент

Тип

Описание

Обязательность

Ids

integer

Идентификаторы документов.

IncludeRelations

boolean

Признак необходимости вывода связанных документов.

IncludeAttachments

boolean

Признак необходимости вывода приложений к документам.

Document.Cards v.2

Примеры

XML

<CardsInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07

/Korus.Eds.Api">

<d2p1:long>1</d2p1:long>

<d2p1:long>2</d2p1:long>

</Ids>

</CardsInfo>

{

"ids": [

"includeRelations": true,

"includeAttachments": true

}

226

CashLiabilityInfo

Информация для сведений о денежном обязательстве.

Элемент

Тип

Описание

Обязательность

SellerInfoNum

integer

Номер строки таблицы информации продавца

ber

IssueCode

string

Код объекта капитального строительства федеральной адресной инвестиционной

программы/код мероприятия по информатизации

CashType

LiabilityCas

Вид средств денежного обязательства

hType

BuyerBudgetC

string

Код по бюджетной классификации (покупатель)

ode

BuyerPurposeC

string

Код цели (покупатель)

ode

AdvancePayme

decimal

Сумма перечисленного аванса

ntSum

number

Document.AcceptTitle v.2/UniversalDocumentAcceptInfo/StateOrderInfo

Примеры

227

Certificate

Информация о зарегистрированном сертификате пользователя.

Элемент

Тип данных

Обязательный

Размер

Описание

integer

1-200

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

Subject

string

1-200

Владелец сертификата

SerialNumber

string

1-200

Серийный номер сертификата

Thumbprint

string

1-200

Отпечаток сертификата

NotBefore

date

Действителен с

NotAfter

date

Действителен по

IsActive

boolean

Признак активного сертификата

Image

Collection of byte

Образ сертификата

Dictionary.UserCertificate,

User.AddCertificate,

User.Certificate v.2

Примеры

<ArrayOfCertificate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.

org/2004/07/Korus.Eds.Api">

<CspType>sample string 8</CspType>

<SerialNumber>sample string 3</SerialNumber>

<Subject>sample string 2</Subject>

<Thumbprint>sample string 4</Thumbprint>

</Certificate>

<CspType>sample string 8</CspType>

<SerialNumber>sample string 3</SerialNumber>

<Subject>sample string 2</Subject>

<Thumbprint>sample string 4</Thumbprint>

</Certificate>

</ArrayOfCertificate>

[

{

"id": 1,

"subject": "sample string 2",

"serialNumber": "sample string 3",

228

Client

Данные клиента.

Элемент

Тип данных

Описание

Обязательность

integer

Идентификатор организации

CompanyType

Тип контрагента(фл/юл)

Name

string (64)

Наименование клиента

FullName

string (500)

Полное наименование клиента

LastName

string (60)

Фамилия руководителя или ИП

FirstName

string (60)

Имя руководителя или ИП

MiddleName

string (60)

Отчество руководителя или ИП

Inn

string (12)

ИНН клиента

Kpp

string (9)

КПП клиента

RegistryNumber

string (13)

ОГРН клиента

RegistrationRequisites

string (100)

Реквизиты свидетельства о государственной регистрации ИП

v2.0.client.{id}

Примеры

<Client xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07

/Korus.Eds.Api">

<CompanyType>Individual</CompanyType>

<FirstName>sample string 5</FirstName>

<FullName>sample string 3</FullName>

<Inn>sample string 7</Inn>

<Kpp>sample string 8</Kpp>

<LastName>sample string 4</LastName>

<MiddleName>sample string 6</MiddleName>

<Name>sample string 2</Name>

<RegistrationRequisites>sample string 10</RegistrationRequisites>

<RegistryNumber>sample string 9</RegistryNumber>

</Client>

{

"id": 1,

"companyType": 0,

"name": "sample string 2",

"fullName": "sample string 3",

"lastName": "sample string 4",

"firstName": "sample string 5",

"middleName": "sample string 6",

"inn": "sample string 7",

"kpp": "sample string 8",

"registryNumber": "sample string 9",

"registrationRequisites": "sample string 10"

}

234

ClientEdiCode

Идентификатор участника ЭДО получателя.

Элемент

Тип

Описание

Обязательность

Комментарии

данных

OperatorNa

string

Наименование оператора ЭДО

(1000)

IsCurrent

boolean

Признак того, что это идентификатор у

локального оператора

IsActive

boolean

Признак того, что код активен

IsDefault

boolean

Признак того, что это код по умолчанию

OperatorId

integer

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

Code

string (46)

Код участника ЭДО

OperatorCo

string (3)

Код оператора ЭДО

IsOneCHub

boolean?

Работа через 1С

Null - нет информации; False - не работает;

True - работает

v2.0 client.ediCode

Примеры

<ClientEdiCode xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org

/2004/07/Korus.Eds.Api">

<Code>sample string 6</Code>

<OperatorCode>sample string 7</OperatorCode>

<OperatorName>sample string 1</OperatorName>

<IsOneCHub>false</IsOneCHub>

</ClientEdiCode>

{

"operatorName": "sample string 1",

"isCurrent": true,

"isActive": true,

"isDefault": true,

"operatorId": 5,

"code": "sample string 6",

"operatorCode": "sample string 7",

"isOneCHub": false,

}

236

ClientRelation

Клиент, зарегистрированный в Курьере, и информация по его взаимосвязям.

Элемент

Тип

Описание

Обязательность

RelationId

integer

Идентификатор взаимосвязи.

Status

RequestRelationStatus

Статус взаимосвязи.

integer

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

Name

string (64)

Краткое наименование абонента.

Code

string (46)

Идентификатор участника ЭДО.

Inn

string (12)

ИНН абонента.

Kpp

string (9)

КПП (только для организации).

v2.0.client.discover

Примеры

<ArrayOfClientRelation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.

datacontract.org/2004/07/Korus.Eds.Api">

<Code>sample string 3</Code>

<Inn>sample string 4</Inn>

<Kpp>sample string 5</Kpp>

<Name>sample string 2</Name>

<Status>NoExists</Status>

</ClientRelation>

<Code>sample string 3</Code>

<Inn>sample string 4</Inn>

<Kpp>sample string 5</Kpp>

<Name>sample string 2</Name>

<Status>NoExists</Status>

</ClientRelation>

</ArrayOfClientRelation>

[

{

"relationId": 1,

"status": 0,

"id": 1,

"name": "sample string 2",

"code": "sample string 3",

"inn": "sample string 4",

"kpp": "sample string 5"

{

"relationId": 1,

"status": 0,

"id": 1,

"name": "sample string 2",

"code": "sample string 3",

238

Company

Данные компании.

Элемент

Тип данных

Описание

Обязательность

OperatorCode

string (3)

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

Code

string (46)

Код участника ЭДО

integer

Идентификатор организации

CompanyType

Тип контрагента(фл/юл)

Name

string (64)

Наименование клиента

FullName

string (500)

Полное наименование клиента

LastName

string (60)

Фамилия руководителя или ИП

FirstName

string (60)

Имя руководителя или ИП

MiddleName

string (60)

Отчество руководителя или ИП

Inn

string (12)

ИНН клиента

Kpp

string (9)

КПП клиента

RegistryNumber

string (13)

ОГРН клиента

RegistrationRequisites

string (100)

Реквизиты свидетельства о государственной регистрации ИП

Dictionary.Client,

Dictionary.FindClient,

v2.0.client,

v2.0.client.{code},

v2.0.client.self

FindAbonentByRuleResponse

Примеры

<Company xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07

/Korus.Eds.Api">

<CompanyType>Individual</CompanyType>

<FirstName>sample string 7</FirstName>

<FullName>sample string 5</FullName>

<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>

{

"operatorCode": "sample string 1",

243

ShipperConsignee

Грузоотправитель/Грузополучатель.

Элемент

Тип данных

Размер

Описание

IdentificationInfo

BuyerSellerRequisites

Грузоотправитель/Грузополучатель и его адрес

Address

Признак того, что указано "он же"

В IdentificationInfo должно быть выбрано одно значение.

Элемент

Тип данных

Описание

Organization

Сведения об организации

Individual

Сведения об индивидуальном предпринимателе

Foreignorganization

Сведения об иностранной организации

Privateindividual

Сведения о физическом лице

Organization

Элемент

Тип данных

Обязательный

Размер

Описание

Name

string

1-1000

Наименование организации

Inn

string

ИНН организации

Kpp

string

КПП организации

Individual

Элемент

Тип данных

Обязательный

Размер

Описание

Name

PersonName

Наименование организации

Inn

string

ИНН организации

Foreignorganization

Элемент

Тип

Обязательный

Размер

Описание

данных

Status

string

Идентификация статуса.

Принимает значение:

ИО - иностранная организация

ИГ - иностранный гражданин

CountryCo

string

Код страны

CountryNa

string

1-255

Наименование страны.

Принимает значение в соответствии с

Общероссийским классификатором стран мира (ОКСМ)

Name

string

1-1000

Наименование иностранной организации полное/Фамилия, имя, отчество (при

наличии) иностранного гражданина

Privateindividual

Элемент

Тип данных

Обязательный

Размер

Описание

245

ContractorDocumentTypes

Информация о контрагенте, включающая данные по типам документов, которыми может обмениваться Клиент с данным

контрагентом в зависимости от направления (исходящее/входящее).

Свойство

Тип

Обязательность

Размер

Описание

RelationId

Int64

Идентификатор взаимосвязи (запроса).

ClientId

Int64

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

ShortName

String (64)

Краткое наименование контрагента.

Kpp

String (9)

КПП контрагента.

Inn

String (12)

ИНН контрагента.

SenderDocumentTypes

DocumentTypeClientRelationApi[]

Список исходящих типов документов.

ReceiverDocumentTypes

DocumentTypeClientRelationApi[]

Список входящих типов документов.

Dictionary.ContractorDocumentTypes

Примеры

<?xml version="1.0" encoding="utf-16"?>

<ShortName>XXXXXXXXXX</ShortName>

<Kpp>XXXXXXXX</Kpp>

<Inn>XXXXXXXXXX</Inn>

</DocumentTypeClientRelation>

</SenderDocumentTypes>

</DocumentTypeClientRelation>

</DocumentTypeClientRelation>

</ReceiverDocumentTypes>

</ContractorDocumentTypes>

247

CorrectionInvoice

Корректировочный счет-фактура.

Элемент

Тип

Обязательный

Размер

Описание

данных

FormatVersion

string

Допустимые значения 5.01 или 5.02, если не указано, то используется 5.01

string

1-200

Идентификатор файла, должен быть сформирован в соотвествии с

требованиями формата ФНС, если не указан формируется автоматически

Number

string

1-256

Порядковый номер корректировочного счета-фактуры

Date

DateTime

Дата составления корректировочного счета-фактуры

InvoiceNumber

string

1000

Порядковый номер счета-фактуры к которому составлен корректировочный

счета-фактура

InvoiceDate

DateTime

Дата составления счета-фактуры счета-фактуры к которому составлен

корректировочный счета-фактура. Может быть не заполнена

InvoiceRevisio

number

Номер с учетом исправления счета-фактуры

nNumber

InvoiceRevisio

DateTime

Дата с учетом исправления счета-фактуры

nDate

RevisionNumb

number

Номер исправления корректировочного счета-фактуры

RevisionDate

DateTime

Дата исправления корректировочного счета-фактуры

CurrencyCode

string

Валюта: Код в соответствии с ОКВ

Seller

BuyerSeller

Сведения о продавце

Buyer

BuyerSeller

Сведения о покупателе

Row

CorrectionInv

Сведения о товаре (работе, услуге)

oiceRow[]

Info

InfoField

Информационное поле документа

Document.CreateCorrectionInvoice

Примеры

<Id>ON_KORSFAKT_1BK000007714171484_2BK000012345678901_20130927_6006B707-8D68-4D43-A19B-D632E49DAA6E</Id>

<Name>XXXXXXXXXX</Name>

</Organization>

</IdentificationInfo>

<Local>

</Local>

249

</Address>

</Seller>

<Buyer>

<Name>XXXXXXXXXX</Name>

</Organization>

</IdentificationInfo>

<Local>

</Local>

</Address>

</Buyer>

<Row>

</Row>

</CorrectionInvoice>

{

id: "ON_KORSFAKT_1BK000007714171484_2BK000012345678901_20130927_6006B707-8D68-4D43-A19B-

D632E49DAA6E",

"number": "123",

"date": "2012-12-12",

currencyCode: "643",

invoiceNumber: "321",

invoiceDate: "2011-12-12",

seller: {

identificationInfo: {

organization: { name: "XXXXXXXXXX", inn: "1234567890", kpp: "123456789" }

address: { local: { regionCode: "XX" } }

buyer: {

identificationInfo: {

organization: { name: "XXXXXXXXXX", inn: "0987654321", kpp: "987654321" }

address: { local: { regionCode: "XX" } }

row: {

name: "",

unitBefore: "018",

unitAfter: "018",

amountBefore: "5",

amountAfter: "5",

priceBefore: "10",

priceAfter: "11",

netSumBefore: "50",

netSumAfter: "55",

vatTypeBefore: "18",

vatTypeAfter: "18",

vatSumBefore: "9",

vatSumAfter: "9",

250

CorrectionInvoiceRow

Сведения о товаре (работе, услуге).

Элемент

Тип данных

Обязательный

Размер

Описание

Name

string

1-1000

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

UnitBefore

string

Kод единицы измерения, до изменения

UnitAfter

string

Kод единицы измерения, после изменения

AmountBefore

decimal

N(18,3)

Количество (объем), до изменения

AmountAfter

decimal

N(18,3)

Количество (объем), после изменения

PriceBefore

decimal

N(17,2)

Цена (тариф) за единицу измерения, до изменения

PriceAfter

decimal

N(17,2)

Цена (тариф) за единицу измерения, после изменения

NetSumBefore

decimal

N(17,2)

Стоимость товаров без налога до изменения

NetSumAfter

decimal

N(17,2)

Стоимость товаров без налога после изменения

ExciseSumBefore

decimal

N(17,2)

В том числе сумма акциза, до изменения

ExciseSumAfter

decimal

N(17,2)

В том числе сумма акциза, после изменения

VatTypeBefore

string

1-7

Налоговая ставка, до изменения*

VatTypeAfter

string

1-7

Налоговая ставка, после изменения*

VatSumBefore

decimal

N(17,2)

В том числе сумма акциза, до изменения

VatSumAfter

decimal

N(17,2)

В том числе сумма акциза, после изменения

TotalSumBefore

decimal

N(17,2)

Стоимость товаров (работ, услуг), имущественных прав

с налогом до изменения

TotalSumAfter

decimal

N(17,2)

Стоимость товаров (работ, услуг), имущественных прав

с налогом после изменения

TextInfo

TextInfo[]

Информационное поле строки

TraceableProducts

TraceableProductInformati

Сведения о товаре, подлежащем прослеживаемости

onCorr[]

ProductIdentificationNumb

Номер средств идентификации товаров до изменения

ersBefore

er[]

(маркировка)

ProductIdentificationNumb

Номер средств идентификации товаров после изменения

ersAfter

er[]

(маркировка)

*Налоговая ставка указывается в виде:

10/110

18/118

без НДС

Document.CreateCorrectionInvoice/CorrectionInvoice

Примеры

252

CreateClarificationNoticeRequest

Тело запроса метода для создания уведомления об уточнении (УОУ).

Элемент

Тип данных

Размер

Описание

Обязательность

Comment

string

0-2000

Текст комментария (причина отклонения).

Mchd

MchdData

Сведения о доверенности.

Ticket.CreateClarificationNotice

Примеры

<Comment>LONG_COMMENT</Comment>

<Mchd>

</Mchd>

</CreateClarificationNoticeRequest>

{

"Comment": "LONG_COMMENT",

"Mchd":

{

"Uuid" : "1be4fb2c-77b7-4311-8e61-0a4c4d97db7b",

"StartDate" : "2023-11-15T00:00:00",

"InternalRegistrationNumber" : "123",

"InternalRegistrationDate" : "2023-11-15T00:00:00",

"MchdViewType" : "Meta",

"AccessMode" : "12345"

}

254

CreateUcdRequest

Запрос на создание УКД.КСЧФ, УКД.ДИС или УКД.КСЧФДИС из упрощенной модели.

Элемент

Тип

Описание

ReceiverCode

string

Идентификатор участника ЭДО получателя документа (опционально)

UcdCorrectionInvoice

Упрощённая модель корректировочного счёта-фактуры.

Document.CreateUcdDocument

Примеры

<Buyer>

<Address>Address</Address>

</Foreign>

<Local>

<Building>building</Building>

<District>District</District>

<House>House</House>

<Locality>Locality</Locality>

<Street>Street</Street>

</Local>

</Address>

<Name>

</Name>

</Individual>

</Organization>

</IdentificationInfo>

<Account>Account</Account>

<Bank>

<Account>Account</Account>

</Bank>

</Requisites>

</Buyer>

256

<Info>

</Info>

<InvoiceNumber>sample string 7</InvoiceNumber>

<InvoiceRevisionNumber>sample string 8</InvoiceRevisionNumber>

<InvoiceNumber>sample string 1</InvoiceNumber>

<InvoiceRevisionNumber>sample string 1<

/InvoiceRevisionNumber>

</UcdInvoiceRevisionInfo>

<InvoiceRevisionNumber>sample string 1<

/InvoiceRevisionNumber>

</UcdInvoiceRevisionInfo>

</InvoiceRevisions>

</UcdInvoiceInfo>

<InvoiceNumber>sample string 1</InvoiceNumber>

<InvoiceRevisionNumber>sample string 1<

/InvoiceRevisionNumber>

</UcdInvoiceRevisionInfo>

<InvoiceRevisionNumber>sample string 1<

/InvoiceRevisionNumber>

</UcdInvoiceRevisionInfo>

</InvoiceRevisions>

</UcdInvoiceInfo>

</Invoices>

<RevisionNumber>sample string 9</RevisionNumber>

<Rows>

<Info>sample string 6</Info>

<Name>sample string 1</Name>

<UnitAfter>sample string 3</UnitAfter>

<UnitBefore>sample string 2</UnitBefore>

257

<VatTypeAfter>sample string 5</VatTypeAfter>

<VatTypeBefore>sample string 4</VatTypeBefore>

1</CheckMarks>

2</CheckMarks>

</ProductIdentificationNumber>

1</CheckMarks>

2</CheckMarks>

</ProductIdentificationNumber>

</ProductIdentificationNumbersAfter>

1</CheckMarks>

2</CheckMarks>

</ProductIdentificationNumber>

1</CheckMarks>

2</CheckMarks>

</ProductIdentificationNumber>

</ProductIdentificationNumbersBefore>

<UcdTraceableProductInfo AdditionalIndicator="0000"

ProductBatchRegisterNumber="0000" TraceableProductUnit="0000" TraceableProductUnitAmountAfter="00"

TraceableProductUnitAmountBefore="00">

</UcdTraceableProductInfo>

<UcdTraceableProductInfo AdditionalIndicator="0000"

ProductBatchRegisterNumber="0000" TraceableProductUnit="0000" TraceableProductUnitAmountAfter="00"

TraceableProductUnitAmountBefore="00">

</UcdTraceableProductInfo>

</TraceableProducts>

</Rows>

<Rows>

<Info>sample string 6</Info>

<Name>sample string 1</Name>

<UnitAfter>sample string 3</UnitAfter>

<UnitBefore>sample string 2</UnitBefore>

258

<VatTypeAfter>sample string 5</VatTypeAfter>

<VatTypeBefore>sample string 4</VatTypeBefore>

1</CheckMarks>

2</CheckMarks>

</ProductIdentificationNumber>

1</CheckMarks>

2</CheckMarks>

</ProductIdentificationNumber>

</ProductIdentificationNumbersAfter>

1</CheckMarks>

2</CheckMarks>

</ProductIdentificationNumber>

1</CheckMarks>

2</CheckMarks>

</ProductIdentificationNumber>

</ProductIdentificationNumbersBefore>

<UcdTraceableProductInfo AdditionalIndicator="0000"

ProductBatchRegisterNumber="0000" TraceableProductUnit="0000" TraceableProductUnitAmountAfter="00"

TraceableProductUnitAmountBefore="00">

</UcdTraceableProductInfo>

<UcdTraceableProductInfo AdditionalIndicator="0000"

ProductBatchRegisterNumber="0000" TraceableProductUnit="0000" TraceableProductUnitAmountAfter="00"

TraceableProductUnitAmountBefore="00">

</UcdTraceableProductInfo>

</TraceableProducts>

</Rows>

<Address>Address</Address>

</Foreign>

<Local>

<Building>building</Building>

<District>District</District>

<House>House</House>

<Locality>Locality</Locality>

<Street>Street</Street>

</Local>

</Address>

<Name>

</Name>

</Individual>

259

</Organization>

</IdentificationInfo>

<Account>Account</Account>

<Bank>

<Account>Account</Account>

</Bank>

</Requisites>

</Seller>

</UcdCorrectionInvoice>

</CreateUcdRequest>

{

"receiverCode": "TST-7806434422-2927",

"UcdCorrectionInvoice": {

"formatVersion": "5.01",

"documentFunction": "UCD_DIC",

"Id": "ON_KORSCHFDOPPR_TST-7806434422-2927_TST-5260418864-83732_20200615_EEDB76FE-27C0-480C-9F95-

55B93A8B8829",

"FormatCode": "1115133",

"Function": "UCD_CSF",

"Number": "111",

"Date": "2023-02-10T12:46:06.747Z",

"InvoiceNumber": "11111",

"InvoiceDate": "2023-01-15T12:46:06.747Z",

"InvoiceRevisionNumber": "222",

"InvoiceRevisionDate": "2023-01-15T12:46:06.747Z",

"RevisionNumber": "13",

"RevisionDate": "2023-01-15T12:46:06.747Z",

"CurrencyCode": "643",

"Seller": {

"IdentificationInfo": {

"Organization": {

"Name": " -",

"Inn": "5260418864",

"Kpp": "529001001"

}

"Address": {

"Local": {

"Zip": "603000",

"RegionCode": "52",

"District": null,

"City": " ",

"Locality": null,

"Street": " ",

"House": " 3",

"Building": null,

"Flat": " 15"

}

"Buyer": {

"IdentificationInfo": {

"Individual": {

"Inn": "351700096973",

"Name": {

"LastName": "",

"FirstName": "",

"MiddleName": ""

}

260

CreateUpdCorrectionInvoiceRequest

Запрос на создание корректировочной счёт-фактуры из упрощенной модели.

Элемент

Тип

Описание

ReceiverCode

string

Идентификатор участника ЭДО получателя документа (опционально)

UpdCorrectionInvoice

Упрощённая модель корректировочного счёта-фактуры.

Примеры

<ReceiverCode>sample string 1</ReceiverCode>

<Buyer>

<Address>sample string 2</Address>

<CountryCode>sample string 1</CountryCode>

</Foreign>

<Local>

<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>

<Street>sample string 6</Street>

<Zip>sample string 1</Zip>

</Local>

</Address>

<Inn>sample string 1</Inn>

<d6p1:FirstName>sample string 2</d6p1:FirstName>

<d6p1:LastName>sample string 1</d6p1:LastName>

<d6p1:MiddleName>sample string 3</d6p1:MiddleName>

</Name>

</Individual>

<Inn>sample string 2</Inn>

<Kpp>sample string 3</Kpp>

<Name>sample string 1</Name>

</Organization>

</IdentificationInfo>

<Account>sample string 1</Account>

<Bank>

<Code>sample string 4</Code>

<Name>sample string 3</Name>

<Account>sample string 1</Account>

<City>sample string 2</City>

</Bank>

</Requisites>

</Buyer>

<CurrencyCode>sample string 9</CurrencyCode>

262

<OperationContent>sample string 3</OperationContent>

<OtherCostInformation>sample string 1</OtherCostInformation>

<DocumentName>sample string 1</DocumentName>

</OperationReason>

<DocumentName>sample string 1</DocumentName>

</OperationReason>

</Reasons>

<TransferDocument>sample string 2</TransferDocument>

</EventContent>

<Id>sample string 3</Id>

<Info>

<Id>sample string 1</Id>

<Id>sample string 1</Id>

<Value>sample string 2</Value>

</IdValuePair>

<Id>sample string 1</Id>

<Value>sample string 2</Value>

</IdValuePair>

</TextInfo>

<Text>sample string 2</Text>

</Info>

<InvoiceNumber>sample string 6</InvoiceNumber>

<InvoiceRevisionNumber>sample string 7</InvoiceRevisionNumber>

<Number>sample string 4</Number>

<RevisionNumber>sample string 8</RevisionNumber>

<Row>

<Info>sample string 6</Info>

<Name>sample string 1</Name>

<UnitAfter>sample string 3</UnitAfter>

<UnitBefore>sample string 2</UnitBefore>

<VatTypeAfter>sample string 5</VatTypeAfter>

<VatTypeBefore>sample string 4</VatTypeBefore>

263

1</CheckMarks>

2</CheckMarks>

</ProductIdentificationNumber>

1</CheckMarks>

2</CheckMarks>

</ProductIdentificationNumber>

</ProductIdentificationNumbersAfter>

1</CheckMarks>

2</CheckMarks>

</ProductIdentificationNumber>

1</CheckMarks>

2</CheckMarks>

</ProductIdentificationNumber>

</ProductIdentificationNumbersBefore>

<UcdTraceableProductInfo AdditionalIndicator="0000" ProductBatchRegisterNumber="0000"

TraceableProductUnit="0000" TraceableProductUnitAmountAfter="00" TraceableProductUnitAmountBefore="00">

</UcdTraceableProductInfo>

<UcdTraceableProductInfo AdditionalIndicator="0000" ProductBatchRegisterNumber="0000"

TraceableProductUnit="0000" TraceableProductUnitAmountAfter="00" TraceableProductUnitAmountBefore="00">

</UcdTraceableProductInfo>

</TraceableProducts>

</Row>

<Row>

<Info>sample string 6</Info>

<Name>sample string 1</Name>

<UnitAfter>sample string 3</UnitAfter>

<UnitBefore>sample string 2</UnitBefore>

<VatTypeAfter>sample string 5</VatTypeAfter>

<VatTypeBefore>sample string 4</VatTypeBefore>

1</CheckMarks>

2</CheckMarks>

264

</ProductIdentificationNumber>

1</CheckMarks>

2</CheckMarks>

</ProductIdentificationNumber>

</ProductIdentificationNumbersAfter>

1</CheckMarks>

2</CheckMarks>

</ProductIdentificationNumber>

1</CheckMarks>

2</CheckMarks>

</ProductIdentificationNumber>

</ProductIdentificationNumbersBefore>

<UcdTraceableProductInfo AdditionalIndicator="0000" ProductBatchRegisterNumber="0000"

TraceableProductUnit="0000" TraceableProductUnitAmountAfter="00" TraceableProductUnitAmountBefore="00">

</UcdTraceableProductInfo>

<UcdTraceableProductInfo AdditionalIndicator="0000" ProductBatchRegisterNumber="0000"

TraceableProductUnit="0000" TraceableProductUnitAmountAfter="00" TraceableProductUnitAmountBefore="00">

</UcdTraceableProductInfo>

</TraceableProducts>

</Row>

<Address>sample string 2</Address>

<CountryCode>sample string 1</CountryCode>

</Foreign>

<Local>

<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>

<Street>sample string 6</Street>

<Zip>sample string 1</Zip>

</Local>

</Address>

<Inn>sample string 1</Inn>

<d6p1:FirstName>sample string 2</d6p1:FirstName>

<d6p1:LastName>sample string 1</d6p1:LastName>

<d6p1:MiddleName>sample string 3</d6p1:MiddleName>

</Name>

</Individual>

<Inn>sample string 2</Inn>

<Kpp>sample string 3</Kpp>

<Name>sample string 1</Name>

</Organization>

</IdentificationInfo>

<Account>sample string 1</Account>

<Bank>

<Code>sample string 4</Code>

<Name>sample string 3</Name>

<Account>sample string 1</Account>

<City>sample string 2</City>

265

</Bank>

</Requisites>

</Seller>

</Decrease>

</Increase>

</Totals>

</UpdCorrectionInvoice>

</CreateUpdCorrectionInvoiceRequest>

{

"receiverCode": "TST-7743543761-555555555-0000000000000",

"updCorrectionInvoice": {

"number": "123",

"date": "2020-01-02",

"currencyCode": "XXX",

"invoiceNumber": "321",

"invoiceDate": "2020-01-01",

"seller": {

"identificationInfo": {

"organization": {

"name": "XXXXXXXXXX",

"inn": "XXXXXXXXXX",

"kpp": "XXXXXXXXX"

}

"address": {

"local": {

"regionCode": "XX"

}

"buyer": {

"identificationInfo": {

"organization": {

"name": "XXXXXXXXXX",

"inn": "XXXXXXXXXX",

"kpp": "XXXXXXXXX"

}

"address": {

"local": {

"regionCode": "XX"

}

"rows": [

{

"name": "",

"unitBefore": "018",

"unitAfter": "018",

"amountBefore": "5",

"amountAfter": "5",

"priceBefore": "10",

"priceAfter": "11",

"netSumBefore": "50",

"netSumAfter": "55",

"vatTypeBefore": "18%",

"vatTypeAfter": "18%",

"vatSumBefore": "9",

"vatSumAfter": "9",

266

Credentials

Данные пользователя.

Элемент

Тип

Обязательный

Размер

Описание

данных

Username

string

1-255

Имя учетной записи пользователя при авторизации по логину/паролю

Password

string

1-255

Пароль учетной записи пользователя при авторизации по логину/паролю

Code

string

1-255

Идентификатор участника ЭДО (обязательно указание для пользователей

зарегистрированных в более чем одной организации - филиальной структуре) при

авторизации по логину/паролю

ApiKey

string

Ключ для доступа к API (когда указан ключ, указание логина и пароля не требуется)

Logon

Примеры

<Username>XXXXXX</Username>

<Password>XXXXXX</Password>

</Credentials>

{ username: "XXXXXX", password: "XXXXXX" }

269

CreditTransaction

Кредитная сделка.

Элемент

Тип данных

Обязательный

Размер

Описание

Комментарий

Segment

string

Сегмент бизнеса.

Столбец 10.

ClientName

string

Наименование организации в CRM.

Столбец 16.

ClientId

string

Идентификатор организации в CRM.

Столбец 17

Inn

string

ИНН организации.

Столбец 18.

Kpp

string

КПП организации.

Столбец 19.

Number

string

Номер кредитной сделки.

Status

CreditTransactionStatus

Статус сделки.

Type

Date

DateTime

Дата кредитной сделки.

Amount

decimal?

Сумма кредитной сделки.

Metadata

string

Сериализованные сведения о прогрессе прохождения

кредитной сделки.

Примеры

272

DelayedDispatch

Рассылка документа.

Элемент

Тип данных

Описание

From

date

Дата начала действия рассылки

date

Дата окончания действия рассылки

IsNeedSign

boolean

Необходимость подписи со стороны отправителя

Receivers

ClientQuery

Список получателей

Number

string

Номер документа

FileName

string

Имя файла документа

TypeCode

string

Код типа документа

MimeType

string

Тип содержимого (тип MIME)

Content

byte[]

Содержимое документа

Ticket.CreateAcceptenceCertificateAcceptTicket

Примеры

DelayedDispath.Add v.2

Примеры

<DelayedDispatch xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org

/2004/07/Korus.Eds.Api">

<FileName>sample string 6</FileName>

<MimeType>sample string 8</MimeType>

<Number>sample string 5</Number>

<Inn>sample string 1</Inn>

<Kpp>sample string 2</Kpp>

</ClientQuery>

<Inn>sample string 1</Inn>

<Kpp>sample string 2</Kpp>

</ClientQuery>

274

DetachedSignatureVerificationRequest

Подписанный документ, обязательно заполнение только полей Content и Signature.

Тип

Описание

Обязательность

Элемент

Content

Collection of byte

Содержимое документа.

Signature

Collection of byte

Содержимое отсоединённой ЭП в формате PKCS#7.

VerificationDate

date

Дата на которую проверяется подпись, если не указана TimeZone, то считается как UTC.

VerifyDetachedSignature v.2

Примеры

<DetachedSignatureVerificationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="

http://schemas.datacontract.org/2004/07/Korus.Eds.WebApi.Models">

</DetachedSignatureVerificationRequest>

{

"content": "QEA=",

"signature": "QEA=",

"verificationDate": "2014-10-29T09:36:50.984875+03:00"

}

QEA=-это строка в кодировке B64.

276

Document

Карточка документа.

Элемент

Тип

Описание

Размер

Обязательность

integer

Идентификатор документа.

1-200

TypeId

integer

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

TypeName

string (255)

Наименование типа документа.

1-255

DocumentTypeC

string (32)

Код типа документа.

ode

Description

string (255)

Описание документа.

BarcodeType

Тип баркода.

BarcodeValue

string (2000)

Значение баркода.

SenderId

integer

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

ReceiverId

integer

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

ParticipantId

integer

Идентификатор контрагента (отправителя или получателя).

1-200

ParticipantName

string (64)

Наименование отправителя/получателя документа.

1-200

Status

DocumentStatus

Статус документа.

Date

date

Дата документа.

RequestSign

boolean

Признак необходимости запроса подписи у получателя.

Number

string (1000)

Номер документа.

1-1000

NetSum

decimal number

Сумма без НДС.

N(17,2)

VatSum

decimal number

Сумма НДС.

N(17,2)

TotalSum

decimal number

Сумма с НДС.

N(17,2)

Actions

Маска доступных действий с документом.

IsMarked

boolean

Признак того что документ добавлен в избранное.

Created

date

Дата создания документа.

SendDate

date

Дата отправки(выставления) документа.

ReceiveDate

date

Дата получения документа.

IsDocflowCompl

boolean

Признак завершенности документооборота.

eted

Comment

string (1000)

Комментарий к документу.

1-1000

ContractNumber

string (50)

Номер договора.

1-50

ContractDate

date

Дата договора.

Type

TransportDocum

Тип транспортного документа.

entType

FormType

DocumentFormT

Тип документа.

ype

SellerCode

string (46)

Идентификатор участника ЭДО отправителя.

возвращает null

BuyerCode

string (46)

Идентификатор участника ЭДО получателя.

возвращает null

FormatVersion

string (128)

Версия формата документа: допустимые значения 5.01 или 5.02, если не

указано, то используется 5.01.

FormatCode

string (128)

Код формата документа.

RevokeReason

string (4 гб)

Причина отзыва.

ContractDescript

string (4 гб)

Описание договора: дата + номер.

ion

277

IsRoaming

boolean

Признак, указывающий, что документ, передавался(должен передаться)

в роуминге.

Content

FileContent

Содержимое документа.

IsPrintable

boolean

Признак того что документ можно распечатать.

Relations

DocumentRelation

Связанные документы.

StatusName

string (200)

Наименование статуса документа (для текущего пользователя).

1-200

RejectReason

string (4 гб)

Причина отклонения.

Filename

string (255)

Имя файла документа.

1-255

SenderName

string (1000)

Наименование отправителя документа.

возвращает null

ReceiverName

string (1000)

Наименование получателя документа.

возвращает null

ExistRouteSigner

boolean

Признак, указывающий отсутствие в маршруте подписанта на стороне

получателя при need_rcpt_sign=1.

DocumentRelati

DocumentRelatio

Статус/тип связи документа (тестовый/промышленный/...).

onType

nType

Attachments

Attachment

Приложения к документу.

StatusChanged

date

Дата смены статуса.

PackageId

integer

Идентификатор пакета, в котором находится документ.

Document.Add,

Document.List,

Document.Card,

Document.Card v.2,

Document.Cards v.2,

Document.ChildCard v.2,

Document.Details

Примеры

<Document xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07

/Korus.Eds.Api">

<Filename>sample string 4</Filename>

<MimeType>sample string 5</MimeType>

<Uuid>sample string 2</Uuid>

</Attachment>

<Filename>sample string 4</Filename>

<MimeType>sample string 5</MimeType>

<Uuid>sample string 2</Uuid>

</Attachment>

</Attachments>

278

<BarcodeValue>sample string 10</BarcodeValue>

<Comment>sample string 24</Comment>

<Filename>sample string 1</Filename>

<MimeType>sample string 2</MimeType>

</Content>

<ContractNumber>sample string 25</ContractNumber>

<Description>sample string 5</Description>

<DocumentRelationType>Productive</DocumentRelationType>

<DocumentTypeCode>sample string 4</DocumentTypeCode>

<Filename>sample string 7</Filename>

<Number>sample string 19</Number>

<ParticipantName>sample string 14</ParticipantName>

<PaymentStatus>NotPaid</PaymentStatus>

<RejectReason>sample string 6</RejectReason>

<Description>sample string 2</Description>

<Relation>Other</Relation>

</DocumentRelation>

<Description>sample string 2</Description>

<Relation>Other</Relation>

</DocumentRelation>

</Relations>

<StatusName>sample string 15</StatusName>

<Type>ReceiveNotice</Type>

<TypeName>sample string 3</TypeName>

</Document>

{

"id": 1,

"typeId": 2,

"typeName": "sample string 3",

"documentTypeCode": "sample string 4",

"description": "sample string 5",

"rejectReason": "sample string 6",

"filename": "sample string 7",

"barcodeType": 0,

"barcodeValue": "sample string 10",

"senderId": 11,

"receiverId": 12,

"participantId": 13,

279

"participantName": "sample string 14",

"status": 0,

"statusName": "sample string 15",

"date": "2014-09-05T13:08:18.575+04:00",

"requestSign": true,

"existRouteSigner": true,

"number": "sample string 19",

"netSum": 1.0,

"vatSum": 1.0,

"totalSum": 1.0,

"documentRelationType": 0,

"actions": 0,

"isMarked": true,

"statusChanged": "2014-09-05T13:08:18.575+04:00",

"created": "2014-09-05T13:08:18.575+04:00",

"sendDate": "2014-09-05T13:08:18.575+04:00",

"receiveDate": "2014-09-05T13:08:18.575+04:00",

"isDocflowCompleted": true,

"comment": "sample string 24",

"contractNumber": "sample string 25",

"contractDate": "2014-09-05T13:08:18.575+04:00",

"content": {

"filename": "sample string 1",

"mimeType": "sample string 2",

"content": "QEA="

"isPrintable": true,

"relations": [

{

"id": 1,

"parentId": 1,

"relation": 0,

"description": "sample string 2"

{

"id": 1,

"parentId": 1,

"relation": 0,

"description": "sample string 2"

}

"attachments": [

{

"id": 1,

"uuid": "sample string 2",

"documentId": 3,

"filename": "sample string 4",

"mimeType": "sample string 5",

"content": "QEA="

{

"id": 1,

"uuid": "sample string 2",

"documentId": 3,

"filename": "sample string 4",

"mimeType": "sample string 5",

"content": "QEA="

}

"paymentStatus": 0,

"isRoaming": true,

"contractDateSpecified": true

}

280

DocumentBatch

Пачка документов.

Элемент

Тип

Описание

Размер

Обязательность

Documents

Docu

Список карточек документов.

ment

Card[]

LinkToFirst

boole

Если true, то между документами будет установлена иерархическая взаимосвязь, все

документы в пачке будут ссылаться на первый документ, как на родителя.

CreatePack

boole

Указывает будут ли документы добавлены в пакет. Если значение - true, то обязательно

age

должны быть заданы параметры PackageName и SendSync. Если значение - false или

данного поля нет в структуре (по умолчанию передается false), документы не будут

добавлены в пакет, а поля PackageName и SendSync будут проигнорированы. Так же

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

без подписи.

PackageNa

string

Наименование пакета.

SendSync

boole

Признак единовременной отправки.

Document.AddBatch

Примеры

<?xml version="1.0"encoding="utf-8"?>

</Contract>

<TypeCode>AGREEMENT</TypeCode>

<Value>barcodtest</Value>

</Barcode>

<Filename>attachment.xml</Filename>

<Content>QmFzZTY0IC0g0…………==</Content>

</Content>

<Value>Value 1</Value>

</StringKeyValue>

</Properties>

</DocumentCard>

1</Comment>

282

DocumentCard

Карточка документа.

Элемент

Тип

Обязательный

Размер

Описание

данных

Comment

string

0-1000

Дополнительная информация

Number

string

1-1000

Номер документа

Date

DateTime

Дата документа

RequestSign

bool

Признак необходимости запроса подписи у получателя

Contract

DocumentR

Данные о договоре

NetSum

decimal

N(17,2)

Сумма без НДС

VatSum

decimal

N(17,2)

Сумма НДС

TotalSum

decimal

N(17,2)

Сумма с НДС

TypeCode

string

Коды типов документов: SF, CSF, ACCOUNT, UPD_SF

Content

FileContent

Тело документа

Signature

Подпись под документом

Relation

RelationType

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

ParentDocum

long?

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

entId

Barcode

Баркод

Attributes

KeyValueOb

Список атрибутов документа. В свойство Key пишется идентификатор

ject[]

справочника, в свойство Value - значение атрибута.

Properties

StringKeyVa

0,100

Дополнительные свойства документа. Документ может содержать до 100

lue[]

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

Document.Add, Document.AddBatch/DocumentBatch

AddAndAccept

AddAndSend

Важно:

В методе AddAndSend не использовать структуру Signature.

Примеры

</Contract>

284

<Value>barcodtest</Value>

</Barcode>

<Filename>INVOICE.xml</Filename>

<Content>qgAwIBAgIKKEwQmQAAAAAAejAKBgYqhQMCAgMFADCBsDEfMB0GCSqG

OQ==</Content>

</Content>

<Content>qgAwIBAgIKKEwQmQAAAAAAejAKBgYqhQMCAgMFADCBsDEfMB0GCSqG

OQ==</Content>

</Signature>

</KeyValueObject>

</KeyValueObject>

</Attributes>

<Value>Value 1</Value>

</StringKeyValue>

</Properties>

</DocumentCard>

{

"Comment": " ",

"Number": "1",

"Date": "2013-04-22T10:17:22.5274138Z",

"NetSum": 1,

"VatSum": 1,

"TotalSum": 2,

"TypeCode": "AGREEMENT",

"Relation": 0,

"ParentDocumentId": null,

"Barcode": {

"Type": 1,

"Value": "barcodtest"

"Contract": {

"Number": "123",

"Date": "2013-03-04T20:00:00Z"

"Content": {

"Filename": "INVOICE.xml",

"MimeType": "text/xml",

"Content": [2, 3, 4]

"Signature": null,

"Properties": [

{ "Key": "key1", "Value": "value 1" },

{ "Key": "key2", "Value": "value 2" }

]

}

285

DocumentEvent

Информация о событии.

Элемент

Тип данных

Описание

long

Идентификатор события

DocumentId

long

Идентификатор документа

TicketId

long?

Идентификатор квитанции (для событий с квитанциями)

EventType

DocumentEventType

Тип события

Date

DateTime

Дата и время события

DocumentRelationType

Признак промышленного/тестового документа

ExtendedTicketType

ExtendedDocumentType

Расширенный тип квитанции

TicketType

TransportDocumentType

Тип квитанции

events-index,

GetDocumentEvents,

Subscription.Events.Totals v.2.0/DocumentEvents,

Subscription.Events v.2.0

Примеры

<EventType>Created</EventType>

<ExtendedTicketType>ReceiveNotificationOfClarificationNotice</ExtendedTicketType>

<TicketType>ClarificationNoticeRoaming</TicketType>

</DocumentEvent>

{ id: 1, documentId: 1017, ticketId: 231, eventType: 1, date: "2012-12-12", documentRelationType: 1,

extendedTicketType: 10, ticketType: 16

}

286

DocumentEvents

Список событий по подписке.

Элемент

Тип данных

Описание

Обязательность

Totals

integer

Количество событий по заданной подписке.

Events

DocumentEvent[]

Cобытия по заданной подписке.

Subscription.Events.Totals v.2.0

Примеры

<<DocumentEvents xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org

/2004/07/Korus.Eds.Api">

<DocumentRelationType>Productive</DocumentRelationType>

<EventType>Undefined</EventType>

<ExtendedTicketType>Undefined</ExtendedTicketType>

<TicketType>ReceiveNotice</TicketType>

</DocumentEvent>

<DocumentRelationType>Productive</DocumentRelationType>

<EventType>Undefined</EventType>

<ExtendedTicketType>Undefined</ExtendedTicketType>

<TicketType>ReceiveNotice</TicketType>

</DocumentEvent>

</Events>

</DocumentEvents>

{

"totals": 1,

"events": [

{

"id": 1,

"documentId": 2,

"ticketId": 1,

"ticketType": 1,

"extendedTicketType": 0,

"eventType": 0,

"date": "2017-04-21T10:58:38.7644453+03:00",

"documentRelationType": 0

{

"id": 1,

"documentId": 2,

"ticketId": 1,

"ticketType": 1,

"extendedTicketType": 0,

287

DocumentHistory

История действий с документом.

Элемент

Тип

Описание

Обязательность

данных

Participant

Сторона участника

CompanyId

integer

Id организации участника

CompanyNa

string

Организация участника

PersonName

string

Имя сотрудника

Status

DocumentSta

Наименование статуса (нового)

tus

StatusName

string

Наименование статуса (нового)

UserId

integer

Id пользователя

UserUid

string

Uid пользователя

Date

date

Дата выполнения действия

Comment

string

Комментарий к действию (причина отклонения, уточнения, отзыва, аннулирования или

отказа в аннулировании)

UserTitle

string

Должность пользователя

Document.History v.2

Примеры

<ArrayOfDocumentHistory xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.

datacontract.org/2004/07/Korus.Eds.Api">

<CompanyName>XXXXXXXXXX</CompanyName>

<Participant>Sender</Participant>

<PersonName>XXXXXXXXXX</PersonName>

<UserUid>uid=c5e472c0807f4e60816583...,ou=people,ou=sber_ast,dc=sso-ds-test,dc=esphere,

dc=local</UserUid>

</DocumentHistory>

<CompanyName>XXXXXXXXXX</CompanyName>

<Participant>Sender</Participant>

<PersonName>XXXXXXXXXX.</PersonName>

<Status>Prepared</Status>

<UserUid>uid=c5e472c0807f4e60816583c69e69c4b40bdb16c73...,ou=people,ou=sber_ast,dc=sso-ds-

test,dc=esphere,dc=local</UserUid>

289

DocumentRoamingInfo

Информация об отправке Транспортного документа/Подписи роуминговому получателю.

Элемент

Тип данных

Обязательный

Описание

long

id Транспортного документа

DocumentType

TransportDocumentType

Тип транспортного документа

StatusDate

DateTime

Дата присвоения Статуса отправки в роуминг в формате DD.MM.YYY HH:MM

RoamingStatus

Статус отправки ТД в роуминг

Document.RoamingInfo

Примеры

<ArrayOfDocumentRoamingInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.

datacontract.org/2004/07/Korus.Eds.Api">

<DocumentType>Document</DocumentType>

</DocumentRoamingInfo>

<DocumentType>ReceiveNotice</DocumentType>

<RoamingStatus>Delivered</RoamingStatus>

</DocumentRoamingInfo>

<DocumentType>ClarificationNotice</DocumentType>

<RoamingStatus>Delivered</RoamingStatus>

</DocumentRoamingInfo>

<DocumentType>AvoidanceRequest</DocumentType>

</DocumentRoamingInfo>

<DocumentType>ClarificationNotice</DocumentType>

<RoamingStatus>Delivered</RoamingStatus>

</DocumentRoamingInfo>

</ArrayOfDocumentRoamingInfo>

[

{

"id": 7368574,

"documentType": 11,

"roamingStatus": 0,

"statusDate": "2019-08-29T17:12:36"

{

"id": 7368575,

296

DocumentRouteEditSimpleModel

Упрощённая модель редактирования маршрута документа.

Элемент

Тип

Размер

Описание

DocumentId

long

Идентификатор документа.

Stages

Stage[]

Этапы маршрута.

participant

Participant

Сторона документооборота (направление маршрута).

Document.EditDocumentRoute

Примеры

<DocumentId>XXXXXXX</DocumentId>

<Participant>Sender</Participant>

<Stage>

</Stage>

<Stage>

</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

}

298

DocumentRouteStage

Этап маршрута согласования документа.

Свойство

Тип

Обязательность

Размер

Описание

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

Примеры

<Side>Sender</Side>

<IsUserEditable>false</IsUserEditable>

<IsEditable>false</IsEditable>

<ProcessedById>XXXXX</ProcessedById>

<ProcessedByLogin>XXXXXXXXXX</ProcessedByLogind>

<ProcessedByUsername>XXXXXXXXXX</ProcessedByUsername>

</DocumentRouteStage>

300

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

Примеры

<Date>

<FromExclusive>false</FromExclusive>

<ToExclusive>false</ToExclusive>

</Date>

</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

}

302

DocumentSign

ЭП документа.

Элемент

Тип данных

Описание

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

Примеры

<Image>MIIHCgYJKoZIhvcNAQcCoIIG+zCCB...QS==</Image>

<MchdUuid>MchdUuid</MchdUuid>

<MchdAccessMode>https://

</MchdAccessMode>

<MchdFileName>MchdFileName</MchdFileName>

<MchdFile>MIIHCgYJKoZIhvcNAQcCoIIG+zCCB...QS==</MchdFile>

<MchdSignature>MIIHCgYJKoZIhvcNAQcCoIIG+zCCB...QS==</MchdSignature>

</DocumentSign>

{

id: XXX,

certificateId: XXXX,

userId: XXX,

image: "MIIHCgYJKoZIhvcNAQcCoIIG+zCCB...QS==",

signed:"2012-10-02",

clientId: XXX,

303

DocumentSigner

Информация о подписанте документа.

Элемент

Тип данных

Описание

Обязательность

Комментарии

Inn

string

ИНН организации /

Обязателен, если SignerType=Organization

индивидуального

/Individual

предпринимателя.

Registratio

string

Реквизиты свидетельства

Обязателен, если SignerType=Individual,

nRequisites

о государственной

для остальных типов - не указывается

регистрации ИП (только

для ИП).

SignerType

Тип подписанта

Необязателен, начиная с версии сервиса

(компании).

122.0. Заполняется только

для документов типа УПД по формату

приказа № ММВ-7-15/820@

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

Примеры

<DocumentSigner xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org

/2004/07/Korus.Eds.Api">

305

<Inn>sample string 1</Inn>

<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>

<AccessMode>www.google.com</AccessMode>

<Uuid>xxe4f2df-bce7-xxxa-bb0e-xxfxxxxxbde3</Uuid>

</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",

"AccessMode": "https://mchd-test.esphere.ru/"

}

306

DocumentSignerInfo

Информация о подписанте.

Элемент

Тип

Описание

Обязательность

Комментарии

данных

Signer

InfoSigner

Подписант документа

В случае, если данный элемент отсутствует в запросе, при формировании

титула данные автоматически заполняются данными текущего

пользователя - SignerType, Inn, Name, RegistrationRequisites, Person, Title.

SignerAuth

Информация о полномочиях

Обязательно только для документа по формату приказа № ММВ-7-15/820@

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

Сведения о доверенности в

Используется для документа по формату приказа № ЕД-7-26/970@.

электронной форме в

машиночитаемом виде,

Заполняется если не указан MchdPaper

используемой для подтверждения

полномочий представителя

MchdPaper

Сведения о доверенности в форме

Используется для документа по формату приказа № ЕД-7-26/970@.

документа на бумажном носителе,

используемой для подтверждения

Заполняется если не указан MchdFile

полномочий представителя

Document.AcceptTitle v.2/UniversalDocumentAcceptInfo,

Document.CreateInvoice/ Invoice

Примеры

307

DocumentType

Тип документа.

Элемент

Тип данных

Обязательный

Размер

Описание

integer

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

DocumentTypeCode

string

Код типа документа.

Name

string

Наименование типа документа.

SenderSignatureRequired

bool

Необходимость подписи отправителя.

ReceiverSignatureRequired

bool

Необходимость подписи получателя.

TypeDocument v.2,

TypeDocument.Code v.2,

TypeDocument.Id v.2

Примеры

<DocumentType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004

/07/Korus.Eds.Api">

<DocumentTypeCode>sample string 2</DocumentTypeCode>

<Name>sample string 3</Name>

</DocumentType>

{

"id": 1,

"documentTypeCode": "sample string 2",

"name": "sample string 3",

"senderSignatureRequired": true,

"receiverSignatureRequired": true

}

309

DzoDeal

Данные сделки ДЗО.

Элемент

Тип данных

Описание

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

}

<DzoDeal xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07

/Korus.Eds.Api">

<DealType>Bundle</DealType>

<DealUid>sample string 2</DealUid>

<ExternalClientUid>sample string 3</ExternalClientUid>

</DzoDeal>

311

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

}

312

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>

<Comment>sample string 2</Comment>

</DzoDealUpdateData>

<Comment>sample string 2</Comment>

</DzoDealUpdateData>

</Data>

<DealUid>sample string 1</DealUid>

</DzoDealBatchUpdateRequest>

314

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">

<Data>sample string 3</Data>

<ServiceCode>sample string 2</ServiceCode>

<ServiceName>sample string 1</ServiceName>

</ExternalServiceData>

<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

}

]

317

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

Примеры

318

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"

}

]

}

322

FindAbonentByRuleResponse

Набор ключ-значение (ИДучЭДО - идентификатор правила).

Элемент

Тип данных

Обязательный

Размер

Описание

RuleId

integer

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

Company

Данные о компании

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

Примеры

<FindAbonentByRuleResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.

datacontract.org/2004/07/Korus.Eds.Api">

<CompanyType>Individual</CompanyType>

<FirstName>sample string 7</FirstName>

<FullName>sample string 5</FullName>

<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>

</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"

}

323

GARAdress

Адрес в соответствии с государственным адресным реестром, указанный в Едином государственном реестре юридических лиц

/почтовый адрес/адрес места жительства/регистрации по месту жительства (по месту пребывания) индивидуального

предпринимателя, указанный в Едином государственном реестре индивидуальных предпринимателей (реквизиты адреса на

территории Российской Федерации).

Элемент

Тип

Обязательный

Размер

Описание

данных

UniqueNumber

string

Уникальный номер адреса объекта адресации в государственном адресном реестре

в виде 36-разрядного GUED

Zip

string

Индекс

RegionCode

string

Код региона

RegionName

string

1-50

Наименование субъекта Российской Федерации

DictrictView

string

Муниципальный район/ городской округ/ внутригородская территория города

федерального значения/ муниципальный округ/ федеральная территория

DictrictName

string

1-255

SettlementView

string

1-50

Населенный пункт (город, деревня, село и прочее)

SettlementNa

string

1-255

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

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

Примеры

326

Group

Описание групп.

Свойство

Тип

Обязательность

Размер

Описание

Int32

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

Name

String

Наименование роли.

Description

String

Описание группы.

Active

bool

Признак активности.

IsDeleted

Boolean

Признак удаленной роли/группы.

IsSystem

Boolean

Признак системной роли/группы.

IsHavePrivilegeForGrant

bool

Признак наличия у текущего пользователя привилегии для назначения

группы.

UserCount

long

Количество пользователей в группе.

Примеры

<Group>

<Name>Group1</Name>

<IsDeleted>false</IsDeleted>

<IsSystem>false</IsSystem>

</Group>

327

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