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

Mchd.ValidateMchd v.2

Возвращает результаты проверки МЧД (по бизнес-правилам ЭДО).

URL: v2.0/mchd/validateMchd

HTTP Method: POST

Body запроса:

Элемент

Тип

Описание

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

Комментарий

mchdUuid

uuid

UUID-доверенности

Заполняется если проверяемая доверенность в виде

метаданных

issuerInn

string (10)

ИНН доверителя

Заполняется если проверяемая доверенность в виде

/(12)

метаданных.

В случае отсутствия будет использован ИНН

компании текущего пользователя.

mchdBody

string

xml-файл МЧД

Заполняется если проверяемая доверенность в виде

(base64)

файла

mchdSigna

string

Подпись файла МЧД

Заполняется если проверяемая доверенность в виде

ture

(base64)

файла

verification

date

Дата на которую требуется проверить

Date

валидность МЧД

confidantS

string (14)

СНИЛС представителя

nils

В случае успешного выполнения, возвращает результаты проверки МЧД.

Примеры запроса

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

xmlns="http://schemas. datacontract.org/2004/07/Korus.Eds.Api.Internal.Model">

<ConfidantSnils>sample string 6</ConfidantSnils>

<IssuerInn>sample string 5</IssuerInn>

<MchdBody>sample string 2</MchdBody>

<MchdSignature>sample string 3</MchdSignature>

<MchdUuid>sample string 1</MchdUuid>

</MchdValidationRequest>

{

"mchdUuid": "sample string 1",

"mchdBody": "sample string 2",

"mchdSignature": "sample string 3",

"verificationDate": "2023-12-04T12:24:42.2951879+03:00",

"issuerInn": "sample string 5",

"confidantSnils": "sample string 6"

}

Body ответа:

Элемент

Тип

Описание

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

Комментарий

success

boole

Результат проверок

true - все проверки пройдены успешно

false - возникла ошибка при валидации МЧД, код ошибки указывается в

errorCode, текст ошибки указывается в errorText

errorText

string

Ошибка если Success

Текст ошибки при проверке МЧД

равен false

errorCode

Код ошибки если

Код ошибки

Success равен false

202

Mchd.ValidateMchdByTicket v.2

Возвращает результаты проверки МЧД по идентификатору транспортного документа и идентификатору подписи.

URL: v2.0/mchd/validateMchdByTicket

HTTP Method: POST

Body запроса:

Элемент

Тип

Описание

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

Комментарий

ticketId

long

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

signatureUuid

string

Универсальный идентификатор подписи

В случае успешного выполнения, возвращает результаты проверки МЧД.

Примеры запроса

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

xmlns="http://schemas. datacontract.org/2004/07/Korus.Eds.Api.Internal.Model">

<SignatureUuid>sample string 2</SignatureUuid>

</MchdValidationByTicketRequest>

{

"ticketId": 1,

"signatureUuid": "sample string 2"

}

Body ответа:

Элемент

Тип

Описание

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

Комментарий

success

boole

Результат проверок

true - все проверки пройдены успешно

false - возникла ошибка при валидации МЧД, код ошибки указывается в

errorCode, текст ошибки указывается в errorText

errorText

string

Ошибка если Success

Текст ошибки при проверке МЧД

равен false

errorCode

Код ошибки если

Код ошибки

Success равен false

HTTP-коды возврата:

200 - операция успешно завершена;

400 - Неверные входные данные запроса;

400 - Не найден транспортный документ;

400 - У пользователя нет прав на документ;

400 - Не найдена подпись;

400 - Подпись сформирована без использования МЧД;

400 - Не удалось собрать необходимые данные для проверки МЧД;

500 - при обработке запроса возникла непредвиденная ошибка.

204

Структуры данных

Структура

Описание

AcceptanceCertificat

Сведения о титуле, при подписании акта о выполнении работ

eAcceptInfo

AcceptanceCode

Код содержания операции

AcceptInfo

Сведения о титуле, при подписании универсальных документов

AdditionalComments

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

Address

Адрес выбирается в зависимости от местонахождения адресата. Должно быть выбрано одно значение Loc

