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

"contractNumber": "sample string 18",

"contractDate": "2017-07-17T12:18:59.138875+03:00",

"type": 1,

"formType": 0,

"sellerCode": "sample string 19",

"buyerCode": "sample string 20",

"formatVersion": "sample string 21",

"filename": "sample string 22",

"revokeReason": "sample string 23",

"contractDescription": "sample string 24",

"isRoaming": true,

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

}

"statusName": "sample string 27",

"rejectReason": "sample string 28",

"senderName": "sample string 29",

"receiverName": "sample string 30",

"existRouteSigner": true,

"documentRelationType": 0,

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

}

"statusChanged": "2017-07-17T12:18:59.1545+03:00",

"packageId": 1

}

]

XML

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

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

110

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

<BarcodeValue>sample string 6</BarcodeValue>

<BuyerCode>sample string 20</BuyerCode>

<Comment>sample string 17</Comment>

<Filename>sample string 1</Filename>

<MimeType>sample string 2</MimeType>

</Content>

<ContractDescription>sample string 24</ContractDescription>

<ContractNumber>sample string 18</ContractNumber>

<Description>sample string 5</Description>

<DocumentRelationType>Productive</DocumentRelationType>

<DocumentTypeCode>sample string 4</DocumentTypeCode>

<Filename>sample string 22</Filename>

<FormType>Other</FormType>

<FormatVersion>sample string 21</FormatVersion>

<Number>sample string 13</Number>

<ParticipantName>sample string 10</ParticipantName>

<ReceiverName>sample string 30</ReceiverName>

<RejectReason>sample string 28</RejectReason>

<Description>sample string 2</Description>

<Relation>Other</Relation>

</DocumentRelation>

<Description>sample string 2</Description>

<Relation>Other</Relation>

</DocumentRelation>

</Relations>

<RevokeReason>sample string 23</RevokeReason>

<SellerCode>sample string 19</SellerCode>

<SenderName>sample string 29</SenderName>

111

<StatusName>sample string 27</StatusName>

<Type>ReceiveNotice</Type>

<TypeName>sample string 3</TypeName>

</Document>

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

<BarcodeValue>sample string 6</BarcodeValue>

<BuyerCode>sample string 20</BuyerCode>

<Comment>sample string 17</Comment>

<Filename>sample string 1</Filename>

<MimeType>sample string 2</MimeType>

</Content>

<ContractDescription>sample string 24</ContractDescription>

<ContractNumber>sample string 18</ContractNumber>

<Description>sample string 5</Description>

<DocumentRelationType>Productive</DocumentRelationType>

<DocumentTypeCode>sample string 4</DocumentTypeCode>

<Filename>sample string 22</Filename>

<FormType>Other</FormType>

<FormatVersion>sample string 21</FormatVersion>

<Number>sample string 13</Number>

<ParticipantName>sample string 10</ParticipantName>

<ReceiverName>sample string 30</ReceiverName>

<RejectReason>sample string 28</RejectReason>

<Description>sample string 2</Description>

<Relation>Other</Relation>

</DocumentRelation>

112

Document.ChildCard v.2

Получение карточки документа (без содержимого документа).

URL: v2.0/document/{parentId}/ref/{id}

HTTP Method: GET

Параметры запроса:

Элемент

Тип

Размер

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

Описание

parentId

integer

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

integer

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

В случае успешного выполнения запроса создается документ и возвращается в виде структуры Document.

Поле ParticipantName структуры данных Document не заполняется!

114

Document.Comments v.2

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

URL: v2.0/document/{id}/comments

HTTP Method: GET

Параметры запроса:

Элемент

Тип

Описание

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

integer

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

В случае успешного выполнения запроса, возвращается список комментариев к документу в виде структуры данных AdditionalCo

mments

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

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

400 - некорректный запрос;

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

Возвращаемые ошибки:

ER-

115

Document.Content

Получение вложенного в документ файла.

URL: /api/document/content/{id}

HTTP Method: GET

Параметры запроса:

Элемент

Тип

Описание

long

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

В случае успешного выполнения запроса, возвращается документ в виде структуры данных FileContent.

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

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

400 - нет прав на просмотр документа;

404 - документ не найден;

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

Дополнительные условия:

У пользователя должен быть доступ к документу

116

Document.Content v.2

Получение содержимого вложенного в документ файла.

URL: /v2.0/document/{id}/content

HTTP Method: GET

Параметры запроса:

Элемент

Тип

Описание

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

integer

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

В случае успешного выполнения запроса, возвращается содержимое файла документа в виде структуры данных FileContent.

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

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

400 - нет прав на просмотр документа;

404 - документ не найден;

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

Дополнительные условия:

У пользователя должен быть доступ к документу

117

Document.Details

Получение детальных данных по документу (с вложенным файлом документа).

URL: /api/document/details/{id}

HTTP Method: GET

Параметры запроса:

Элемент

Тип

Описание

long

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

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

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

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

400 - нет прав на просмотр документа;

404 - данный файл не найден;

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

Дополнительные условия:

У пользователя должен быть доступ к документу;

Приложения к документу выводятся без содержимого.

Возвращаемые ошибки:

ER-20101 - Невозможно произвести действия над документом. Необходимо подтвердить получение документа во вкладке

"Квитанции".

ER-20103 - У вас нет прав на просмотр данного документа.

ER-10301 - Документ '{0}' не найден.

118

Document.DocumentProtocol

Возвращает протокол передачи документа в электронном виде в формате pdf.

URL: /api/document/documentProtocol/{id}

HTTP Method: POST

Параметры запроса:

Элемент

Тип

Описание

long

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

В случае успешного выполнения запроса, возвращает протокол передачи документа в электронном виде в формате pdf в

структуре FileContent.

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

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

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

119

Document.DocumentRoute

Возвращает маршрут согласования документа.

URL: /api/document/documentRoute?docId={id}

HTTP Method: POST

Параметры запроса:

Элемент

Тип

Размер

Описание

docId

long

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

В случае успешного выполнения запроса возвращает список структур DocumentRouteStage.

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

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

400 - при обработке запроса возникла ожидаемая ошибка;

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

120

Document.ExternalServices v.2

Возвращает информацию, добавленную внешними сервисами.

URL: /v2.0/document/{id}/externalServices

HTTP Method: GET

Параметры запроса:

Элемент

Тип

Описание

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

long

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

serviceCode

string

Код сервиса

В случае успешного выполнения запроса, возвращается информация, добавленная внешними сервисами в виде массива

структур ExternalServiceData.

Коды сервисов:

Код

Описание

Честный знак

PAYMENT_ORDER

Платежные поручения

DovSer

Сервис проверки доверенностей

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

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

400 - ошибка входных параметров;

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

121

Document.GetIncompletePrintTaskInfoList v.2

Получение информации о задачах в очереди на асинхронную печать (статусы: "создан", "в очереди")

URL: v2.0/document/getIncompletePrintTaskInfoList

HTTP Method: GET

Параметры запроса: нет

Производит поиск в таблице выполнения HeavyTask незавершенных задач: если незавершенные задачи есть, возвращает иденти

фикаторы незавершенных задач по печати документов в виде структуры данных TaskInfoModel.

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

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

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

122

Document.GetNextUserDocument

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

URL: /api/document/getNextUserDocument/{id}

HTTP Method: GET

Параметры запроса:

Элемент

Тип

Описание

long

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

В случае успешного выполнения запроса, возвращается массив структур UserLogin.

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

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

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