alAddress или ForeignAddress

AddDocumentComm

Параметры метода добавления комментария к документу

entRequest

ApiDocumentFilter

Параметры фильтрации через API папки с документами

ApiUser

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

ArrayOflong

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

Attachment

Класс, реализующий файл-приложение

Barcode

Штрих - код

BuyerSeller

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

CashLiabilityInfo

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

Certificate

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

Classifier

Значение атрибута

ClassifierTemplate

Шаблон атрибута

ClassifierValue

Значение атрибута

Client

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

ClientDiscovery

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

ClientEdiCode

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

ClientQuery

Информация для поиска контрагента в системе СФЕРА Курьер

ClientRelation

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

ClientSearchInfo

Данные для поиска контрагента

ClientShortInfo

Краткая информация о клиенте

Company

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

Consignee

Грузополучатель

ContractorDocument

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

Types

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

CorrectionInvoice

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

CorrectionInvoiceRow

Строка сведений о товаре (работе, услуге) в корректировочном счете-фактуре

Credentials

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

DateRange

Интервал даты документа

DelayedDispatch

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

205

DetachedSignatureV

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

erificationRequest

Document

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

DocumentBatch

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

DocumentCard

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

DocumentEvent

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

DocumentHistory

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

DocumentPackage

Модель добавляемого пакета

DocumentPropertyD

Описание дополнительного свойства документа

escriptionInfo

DocumentRef

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

DocumentRefEx

Является дополнением структуры DocumentRef

DocumentRelation

Иерархия связей документа

DocumentRouteEdit

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

SimpleModel

DocumentRouteStage

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

DocumentSearchArg

Аргументы поиска

uments

DocumentSign

ЭП документа

DocumentSigner

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

DocumentSignerInfo

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

DocumentType

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

DocumentTypeClient

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

RelationApi

DzoDeal

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

DzoDealDraft

Информация для создания сделки ДЗО

DzoDealService

Список услуг сделки ДЗО

DzoDealUpdateData

Данные для обновления сделки ДЗО.

DzoDealUpdateRequ

Информация для создания сделки ДЗО

est

ExceptionDetails

Информация о серверном исключении

FileContent

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

FilterField

Свойства фильтра

Filters

Свойства фильтра.

FolderFilter

ForeignAddress

Адрес местонахождения за пределами Российской Федерации

Invoice

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

InfoField

Информация о файле

InfoSigner

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

InvoiceRow

Строка сведений о товаре (работе, услуге) в счете-фактуре

206

KeyValueObject

Объект для хранения пар значений

LocalAddress

Адрес местонахождения в Российской Федерации

LogicalMessages

Логическое сообщение в транспортной квитанции от ЦРПТ

LogonResponse

Авторизационный токен для входа в систему

MchdData

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

PaymentInfo

Информация о платежно-расчетном документе

Person

Персональные данные

PersonName

Значения персональных данных

ProductGroup

Группы товаров

RelationEvent

Информация о событии по взаимосвязи

RelationRequest

Данные запроса на создание взаимосвязи

RelationRequestDet

Список запросов на создание взаимосвязей

ails

Role

Описание ролей

SearchResult

Информация о результатах поиска

ShipmentDocument

Документ об отгрузке

Requisites

Shipper

Информация о грузоотправителе

Signature

Электронная подпись

SignatureDetails

Данные сертификата пользователя из подписи

SignatureWithTicket

Подпись с квитанцией

SignedContent

Информация о квитанции

Signer

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

SignerAuthority

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

Stage

Этап шаблона маршрута

StateInformationLab

Информация от ГИС МТ (Государственная информационная система мониторинга товаров "Честный знак")

elingSystem

по транспортной квитанции

StateOrderInfo

Информация покупателя об обстоятельствах закупок для государственных и муниципальных нужд (для

учета Федеральным казначейством денежных обязательств)

StringKeyValue

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

StringResult

Класс-обёртка для строкового значения

Subscription

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

Ticket

Информация о квитанции

TicketContent

Содержимое подписанной квитанции

TicketDetails