123

Document.GetPdfByTaskId v.2

Возвращает pdf документ по идентификатору задачи печати документа.

URL: v2.0/document/pdfByTaskId/{taskId}

HTTP Method: GET

HTTP- Content-Type application/json

Параметры запроса:

Элемент

Тип

Описание

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

taskId

long

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

Возвращает pdf документ после подготовки печатной формы с помощью метода Document.Print v.2, возвращаемый тип FileContent

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

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

400 - нет прав на просмотр данного документа;

Возвращается в случае, если не совпадают компании у пользователя создавшего задачу и пользователя

запрашивающего результат.

400 - печатная форма не найдена;

Возвращается в случае, если задача еще не выполнена.

400- ER-20006: Ошибка входных параметров.

Возвращается в случае, если запрошен неизвестный taskId.

500 - печатная форма удалена, так как прошло более суток с момента ее подготовки;

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

124

Document.GetProperty v.2

Получение списка дополнительных свойств документа.

URL: v2.0/document/{id}/property

HTTP Method: GET

Параметры запроса:

Элемент

Тип

Описание

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

integer

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

В случае успешного выполнения запроса получаем список дополнительных свойств документа в структуре StringKeyValue.

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

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

400 - некорректный запрос;

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

125

Document.GetPropertyDescription

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

URL: /api/document/getpropertydescription

HTTP Method: POST

Параметры запроса:

Элемент

Тип

Размер

Описание

code

string

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

В случае успешного выполнения запроса возвращается список структур DocumentPropertyDescriptionInfo.

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

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

400 - возникла предвиденная ошибка;

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

126

Document.GetPropertyValue v.2

Возвращает значение дополнительного свойства документа по заданному ключу.

URL: v2.0/document/{id}/property/{key}

HTTP Method: GET

Параметры запроса:

Элемент

Тип

Описание

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

integer

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

key

string

Ключ свойства

В случае успешного выполнения запроса возвращает значение дополнительного свойства документа по заданному ключу.

Примеры

XML

<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>

JSON

"sample string 1"

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

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

400 - некорректный запрос;

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

127

Document.GetSignatureDetails

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

URL: /api/document/getSignatureDetails/{id}

HTTP Method: GET

Параметры запроса:

Элемент

Тип

Описание

long

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

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

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

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

400 - указан не корректный параметр;

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

128

Document.GetSignatures

Возвращает список ЭП документа.

URL: /api/document/getsignatures/{id}

HTTP Method: GET

Параметры запроса:

Элемент

Тип

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

Описание

long

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

isMchdAsFi

bool

Получение МЧД в виде файла. При включении параметра метод возвращает МЧД в виде файлов если

изначально МЧД была передана в виде метаданных

isMchdAsM

bool

Получение МЧД в виде метаданных. При включении параметра метод возвращает МЧД в виде

eta

метаданных если изначально МЧД была передана в виде файла (пакета)

В случае успешного выполнения, возвращает список ЭП документа в виде структуры данных DocumentSign.

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

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

400 - указан некорректный параметр;

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

Дополнительные условия:

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

129

Document.PackageDetails v.2

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

URL: /v2.0/package/{id}

HTTP Method: GET

Параметры запроса:

Элемент

Тип

Описание

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

integer

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

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

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

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

400 - нет прав на просмотр документа;

404 - данный файл не найден;

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

131

Document.Print v.2

Осуществляет подготовку печатной формы документа.

URL: v2.0/document/{documentId}/print

HTTP Method: GET

Параметры запроса:

Элемент

Тип

Описание

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

documentId

long

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

isPdfWithStamp

bool

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

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

Выходные параметры в случае успешного выполнения запроса:

Элемент

Тип

Описание

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

taskId

integer

Идентификатор задачи на подготовку ПФ в HeavyTask

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

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

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

400 - Превышено количество неоконченных задач на подготовку ПФ. Попробуйте повторить запрос позже;

500 - Ошибка публикации ресурсоемкой задачи;

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

Метод является асинхронным. Для проверки готовности и получения печатной формы документа необходимо использовать

метод Document.GetPdfByTaskId v.2, в качестве входного параметра передав ему taskId.

На текущий момент возможен просмотр печатной формы и ее выгрузка по API для файлов, размер которых =< 3Мб.

132

Document.RejectedComment

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

URL: /api/document/rejectedComment/{id}

HTTP Method: POST

Параметры запроса:

Элемент

Тип

Размер

Описание

long

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

В случае успешного выполнения возвращает текст комментария в объекте StringResult или null, если документ не отклонялся.

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

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

400 - при обработке запроса возникла ожидаемая ошибка;

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

Дополнительные условия:

Документ должен иметь статус "Отклонен", иначе метод возвратит null;