Информация и содержимое квитанции

TicketFilter

Фильтр поиска по квитанциям.

Torg12AcceptInfo

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

User

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

UserDetails

Расширенная информация о пользователе

207

UserLogin

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

VersionInfo

Информация о сборке

Warrant

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

WarrantIssuer

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

WarrantSubject

Информация о должностном лице получателе доверенности

CreditTransaction

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

ClientRelationDocum

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

entType

ClientRelationDocum

Базовые сведения о типе документа в разрезе взаимосвязи клиента

entTypeInfo

Relation

Взаимосвязи клиента

RelationAssertReque

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

UcdInvoiceInfo

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

UcdInvoiceRevisionI

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

nfo

SignatureMchdIdenti

Информация о МЧД.

208

AcceptanceCertificateAcceptInfo

Сведения о титуле, при подписании акта о выполнении работ.

Элемент

Тип данных

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

Размер

Описание

Date

DateTime

Дата подписи акта заказчиком.

Comment

string

0-2000

Комментарий заказчика.

Warrant

Сведения о доверенности подписывающего со стороны заказчика работ (услуг).

Acceptor

Signer

Должностное лицо, представляющее заказчика работ (услуг).

Action

Actions

Действие с документом.

Claim

string

0-2000

Претензии заказчика.

Ticket.CreateAcceptenceCertificateAcceptTicket

Примеры

209

AcceptanceCode

Код содержания операции.

Элемент

Тип

Описание

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

ResultCode

AcceptanceResultCode

Код, обозначающий итог приемки товара (работ, услуг, прав)

DocumentName

string

Наименование документа, оформляющего расхождения

DocumentTypeCode

AcceptanceDocument

Код вида документа о расхождениях

Type

BuyerDocumentNum

string

Номер документа покупателя о расхождениях

ber

DocumentDate

date

Дата документа о расхождениях

FileId

string

Идентификатор файла обмена документа о расхождениях, сформированного

покупателем

Document.AcceptTitle v.2/UniversalDocumentAcceptInfo

Примеры

"acceptanceCode": {

"resultCode": 1,

"documentName": "sample string 5",

"documentTypeCode": 2,

"buyerDocumentNumber": "sample string 6",

"documentDate": "2017-03-17T15:16:19.230875+03:00",

"fileId": "sample string 7"

210

AcceptanceValuesInformation

Сведения по итогам приемки ценностей.

Элемент

Тип

Размер

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

Описание

XPath

Date

DateTi

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

/Файл/Документ/СвИтПрием

по итогам приемки

/@ДатаСвИтПрием

AcceptanceValuesInformatio

string

1-1000

Содержание сведений по итогам

/Файл/Документ/СвИтПрием

nContent

приемки

/@СодСвИтПрием

Info

InfoFie

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

Ticket.CreatePriRasxAdditionalInfoTicket v.2/ PriRasxAdditionalInfo

Примеры

{

"AcceptanceValuesInformation":

{

"Date": "2020-02-04",

"AcceptanceValuesInformationContent": " ",

"Info":

{

"TextInfo": [

{

"Id": "150",

"Value": "11111"

}

]

}

211

AdditionalComments

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

Элемент

Тип

Описание

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

DocumentId

integer

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

UserId

integer

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

string (80)

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

FullName

string ()

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

Created

date

Дата добавления комментария.

Comment

string (1000)

Текст комментария.

Document.Comments v.2

Примеры

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

xmlns="http://schemas. datacontract.org/2004/07/Korus.Eds.Api">

<Comment>sample string 6</Comment>

<FullName>sample string 4</FullName>

<Login>sample string 3</Login>

</AdditionalComment>

<Comment>sample string 6</Comment>

<FullName>sample string 4</FullName>

<Login>sample string 3</Login>

</AdditionalComment>

</ArrayOfAdditionalComment>

[

{

"documentId": 1,

"userId": 2,

"login": "sample string 3",

"fullName": "sample string 4",

"created": "2014-09-08T15:04:50.3174033+04:00",

"comment": "sample string 6"

{

"documentId": 1,

"userId": 2,

"login": "sample string 3",

"fullName": "sample string 4",

"created": "2014-09-08T15:04:50.3174033+04:00",

"comment": "sample string 6"

}

]

212

Address

Адрес выбирается в зависимости от местонахождения адресата. Должно быть выбрано одно значение.

Элемент

Тип

Описание

данных

Local

LocalAdd

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

ress

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

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

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

GAR

GARAdre

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

реестре юридических лиц/почтовый адрес/адрес места жительства/регистрации по месту жительства

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

реестре индивидуальных предпринимателей (реквизиты адреса на территории Российской Федерации)

INF

INFAdress

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

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

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

(информация об адресе, в том числе об адресе за пределами территории Российской Федерации)

v2.0.client.{clientId}.address.legal,

Document.CreateCorrectionInvoice/BuyerSeller,

Document.CreateInvoice/ Invoice/Consignee,

Document.CreateInvoice/Invoice/BuyerSeller

Примеры

214

AddDocumentCommentRequest

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

Элемент

Тип данных

Размер

Описание

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

Comment

string

0-2000

Текст комментария

Visibility

DocumentCommentVisibility

Область видимости комментария.

Комментарий по умолчанию доступен только

пользователям организации автора комментария,

но при необходимости можно сделать его

доступным любому пользователю.

Document.AddComment v.2

Примеры

215

AdminDocumentCard

Карточка документа для администратора системы.

Элемент

Тип

Описание

Размер

Attachments

Attachment

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

BarcodeType

Тип баркода.

BarcodeValue

string (2000)

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

BuyerCode

string (46)

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

Comment

string (1000)

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

1-1000

Content

FileContent

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

ContractDate

date

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

ContractDescription

string (4 гб)

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

ContractNumber

string (50)

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

1-50

Created

date

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

Date

date

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

Description

string (255)

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

DocumentRelationType

DocumentRelationT

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

ype

DocumentTypeCode

string (32)

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

Filename

string (255)

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

1-255

FormatCode

string (128)

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

FormatVersion

string (128)

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

то используется 5.01.

FormType

DocumentFormType

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

integer

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

1-200

IsInTrash

boolean

Признак того, что документ находится в корзине.

IsPrintable

boolean

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

IsRoaming

boolean

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

IsReceiverDocflowCompl

boolean

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

eted

IsSenderDocflowComple

boolean

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

ted

NetSum

decimal number

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

N(17,2)

Number

string (1000)

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

1-1000

SenderPackageId

integer

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

SenderPackageName

string (255)

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

ReceiverPackageId

integer

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

ReceiverPackageName

string (255)

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

ReceiveDate

date

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

ReceiverId

integer

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

ReceiverName

string (64)

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

ReceiverInn

string

ИНН получателя.

ReceiverKpp

string

КПП получателя.

SenderRejectReason

string (4 гб)

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

216

ReceiverRejectReason

string (4 гб)

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

RequestSign

boolean

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

SenderRevokeReason

string (4 гб)

Причина отзыва на стороне отправителя.

ReceiverRevokeReason

string (4 гб)

Причина отзыва на стороне получателя.

SellerCode

string (46)

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

SendDate

date

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

SenderId

integer

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

SenderName

string (64)

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

SenderInn

string

ИНН отправителя.

SenderKpp

string

КПП отправителя.

SenderStatus

DocumentStatus

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

SenderStatusChanged

date

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

SenderStatusName

string (200)

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

1-200

ReceiverStatus

DocumentStatus

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

ReceiverStatusChanged

date

Дата смены статуса получателя.

ReceiverStatusName

string (200)

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

TotalSum

decimal number

Сумма с НДС.

N(17,2)

Type

TransportDocument

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

Type

TypeId

integer

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

TypeName

string (255)

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

1-255

VatSum

decimal number

Сумма НДС.

N(17,2)

SchemaVersionId

integer

Версия схемы документа.

SenderRequestAvoidance

string (4 гб)

Предложение об аннулировании на стороне отправителя.

ReceiverRequestAvoidan

string (4 гб)

Предложение об аннулировании на стороне получателя.

SenderRejectAvoidanceR

string (4 гб)

Причина отказа в аннулировании на стороне отправителя.

eason

ReceiverRequestAvoidan

string (4 гб)

Предложение об аннулировании на стороне получателя.

SenderBusinessProcessT

BusinessProcessTy

Тип бизнес процесса на стороне отправителя.

ype

SenderBusinessProcessId

integer

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

ReceiverBusinessProcess

BusinessProcessTy

Тип бизнес процесса на стороне получателя.

Type

ReceiverBusinessProcess

integer

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

IsSignRejectedByReceiv

boolean

Признак отказа получателем в запрошенной отправителем подписи.

IsSignRejectedBySender

boolean

Признак отказа отправителем в запрошенной получателем подписи.

Properties

StringKeyValue[]

Список дополнительных свойств (параметров) документа.

217

ApiDocumentFilter

Параметры фильтрации через API папки с документами.

Элемент

Тип

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

Размер

Описание

данных

Folder

Document

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

Folder

Participant

long

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

Document

string (32)

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

TypeCode

StatusId

int?

Идентификатор статуса. Соответствует значениям DocumentStatus, приведённым к int.

В дальнейшем тип будет изменён с int на DocumentStatus

From

DateTime

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

DateTime

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

CreatedFromDateTime

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

CreatedTo

DateTime

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

IsMine

bool?

IsMine=true: признак того, что документ назначен текущему пользователю, для

Folder=OnProcess. Иначе генерируется ошибка.

UserId

int[]

Идентификатор участника маршрута. Используется для Folder=Processed или Archive,

при попытке задания для других папок возвращается ошибка.

RoleId

int[]

Идентификатор группы участников маршрута.

FileName

string

Имя файла.

Attributes

List<KeyV

Атрибуты документа.

alueObject

Key - ID атрибута.

Value - Значение атрибута.

Take

int?

Максимальное количество отображаемых документов. Параметр необходимо

использовать в паре со Skip. Если необходимость пропуска документов отсутствует, то

указать значение Skip, равное 0.

Skip

int?

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

фильтрации. Обязательно при указании Take.

Document.List

Примеры

<Folder>Draft</Folder>

</UserId>

</ApiDocumentFilter>

218

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

Примеры

220

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

225

Элемент

Тип данных

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

Размер

Описание

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

226

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

}

227

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

Примеры

228

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>

229

Classifier

Значение атрибута.

Элемент

Тип данных

Размер

Описание

long

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

ClientId

long

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

Name

string

1-256

Наименование справочника.

Comment

string

1-512

Комментарий справочника.

IsNameEditable

string

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

Classifier.GetClassifiers

Примеры

</Classifier>

{

id: 868,

clientId: 582,

comment: ""

}

232

ClassifierTemplate

Шаблон атрибута.

Элемент

Тип данных

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

Размер

Описание

long

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

Name

string

1-128

Название справочника.

Comment

string

1-512

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

IsRequired

bool

Признак обязательности атрибута.

Participant

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

IsSelectOnly

bool

Признак соответствия справочнику.

Classifier.Template

Примеры

<IsRequired>false</IsRequired>

<Participant>Sender</Participant>

<IsSelectOnly>false</IsSelectOnly>

</ClassifierTemplate>

233

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"

}

235

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,

}

237

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>

239

ClientRelationDocumentType

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

Унаследован (содержит поля) от типа ClientRelationDocumentTypeInfo.

Элемент

Тип данных

Размер

Описание

Code

string

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

Name

string

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

IsSelected

bool

Признак включения типа документа во взаимосвязь.

IsDefaultSelected

bool

Признак включения типа документа во взаимосвязь по умолчанию.

IsEdiCodeDefault

bool

Признак использования идентификатора участника ЭДО по умолчанию.

Примеры

241

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>

244

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

Элемент

Тип данных

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

Размер

Описание

246

Inn

string

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

Status

string

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

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

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

1 - иное

FIO

ФИО

Lastname

string

1-60

Фамилия

Firstname

string

1-60

Имя

Patronymic

string

1-60

Отчество

Document.CreateInvoice/ Invoice

Примеры

<Name>

<OrganizationName>XXXXXXXXXX</OrganizationName>

</Name>

<Local>

</Local>

</Address>

</Consignee>

{ name: {organizationName: "XXXXXXXXXX"}, address: {local: {regionCode: "78"}}}

247

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>

248

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

Примеры

250

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

<Name>XXXXXXXXXX</Name>

</Organization>

</IdentificationInfo>

<Local>

</Local>

</Address>

</Seller>

<Buyer>

<Name>XXXXXXXXXX</Name>

</Organization>

</IdentificationInfo>

<Local>

</Local>

</Address>

</Buyer>

<Row>

</Row>

</CorrectionInvoice>

251

{

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

unitBefore: "018",

unitAfter: "018",

amountBefore: "5",

amountAfter: "5",

priceBefore: "10",

priceAfter: "11",

netSumBefore: "50",

netSumAfter: "55",

vatTypeBefore: "18",

vatTypeAfter: "18",

vatSumBefore: "9",

vatSumAfter: "9",

totalSumBefore: "59",

totalSumAfter: "64.90"

}

252

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

Примеры

253

</CorrectionInvoiceRow>

{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", totalSumBefore: "59", totalSumAfter: "64.90"}

254

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"

}

255

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>

257

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

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>

<Rows>

<Info>sample string 6</Info>

<Name>sample string 1</Name>

<UnitAfter>sample string 3</UnitAfter>

<UnitBefore>sample string 2</UnitBefore>

259

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

260

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

}