Метод возвращает комментарий (причину отклонения), указанный в уведомлении об уточнении (для типов документов:

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

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

133

Document.RoamingInfo

Получение информации о статусе отправки документа и связанных с ним квитанций/подписей роуминговому получателю.

URL: /v2.0/document/{id}/RoamingInfo

HTTP Method: GET

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

Тип

Описание

long

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

В случае успешного выполнения возвращает массив элементов со структурой данных DocumentRoamingInfo.

Коды ответов HTTP:

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

400 - при некорректном обращении к сервису;

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

Дополнительные условия:

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

Документ должен быть передан в роуминге

Документ не находится в статусе "Черновик", "На подписании", "Отозван", "Ожидается отправка"

134

Document.TransportTicket

Получение информации и содержимое транспортной квитанции от ЦРПТ.

URL: /integration/marking/document/{documentId}/transportTicket

HTTP Method: GET

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

Тип

Описание

long

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

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

https://courier-demo-api.esphere.ru/integration/marking/document/1469081/transportTicket/

В случае успешного выполнения запроса возвращает информацию и содержимое транспортной квитанции:

Элемент

Тип

Описание

transportPackageSendDate

datetime

дата отправки пакета в ЦРПТ

transportPackageReceiveDate

datetime

дата принятия транспортного пакета (из квитанции от ЦРПТ)

transportPackageId

string (1-100)

Идентификатор транспортного пакета (ИдТП)

operatorRecipient

string (3)

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

(ОператорПолучатель)

stateInformationLabelingSyst

информация от ГИС МТ

Коды ответов HTTP:

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

400 - нет доступа:

ER-20103 - В данный момент вы не можете совершать действие над документом. Возможно, документ уже взять

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

ER-10000 - Транспортный документ с идентификатором '{0}' не найден (в случае если документ еще не ушел в

ЦРПТ)

ER-10001 - Логическое сообщение, содержащее документ с идентификатором '{0}', не найдено (если ЦРПТ еще

не ответил транспортной квитанцией на отправленный им документ)

404 - документ не найден:

ER-10002 - Транспортная квитанция с идентификатором '{0}' не найдена (если ЦРПТ еще не ответил

транспортной квитанцией на отправленный им документ)

Дополнительные условия:

пользователь, отправивший запрос, должен принадлежать к организации, участвующей в документообороте данного

документа

Примеры

{

"transportPackageSendDate": "2020-08-21T10:31:23.78023",

"transportPackageReceiveDate": "2020-08-21T07:31:55.603Z",

"transportPackageId": "2BK_MDT_20200821_95419bb293a0498f93873709a7aee80d",

135

"operatorRecipient": "GMT",

"stateInformationLabelingSystem": {

"transportPackageHashAmount": "gost3411-2012-256:

f465798a011edfba991f414cfc8aac99e257db16247e41d74096dd35e8d86c72",

"transportPackageIdInternal": "UCMS00000000000000000018-8372",

"logicalMessages": [

{

"technologicalTicketId": "UINT04TXMNGR00000000000000004335-1096",

"logicalMessageIdExternal": "1b9e4d1c96274b24b73a492b3563db80",

"logicalMessageIdInternal": "UUD00000000000000000012-0710",

"fileId": "ON_NSCHFDOPPRMARK_2BK-2465310432-62289_2BK-7713026678-62288_20200727_C1043DD0-7F54-41D5-

B738-350098DA22D4",

"documentId": "fa9db0efd9f743b48e1d66386c5338f1"

{

"technologicalTicketId": "UINT04TXMNGR00000000000000004335-1097",

"logicalMessageIdExternal": "3501e5fc8b734dfd96abdfa9fd3857d9",

"logicalMessageIdInternal": "UUD00000000000000000012-0712",

"fileId": "ON_NSCHFDOPPRMARK_2BK-2465310432-62289_2BK-7713026678-62288_20200727_ABA64592-0D69-4DEF-

A1E8-0628AEE7C7A1",

"documentId": "9da0a0d5a86f4a85aeb8ea2b1a3a9de8"

{

"technologicalTicketId": "UINT04TXMNGR00000000000000004334-8049",

"logicalMessageIdExternal": "cfcddc3f9b5e425884c32515aabd0386",

"logicalMessageIdInternal": "UUD00000000000000000012-0714",

"fileId": "ON_KORSCHFDOPPR_2BK-2465310432-62289_2BK-7713026678-62288_20200729_1E13A8E1-1B6F-48B4-

A485-4DD3CCDEE923",

"documentId": "37b8762696a945c0adf85c4a4930b8bc"

{

"technologicalTicketId": "UINT04TXMNGR00000000000000004333-7892",

"logicalMessageIdExternal": "714e529c373c4306b6e92cfcfceb9f8b",

"logicalMessageIdInternal": "UUD00000000000000000012-0716",

"fileId": "ON_NSCHFDOPPRMARK_2BK-2465310432-62289_2BK-7713026678-62288_20200728_95DB61DE-472B-4781-

96ED-485E2BD3E2E5",

"documentId": "523e81b642654c60b36c0d715e8163dd"

}

"processingError": null

}

136

Document.TechnologicalTicket

Получение Технологической Квитанции, сформированной Оператором Маркировки.

URL: /integration/marking/document/{id}/technologicalTicket/

Headers: Auth-token, content-type

HTTP Method: GET

Параметры запроса:

Элемент

Тип

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

Описание

long

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

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

https://courier-demo-api.esphere.ru/integration/marking/document/1469081/technologicalTicket/

При успешном выполнении запроса, возвращается ответ, содержащий Контент Технологической квитанции в BASE64, Имя файла

и Тип данных.

Параметры ответа:

Элемент

Тип

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

Описание

Content

Collection of byte

Закодированный в BASE64 контент Технологической квитанции, полученной от ЦРПТ

Filename

string

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

Guid.json

MimeType

string

application/json

Пример ответа:

{

"filename": "4e961909-53fd-47db-92c2-288ef515f305.json",

"mimeType": "application/json",

"content":

"ew0KICAiQ29kZSI6IDIsDQogICJTdGF0ZSI6ICJJTl9QUk9HUkVTUyIsDQogICJPcGVyYXRpb25zIjogWw0KICAgIHsNCiAgICAgICJEZXRhaWx

zIjogew0KICAgICAgICAiRXJyb3JzIjogbnVsbCwNCiAgICAgICAgIlN1Y2Nlc3NmdWwiOiAidHJ1ZSIsDQogICAgICAgICJEb2N1bWVudE5hbWU

iOiAiT05fTlNDSEZET1BQUk1BUktfMkJLLTQ0NDMzMzIyMjEtMTAwMDcxNDAwMzE1MF8yQkstNDQ0MzMzMDAwMC0xMDAwNzE0MDAzMDAwXzIwMjA

wNjAyX0ZBMTM4MUM1LTMxQTMtNDhBMS1COTUyLUE3OTM0NDlGOUQ2NiIsDQogICAgICAgICJEb2N1bWVudFR5cGUiOiAiVU5JVkVSU0FMX1RSQU5

TRkVSX0RPQ1VNRU5UIiwNCiAgICAgICAgIlByb2R1Y3RHcm91cHMiOiBudWxsLA0KICAgICAgICAiRG9jdW1lbnROdW1iZXIiOiAiMTIzIiwNCiA

gICAgICAgIkRvY3VtZW50RGF0ZVRpbWUiOiAiMDIuMDYuMjAyMCINCiAgICAgIH0sDQogICAgICAiT3BlcmF0aW9uSWQiOiAiZDNkYzZiNzMtYmJ

lZS00OWQ1LWIzOTctYmIzNGY1NzJiNTIwIiwNCiAgICAgICJPcGVyYXRpb25EYXRlIjogLTIxNDc0ODM2NDgsDQogICAgICAiT3BlcmF0aW9uVHl

wZSI6IDANCiAgICB9LA0KICAgIHsNCiAgICAgICJEZXRhaWxzIjogew0KICAgICAgICAiRXJyb3JzIjogWw0KICAgICAgICAgIHsNCiAgICAgICA

gICAgICJDb2RlIjogMjIsDQogICAgICAgICAgICAiRGF0YSI6IHsNCiAgICAgICAgICAgICAgIkNpcyI6IFsNCiAgICAgICAgICAgICAgICAiMzM

zMyIsDQogICAgICAgICAgICAgICAgIjMzMzMzIg0KICAgICAgICAgICAgICBdLA0KICAgICAgICAgICAgICAiVHBlIjogbnVsbCwNCiAgICAgICA

gICAgICAgIlBhY2siOiBudWxsLA0KICAgICAgICAgICAgICAiQ291bnQiOiAyLA0KICAgICAgICAgICAgICAiRml4RGF0ZSI6IG51bGwsDQogICA

gICAgICAgICAgICJJbnZvaWNlIjogbnVsbCwNCiAgICAgICAgICAgICAgIkZpeE51bWJlciI6IG51bGwsDQogICAgICAgICAgICAgICJJbnZvaWN

lRGF0ZSI6IG51bGwsDQogICAgICAgICAgICAgICJQYXJ0aWNpcGFudCI6IG51bGwNCiAgICAgICAgICAgIH0sDQogICAgICAgICAgICAiVGV4dCI

6IG51bGwsDQogICAgICAgICAgICAiRXJyb3IiOiB7DQogICAgICAgICAgICAgICJDaXNOb3RFeGlzdHMiOiB7fQ0KICAgICAgICAgICAgfQ0KICA

gICAgICAgIH0NCiAgICAgICAgXSwNCiAgICAgICAgIlN1Y2Nlc3NmdWwiOiAidHJ1ZSIsDQogICAgICAgICJEb2N1bWVudE5hbWUiOiBudWxsLA0

KICAgICAgICAiRG9jdW1lbnRUeXBlIjogbnVsbCwNCiAgICAgICAgIlByb2R1Y3RHcm91cHMiOiBbDQogICAgICAgICAgInVua25vd24iDQogICA

gICAgIF0sDQogICAgICAgICJEb2N1bWVudE51bWJlciI6IG51bGwsDQogICAgICAgICJEb2N1bWVudERhdGVUaW1lIjogbnVsbA0KICAgICAgfSw

NCiAgICAgICJPcGVyYXRpb25JZCI6ICIzZjM2YTFiOC05ZjY5LTQyZTUtODI1Yi1jZGYwNmIxZTI5YmYiLA0KICAgICAgIk9wZXJhdGlvbkRhdGU

137

iOiAtMjE0NzQ4MzY0OCwNCiAgICAgICJPcGVyYXRpb25UeXBlIjogMQ0KICAgIH0NCiAgXSwNCiAgIkRlc2NyaXB0aW9uIjogIkRvY3VtZW50IGl

uIHByb2Nlc3NpbmciLA0KICAiUmVzdWx0RG9jSWQiOiAiVUlOVDA0VFhNTkdSMDAwMDAwMDAwMDAwMDAwMDQzOTYtMDcwNiIsDQogICJTb3VyY2V

Eb2NJZCI6ICJVVUQwMDAwMDAwMDAwMDAwMDAwMDAwNS05OTg1IiwNCiAgIlJlc3VsdERvY0RhdGUiOiAtMjE0NzQ4MzY0OCwNCiAgIlNvdXJjZUR

vY0RhdGUiOiAtMjE0NzQ4MzY0OA0KfQ=="

}

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

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

400 - нет доступа:

ER-20103: В данный момент вы не можете совершать действие над документом. Возможно, документ уже взят на

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

ER-10000 - По идентификатору документа '{0}' транспортный документ не найден.

ER-10001 - Логическое сообщение, содержащее документ с идентификатором '{0}', не найдено.

404 - документ не найден:

ER-10003 - Технологическая квитанция с идентификатором '{0}' не найдена.

Ограничения: Клиент может обратиться только к принадлежащему его организации документу, т.е. организация должна

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

138

Отложенная отправка/рассылка

Функционал отложенной отправки документов позволяет реализовать следующий процесс работы с контрагентами:

При отправке запроса на создание взаимосвязи сразу же отправлять документ. Документ будет доставлен контрагенту, только

после принятия им запроса. При этом исключается процесс контроля принятых запросов, для того чтобы отправить контрагенту,

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

Отправка будет инициирована в момент принятия запроса на взаимосвязь контрагентом и осуществляться от имени

пользователя, инициирующего рассылку.

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

подпись сотруднику, который инициировал рассылку.

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

отправляется контрагенту.

Метод

Описание

DelayedDispath.Add v.2

Добавление рассылки документа

139

DelayedDispath.Add v.2

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

URL: v2.0/delayedDispath

HTTP Method: PUT

Параметры запроса:

Элемент

Тип

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

Описание

BODY

DelayedDispatch

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

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

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

201- операция успешно завершена: рассылка добавлена успешно;

400 - при обработке запроса возникла ожидаемая ошибка;

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

140

Методы для работы с квитанциями

В системе СФЕРА Курьер квитанции являются транспортными документами.

Метод

Описание

Ticket.Add

Добавление подписанной пользовательской квитанции "Извещение о получении"

Ticket.

Формирование титула заказчика для Акта выполненных работ

CreateAcceptenceCertificateAcceptTi

cket

Ticket.CreateClarification

Формирование уведомления об уточнении (УОУ)

Ticket.CreateClarificationNotice

Формирование уведомления об уточнении (УОУ) без ограничения длины комментария

(комментарий в теле запроса)

Ticket.CreateReply

Формирование ответной пользовательской квитанции

Ticket.CreateTorg12AcceptTicket

Формирование титула покупателя для Товарной накладной (ТОРГ-12)

Ticket.DocumentReply v.2

Создание ответной квитанции по идентификатору документа

Ticket.GetTicketIdList

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

Ticket.Index

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

правило ИОП)

Ticket.Unreplied v.2

Возвращение списка неотвеченных квитанций

Tickets.Ticket

Получение информации о (и содержимого) квитанции

Tickets.Tickets

Получение списка квитанций с подписями для документа и с самим документом

141

Ticket.Add

Функция добавляет подписанную пользовательскую квитанцию указанного типа.

URL: /api/tickets/add/{id}?ticketPurpose={ticketPurpose}

HTTP Method: POST

Метод предназначен для добавления только следующих типов квитанций:

TicketPurpose.ConfirmReceive (Извещение о получении)

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

Все остальные типы добавляются через соответствующие квитанциям действия над самим документом.

Параметры запроса:

Элемент

Тип

Описание

long

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

ticket

SignedContent

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

Параметры URL:

Элемент

Тип

Описание

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

ticketPurpose

TicketPurpose

Тип назначения квитанции (по умолчанию

используется значение ConfirmReceive - извещение о получении)

В случае успешного выполнения запроса добавляется подписанная пользовательская квитанция и возвращается информацию (и

содержимое) квитанции в структуре TicketDetails.

В случае успешного выполнения запроса добавляется подписанная пользовательская квитанция.

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

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

400 - не удалось сформировать ответный транспортный документ для существующей квитанции;

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

Дополнительные условия:

ИОП формируется для (в скобках кодировка код из перечисления TransportDocumentType):

Счет-фактура (Invoice)

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

ТОРГ-12, роуминг (Torg12SellerTitle)

Акт оказания услуг, роуминг (AcceptanceCertificatePerformerTitle)

Неструктурированный документ, роуминг (Document)

Важно! Для корректного добавления и обработке квитанции на стороне получателя должен быть настроен маршрут для

документа, к которому она добавляется.

Возвращаемые ошибки:

ER-11041 - Квитанция '{0}' не соответствует XSD схеме: {1}. (Если ticket.Content не соответствует XSD схеме Извещения

о получении);

ER-10106 - Ошибка декодирования CMS контейнера;

ER-10108 - Ошибка проверки ЭЦП: Подпись неверна. (Если подпись под документом ticket.Signature сформирована не

для содержимого документа ticket.Content);

142

ER-10107 - Ошибка проверки ЭЦП: Документ подписан неизвестным сертификатом. (Если у пользователя нет активного

сертификата, соответствующего сертификату, с помощью которого была сформирована подпись под документом);

ER-10109 - Ошибка проверки сертификата: {0} (сертификат не валиден на дату подписания документа по указанной

причине);

ER-10112 - Подписант в документе отличается от субъекта в сертификате, ожидалось '{0}', а встретилось '{1}';

ER-10110 - Контейнер с подписью не содержит сертификата;

ER-10100 - Ошибка проверки ЭЦП: Неопределенная ошибка;

ER-20010 - Квитанция такого типа уже добавлена.

143

Ticket.CreateAcceptenceCertificateAcceptTicket

Формирует титул заказчика для акта выполненных работ.

URL: /api/tickets/createAcceptenceCertificateAcceptTicket/{id}

HTTP Method: POST

Параметры запроса:

Элемент

Тип

Описание

long

Идентификатор транспортного документа.(параметр Id из структуры TicketDetails)

data

AcceptanceCertificateAcceptInfo

Информация для титула заказчика.

В случае успешного выполнения запроса возвращает титул заказчика в структуре FileContent.

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

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

400 - невозможно сформировать титул заказчика;

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

Возвращаемые ошибки:

ER-12113 - Квитанция (транспортный документ) '{0}' не найден.

ER-12114 - Титул заказчика для акта выполненных работ может формироваться только на титул исполнителя.

ER-12115 - Невозможно сформировать титул заказчика для квитанции (транспортного документа) '{0}'. (У документа,

полученного из транспортного документа, не установлен флаг Actions.AcceptWithTicket (Принятие с квитанцией.))

ER-20101 - Невозможно произвести действия над документом. Необходимо подтвердить получение документа во вкладке

"Квитанции".

ER-20103 - В данный момент вы не можете совершать действие над документом. Возможно, документ уже взят на

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

144

Ticket.CreateClarification

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

комментария (комментарий в теле запроса) Ticket.CreateClarificationNotice.

URL: /api/tickets/createclarification/{id}

HTTP Method: POST

Параметры URL:

Элемент

Тип

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

Описание

long

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

Параметры запроса:

Элемент

Тип

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

Описание

comment

string

Текст причины отклонения

Параметры Body:

Элемент

Тип

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

Описание

data

MchdData

Данные по МЧД для создания квитанций

В случае успешного выполнения запроса формирует уведомление об уточнении в структуре FileContent.

Формат УОУ для счетов-фактур и корректировочных счетов-фактур: ФНС.

Для остальных типов роуминговых документов формат УОУ регламентируется технологией РОСЭУ.

Сформированное УОУ далее необходимо подписать и добавить в Курьер методом Document.RequestClarification.

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

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

400 - ошибка при создании ответа на квитанцию:

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

документа

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

Возвращаемые ошибки:

ER-12010 - Невозможно отклонить документ, т.к. отсутсвует исходный документ. (Для документа не удалось загрузить

транспортный документ или у транспортного документа нет исходного документа.)

145

Ticket.CreateClarificationNotice

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

аналогичен Ticket.CreateClarification.

URL: /api/tickets/createClarificationNotice/{id}

HTTP Method: POST

Параметры URL:

Элемент

Тип

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

Описание

long

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

Параметры Body:

Элемент

Тип

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

Описание

data

CreateClarificationNoticeRequest

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

В случае успешного выполнения запроса формирует уведомление об уточнении в структуре FileContent.

Формат УОУ для счетов-фактур и корректировочных счетов-фактур: ФНС.

Для остальных типов роуминговых документов формат УОУ регламентируется технологией РОСЭУ.

Сформированное УОУ далее необходимо подписать и добавить в Курьер методом Document.RequestClarification.

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

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

400 - ошибка при создании ответа на квитанцию:

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

документа

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

Возвращаемые ошибки:

ER-12010 - Невозможно отклонить документ, т.к. отсутствует исходный документ. (Для документа не удалось загрузить

транспортный документ или у транспортного документа нет исходного документа.)

146

Ticket.CreatePriRasxAdditionalInfoTicket v.2

Метод по созданию Дополнительных сведений к Документу о приемке материальных ценностей и (или) расхождениях,

выявленных при их приемке.

URL: v2.0/ticket/priRasxAdditionalInfo/document/{id}

Метод: POST

Параметры запроса:

Элемент

Тип

Описание

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

integer

ID документа

priRasxAdditionalInfo

PriRasxAdditionalInfo

Упрощенная модель Дополнительных сведений документа

В результате успешного выполнения запроса из упрощенной модели Дополнительных сведений и данных Основного документа,

создается готовый XML документ Дополнительных сведений, который возвращается в виде структуры данных FileContent.

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

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

400 - при некорректном заполнении упрощенного документа или если не найден абонент;

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

Ограничения:

Дополнительные сведения возможно создать к Документу о приемке материальных ценностей и (или) расхождениях,

выявленных при их приемке, находящемуся в одном из статусов: Отправлен, Получен, Принят, Подписан, На согласовании.

Сервис вернет ошибку в случае, если в теле запроса в одном элементе массива Signers не передан ни один, или передано более

одного элемента из набора: Physical, Individual или OrganizationSignerInfo. Текст ошибки: "Для одного подписанта следует

указывать только один тип: ЮЛ, ИП или ФЛ".

147

Ticket.CreateReply

Формирует ответную пользовательскую квитанцию.

URL: /api/tickets/createreply/{id}

HTTP Method: POST

Параметры запроса:

Элемент

Тип

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

Описание

long

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

data

MchdData

Данные по МЧД для создания квитанций

В случае успешного выполнения запроса формирует ответную пользовательскую квитанцию в структуре FileContent.

Формат ИОП для счетов-фактур и корректировочных счетов-фактур: ФНС.

Для остальных типов роуминговых документов формат ИОП регламентируется технологией РОСЭУ.

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

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

400 - ошибка при создании ответа на квитанцию;

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

Дополнительные условия:

Ответная квитанция формируется:

на: Подтверждение даты получения(ReceiveConfirmation), Подтверждение даты отправки(SendConfirmation), Документ

(основной документ), ПодтверждениеОтправкиИзвещенияОПолученииДокумента, Уведомление об уточнении

(ClarificationNotice);

только в ответ на входящие документы;

только для документа с подписью.

Возвращаемые ошибки:

ER-10303 - Нельзя сформировать извещение о получении в ответ на '{расширенный тип документа}'.

ER-10313 - Нельзя сформировать извещение о получении для документа у которого нет подписи.

ER-10325 - Для квитанции 'Извещение о получении документа (ИОП)' формирование ИоП/УоУ не предусмотрено

документооборотом.

148

Ticket.CreateTorg12AcceptTicket

Формирует титул покупателя для ТОРГ-12.

URL: /api/tickets/createTorg12AcceptTicket/{id}

HTTP Method: POST

Параметры запроса:

Элемент

Тип

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

Описание

long

Идентификатор транспортного документа.(параметр Id из структуры TicketDetails)

data

Torg12AcceptInfo

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

В случае успешного выполнения запроса возвращает титул покупателя в структуре FileContent.

Далее, титул покупателя необходимо подписать и добавить методом Document.Sign.

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

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

400 - невозможно сформировать титул покупателя;

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

Возвращаемые ошибки:

ER-12113 - Квитанция (транспортный документ) '{0}' не найден.

ER-12115 - Невозможно сформировать титул заказчика для квитанции (транспортного документа) '{0}'. (У документа,

полученного из транспортного документа, не установлен флаг Actions.AcceptWithTicket (Принятие с квитанцией.))

ER-12116 - Титул покупателя для ТОРГ-12 может формироваться только на титул продавца.

ER-20101 - Невозможно произвести действия над документом. Необходимо подтвердить получение документа во вкладке

"Квитанции".

ER-20103 - У вас нет прав на просмотр данного документа.

149

Ticket.DocumentReply v.2

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

URL: v2.0/ticket/documentReply/{id}

HTTP Method: GET

Параметры запроса:

Элемент

Тип

Описание

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

integer

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

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

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

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

400 - ошибка при создании ответа на квитанцию;

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

150

Ticket.GetTicketIdList

Возвращает список идентификаторов транспортных документов по имени файла.

URL: /api/tickets/getTicketIdList/

HTTP Method: POST

Параметры запроса:

Элемент

Тип

Описание

fileName

string

Наименование файла

Поиск регистронезависимый. В случае успешного выполнения запроса, возвращается массив идентификаторов транспортных

документов упорядоченный по возрастанию этих самых идентификаторов.

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

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

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

151

Tickets.Ticket

Возвращает информацию (и содержимое) квитанции.

URL: /api/tickets/ticket/{id}

HTTP Method: GET

Параметры запроса:

Элемент

Тип

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

Описание

long

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

isMchdAsFi

bool

Получение МЧД в виде файла. При включении параметра метод возвращает МЧД в виде файлов если

изначально МЧД была передана в виде метаданных

isMchdAsM

bool

Получение МЧД в виде метаданных. При включении параметра метод возвращает МЧД в виде

eta

метаданных если изначально МЧД была передана в виде файла (пакета)

В случае успешного выполнения запроса возвращает информацию и содержимое квитанции в структуре TicketDetails.

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

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

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

154

Tickets.Tickets

Возвращает список квитанций с подписями для документа.

Документ, для которого возвращаются квитанции, присутствует в этом списке.

URL: /api/tickets/tickets/{id}

HTTP Method: GET

Параметры запроса:

Элемент

Тип

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

Описание

long

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

isMchdAsFi

bool

Получение МЧД в виде файла. При включении параметра метод возвращает МЧД в виде файлов, в

том случае, если изначально МЧД была передана в виде метаданных

isMchdAsM

bool

Получение МЧД в виде метаданных. При включении параметра метод возвращает МЧД в виде

eta

метаданных если изначально МЧД была передана в виде файла (пакета)

В случае успешного выполнения запроса возвращает список структур TicketDetails.

Особые условия:

При использовании данного метода в структуре TicketDetails параметр NeedReply всегда имеет значение false.

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

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

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

155

Методы для работы с событиями

ВАЖНО!

Для оперативной работы с событиями необходимо использовать функционал подписок. Методы для работы с

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

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

операции зависит от количества запрашиваемых событий и может занять длительное время.

Метод

Описание

events-index

Получение списка событий начиная с заданного события

GetDocumentEvents

Получение списка событий по документу

GetLastEventId

Получение идентификатора последнего события

156

events-index

URL: /api/events/{id}

HTTP Method: POST

Параметры запроса:

Элемент

Тип

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

Описание

long

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

count

long

Количество возвращаемых событий

Параметр count метода передается через заголовок запроса (метод GET).

/api/events/{id}?count=n

В случае успешного выполнения запроса возвращается список событий начиная с определенного события в структуре DocumentE

vent

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

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

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

ВАЖНО!

Данный метод возвращает данные не более чем о 1000 событиях при указании параметра "count", либо данные о 100

событиях, если параметр "count" не указан.

157

CorrelationEvent.Create v.2.0

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

URL: v2.0/correlationevent/create

HTTP Method: POST

В случае успешного выполнения запроса создается подписка на события по взаимосвязям компании. Возвращается информация

о токене подписки:

Элемент

Тип данных

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

Описание

Token

string

Токен подписки на события по взаимосвязям

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

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

400 - при обработке запроса возникла ожидаемая ошибка;

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

Возвращаемые ошибки:

ER-20125 - У вас нет прав на выполнение операции (Если у пользователя нет доступа к подписке);

ER-20005 - Превышено максимальное число подписок для компании (Если подписка уже существует).

161

CorrelationEvent.Events v.2.0

Возвращает информацию о существующих в ленте событиях по взаимосвязям компании.

URL: v2.0/correlationevent/events

HTTP Method: GET

Параметры запроса:

Элемент

Тип

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

Описание

token

string

Токен подписки

count

integer

Default value is

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

1000

событий

В случае успешного выполнения запроса возвращает массив событий по взаимосвязям компании в структуре RelationEvent.

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

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

400 - при обработке запроса возникла ожидаемая ошибка;

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

Дополнительные условия:

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

Возвращаемые ошибки:

ER-20125 - У вас нет прав на выполнение операции (Если у пользователя нет доступа к подписке);

ER-20141 - Указан несуществующий токен (Если пользователь указал несуществующий(удаленный) токен подписки).

162

CorrelationEvent.Subscriptions v.2.0

Возвращает информацию о существующих подписках на ленту событий по взаимосвязям компании.

URL: v2.0/correlationevent/subscriptions

HTTP Method: GET

В случае успешного выполнения запроса возвращает список подписок на события компании в виде структур Subscription. Если

подписок нет - возвращается пустой список.

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

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

400 - при обработке запроса возникла ожидаемая ошибка;

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

Возвращаемые ошибки:

ER-20125 - У вас нет прав на выполнение операции (Если у пользователя нет доступа к подписке);

ER-20141 - Указан несуществующий токен (Если пользователь указал несуществующий(удаленный) токен подписки).

163

Методы для работы с подписками

Обратите внимание!

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

Метод

Описание

Subscription.Add v.2.0

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

Subscription.DeleteEvents v.2.0

Удаление указанных событий из очереди событий подписки

Subscription.DeleteEvent v.2.0

Удаление события из очереди событий подписки

Subscription.Delete v.2.0

Удаление подписки и всех событий в ней

Subscription.Events v.2.0

Получение событий по заданной подписке

Subscription.Events.Totals v.2.0

Получение событий по заданной подписке с количеством событий

Subscription.GetSubscriptionDetails v.2.0

Получение информации о подписке

Subscription.GetSubscriptions v.2.0

Получение списка подписок на события

164

Subscription.Add v.2.0

Добавляет новую подписку. Для добавления подписки с доступом только текущему пользователю может быть добавлен

необязательный параметр isRestricted - признак подписки с ограниченным доступом.

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

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

URL: v2.0/subscription?isRestricted=false

HTTP Method: PUT

Параметры запроса (query string):

Элемент

Тип

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

Описание

isRestricted

bool

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

Тело запроса (body):

Элемент

Тип

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

Описание

SubscriptionRequest

Массив идентификаторов контрагентов

Пример запроса со списком контрагентов:

<SubscriptionRequest xmlns="http://schemas.datacontract.org

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

<PartnerIds xmlns:d3p1="http://schemas.microsoft.com/2003

/10/Serialization/Arrays">

<d3p1:long>495</d3p1:long>

<d3p1:long>539</d3p1:long>

<d3p1:long>1319</d3p1:long>

</PartnerIds>

</SubscriptionRequest>

При указании параметра isRestricted = true метод добавляет новую подписку с ограниченным доступом к событиям. Права на

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

При указании списка контрагентов SubscriptionRequest метод добавляет новую подписку на события по документам, у которых

одной из сторон документооборота являются указанные контрагенты.

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

Дополнительные условия:

Максимальное количество подписок с ограничениями на одну компанию ограничено 5. При превышении данного лимита будет

возвращена ошибка с кодом ER-20005.

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

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

400 - при обработке запроса возникла ожидаемая ошибка;

165

Subscription.DeleteEvents v.2.0

Удаляет из ленты событий (по взаимосвязям и документам) массив событий, идентификаторы которых были указаны в массиве.

URL: v2.0/subscription/{token}/event

HTTP Method: DELETE

Параметры запроса:

Элемент

Тип

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

Описание

token

string

Токен подписки на события

ArrayOflong

ArrayOflong[]

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

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

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

204 - события удалены успешно;

400 - при обработке запроса возникла ожидаемая ошибка;

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

Возвращаемые ошибки:

ER-20125 - У вас нет прав на выполнение операции (Если у пользователя нет доступа к подписке);

ER-20141 - Указан несуществующий токен (Если пользователь указал несуществующий(удаленный) токен подписки).

167

Subscription.DeleteEvent v.2.0

Удаляет событие из очереди событий подписки.

URL: v2.0/subscription/{token}/event/{eventId}

HTTP Method: DELETE

Параметры запроса:

Элемент

Тип

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

Описание

token

string

Токен подписки

eventId

integer

Идентификатор события, которое необходимо удалить

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

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

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

204 - события успешно удалены;

400 - при обработке запроса возникла ожидаемая ошибка;

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

Возвращаемые ошибки:

ER-20125 - У вас нет прав на выполнение операции (Если у пользователя нет доступа к подписке).

168

Subscription.Delete v.2.0

Удаляет подписку компании на получение событий (по взаимосвязям и документам). По авторизационному токену проводится

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

URL: v2.0/subscription/{token}

HTTP Method: DELETE

Параметры запроса:

Элемент

Тип данных

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

Описание

Token

string

Токен подписки на события

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

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

204 - подписка удалена успешно;

400 - при обработке запроса возникла ожидаемая ошибка;

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

Возвращаемые ошибки:

ER-20125 - У вас нет прав на выполнение операции (Если у пользователя нет доступа к подписке);

ER-20141 - Указан несуществующий токен (Если пользователь указал несуществующий(удаленный) токен подписки).

169

Subscription.Events.Totals v.2.0

Возвращает события по заданной подписке с количеством событий.

URL: v2.0/subscription/{token}/event/totals?count={count}

HTTP Method: GET

Параметры запроса:

Элемент

Тип

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

Описание

token

string

Токен подписки

count

integer

Default value is

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

1000

событий

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

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

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

400 - при обработке запроса возникла ожидаемая ошибка;

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

Дополнительные условия:

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

Возвращаемые ошибки:

ER-20125 - У вас нет прав на выполнение операции (Если у пользователя нет доступа к подписке).

170

Subscription.Events v.2.0

Возвращает события по заданной подписке.

URL: v2.0/subscription/{token}/event?count={count}

HTTP Method: GET

Параметры запроса:

Элемент

Тип

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

Описание

token

string

Токен подписки

count

integer

Default value is

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

1000

событий

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

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

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

400 - при обработке запроса возникла ожидаемая ошибка;

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

Дополнительные условия:

Если количество событий которое необходимо вернуть не указано, то возвращаются первая 1000 событий.

Возвращаемые ошибки:

ER-20125 - У вас нет прав на выполнение операции (Если у пользователя нет доступа к подписке).

171

Subscription.GetSubscriptionDetails v.2.0

Возвращает информацию о подписке пользователя.

URL: v2.0/subscription/{token}

HTTP Method: GET

Параметры запроса:

Элемент

Тип

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

Описание

token

string

Токен подписки

В случае успешного выполнения запроса возвращает информацию о подписке в виде структуры Subscription.

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

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

400 - при обработке запроса возникла ожидаемая ошибка;

404 - подписка не найдена;

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

172

TypeDocument v.2

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

UURL: v2.0/documentType/

HTTP Method: GET

Параметры запроса:

Нет.

В случае успешного выполнения запроса возвращает список типов документов в виде списка структур данных DocumentType

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

<DocumentTypeCode>sample string 2</DocumentTypeCode>

<Name>sample string 3</Name>

</DocumentType>

</ArrayOfDocumentType>

[

{

"id": 1,

"documentTypeCode": "sample string 2",

"name": "sample string 3",

"senderSignatureRequired": true,

"receiverSignatureRequired": true

{

"id": 1,

"documentTypeCode": "sample string 2",

"name": "sample string 3",

"senderSignatureRequired": true,

"receiverSignatureRequired": true

}

]

175

Classifier.ClassifierValues

Возвращает список значений справочника.

URL: /api/classifier/classifierValues

HTTP Method: POST

Элемент

Тип

Описание

classifierId

long

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

isNotActive

bool

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

В случае успешного выполнения возвращается список структур ClassifierValue.

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

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

400 - возникла предвиденная ошибки;

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

179

Classifier.Template

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

URL: /api/classifier/template

URL: /api/classifier/template/?documentTypeCode={documentTypeCode}&receiverCode={receiverCode} - при использовании XML

параметры запроса передаются не в теле запроса, а в URL.

HTTP Method: POST

Элемент

Тип

Описание

documentTypeCode

string

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

receiverCode

string

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

В случае успешного выполнения возвращается список структур ClassifierTemplate.

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

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

400 - возникла предвиденная ошибка;

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

181

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

Метод

Описание

Dictionary.Signer

Получение информации о текущем пользователе

Dictionary.UserCertificate

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

Dictionary.UserInfo

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

Helper.RoleList

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

Helper.GroupList

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

Helper.UserIdByLogin

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

Helper.UserList

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

User.AddCertificate

Добавление нового сертификата пользователю

User.AddUser

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

User.Certificate v.2

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

User.LockUser

Изменение статуса пользователя (активен/неактивен)

User.AddGroup v.2

Добавление пользователя в группу

User.AddRole v.2

Добавление роли пользователю

182

Dictionary.UserCertificate

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

URL: /api/dictionary/usercertificate

HTTP Method: GET

В случае успешного выполнения запроса, возвращается информация об активном зарегистрированном сертификате

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

Если у пользователя нет зарегистрированного сертификата, возвращается ExceptionDetails.

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

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

400 - у пользователя нет активных сертификатов;

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

Возвращаемые ошибки:

ER-10111 - Для пользователя '{0}' нет зарегистрированного сертификата ЭП (У пользователя нет активных

сертификатов.)

184

Helper.UserIdByLogin

Возвращает идентификатор пользователя по логину.

URL: /api/helper/userIdByLogin

HTTP Method: POST

Параметры запроса:

Элемент

Тип

Описание

string

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

dirId

UserDirectory

Каталог пользователей.

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

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

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

400 - при обработке запроса возникла ожидаемая ошибка;

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

188

Helper.UserList

Возвращает список пользователей компании, к которой принадлежит авторизованный пользователь.

URL: /api/helper/userList

HTTP Method: POST

В случае успешного выполнения возвращает список пользователей в виде структуры данных UserDetails.

Поле ClientInfo структуры UserDetails в данном методе не заполняется.

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

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

400 - при обработке запроса возникла ожидаемая ошибка;

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

189

User.AddCertificate

Добавляет новый сертификат к пользователю.

URL: /api/user/addCertificate/?userId={userId}

HTTP Method: POST

Параметры запроса:

Элемент

Тип

Размер

Описание

userId

long

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

certificate

Certificate

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

В случае успешного выполнения запроса, сертификат добавляется к пользователю и становится активным.

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

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

400 - вызывается если поля заполнены не корректно, не корректный сертификат;

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

Дополнительные условия:

Обязательные поля структуры Certificate - Image;

Возвращаемые ошибки:

ER-12003 - Отсутствует обязательный параметр '{0}'.

ER-12205 - Пользователь с идентификатором '{0}' не найден.

ER-12302 - Добавление сертификата для пользователя с подсистемой отличной от "Внешняя" невозможно.

ER-20107 - Данный сертификат для пользователя уже загружен в систему.

ER-10115 - Сертификат не удовлетворяет требованиям 63-ФЗ: Отсутствует обязательное дополнение: Политики

сертификата (2.5.29.32).

ER-10115 - Сертификат не удовлетворяет требованиям 63-ФЗ: Поле 'ОГРН' в кодировке 'DerPrintableString', вместо

'DerNumericString'.

ER-10109 - Ошибка проверки сертификата: Сертификат был отозван

ER-10109 - Ошибка проверки сертификата: Истек/не наступил срок действия требуемого сертификата при проверке по

системным часам или по отметке времени в подписанном файле.

ER-10109 - Ошибка проверки сертификата: Цепочка сертификатов обработана, но обработка прервана на корневом

сертификате, у которого отсутствует отношение доверия с поставщиком доверия.

ER-12310: Добавление сертификата для организации невозможно: Отсутствует активный прямой идентификатор

участника ЭДО.

Примеры:

XML

URL: {{Parameters.Server.Url}}/api/user/addCertificate?userId={{userId}}

Body:

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

<Image>MIIJXzCCCQ6gAwIBAgIKKiTKLwAAAAAAHjAIBgYqhQMCAgMwg...PRS+EvIHIgeI/dhw</Image>

</Certificate>

190

User.AddGroup v.2

Добавляет пользователя в группу.

URL: v2.0/user/{userId}/group

HTTP Method: PUT

Параметры запроса:

Элемент

Тип

Описание

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

userId

integer

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

BODY

SetUserGroupRequest

Параметры метода добавления пользователя в группу

В случае успешного выполнения запроса пользователь добавляется в группу, и возвращается код HTTP 204.

Ограничения:

Пользователь с указанным Id должен принадлежать организации пользователя, вызывающего метод;

Группа с указанным Id должна принадлежать организации пользователя, вызывающего метод.

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

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

Результат

204

Операция успешно завершена, пользователь добавлен в группу.

400

Значение не может быть неопределенным. Имя параметра: group

ER-10520 - Пользователь с uid='{0}' не найден в компании с id='{0}'

ER-20006 - Ошибка входных параметров

ER-20005 - Группа <Наименование группы> не соответствует компании пользователя

ER-20005 - Нельзя назначить группу для пользователя в указанную компанию

403

ER-20124 - Для выполнения операции необходима привилегия <Наименование привилегии>.

ER-20125 - У вас нет прав на выполнение операции

404

Пользователь не найден

500

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

Примеры

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

/2004/07/Korus.Eds.WebApi.Models">

</SetUserGroupRequest>

{

"groupId": 1

}

191

User.AddRole v.2

Добавляет роль пользователю.

URL: v2.0/user/{userId}/role

HTTP Method: PUT

Параметры запроса:

Элемент

Тип

Описание

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

userId

integer

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

BODY

SetUserRoleRequest

Параметры метода добавления роли пользователю

В случае успешного выполнения запроса роль добавляется пользователю, и возвращается код HTTP 204.

Ограничения:

Пользователь с указанным Id должен принадлежать организации пользователя, вызывающего метод;

Роль должна принадлежать организации пользователя.

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

HTTP-код

Результат

возврата

204

Операция успешно завершена, пользователю назначена роль.

400

Значение не может быть неопределенным. Имя параметра: role

ER-10520 - Пользователь с uid='{0}' не найден в компании с id='{0}'

ER-20006 - Ошибка входных параметров. Указан несуществующий токен

ER-20005 - Нельзя назначить права для пользователя в указанную компанию

ER-20005 - Роль <Наименование роли> не соответствует компании пользователя

ER-20005 - Нельзя назначить привилегию <Наименование привилегии> без родительской привилегии

<Наименование привилегии>

403

ER-20124 - Для выполнения операции необходима привилегия <Наименование привилегии>

ER-20125 - У вас нет прав на выполнение операции

404

Пользователь не найден

500

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

Примеры

XML

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

org/2004/07/Korus.Eds.WebApi.Models">

</SetUserRoleRequest>

{

"roleId": 1

}

192

User.AddUser

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

URL: /api/user/addUser

HTTP Method: POST

Параметры запроса:

Элемент

Тип

Размер

Описание

user

ApiUser

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

В случае успешного выполнения запроса, пользователь сохраняется в систему со статусом неактивен.

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

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

400 - вызывается если поля заполнены не корректно, не корректный сертификат;

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

Дополнительные условия:

Обязательные поля структуры ApiUser - LastName, FirstName, Login, Password, Email, Title;

в Login не должно быть русских символов;

Для ролей/групп надо заполнять только поле Id;

Список групп можно получить с помощью метода Helper.GroupList;

Всем новым пользователям по умолчанию добавляется роль "Пользователь системы";

Запрещено добавлять роли "Администратор системы" и "Специальная роль для BPEL."

Возвращаемые ошибки:

ER-12003 - Отсутствует обязательный параметр '{0}'.

ER-12313: Добавленному пользователю не удалось указать список ролей и выставить признак активности. Обратитесь в

службу технической поддержки

ER-20005: Пользователь с логином "{0}" уже существует

ER-12310: Добавление сертификата для организации невозможно: Отсутствует активный прямой идентификатор

участника ЭДО.

ER-10109: Ошибка проверки сертификата: Сертификат был отозван Истек/не наступил срок действия требуемого

сертификата при проверке по системным часам или по отметке времени в подписанном файле.

ER-10109: Ошибка проверки сертификата: Цепочка сертификатов обработана, но обработка прервана на корневом

сертификате, у которого отсутствует отношение доверия с поставщиком доверия.

ER-10115: Сертификат не удовлетворяет требованиям 63-ФЗ: Отсутствует обязательное дополнение: Политики

сертификата (2.5.29.32).

194

User.LockUser

Изменяет статус пользователя активен/неактивен.

URL: /api/user/lockUser/?userId={userId}

HTTP Method: POST

Параметры запроса:

Элемент

Тип

Размер

Описание

userId

long

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

lockUser

bool

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

В случае успешного выполнения запроса, статус пользователя изменяется.

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

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

400 - вызывается если поля заполнены не корректно;

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

196

VerifyDetachedSignature v.2

Проверяет подлинность подписанного содержимого файла. Для вызова данного метода не требуется аутентификация

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

URL: v2.0/verify/detachedSignature

HTTP Method: POST

Параметры запроса:

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

Signature.

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

XML

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

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

</DetachedSignatureVerificationRequest>

JSON

{

"content": "QEA=",

"signature": "QEA=",

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

}

В случае успешного выполнения возвращает код 2XX.

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

2XX - проверка выполнена успешно;

4XX - возникла предвиденная ошибка;

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

198

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

201

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 - при обработке запроса возникла непредвиденная ошибка.

203

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

Структура

Описание

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

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

204

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

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

205

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

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

UserLogin

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

206

VersionInfo

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

Warrant

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

WarrantIssuer

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

WarrantSubject

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

CreditTransaction

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

ClientRelationDocum

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

entType

ClientRelationDocum

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

entTypeInfo

Relation

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

RelationAssertReque

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

UcdInvoiceInfo

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

UcdInvoiceRevisionI

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

nfo

SignatureMchdIdenti

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

207

AcceptanceCertificateAcceptInfo

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

Элемент

Тип данных

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

Размер

Описание

Date

DateTime

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

Comment

string

0-2000

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

Warrant

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

Acceptor

Signer

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

Action

Actions

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

Claim

string

0-2000

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

Ticket.CreateAcceptenceCertificateAcceptTicket

Примеры

208

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"

209

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"

}

]

}

210

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"

}

]

211

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

Примеры

213

AddDocumentCommentRequest

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

Элемент

Тип данных

Размер

Описание

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

Comment

string

0-2000

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

Visibility

DocumentCommentVisibility

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

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

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

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

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

Document.AddComment v.2

Примеры

214

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 гб)

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

ReceiverRejectReason

string (4 гб)

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

215

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

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

216

ApiDocumentFilter

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

Элемент

Тип

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

Размер

Описание

данных

Folder

Document

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

Folder

Participant

long

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

Document

string (32)

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

TypeCode

StatusId

int?

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

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

From

DateTime

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

DateTime

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

CreatedFrom

DateTime

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

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>

217

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