261

}

"Address": {

"Foreign": {

"CountryCode": "010",

"Address": ""

}

"Rows": [

{

"NAME": "",

"UNITBEFORE": "796",

"UNITAFTER": "796",

"AMOUNTBEFORE": 22,

"AMOUNTAFTER": 21,

"PRICEBEFORE": 100,

"PRICEAFTER": 100,

"NETSUMBEFORE": 2200,

"NETSUMAFTER": 2100,

"EXCISESUMBEFORE": 2,

"EXCISESUMAFTER": 1,

"VATTYPEBEFORE": "20%",

"VATTYPEAFTER": "20%",

"VATSUMBEFORE": 123123,

"VATSUMAFTER": 123,

"TOTALSUMBEFORE": 2200,

"TOTALSUMAFTER": 2100,

"INFO": "SOME IFNO",

"TRACEABLEPRODUCTS": [

{

"ADDITIONALINDICATOR": "1",

"TRACEABLEPRODUCTUNIT": "356",

"PRODUCTBATCHREGISTERNUMBER": "0747",

"TRACEABLEPRODUCTUNITAMOUNTBEFORE": "10",

"TRACEABLEPRODUCTUNITAMOUNTAFTER": "11"

}

]

}

"Info": {

"Id": "85CB0BD-02D6-4F18-AEC3-8186749A5F401",

"TextInfo": [

{

"Id": "_",

"Value": "98237011"

}

]

}

262

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>

263

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

264

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>

265

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

266

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

267

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

270

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

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

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

Примеры

273

DateRange

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

Элемент

Тип данных

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

Размер

Описание

From

DateTime?

Дата начала интервала

DateTime?

Дата окончания интервала

FromExclusive

bool

Исключать при совпадении даты начала из выборки

ToExclusive

bool

Исключать при совпадении даты окончания из выборки

Document.SearchByParams/DocumentSearchArguments

Примеры

<FromExclusive>false</FromExclusive>

<ToExclusive>false</ToExclusive>

</DateRange>

{

"From":"2013-01-31T20:00:00Z",

"To":"2013-02-28T20:00:00Z",

"FromExclusive":false,

"ToExclusive":false,

"Empty":true

}

274

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

Примеры

275

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

</Receivers>

<TypeCode>sample string 7</TypeCode>

</DelayedDispatch>

{

"from": "2016-01-26T09:11:47.8889687+03:00",

"to": "2016-01-26T09:11:47.8889687+03:00",

"isNeedSign": true,

"receivers": [

{

"id": 1,

"inn": "sample string 1",

"kpp": "sample string 2"

{

"id": 1,

"inn": "sample string 1",

"kpp": "sample string 2"

}

"number": "sample string 5",

"fileName": "sample string 6",

"typeCode": "sample string 7",

"mimeType": "sample string 8",

"content": "QEA="

}

276

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.

277

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

278

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>

279

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

280

"receiverId": 12,

"participantId": 13,

"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

}

281

DocumentBatch

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

Элемент

Тип

Описание

Размер

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

Documents

Docu

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

ment

Card[]

LinkToFirst

boole

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

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

CreatePack

boole

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

age

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

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

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

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

без подписи.

PackageNa

string

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

SendSync

boole

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

Document.AddBatch

Примеры

283

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

<Filename>ON_SFAKT_TST-0940437840-2285_TST-9656011041-1442_20161221_7AC5CA9A-

A175- 4931-AF7D-9D00E57564C7.xml</Filename>

PD94bWwgdmuJUU1QiIC8+PC/

+j/PSLP5fLw7uIiIMjs/z0iz+Xy8CIgzvL35fHy4u49Is/l8vDu4uj3IiAvPjwv3ss+PC/P7uTv6PHg7fI+PC

/E7urz7OXt8j48L9Tg6es+………

</Content>

</DocumentCard>

</Documents>

<LinkToFirst>false</LinkToFirst>

<PackageName>Package Name </PackageName>

</DocumentBatch>

284

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.

Примеры

286

</Contract>

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

287

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

}

289

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>

290

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

Примеры

292

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

</DocumentHistory>

</ArrayOfDocumentHistory>

[

{

"participant": 1,

"companyId": XXXX,

"companyName": "XXXXXXXXXX",

"personName": "XXXXXXXXXX",

"status": 1,

"statusName": "",

"userId": XXXX,

"userUid": "uid=c5e472c0807f4e60816583c69e69c4b40bdb16c73a9...,ou=people,ou=sber_ast,dc=sso-ds-

test, dc=esphere,dc=local",

"comment": null,

"date": "2020-07-15T09:03:41",

"userTitle": ""

}

]

293

DocumentPackage

Модель добавляемого пакета.

Элемент

Тип

Описание

Размер

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

Name

string

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

SendSync

boolean

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

Documents

Collection of integer

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

Document.Package v.2

Примеры

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

</Documents>

<Name>sample string 1</Name>

</DocumentPackage>

{

"name": "sample string 1",

"sendSync": true,

"documents": [

]

}

294

DocumentPropertyDescriptionInfo

Описание дополнительного свойства документа.

Элемент

Тип данных

Размер

Описание

name

string

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

code

string

Код параметра.

ismandatory

bool

Признак обязательности указания.

values

string[]

Список возможных значений.

Document.GetPropertyDescription

Примеры

<IsMandatory>false</IsMandatory>

</Values>

</DocumentPropertyDescriptionInfo>

{

code: "type_71",

isMandatory: false,

values: ["", "1", "2"]

}

295

DocumentRefEx

Является дополнением структуры DocumentRef

Элемент

Тип элемента

Размер

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

Описание

Number

string

1-256

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

Date

DateTime

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

DocumentTypeCode

string

1-32

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

ReceiverCode

string

4-46

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

Document.Exist,

Document.ExistSended

Примеры

</DocumentRefEx>

{ Number: "123", Date: "2012-12-12", DocumentTypeCode: "SF", ReceiverCode: "2BK-1234567890123-

1234567643- 12345678" }

297

DocumentRelation

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

Элемент

Тип данных

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

Размер

Описание

integer

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

ParentId

integer

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

Relation

RelationType

Тип взаимосвязи документов.

Description

string

0-255

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

Document.Add/Document,

Document.AddRelation,

Document.List/Document,

Document.Card/Document,

Document.Card v.2/Document,

Document.Details/Document

Примеры

<Relation>Other</Relation>

</DocumentRelation>

{

"id": 288958,

"parentId": 288956,

"relation": 0,

"description": ""

}

298

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>

299

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