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

1. API

1.1 История изменений

1.2 Общая информация

1.2.1 Доступ к API

1.2.2 Формат запросов

1.2.3 Авторизационный токен

1.3 Список методов

1.3.1 Аутентификация

1.3.1.1 Logon

1.3.1.2 LogonByApiKey

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

1.3.2.1 Получение информации о клиенте

1.3.2.1.1 Dictionary.Client

1.3.2.1.2 Dictionary.ContractorDocumentTypes

1.3.2.1.3 Dictionary.FindClient

1.3.2.1.4 v2.0.client

1.3.2.1.5 v2.0.client.{code}

1.3.2.1.6 v2.0.client.{id}

1.3.2.1.7 v2.0.client.discover

1.3.2.1.8 v2.0.client.self

1.3.2.1.9 v2.0 client.ediCode

1.3.2.1.10 v2.0 client.ediCodes

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

1.3.3 Методы для настройки взаимосвязей

1.3.3.1 Relation.AddDocumentType v.2

1.3.3.2 Relation.DeleteDocumentType v.2

1.3.3.3 RelationCorrelated v.2

1.3.3.4 RelationRequest.Accept v.2

1.3.3.5 RelationRequest.AddRequest v.2

1.3.3.6 RelationRequest.DeleteRequest v.2

1.3.3.7 RelationRequest.ListRequest v.2

1.3.3.8 RelationRequest.Reject v.2

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

1.3.4.1 Действия над документом

1.3.4.1.1 Document.Accept

1.3.4.1.2 Document.AcceptAvoidanceRequest v.2

1.3.4.1.3 Document.AcceptRevoke

1.3.4.1.4 Document.AcceptTitle v.2

1.3.4.1.5 Document.Add

1.3.4.1.6 Document.AddAttachment

1.3.4.1.7 Document.AddBatch

1.3.4.1.8 Document.AddComment v.2

1.3.4.1.9 Document.AddProperty v.2

1.3.4.1.10 Document.AddRelation

1.3.4.1.11 Document.Attachment

1.3.4.1.12 Document.AvoidanceRequest v.2

1.3.4.1.13 Document.ChangeRoute

1.3.4.1.14 Document.ChangeSigner v.2

1.3.4.1.15 Document.CreateAvoidanceRequest v.2

1.3.4.1.16 Document.CreateAvoidanceRequestClarificationNotice v.2

1.3.4.1.17 Document.CreateCorrectionInvoice

1.3.4.1.18 Document.CreateInvoice

1.3.4.1.19 Document.CreateUcdDocument

1.3.4.1.20 Document.Delete

1.3.4.1.21 Document.EditDocumentRoute

1.3.4.1.22 Document.Exist

1.3.4.1.23 Document.ExistSended

1.3.4.1.24 Document.List

1.3.4.1.25 Document.Package v.2

1.3.4.1.26 Document.PackageAdd v.2

1.3.4.1.27 Document.PackageDelete v.2

1.3.4.1.28 Document.Pdf

1.3.4.1.29 Document.Pdf v.2

1.3.4.1.30 Document.Recovery

1.3.4.1.31 Document.Reject

1.3.4.1.32 Document.RejectAvoidanceRequest v.2

1.3.4.1.33 Document.RequestClarification

1.3.4.1.34 Document.Revoke

1.3.4.1.35 Document.SearchByParams

1.3.4.1.36 Document.SelfRoute

1.3.4.1.37 Document.Send

1.3.4.1.38 Document.SetFavorite

100

1.3.4.1.39 Document.Sign

101

1.3.4.1.40 Document.Trash

102

1.3.4.1.41 Document.UpdateContent v.2

103

1.3.4.1.42 Document.CancelPrintTasks v.2

104

1.3.4.2 Получение информации о документе

105

1.3.4.2.1 Document.Attributes

106

1.3.4.2.2 Document.Card

107

1.3.4.2.3 Document.Card v.2

108

1.3.4.2.4 Document.Cards v.2

109

1.3.4.2.5 Document.ChildCard v.2

115

1.3.4.2.6 Document.Comments v.2

116

1.3.4.2.7 Document.Content

117

1.3.4.2.8 Document.Content v.2

118

1.3.4.2.9 Document.Details

119

1.3.4.2.10 Document.DocumentProtocol

120

1.3.4.2.11 Document.DocumentRoute

121

1.3.4.2.12 Document.ExternalServices v.2

122

1.3.4.2.13 Document.GetIncompletePrintTaskInfoList v.2

123

1.3.4.2.14 Document.GetNextUserDocument

124

1.3.4.2.15 Document.GetPdfByTaskId v.2

125

1.3.4.2.16 Document.GetProperty v.2

126

1.3.4.2.17 Document.GetPropertyDescription

127

1.3.4.2.18 Document.GetPropertyValue v.2

128

1.3.4.2.19 Document.GetSignatureDetails

129

1.3.4.2.20 Document.GetSignatures

130

1.3.4.2.21 Document.History v.2

131

1.3.4.2.22 Document.PackageDetails v.2

132

1.3.4.2.23 Document.Print v.2

133

1.3.4.2.24 Document.RejectedComment

134

1.3.4.2.25 Document.RoamingInfo

135

1.3.4.2.26 Document.TransportTicket

136

1.3.4.2.27 Document.TechnologicalTicket

138

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

140

1.3.4.3.1 DelayedDispath.Add v.2

141

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

142

1.3.5.1 Ticket.Add

143

1.3.5.2 Ticket.CreateAcceptenceCertificateAcceptTicket

145

1.3.5.3 Ticket.CreateClarification

146

1.3.5.4 Ticket.CreateClarificationNotice

147

1.3.5.5 Ticket.CreatePriRasxAdditionalInfoTicket v.2

148

1.3.5.6 Ticket.CreateReply

149

1.3.5.7 Ticket.CreateTorg12AcceptTicket

150

1.3.5.8 Ticket.DocumentReply v.2

151

1.3.5.9 Ticket.GetTicketIdList

152

1.3.5.10 Ticket.Index

153

1.3.5.11 Ticket.Unreplied v.2

154

1.3.5.12 Tickets.Ticket

155

1.3.5.13 Tickets.Tickets

156

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

157

1.3.6.1 events-index

158

1.3.6.2 GetDocumentEvents

159

1.3.6.3 GetLastEventId

160

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

161

1.3.7.1 CorrelationEvent.Create v.2.0

162

1.3.7.2 CorrelationEvent.Events v.2.0

163

1.3.7.3 CorrelationEvent.Subscriptions v.2.0

164

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

165

1.3.8.1 Subscription.Add v.2.0

166

1.3.8.2 Subscription.DeleteEvents v.2.0

168

1.3.8.3 Subscription.DeleteEvent v.2.0

169

1.3.8.4 Subscription.Delete v.2.0

170

1.3.8.5 Subscription.Events.Totals v.2.0

171

1.3.8.6 Subscription.Events v.2.0

172

1.3.8.7 Subscription.GetSubscriptionDetails v.2.0

173

1.3.8.8 Subscription.GetSubscriptions v.2.0

174

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

175

1.3.9.1 TypeDocument v.2

176

1.3.9.2 TypeDocument.Code v.2

177

1.3.9.3 TypeDocument.Id v.2

178

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

179

1.3.10.1 Classifier.ClassifierValues

180

1.3.10.2 Classifier.GetClassifiers

181

1.3.10.3 Classifier.Template

182

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

183

1.3.11.1 Dictionary.Signer

184

1.3.11.2 Dictionary.UserCertificate

185

1.3.11.3 Dictionary.UserInfo

186

1.3.11.4 Helper.RoleList

187

1.3.11.5 Helper.GroupList

188

1.3.11.6 Helper.UserIdByLogin

189

1.3.11.7 Helper.UserList

190

1.3.11.8 User.AddCertificate

191

1.3.11.9 User.AddGroup v.2

192

1.3.11.10 User.AddRole v.2

193

1.3.11.11 User.AddUser

195

1.3.11.12 User.Certificate v.2

196

1.3.11.13 User.LockUser

197

1.3.12 Вспомогательные методы

198

1.3.12.1 VerifyDetachedSignature v.2

199

1.3.12.2 Version

200

1.3.13 Методы для работы с МЧД

201

1.3.13.1 Mchd.ValidateMchd v.2

202

1.3.13.2 Mchd.ValidateMchdByTicket v.2

204

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

205

1.4.1 AcceptanceCertificateAcceptInfo

209

1.4.2 AcceptanceCode

210

1.4.3 AcceptanceValuesInformation

211

1.4.4 AdditionalComments

212

1.4.5 Address

214

1.4.6 AddDocumentCommentRequest

215

1.4.7 AdminDocumentCard

216

1.4.8 ApiDocumentFilter

218

1.4.9 ApiUser

220

1.4.10 ArrayOflong

222

1.4.11 Attachment

223

1.4.12 Barcode

224

1.4.13 BuyerSeller

225

1.4.14 CardsInfo

227

1.4.15 CashLiabilityInfo

228

1.4.16 Certificate

229

1.4.17 ChangeDocumentUserModel

231

1.4.18 Classifier

232

1.4.19 ClassifierTemplate

233

1.4.20 ClassifierValue

234

1.4.21 Client

235

1.4.22 ClientDiscovery

236

1.4.23 ClientEdiCode

237

1.4.24 ClientQuery

238

1.4.25 ClientRelation

239

1.4.26 ClientRelationDocumentType

241

1.4.27 ClientSearchInfo

242

1.4.28 ClientShortInfo

243

1.4.29 Company

244

1.4.30 ShipperConsignee

246

1.4.31 ContractorDocumentTypes

248

1.4.32 ClientRelationDocumentTypeInfo

249

1.4.33 CorrectionInvoice

250

1.4.34 CorrectionInvoiceRow

253

1.4.35 CreateClarificationNoticeRequest

255

1.4.36 CreatePaymentOrderForEmailRequest

256

1.4.37 CreateUcdRequest

257

1.4.38 CreateUpdCorrectionInvoiceRequest

263

1.4.39 CreateUpdInfoRequestModel

269

1.4.40 Credentials

270

1.4.41 CreditRequest

271

1.4.42 CreditRequestLine

272

1.4.43 CreditTransaction

273

1.4.44 DateRange

274

1.4.45 DelayedDispatch

275

1.4.46 DetachedSignatureVerificationRequest

277

1.4.47 Document

278

1.4.48 DocumentAudit

282

1.4.49 DocumentBatch

283

1.4.50 DocumentCard

286

1.4.51 DocumentEvent

289

1.4.52 DocumentEvents

290

1.4.53 DocumentHistory

292

1.4.54 DocumentPackage

294

1.4.55 DocumentPropertyDescriptionInfo

295

1.4.56 DocumentRef

296

1.4.57 DocumentRefEx

297

1.4.58 DocumentRelation

298

1.4.59 DocumentRoamingInfo

299

1.4.60 DocumentRouteEditSimpleModel

301

1.4.61 DocumentRouteStage

303

1.4.62 DocumentSearchArguments

305

1.4.63 DocumentSign

306

1.4.64 DocumentSigner

308

1.4.65 DocumentSignerInfo

310

1.4.66 DocumentType

312

1.4.67 DocumentTypeClientRelationApi

313

1.4.68 DzoDeal

314

1.4.69 DzoDealDraft

315

1.4.70 DzoDealService

316

1.4.71 DzoDealUpdateData

317

1.4.72 DzoDealUpdateRequest

318

1.4.73 ExceptionDetails

319

1.4.74 ExternalServiceData

320

1.4.75 FileContent

321

1.4.76 FilterField

323

1.4.77 Filters

324

1.4.78 FindAbonentByRuleRequest

325

1.4.79 FindAbonentByRuleResponse

326

1.4.80 FolderFilter

327

1.4.81 ForeignAddress

328

1.4.82 GARAdress

329

1.4.83 Group

330

1.4.84 HandoverInfo

331

1.4.85 IndividualSignerInfo

332

1.4.86 INFAdress

333

1.4.87 Info

334

1.4.88 InfoField

335

1.4.89 InfoSigner

336

1.4.90 Invoice

337

1.4.91 InvoiceRow

342

1.4.92 KeyValueObject

344

1.4.93 LocalAddress

345

1.4.94 LogicalMessages

347

1.4.95 LogonResponse

348

1.4.96 LongKeyValue

349

1.4.97 MchdData

350

1.4.98 MchdFile

352

1.4.99 MchdPaper

353

1.4.100 OperationReason

354

1.4.101 OrganizationSignerInfo

355

1.4.102 PackageCard

356

1.4.103 PackageCardAdmin

359

1.4.104 PackageDocument

360

1.4.105 PackageDocumentAdmin

361

1.4.106 PaymentInfo

362

1.4.107 PaymentOrderStatusInfo

363

1.4.108 Person

364

1.4.109 PersonName

365

1.4.110 PhysicalSignerInfo

366

1.4.111 ProductGroup

367

1.4.112 ProductIdentificationNumber

368

1.4.113 Relation

369

1.4.114 RelationAssertRequest

371

1.4.115 RelationEvent

372

1.4.116 RelationInfo

373

1.4.117 RelationInfoDocumentType

376

1.4.118 RelationRequest

377

1.4.119 RelationRequestDetails

378

1.4.120 Role

381

1.4.121 RoleFilter

382

1.4.122 RoleWithPrivilege

383

1.4.123 PriRasxAdditionalInfo

384

1.4.124 Privilege

385

1.4.125 SearchResult

386

1.4.126 SetUserGroupRequest

387

1.4.127 SetUserRoleRequest

388

1.4.128 ShipmentDocumentRequisites

389

1.4.129 Shipper

390

1.4.130 Signature

391

1.4.131 SignatureDetails

394

1.4.132 SignatureWithTicket

395

1.4.133 SignedContent

397

1.4.134 Signer

400

1.4.135 SignerAuthority

401

1.4.136 SignerInfo

402

1.4.137 SignatureMchdIdentify

403

1.4.138 Stage

404

1.4.139 StateInformationLabelingSystem

405

1.4.140 StateOrderInfo

406

1.4.141 StringKeyValue

408

1.4.142 StringResult

409

1.4.143 Subscription

410

1.4.144 SubscriptionRequest

411

1.4.145 TaskInfoModel

412

1.4.146 TextInfo

413

1.4.147 Ticket

414

1.4.148 TicketContent

415

1.4.149 TicketDetails

416

1.4.150 TicketInfo

418

1.4.151 TicketFilter

420

1.4.152 TicketIdListRequest

421

1.4.153 Torg12AcceptInfo

422

1.4.154 TraceableProductInformation

424

1.4.155 TraceableProductInformationCorr

425

1.4.156 UcdCorrectionInvoice

426

1.4.157 UcdEventContent

433

1.4.158 UcdInvoiceInfo

434

1.4.159 UcdInvoiceRevisionInfo

435

1.4.160 UniversalDocumentAcceptInfo

436

1.4.161 UpdCorrectionInvoice

437

1.4.162 UpdEconomyContent

443

1.4.163 UpdInfo

444

1.4.164 User

449

1.4.165 UserAdminFilter

450

1.4.166 UserDetails

451

1.4.167 UserIdentity

453

1.4.168 UserInfoForAdmin

454

1.4.169 UserLogin

455

1.4.170 VersionInfo

456

1.4.171 Warrant

457

1.4.172 WarrantIssuer

458

1.4.173 WarrantSubject

459

1.5 Перечисления

460

1.5.1 AcceptanceDocumentType

462

1.5.2 AcceptanceResultCode

463

1.5.3 AccessType

464

1.5.4 Actions

465

1.5.5 BarcodeType

467

1.5.6 BusinessProcessType

468

1.5.7 ClientMode

469

1.5.8 CompanyType

470

1.5.9 CreditTransactionStatusType

471

1.5.10 DirectDebitPaymentStatus

472

1.5.11 Directories

473

1.5.12 DocumentCommentVisibility

474

1.5.13 DocumentDirection

475

1.5.14 DocumentEventType

476

1.5.15 DocumentFolder

478

1.5.16 DocumentFormType

479

1.5.17 DocumentRelationType

481

1.5.18 DocumentStatus

482

1.5.19 DzoDealState

483

1.5.20 DzoDealType

484

1.5.21 EdiCodeType

485

1.5.22 ExtendedDocumentType

486

1.5.23 LiabilityCashType

488

1.5.24 Participant

489

1.5.25 RelationRequestSide

490

1.5.26 RelationRequestStatus

491

1.5.27 RelationType

492

1.5.28 RequestRelationStatus

493

1.5.29 RequestStatus

494

1.5.30 RoamingStatus

495

1.5.31 RoleType

496

1.5.32 SignerRole

497

1.5.33 SignerStatus

498

1.5.34 SignerType

499

1.5.35 StateOrderPaymentType

500

1.5.36 TicketPurpose

501

1.5.37 TransportDocumentType

502

1.5.38 CorrelationEventType

505

1.5.39 UserDirectory

506

1.6 Справочная информация

507

1.6.1 Типовые задачи, примеры

508

1.6.1.1 Аутентификация по логину/паролю

509

1.6.1.2 Поиск контрагента и определение идентификатора участника ЭДО

510

1.6.1.3 Получение списка активных контрагентов

511

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

512

1.6.1.5 Действия над документами

513

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

514

1.6.1.5.2 Добавление приложения к документу в статусе "Черновик"

517

1.6.1.5.3 Подписание документа и продвижение документа дальше по маршруту

518

1.6.1.5.4 Определение наличия документа на обработку

519

1.6.1.5.5 Скачивание документа, подписи

522

1.6.1.6 Обмен типовыми документами

523

1.6.1.6.1 Неструктурированные документы

524

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

526

1.6.1.6.3 Товарная накладная

530

1.6.1.6.4 Акт выполненных работ

532

1.6.1.6.5 Подтверждающий документ для ГОЗ

533

1.6.1.6.6 Универсальный передаточный документ Счет-фактура

534

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

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

538

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

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

541

1.6.2 Коды типов документов

544

История изменений

Изменения в версии

129.0

Изменения в версии

123.0

Изменения в версии

122.0

Изменения в версии

121.0

Изменения в версии

120.0

Изменения в версии

118.0

Изменения в версии

115.0

Изменения в версии

113.0

Изменения в версии

112.0

Изменения в версии

111.0

Изменения в версии

110.0

Изменения в версии

109.0

Изменения в версии

108.0

Изменения в версии

107.0

Изменения в версии

105.0

Изменения в версии

104.0

Изменения в версии

100.0

Изменения в версии

99.0

Изменения в версии

97.0

Изменения в версии

94.0

Изменения в версии

90.0

Изменения в версии

85.0

Изменения в версии

84.0

Изменения в версии

81.0

Изменения в версии

80.0

Изменения в версии

74.0

Изменения в версии

73.0

Изменения в версии

72.0

Изменения в версии

69.0

Изменения в версии

68.0

Изменения в версии

67.0

Изменения в версии

66.0

Изменения в версии

64.0

Изменения в версии

63.0

Изменения в версии

60.0

Изменения в версии

57.0

Изменения в версии

53.0

Изменения в версии

49.0

Изменения в версии

46.0

Изменения в версии

44.0

Изменения в версии

41.0

Изменения в версии

40.0

Изменения в версии

39.0

Изменения в версии

37.0

Изменения в версии

36.0

Изменения в версии

35.0

Изменения в версии

34.0

Изменения в версии

32.0

Изменения в версии

29.0

Изменения в версии

28.0

Изменения в версии

27.0

Изменения в версии

26.0

Изменения в версии

24.0

Изменения в версии

21.1

Изменения в версии

21.0

Изменения в версии

20.0

Изменения в версии

19.0

Изменения в версии

18.0

Изменения в версии

17.1

Изменения в версии

16.0

Изменения в версии

14.0

Изменения в версии

13.2

Изменения в версии

13.0

Изменения в версии

12.1

Изменения в версии 12.0

Изменения в версии 11.0

Изменения в версии 10.0

Изменения в версии 9.0

Изменения в версии 8.0

Изменения в версии 7.1

Изменения в версии 7.0

Изменения в версии 129.0

Новый параметр UID, содержащий уникальный идентификатор документа, добавлен в структуры для методов:

Invoice - во входные параметры для метода Document.CreateInvoice;

UniversalDocumentAcceptInfo - во входные параметры для метода Document.AcceptTitle v.2.

Изменения в версии 123.0

Добавлен новый метод Document.CancelPrintTasks v.2 для удаления задач из очереди на асинхронную печать документа.

Изменения в версии 122.0

Добавлены новые методы:

Ticket.CreateClarificationNotice - для создания УОУ без ограничения длины комментария (комментарий в теле запроса);

Document.GetIncompletePrintTaskInfoList v.2 - для получения информации о задачах в очереди на асинхронную печать

(статусы: "создан", "в очереди").

Добавлены структуры:

CreateClarificationNoticeRequest - тело запроса для создания УОУ методом Ticket.CreateClarificationNotice;

TaskInfoModel - выходная информация о незавершенных задачах по печати документов для метода Document.

GetIncompletePrintTaskInfoList v.2.

Новый параметр MchdInn, содержащий ИНН доверителя, добавлен в структуру SignatureMchdIdentify (Информация об МЧД)

параметра Chain (Цепочка МЧД).

Новый параметр MchdInn, содержащий ИНН доверителя, добавлен в структуры для методов:

DocumentSign - в выходные параметры для метода Document.GetSignatures;

Signature - в выходные параметры для методов Tickets.Ticket и Tickets.Tickets;

Signature - во входные параметры для методов Document.AcceptAvoidanceRequest v.2, Document.Add, Document.AddBatch

, AddAndAccept и AddAndSend;

SignatureWithTicket - во входные параметры для методов Document.Sign, SignWithRouteUpdate;

SignedContent - во входные параметры для методов Document.Accept, AcceptWithRouteUpdate, Document.

AvoidanceRequest v.2, Document.RejectAvoidanceRequest v.2, Document.RequestClarification, RequestClarificationWithRouteU

pdate, Ticket.Add.

Внесены изменения в в существующих методах и структурах в части приказа № ЕД-7-26/970@:

1. Для метода Document.CreateInvoice изменена структура входных параметров (структуры данных Invoice): добавлен новы

й параметр в виде структуры ProductGroup для документа по приказу № ЕД-7-26/970@, изменены структуры BuyerSeller,

Shipper, Consignee, ShipperConsignee, InvoiceRow[], DocumentSignerInfo[] и связанные с ними структуры.

Метод создает документ типа UPD_SF по формату приказа № ММВ-7-15/820@ или приказа № ЕД-7-26/970@ в зависимости от

значений во входных параметрах FormatVersion, FormatCode и Date.

если значение FormatVersion не передано и Date больше или равно 31.12.2019, то для FormatCode по-умолчанию

указывается значение 1115131, УПД формируется по формату приказа № ММВ-7-15/820@.

если FormatVersion = 5.01, то вне зависимости от Date для FormatCode по-умолчанию указывается значение 1115131,

УПД формируется по формату приказа № ММВ-7-15/820@.

если FormatVersion = 5.02 и Date больше или равно 08.03.2024, то для FormatCode по-умолчанию указывается значение

1115131, УПД формируется по формату приказа № ЕД-7-26/970@.

При этом в зависимости от формата необходимо передавать соответствующие данные структуры Invoice.

2. Для метода Document.ChangeSigner v.2 изменена обязательность заполнения поля "SignerType" во входных параметрах (за

полняется только для документов типа УПД по формату приказа № ММВ-7-15/820@). Сведения о доверенности (MchdData)

отображаюется непосредственно в структуре DocumentSigner.

3. Для метода Document.AcceptTitle v.2 изменена структура входных параметров (структура данных DocumentSignerInfo) в

соответствии с приказом № ЕД-7-26/970@.

Изменения в версии 121.0

Для передачи информации о цепочке передоверия МЧД добавлен новая структура SignatureMchdIdentify - цепочка МЧД.

Новая структура SignatureMchdIdentify в виде параметра Chain добавлена в выходные параметры методов:

Document.GetSignatures - в структуру DocumentSign;

Tickets.Ticket - в структуру Signature;

Tickets.Tickets - в структуру Signature.

Новая структура SignatureMchdIdentify в виде параметра Chain добавлена во входные параметры методов:

Document.AcceptAvoidanceRequest v.2 - в структуру Signature;

Document.Add - в структуру Signature;

Document.AddBatch - в структуру Signature;

AddAndAccept - в структуру Signature;

AddAndSend - в структуру Signature;

Document.Sign - в структуру SignatureWithTicket;

SignWithRouteUpdate - в структуру SignatureWithTicket;

Document.Accept - в структуру SignedContent;

AcceptWithRouteUpdate - в структуру SignedContent;

Document.AvoidanceRequest v.2 - в структуру SignedContent;

Document.RejectAvoidanceRequest v.2 - в структуру SignedContent;

Document.RequestClarification - в структуру SignedContent;

RequestClarificationWithRouteUpdate - в структуру SignedContent;

Ticket.Add - в структуру SignedContent.

Изменения в версии 120.0

В параметры запроса метода отправки документа на печать Document.Print v.2 добавлен параметр isPdfWithStamp (Признак

печати документа со штампом).

Изменения в версии 118.0

Для метода отправки документа на печать Document.Print v.2 добавлен HTTP-код возврата: 400 - Превышено количество

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

Во входные параметры методов Document.GetSignatures, Tickets.Ticket и Tickets.Tickets добавлен параметр isMchdAsMeta

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

МЧД была передана в виде файла (пакета).

Добавлена новая группа методов для работы с МЧД:

Mchd.ValidateMchd v.2 - метод получения результата проверки МЧД (по бизнес-правилам ЭДО);

Mchd.ValidateMchdByTicket v.2 - метод получения результата проверки МЧД по идентификатору транспортного документа

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

Изменения в версии 115.0

Во входные параметры методов Document.GetSignatures, Tickets.Ticket и Tickets.Tickets добавлен параметр isMchdAsFile

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

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

Добавлены новые методы:

Document.Print v.2 - метод для подготовки ПФ в HeavyTask;

Document.GetPdfByTaskId v.2 - метод для проверки готовности/возврата ПФ.

Изменения в версии 113.0

Для обеспечения указания множества счетов-фактур/ исправлений счетов-фактур при создании коррректировочного счета-

фактуры добавлены новые структуры, которые используются в структуре UcdCorrectionInvoice запроса на создание УКД.КСЧФ,

УКД.ДИС или УКД.КСЧФДИС (CreateUcdRequest) из упрощенной модели для метода Document.CreateUcdDocument (создание УКД.

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

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

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

фактура.

В метод замены подписанта в черновике документа Document.ChangeSigner v.2 в структуру DocumentSigner добавлены поля

структуры MchdData.

В методы API, которые в качестве входных параметров принимают сведения о МЧД, добавлено ограничение - прикрепление

только одного типа МЧД (либо МЧД в виде файла, либо в виде метаданных): Document.Add, Document.AddBatch, AddAndAccept, A

ddAndSend, Document.Sign, SignWithRouteUpdate, Document.Accept, AcceptWithRouteUpdate, Document.Document.

RequestClarification, RequestClarificationWithRouteUpdate, Ticket.Add, Document.AvoidanceRequest v.2, Document.

RejectAvoidanceRequest v.2, Document.AcceptAvoidanceRequest v.2. В случае попытки одновременного прикрепления двух типов

МЧД методы возвращает ошибку: « Укажите один тип МЧДª.

Изменения в версии 112.0

Уточнение для метода Ticket.Add - метод используется для добавления только следующих типов квитанций:

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

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

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

1. Accept - метод для действия «Принять документª. Добавляет титул покупателя/титул заказчика.

2. RequestClarification - метод для действия «Отклонить документª (в случае если документооборот подразумевает

отклонение документа с формированием «Уведомления об уточненииª). Добавляет квитанцию «Уведомление об

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

3. Document.RejectAvoidanceRequest v.2 - метод для действия «Отклонить полученное предложение об аннулированииª.

Добавляет квитанцию «Уведомление об уточненииª для квитанции «Предложение об аннулированииª.

4. Document.AvoidanceRequest v.2 - метод для действия «Предложить аннулированиеª. Добавляет квитанцию

«Предложение об аннулированииª.

Изменения в версии 111.0

Добавлен новый метод RelationCorrelated v.2, который возвращает список активных взаимосвязей по параметрам: ИНН/КПП

контрагента, ИдУчЭДО контрагента или идентификатора взаимосвязи.

Добавлены структуры:

RelationInfo - информация по взаимосвязи;

RelationInfoDocumentType - информация о типах документов по взаимосвязи.

Изменение в TicketPurpose - из перечисления удалены значения типов квитанций, которые не добавляются методом Ticket.Add.

Изменение для метода Ticket.Add - метод используется для добавления только следующих типов квитанций:

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

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

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

Изменение для метода Document.CreateAvoidanceRequestClarificatio - в тело запроса добавлен параметр data (данные по МЧД

для создания квитанций)

Изменения в версии 110.0

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

CorrelationEvent.Events v.2.0 - возвращает информацию о существующих в ленте событиях по взаимосвязям компании;

CorrelationEvent.Create v.2.0 - создает подписку на события по взаимосвязям для определенной компании;

CorrelationEvent.Subscriptions v.2.0 - возвращает информацию о существующих подписках на ленту событий по

взаимосвязям компании;

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

CorrelationEventType - типы событий по взаимосвязи.

Во входные параметры методов Ticket.CreateReply и Ticket.CreateClarification добавлена структура MchdData для указания

данных по МЧД.

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

Сведения в МЧД можно загружать только при использовании сертификата ФЛ.

Изменения в версии 109.0

В структуры DocumentSign, Signature, SignatureWithTicket, SignedContent добавлены параметры:

MchdUuid - идентификатор МЧД;

MchdAccessMode - сведения об информационной системе, осуществляющей хранение МЧД;

MchdFileName - название файла МЧД;

MchdFile - содержимое файла МЧД;

MchdSignature - содержимое файла подписи МЧД.

При передаче данных по МЧД нужно передать либо MchdUuid c MchdAccessMode, либо данные по файлам

(MchdFileName, MchdFile, MchdSignature).

Данные параметры используются в качестве выходных для методов: Document.GetSignatures, Tickets.Ticket, Tickets.Tickets.

Данные параметры используются в качестве входных для методов: Document.AcceptAvoidanceRequest v.2, Document.Add, Docume

nt.AddBatch, AddAndAccept, AddAndSend, Document.Sign, SignWithRouteUpdate, Document.Accept, AcceptWithRouteUpdate, Docume

nt.AvoidanceRequest v.2, Document.RejectAvoidanceRequest v.2, Document.RequestClarification, RequestClarificationWithRouteUpdate

, Ticket.Add.

Изменения в версии 108.0

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

по формату, соответствующему приказу ФНС от 12.10.2020 № ЕД-7-26/736@.

Добавлены структуры:

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

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

Изменения в версии 107.0

В список расширенных типов документов ExtendedDocumentType добавлены документы:

ReceiveNotificationOfAcceptDocument - Извещение о получении документа покупателя (титул покупателя);

ReceiveConfirmationOfSpecifyingDocument - Подтверждение получения дополнительного документа;

SendConfirmationOfSpecifyingDocument - Подтверждение даты отправки дополнительного документа;

SendConfirmationOfSpecifyingDocumentForOperator - Подтверждение даты отправки

дополнительного документа, направляемое в адрес оператора;

ReceiveNotificationOfSpecifyingDocument - Извещение о получении дополнительного документа.

Изменения в версии 105.0

В структуру ClientEdiCode метода v2.0 client.ediCode добавлен признак работы через 1С - параметр IsOneCHub, который может

принимать значения: Null - нет информации; False - не работает; True - работает.

Изменения в версии 104.0

В структуре RelationRequestDetails изменены параметры:

OperatorCode - код оператора ЭДО получателя запроса;

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

Изменения в версии 100.0

Добавлен новый метод v2.0 client.ediCodes, который возвращает список всех идентификаторов участника ЭДО контрагента.

Изменения в версии 99.0

Для метода Document.AcceptTitle v.2 параметр AcceptanceCode структуры UniversalDocumentAcceptInfo обязателен в случае,

когда имя файла титула продавца имеет в своем составе префикс ON_NSCHFDOPPRMARK_доп.

Изменения в версии 97.0

Запрос метода Relation.AddDocumentType v.2 дополнен возможностью добавления/редактирования параметра "Код участника

ЭДО" для типа документа исходящего направления в существующей активной взаимосвязи между контрагентами.

В методе RelationRequest.AddRequest v.2 добавлена проверка наличия у организации, создающей взаимосвязь, доп. параметра

"Запрет настройки роуминговой взаимосвязи (исходящий)".

В перечисление TransportDocumentType добавлены новые типы транспортных документов UpdSvrk (Документ, включающий в

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

(принципала). Документ с функцией СвРК) и UpdSvzk (Документ, включающий в себя сведения о факте закупки комиссионером

(агентом, действующим от собственного имени) товаров для комитента (принципала). Документ с функцией СвЗК).

Изменения в версии 94.0

В структуру Invoice метода Document.CreateInvoice добавлены сведения о документах об отгрузке - параметр ShipmentDocument

Requisites.

Изменения в версии 90.0

Добавлена структура ShipmentDocumentRequisites - документы об отгрузке.

Изменения в версии 85.0

Добавлена новая структура SubscriptionRequest - запрос на создание подписки.

В параметры запроса метода Subscription.Add v.2.0 добавлена структура SubscriptionRequest.

Изменения в версии 84.0

В структуру RelationRequest добавлены параметры:

OperatorCode - код оператора ЭДО;

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

В структуру RelationRequestDetails добавлены параметры:

OperatorCode - код оператора ЭДО;

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

Изменения в версии 81.0

Добавлен новый метод Document.TechnologicalTicket, который возвращает информацию по технологической квитанции,

сформированной Оператором Маркировки, в виде набора элементов: Контент Технологической квитанции в BASE64, Имя файла

и Тип данных.

В перечисление DocumentEventType добавлены значения:

SentToMarkingOperator - документ отправлен Оператору Маркировки;

.TechTicketReceived - от Оператора Маркировки получена Технологическая квитанция.

Изменения в версии 80.0

Добавлен новый метод Document.TransportTicket, который возвращает информацию и содержимое транспортной квитанции от

ЦРПТ в виде структуры.

Добавлена структура StateInformationLabelingSystem - информация от ГИС МТ (Государственная информационная система

мониторинга товаров "Честный знак") по транспортной квитанции.

Добавлена структура logicalMessages - логическое сообщение в транспортной квитанции от ЦРПТ.

Изменения в версии 74.0

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

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

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

Добавлена структура AcceptanceValuesInformation - сведения по итогам приемки ценностей.

Добавлена структура SignerInfo - сведения о подписанте.

Добавлена структура PhysicalSignerInfo - сведения о подписанте - физическом лице.

Добавлена структура IndividualSignerInfo - сведения о подисанте - ИП.

Добавлена структура OrganizationSignerInfo - сведения о подписанте - ЮЛ.

Добавлена структура Info - информационное поле: Идентификатор + Значение.

Добавлено перечисление SignerRole - область полномочий подписанта.

Добавлено перечисление SignerStatus - статус подписанта.

В перечисление TransportDocumentType добавлено значение:

Contract - тип транспортного документа - договор.

Изменения в версии 73.0

В перечисление TransportDocumentType добавлено значение:

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

В перечисление ExtendedDocumentType добавлено значение:

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

В перечисление Actions добавлено значение:

AddAdditionalInfo - признак возможности добавления Дополнительных сведений.

Изменения в версии 72.0

В перечисление ExtendedDocumentType добавлены значения:

AvoidanceRequestAcceptSignature - подпись к предложению об аннулировании.

Изменения в версии 69.0

Добавлен новый метод Document.RoamingInfo, который по ID документа возвращает информацию о статусе отправки документа

и связанных с ним квитанций/подписей в виде структуры DocumentRoamingInfo.

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

/подписей в роуминге.

Добавлено перечисление RoamingStatus - статусы отправки в роуминг Транспортного документа / Подписи.

В структуру Invoice добавлены параметры:

FormatCode - код формата документа;

CircumstancesInvoiceFormation - обстоятельства формирования счета-фактуры, применяемого при расчетах по налогу на

добавленную стоимость. Возможные значения: 1, 2, 3.

В структуру PaymentInfo добавлен параметр Sum - сумма платежно-расчетного документа.

В структуру InvoiceRow добавлены параметры:

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

ProductIdentificationNumbers - номер средств идентификации товаров.

Добавлена структура TraceableProductInformation - сведения о товаре, подлежащем прослеживаемости.

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

Изменения в версии 68.0

В структуре CorrectionInvoice поле InvoiceDate может быть не заполнено.

Добавлен новый метод Document.UpdateContent v.2, который изменяет основной файл, к уже созданному документу в статусе

"Черновик".

Изменения в версии 67.0

В структуру Document добавлен параметр FormateCode - Код формата документов.

В структуру ApiDocumentFilter добавлена параметр Attributes - атрибуты документа в виде структуры KeyValueObject для поиска

документа методом Document.List по значению атрибута.

При использовании методов Document.Add и Document.AddBatch рекомендовано в элемент Date (Дата документа) и в элемент

Content (Содержимое документа при работе со структурированным документом), передавать идентичные значения параметра

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

Изменения в версии 66.0

В структуру ApiDocumentFilter добавлены параметры:

Take - размер страницы. Максимальное количество отображаемых документов.;

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

Изменения в версии 64.0

В структуру ApiDocumentFilter добавлен параметр FileName - имя файла.

Изменения в версии 63.0

В структуру DocumentHistory добавлен параметр UserTitle - должность пользователя.

Добавлен новый метод Document.ExternalServices, который возвращает информацию добавленную внешними сервисами в виде

текстовой строки в формате JSON.

В структуру UserDetails внесены изменения:

удалены параметры: DirectoryName, IsSbbol, Inn, Kpp;

переименован параметр с BranchDocflowAccessable на DirectoryName BranchDocflowAccessable.

Изменения в версии 60.0

Для метода Document.AcceptTitle v.2 в структуру UniversalDocumentAcceptInfo добавлены параметры в виде структур:

AcceptanceCode - код содержания операции;

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

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

Для структуры AcceptanceCode добавлены перечисления:

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

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

Новая структура StateOrderInfo содержит набор параметров и структуру CashLiabilityInfo (Информацию для сведений о денежном

обязательстве).

Для структуры CashLiabilityInfo добавлено перечисление LiabilityCashType - вид средств денежного обязательства.

Для структуры StateOrderInfo добавлено перечисление StateOrderPaymentType - вид платежа закупок для государственных и

муниципальных нужда.

Изменения в версии 57.0

Добавлены новые методы:

User.AddGroup v.2 - для добавления пользователя в группу;

User.AddRole v.2 - для добавления роли пользователю.

Изменения в версии 53.0

В структуру Subscription добавлены параметры:

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

UserId - идентификатор пользователя, создавшего подписку.

Для метода Subscription.Add v.2.0 добавлен входной необязательный параметр isRestricted - признак подписки с ограниченным

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

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

При выполнении методов Subscription.DeleteEvents v.2.0, Subscription.DeleteEvent v.2.0, Subscription.Delete v.2.0, Subscription.

Events.Totals v.2.0, Subscription.Events v.2.0 осуществляется проверка доступа к подписке.

Изменения в версии 49.0

Из перечисления DocumentFolder удалено значение Archive.

Изменения в версии 46.0

Добавлен новый метод TypeDocument v.2 для получения списка всех типов документов для компании.

Удален метод Relation.DeleteRelation v.2.

Изменения в версии 44.0

В структуру Invoice добавлен параметр IdContract - Идентификатор государственного контракта.

Для метода Document.CreateInvoice параметр IdContract обязателен, если Date 01.07.2017.

Изменения в версии 41.0

Для метода Document.CreateInvoice добавлено условие создания документа с типом Счёт-фактура/ УПД.СЧФ из упрощенной

модели счета-фактуры в зависимости от даты, указанной во входном параметре Date:

Если дата < 01.07.2017, то тип документа - Счет-фактура

Если дата 01.07.2017, то тип документа - УПД.СЧФ.

В структуру Invoice добавлен параметр DocumentSignerInfo (информация о подписанте), обязательный если Date

01.07.2017.

В структуре InvoiceRow параметры NetSum и VatSum обязательные, если Date

01.07.2017 (т.к. тип документа - УПД.СЧФ).

Добавлено дополнительное условие в метод Document.Add - если элемент Date

01.07.2017, а элемент TypeCode принимает

значение SF, значение SF заменяется на UPD_SF.

В структуру DocumentCard добавлен возможный код документа UPD_SF.

Изменения в версии 40.0

В параметры запроса методов добавлен необязательный параметр ediCode - ID участника ЭДО компании. Изменения в методах:

AcceptDocument

AddDocument

AddTicket

CreateAcceptenceCertificateAcceptTicket

CreateClarification

CreateReplyTicket

CreateTorg12AcceptTicket

GetSignatures

GetTickets

Pdf

RejectDocument

RequestClarification

Tickets

Для метода Document.AddAttachment добавлено условие доступности добавления дополнительного приложения - наличие

признака "Дополнительное приложение" для типа документа.

Добавлен новый метод Document.Cards v.2 для получения информации по произвольному списку документов.

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

Добавлен новый метод Ticket.Unreplied v.2 для получения списка неотвеченных квитанций..

Добавлена новая структура TicketFilter - фильтр поиска по квитанциям.

Добавлен новый метод Ticket.DocumentReply v.2

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

Изменения в версии 39.0

Изменения в библиотеке eds.api.public.dll:добавлен метод GetSubscriptionEventsWithTotalsByCount аналог

метода GetSubscriptionEventsWithTotals.

В структуре DocumentSignerInfo изменено наименование поля: InfoSigner на Signer.

В методе Document.AcceptTitle v.2 изменено наименование параметра запроса: AcceptInfo на UniversalDocumentAcceptInfo.

Изменения в версии 37.0

Добавлен новый метод Subscription.Events.Totals v.2.0 для получения событий по заданной подписке с количеством событий.

Добавлена новая структура:

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

Изменения в версии 36.0

В структуру DocumentSigner добавлено новое поле Name - краткое наименование организации.

Из структуры UserDetails удалены поля Thumbprint , CertificateBegin, CertificateEnd, Certificate.

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

Добавлены новые структуры:

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

DocumentSignerInfo - информация о подписанте;

InfoSigner - подписант документа;

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

Изменения в версии 35.0

В перечисление Actions добавлено значение:

SignReceiveNtfcOfDoc - признак возможности подписания квитанции ИОП.

В перечисление TransportDocumentType добавлены значения:

DocumentOfTransferOfWorkResultsPerformerInfo - документ о передаче результатов работ. Информация исполнителя;

DocumentOfTransferOfWorkResultsCustomerInfo - документ о передаче результатов работ. Информация заказчика;

DocumentOfTransferOfGoodsSellerInfo - документ о передаче товаров при торговых операциях. Информация продавца;

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

Изменения в версии 34.0

В перечисление DocumentEventType добавлено значение:

RestoredFromTrash - документ восстановлен из корзины.

В перечисление DocumentStatus добавлено значение:

WaitingForSend - документ ожидает отправки.

В структуру Document добавлено новое поле PackageId - идентификатор пакета, в котором находится документ.

Изменения в методе Document.AddBatch:

с помощью метода можно создавать пачку документов и сразу добавлять их в пакет;

добавлены поля:

CreatePackage - признак добавления документов в пакет;

PackageName - наименование пакета;

SendSync - признак единовременной отправки;

в возвращаемой структуре Document не указывается информация Relation.

Добавлены новые структуры:

DocumentPackage - модель добавляемого пакета;

PackageCard - карточка пакета;

PackageDocument - сведения о документе пакета.

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

Document.Package v.2 - объединяет существующие документы в пакет.

Document.PackageAdd v.2 - добавляет документы в существующий пакет.

Document.PackageDelete v.2 - исключает документы из существующего пакета.

Document.PackageDetails v.2 - получение сведений о составе пакета документов.

Изменения в версии 32.0

Добавлен метод v2.0/document/{documentId}/signer - заменяет подписанта в черновике документа.

Удален метод Document.ValidateX5Invoice ввиду переноса валидации непосредственно в метод Document.Add и переходом на

использование нового формата счета-фактуры (УПД).

Изменения в версии 29.0

В перечисление Action добавлено значение:

SignReplyTicket - признак необходимости подписания ответного титула, ранее сформированного.

В структуре SignedContent стали необязательны следующие поля:

Filename

MimeType

Content

В методе Document.Accept добавлен комментарий: Если в SignedContent передается только Signature (для файла обмена

покупателя), то подписывается файл обмена покупателя для УПД ДОП и УПД СЧФ ДОП.

Изменения в версии 28.0

Изменения в библиотеке Korus.Eds.Api:

Пакет RestSharp обновлён до версии 105.2.3

Пакет Newtonsoft.Json обновлён до версии 8.0.3

Во все методы API 2.0 добавлен возвращаемый параметр ErrorNumber - код ошибки.

Добавлен метод v2.0.client.{code} - возвращает информацию о клиенте по его идентификатору участника ЭДО в системе.

В перечисление Action добавлены значения:

AssignableToSelf

- признак возможности назначить документ себе в обработку;

AcceptWithoutSign - признак принятия с отказом в запрошенной подписи.

Изменения в методе v2.0.client.edi.code:

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

документа;

Удалены поля receiverI и documentTypeId.

Изменения в версии 27.0

В структуру Document возвращено поле ParticipantName.

Из структуры Company удалены поля Directories, IsLocal, OperatorId,

В структуру SearchResult добавлены поля: Created и TypeCode.

В ленту документов DocumentEventType добавлено событие "Отказ от подписи" - SignatureReject .

В перечисление Action добавлены значения:

PackageRouteSync - признак принадлежности документа к пакету с синхронизацией маршрутов;

RemoveFromPackage - пользователь может исключить документ из пакета.

Добавлена структура Client.

Добавлен метод v2.0.client.{id} - возвращает информацию о клиенте по его идентификатору в системе.

Изменения в версии 26.0

В структуру DocumentRouteStage внесено изменение:

1. Изменены наименования полей: UserIdDone на ProcessedById , UserNameDone на ProcessedByUsername.

2. Добавлено поле ProcessedByLogin.

В структуру DocumentType добавлены поля обязательности подписи:

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

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

В структуру AcceptanceCertificateAcceptInfo внесено изменение:

1. Изменено наименование поля: Message на Comment.

2. Добавлено поле "Претензия заказчика" - Claim .

В структуру Document возвращено поле IsMarked.

Изменения в версии 24.0

Для методов Document.Add, Document.Send и Document.Sign добавлены проверки:

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

2. Проверка на наличие обязательных атрибутов

3. Проверка на корректность ввода атрибутов с признаком «Значения только из справочникаª

В структуру данных ClassifierTemplate добавлен элемент IsSelectOnly

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

GetPropertyDescription

Изменения в версии 21.1

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

Добавлен метод отложенной отправки документа DelayedDispath.Add v.2

Добавлены методы для хранение и получение дополнительных параметров документов Document.AddProperty v.2, Docum

ent.GetProperty v.2, Document.GetPropertyValue v.2

Добавлена структура данных Subscription

Добавлена структура данных DelayedDispatch

Добавлена структура данных ClientShortInfo

Добавлена структура данных StringKeyValue

Добавлены новые параметры поиска идентификатора участника ЭДО получателя в метод v2.0 client.ediCode

Изменения в версии 21.0

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

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

Дополнена структура данных Credentials

Дополнена структура данных Stage

Дополнена структура данных DocumentRouteStage

Изменения в версии 20.0

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

Добавлен метод TypeDocument.Code v.2

Добавлен метод TypeDocument.Id v.2

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

Добавлен метод Document.ChildCard v.2

Добавлен метод Document.AddBatch

Добавлен метод Document.AddComment v.2

Добавлен метод Document.CreateAvoidanceRequestClarificationNotice v.2

Добавлен метод Document.AcceptAvoidanceRequest v.2

Добавлен метод Document.RejectAvoidanceRequest v.2

Добавлена структура данных DocumentBatch

Добавлена структура данных DocumentType

Добавлена структура данных AddDocumentCommentRequest

Добавлено перечисление DirectDebitPaymentStatus.

Изменения в версии 19.0

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

Добавлен метод Document.CreateAvoidanceRequest v.2

Добавлен метод Document.AvoidanceRequest v.2

Добавлен метод Ticket.CreateClarificationNotice v.2

Добавлен метод Ticket.AcceptAvoidanceRequest v.2

Изменения в версии 18.0

Из структуры Stage удалено поле TypicalStageId.

Изменения в версии 17.1

2015.04.13

В структуры Invoice и CorrectionInvoice внесены изменения:

Добавлено поле FormatVersion, оно определяет версию формата формируемого документа, допустимые значения 5.01 и

5.02, по умолчанию, в целях сохранения совместимости, используется версия 5.01;

В структуру InfoField внесено изменение:

Добавлена поддержка информационных полей нового формата (с идентификатором и значением). При формировании

документа для версии 5.01 используется поле Text, для версии 5.02 - поле TextInfo. Не допускается одновременное

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

будет пустым;

В структуры InvoiceRow и CorrectionInvoiceRow внесены изменения:

Из списка допустимых значений поля VatType убрано "20";

Добавлено множественное поле TextInfo в котором хранятся пары идентификатор/значение для информационного поля

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

В структуру Document внесено изменение:

Удалено поле SchemaVersionId.

В структуру Document внесено изменене:

Удалено поле SchemaVersionId.

Изменения в версии 16.0

2015.03.01

Изменены методы:

Изменен метод Document.Add: добавлена проверка на наличие прямого идентификатора ЭДО получателя id и отсутствии

признака IsRoaming.

Изменены методы Document.Add, Document.List, Document.Card: незначительно изменены форматы ответных XML:

внутри сущности <Document> -> <Content> теперь всегда будет указываться пустой тег <Content /> .

В структуру Document внесено изменение:

Добавлено поле PaymentStatus, определяет статус оплаты ЭСФ (по договору автоматической оплаты).

Добавлено перечисление DirectDebitPaymentStatus.

Изменения в версии 14.0

2014.10.24

Добавлены методы для работы с взаимосвязями:

Добавлен метод DeleteRelation.

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

Добавлен метод v2.0 client.ediCode.

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

Добавлен метод Document.History v.2.

Добавлены вспомогательные методы:

Добавлен метод VerifyDetachedSignature v.2.

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

Изменены методы:

Изменен метод Document.Accept: параметр id (идентификатор документа) в запросе сделан обязательным; в запрос

добавляется параметр ticket (подписанная квитанция) структуры SignedContent в случае , если требуется добавление

титула покупателя/титула заказчика.

Изменен метод Ticket.CreateClarification: сформированное УОУ далее необходимо подписать и добавить в Курьер методом

Document.RequestClarification.

Изменен метод Ticket.GetTicketIdList: поиск регистронезависимый. Возвращает массив идентификаторов транспортных

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

Изменен метод Ticket.CreateTorg12AcceptTicket: титул покупателя необходимо подписать и добавить методом Document.

Sign.

Изменен метод User.AddCertificate: изменение логики-нельзя добавить пользователю компании без активного оператора

ЭДО.

Изменен метод User.AddUser: изменение логики-нельзя добавить пользователя одновременно с сертификатом, если у

компании нет активного прямого идентификатора ЭДО.

Изменены структуры данных:

Изменена структура данных Company: добавлены поля OperatorId, OperatorCode, FullName, RegistrationRequisites, IsLocal.

Изменена структура данных DocumentEvent: добавлены поля ExtendedTicketType, TicketType.

Изменения в версии 13.2

2014.09.10

Добавлены методы для работы с взаимосвязями:

Добавлен метод Relation.AddDocumentType v.2.

Добавлен метод Relation.DeleteDocumentType v.2.

Добавлен метод RelationRequest.Accept v.2.

Добавлен метод RelationRequest.AddRequest v.2.

Добавлен метод RelationRequest.DeleteRequest v.2.

Добавлен метод RelationRequest.ListRequest v.2.

Добавлен метод RelationRequest.Reject v.2.

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

Добавлен метод v2.0.client.self.

Добавлен метод v2.0.client.

Добавлен метод v2.0.client.discover.

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

Добавлен метод Document.Card v.2: добавлен новый вариант метода.

Добавлен метод Document.Content v.2: добавлен новый вариант метода.

Добавлен метод Document.Comments v.2.

Изменения в версии 13.0

2014.07.10

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

Добавлен метод Ticket.GetTicketIdList.

Изменения в версии 12.1

2014.03.25

Добавлен метод Document.Attributes.

Изменения в версии 12.0

2014.01.16

Добавлено событие Revoked в перечисление DocumentEventType.

2014.01.20

Добавлен метод Document.DocumentProtocol.

2014.01.31

Добавлен метод User.AddUser.

Добавлен метод User.AddCertificate.

Добавлен метод User.LockUser.

2014.03.01

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

Изменён метод User.AddUser: на вход подаётся структура ApiUser.

2014.03.04

Добавлен метод Helper.RoleList.

2014.03.12

Изменен метод Ticket.Index: возврат списка квитанций на которые пользователю надо сформировать ответ (NeedReply =

true).

Изменения в версии 11.0

2013.11.07

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

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

Добавлен метод Dictionary.ContractorDocumentTypes.

2013.12.03

Изменен метод Ticket.CreateClarification: определение формата УОУ по идентификатору транспортного пакета

Изменен метод Ticket.CreateReply: определение формата ИОП по идентификатору транспортного пакета

2013.12.07

Добавлен метод Document.AddAttachment.

Добавлен метод Document.Attachment.

Изменены методы Document.Card, Document.Details: добавлена возможность получать приложения к документу без

содержимого.

2013.12.28

Изменена структура данных DocumentCard: добавлено поле RequestSign

Изменения в версии 10.0

2013.10.16

Добавлено событие DeliveredForReciever в перечисление DocumentEventType.

Изменения в версии 9.0

2013.08.02

Добавлена возможность имперсонализироваться под другим пользователем компании (Общая информация).

2013.08.09

Изменена структура данных ApiDocumentFilter: добавлены поля IsMine, UserId и RoleId.

2013.08.19

Добавлен метод Document.Attributes.

2013.09.25

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

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

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

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

Добавлено перечисление RoleType.

Добавлен метод Helper.GroupList.

Добавлен метод Helper.UserList.

Добавлен метод Helper.UserIdByLogin.

Добавлен метод Document.EditDocumentRoute.

2013.10.02

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

Добавлен метод Document.DocumentRoute.

2013.10.08

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

Добавлен метод Document.RejectedComment.

Изменения в версии 8.0

2013.07.10

В структуре DocumentCard добавлено свойство Attributes.

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

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

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

Добавлено перечисление Participant.

Добавлен метод Classifier.Template.

Добавлен метод Classifier.ClassifierValues.

Изменения в версии 7.1

2013.06.13

Добавлен метод Document.ChangeRoute.

Добавлен метод Document.Accept.

Добавлен метод Document.Reject.

Добавлен метод Document.Revoke.

Добавлен метод Document.AcceptRevoke.

Добавлен метод Document.Trash.

Добавлен метод Document.Recovery.

Добавлен метод Document.Delete.

Добавлен метод Document.SetFavorite.

Добавлен метод Document.SelfRoute.

2013.06.20

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

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

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

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

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

Добавлен метод Ticket.CreateTorg12AcceptTicket.

Добавлен метод Ticket.CreateAcceptenceCertificateAcceptTicket.

2013.06.25

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

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

Изменён метод Document.Sign: добавлена возможность загружать титул покупателя (ТОРГ-12) и титул заказчика (Акт).

2013.07.03

Структура Folders изменена на DocumentFolder и дополнена.

Изменения в версии 7.0

Изменена структура данных TicketDetails, теперь вместо одиночной подписи содержится массив элементов Signature.

Изменена структура данных Signature, поле Signer переименовано в SignerCode, добавлено поле Uuid.

Все методы в случае возврата не 200 HTTP-кода возвращают ExceptionDetails.

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

метода.

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

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

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

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

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

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

Добавлено перечисление UserDirectory.

Изменён метод Dictionary.FindClient: если контрагент не найден, возвращается null вместо ошибки 404.

Изменён метод Dictionary.UserCertificate: если у пользователя нет зарегистрированного сертификата, возвращается Except

ionDetails.

Изменен метод Document.ExistSended: проверяет наличие уникального документа, удовлетворяющего условиям:

1. от текущего отправителя;

2. не отклоненный и не отозванный;

3. не находящийся в корзине.

Добавлен метод Dictionary.Client.

Добавлен метод Document.AddRelation.

Добавлен метод Document.Pdf.

Добавлен метод Tickets.Tickets.

Добавлен метод Version.

Добавлен метод Document.ValidateX5Invoice.

В структуру User добавлены свойство Uid, Login.

В структуре Certificate удалено свойство Issuer, добавлено поле CspType.

В структуре Document добавлены свойства ParticipantId, ParticipantName, StatusName, IsMarked, Relations.

В структуре DocumentCard добавлено свойство Barcode.

Общая информация

API - набор готовых классов, процедур, функций, структур и констант, предоставляемых приложением (библиотекой, сервисом)

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

API СФЕРА Курьер позволяет выполнять следующие действия:

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

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

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

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

аннулировать, отклонять) и квитанциями;

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

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

По предоставленным данным автоматически создавать ЭСФ и КЭСФ нужного формата;

Настраивать и управлять маршрутами документов внутри организации;

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

Формат запросов

В текущей версии API, чтобы получить json в ответ надо добавить в заголовок запроса:

Content-Type: application/json

в версии 2 API (там где методы начинаются на v2) json выдаётся по умолчанию. Там наоборот, чтобы получить xml надо в

запросе добавить

заголовок:

Accept: application/xml

ВАЖНО!

При воспроизведении запросов в XML важен порядок указания параметров запроса.

ВАЖНО!

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

ВАЖНО!

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

заголовок Thumbprint, в который надо передавать отпечаток сертификата целевого пользователя.

Пример имперсонализованного вызова через библиотеку:

var client = new ComClient();

client.Thumbprint = "1231231231231232321";

client.Login(_username, _password);

client.DocumentAdd(

);

Авторизационный токен

ВАЖНО!

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

идентифицирующий пользователя, который возвращается после авторизации. Авторизационный токен - это id сессии, т.

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

информации с каждым запросом используется HTTP-заголовок - Auth-Token.

Ниже представлен простой пример запроса к тестовому серверу.

URL запроса: http://courier-test.esphere.ru/api/dictionary/findClient

HTTP Метод: POST

Headers:

Content-Type: application/xml

Auth-token: 12E33AE704161856F7716E9CA12DC3B29498A16F0F...

Data:

<Inn>XXXXXXXXXX</Inn

<kpp>XXXXXXXXX</kpp

Фрагментация токена

Начиная с версии 14, появилась возможность передавать авторизационный токен фрагментированный на отдельные части: Auth

-Token-1, Auth-Token-2 и т.д.

В случае если в запросе отсутствует заголовок Auth-Token, то система пытается собрать токен из заголовков Auth-Token-1, Auth

-Token-2 и т.д.

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

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

Logon

URL: /api/auth/logon

HTTP Method: POST

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

Элемент

Тип

Описание

credentials

Credentials

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

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

Данный токен требуется добавить в HTTP-заголовок для дальнейшей работы с методами.

ВАЖНО!

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

заголовок Thumbprint, в который надо передавать отпечаток сертификата целевого пользователя.

У пользователя который имперсонализируется через HTTP-заголовок Thumbprint, обязательно должна быть включена

роль "Имперсонализация"

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

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

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

401 - доступ запрещен (логин и пароль или apikey заданы неверно или пользователь зарегистрирован в более чем одной

организации - филиальной структуре и требуется указание ид. уч. ЭДО);

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

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

Группа

Метод

Описание

Получение

Dictionary.Client

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

информации о

клиенте

Dictionary.

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

ContractorDocumen

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

tTypes

Dictionary.

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

FindClient

v2.0.client

Получение списка организаций

v2.0.client.{code}

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

v2.0.client.

Получение юридического адреса организации по идентификатору организации

{clientId}.address.

legal

v2.0.client.discover

Получение информации о взаимосвязях клиентов по ИНН (КПП)

v2.0 client.ediCode

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

v2.0 client.ediCodes

Получение списка всех идентификаторов участника ЭДО контрагента

v2.0.client.{id}

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

v2.0.client.self

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

Получение информации о клиенте

Метод

Описание

Dictionary.Client

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

Dictionary.

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

ContractorDocumentTyp

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

Dictionary.FindClient

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

v2.0.client

Получение списка организаций

v2.0.client.{code}

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

v2.0.client.{clientId}.

Получение юридического адреса организации по идентификатору организации

address.legal

v2.0.client.discover

Получение информации о взаимосвязях клиентов по ИНН (КПП)

v2.0 client.ediCode

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

v2.0 client.ediCodes

Получение списка всех идентификаторов участника ЭДО контрагента

v2.0.client.{id}

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

v2.0.client.self

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

v2.0.client.discover

Поиск клиентов по ИНН и КПП

URL: v2.0/client/discover

HTTP Method: POST

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

массив информации по искомым компаниям (заполняется только ИНН и КПП) в виде структуры данных ClientDiscovery

Элемент

Тип

Описание

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

Inn

string

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

Kpp

string

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

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

XML

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

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

<Inn>sample string 1</Inn>

<Kpp>sample string 2</Kpp>

</ClientDiscovery>

<Inn>sample string 1</Inn>

<Kpp>sample string 2</Kpp>

</ClientDiscovery>

</ArrayOfClientDiscovery>

JSON

[

{

"inn": "sample string 1",

"kpp": "sample string 2"

{

"inn": "sample string 1",

"kpp": "sample string 2"

}

]

Данный метод доступен для вызова всем пользователям.

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

взаимосвязям этих клиентов в виде структуры данных ClientRelation

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

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

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

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

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

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

v2.0 client.ediCode

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

URL: v2.0/client/ediCode?receiverId={receiverId}&documentTypeId={documentTypeId} - поиск по идентификатору получателя.

Параметры URL:

Элемент

Тип

Описание

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

receiverId

integer

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

documentTypeId

integer

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

URL: v2.0/client/ediCode?inn={inn}&kpp={kpp}&documentTypeCode={documentTypeCode}&hasRelation={hasRelation} - поиск по

ИНН / КПП получателя

Параметры URL:

Элемент

Тип

Описание

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

inn

string

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

kpp

string

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

documentTypeCode

string

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

hasRelation

boolean

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

документа.

HTTP Метод: GET

Возвращаемые значения:

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

Для поиска по ИНН / КПП получателя в зависимости от признака hasRelation:

hasRelation = False или отсутствует во входных параметрах (если hasRelation в запросе отсутствует, то по умолчанию

назначается значение False.) - в случае успешного выполнения запроса, возвращает идентификатор участника ЭДО получателя

в виде структуры ClientEdiCode.

hasRelation = True:

если найдена одна компания, возвращает идентификатор участника ЭДО найденной компании в виде структуры ClientEdi

Code;

если найдено больше одной компании, возвращает ошибку:«ER-12012: Параметрам поиска удовлетворяет более одной

организацииª

если не найдена ни одна компания, возвращает ошибку «ER12410 - Не найдена организация с ИНН {0}, КПП {1}»

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

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

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

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

Relation.AddDocumentType v.2

Добавляет/редактирует Идентификатор участника ЭДО для типа документа исходящего направления в существующей активной

взаимосвязи между контрагентами.

URL: v2.0/relation/{id}/documentType/{documentTypeId}?ediCode={ediCode}

HTTP Method: PUT

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

Элемент

Тип

Описание

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

integer

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

documentTypeId

integer

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

ediCode

string

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

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

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

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

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

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

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

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

ER-12422: Идентификатор участника ЭДО {0} не активен или отсутствует;

ER-20005 - Невозможно редактирование заблокированной взаимосвязи {Идентификатор взаимосвязи}.

RelationCorrelated v.2

Возвращает список взаимосвязей по параметрам.

URL: v2.0/relation/correlated

HTTP Method: POST

Тело запроса:

Элемент

Тип

Описание

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

Inn

string

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

Kpp

string

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

EdiCode

string

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

integer

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

При запросе в формате XML родительский элемент в теле запроса должен быть CorrelatedListByParamRequest.

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

Body - ИНН контрагента / КПП контрагента

{

"inn": "XXXXXXXXXX",

"kpp": "XXXXXXXXX"

}

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

{

"EdiCode": "2BK-390103073895-9459"

}

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

{

"Id": 1132682

}

Body - ИНН контрагента / КПП контрагента

<Inn>XXXXXXXXXX</Inn>

<Kpp>XXXXXXXXX</Kpp>

</CorrelatedListByParamRequest>

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

</CorrelatedListByParamRequest>

RelationRequest.AddRequest v.2

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

URL: v2.0/relation-request

HTTP Method: PUT

Тело запроса:

Данные о клиенте в виде структуры данных RelationRequest.

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

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

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

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

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

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

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

участника ЭДО", или "по умолчанию" в карточке контрагента прямой роуминговый "Идентификатор участника ЭДО", то

для организации, создающей запрос на взаимосвязь, доп. параметр "Запрет настройки роуминговой взаимосвязи

(исходящий)" не должен быть установлен.

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

ER-12305: Контрагенту было отправлено приглашение ранее;

ER-20005: Для организации запрещено создавать роуминговые запросы на взаимосвязь. Обратитесь к администратору системы.

RelationRequest.ListRequest v.2

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

URL: v2.0/relation-request

HTTP Method: GET

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

Элемент

Тип

Описание

Размер

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

Query

string

Подстрока поиска объектов по контрагенту и ИНН

Side

RelationReq

Сторона запроса

uestSide

Participant

integer

Идентификатор клиента второй стороны

Status

RelationReq

Статус клиента

uestStatus

Inn

string

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

10-12

IsRoaming

boolean

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

DateFrom

date

Начало периода создания запроса

DateTo

date

Окончание периода создания запроса

Filter

FilterField

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

Skip

integer

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

Take

integer

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

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

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

период времени, в виде структуры данных RelationRequestDetails

При указании поля Take обязательно указывать Skip.

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

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

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

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

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

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

Группы

Метод

Описание

Действия над

Document.Accept

Принятие документа

документом

Document.

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

AcceptAvoidanceRequest v.2

Document.AcceptRevoke

Подтверждение отзыва документа

Document.AcceptTitle v.2

Создает новую форму для выбранного типа документа

Document.Add

Создание документа в статусе "Черновик"

Document.AddAttachment

Добавление приложения к документу в статусе "Черновик"

Document.AddBatch

Добавление пачки документов в систему

Document.AddComment v.2

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

Document.AddRelation

Добавление связи между документами

Document.Attachment

Печать в attachment

Document.AvoidanceRequest

Отправка предложения об аннулировании документа

v.2

Document.ChangeRoute

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

Document.ChangeSigner

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

Document.

Формирование запроса на предложение об аннулировании документа

CreateAvoidanceRequest v.2

Document.

Формирование ответной квитанции - отказа от предложения об

CreateAvoidanceRequestClarifi

аннулировании документа (УОУ)

cationNotice v.2

Document.

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

CreateCorrectionInvoice

Document.CreateInvoice

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

Document.Delete

Удаление документа

Document.EditDocumentRoute

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

Document.Exist

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

Document.ExistSended

Проверка наличия уникального документа, удовлетворяющего условиям:

1) от текущего отправителя;

2) не отклоненный и не отозванный;

3) не находящийся в корзине.

Document.List

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

Document.Package v.2

Объединяет существующие документы в пакет.

Document.PackageAdd v.2

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

Document.PackageDelete v.2

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

Document.Pdf

Печать в pdf

Document.Recovery

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

Document.Reject

Отклонение документа

Document.

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

RejectAvoidanceRequest v.2

Document.RequestClarification

Отклонение документа и добавление уведомления об уточнении

Document.Revoke

Отзыв документа

Document.SearchByParams

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

Document.SelfRoute

Назначение документа себе в обработку

Document.Send

Отправка документа

Document.SetFavorite

Сохранение или удаление отметки "Избранный" на документе

Document.Sign

Подписание документа и продвижение документа дальше по маршруту

Document.Trash

Перемещение документа в корзину

Document.AddProperty v.2

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

Document.UpdateContent v.2

Изменяет основной файл к созданному документу в статусе "Черновик"

Получение

Document.Attributes

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

информации о

документе

Document.Card

Получение детальных данных по документу (без вложенного файла

документа)

Document.Card v.2

Получение детальных данных по документу (без вложенного файла

документа)

Document.Cards v.2

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

Document.ChildCard v.2

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

Document.Comments v.2

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

Document.Content

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

Document.Content v.2

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

Document.Details

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

документа)

Document.DocumentProtocol

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

pdf

Document.DocumentRoute

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

Document.

Получение информации о следующем пользователе на маршруте

GetNextUserDocument

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

Document.GetSignatureDetails

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

Document.GetSignatures

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

Document.History v.2

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

Document.PackageDetails v.2

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

Document.RejectedComment

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

Document.GetProperties v.2

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

Document.GetPropetryValue

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

v.2

ключу

Document.

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

GetPropertyDescription

документа

Document.TransportTicket

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

Отложенная

DelayedDispath.Add v.2

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

отправка/рассылка

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

Метод

Описание

Document.Accept

Принятие документа

Document.AcceptAvoidanceRequest v.2

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

Document.AcceptRevoke

Подтверждение отзыва документа

Document.AcceptTitle v.2

Создает новую форму для выбранного типа документа

Document.Add

Создание документа в статусе "Черновик"

Document.AddAttachment

Добавление приложения к документу в статусе "Черновик"

Document.AddBatch

Добавление пачки документов в систему

Document.AddComment v.2

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

Document.AddRelation

Добавление связи между документами

Document.Attachment

Печать в attachment

Document.AvoidanceRequest v.2

Отправка предложения об аннулировании документа

Document.ChangeRoute

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

Document.ChangeSigner v.2

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

Document.CreateAvoidanceRequest v.2

Формирование запроса на предложение об аннулировании документа

Document.

Формирование ответной квитанции - отказа от предложения об аннулировании

CreateAvoidanceRequestClarificationNotice v.2

документа (УОУ)

Document.CreateCorrectionInvoice

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

Document.CreateInvoice

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

Document.Delete

Удаление документа

Document.EditDocumentRoute

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

Document.Exist

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

Document.ExistSended

Проверка наличия уникального документа, удовлетворяющего условиям:

1) от текущего отправителя;

2) не отклоненный и не отозванный;

3) не находящийся в корзине.

Document.List

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

Document.Package v.2

Объединяет существующие документы в пакет.

Document.PackageAdd v.2

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

Document.PackageDelete v.2

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

Document.Pdf

Печать в pdf

Document.Pdf v.2

Печать в PDF

Document.Recovery

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

Document.Reject

Отклонение документа

Document.RejectAvoidanceRequest v.2

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

Document.RequestClarification

Отклонение документа и добавление уведомления об уточнении

Document.Revoke

Отзыв документа

Document.Accept

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

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

HTTP Method: POST

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

Элемент

Тип

Описание

long

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

Обязательно

документа

ticket

SignedC

Подписанная

Только если требуется добавление титула покупателя/титула заказчика.

ontent

квитанция

Если в SignedContent передается только Signature (для файла обмена покупателя), то

подписывается файл обмена покупателя для УПД ДОП и УПД СЧФ ДОП.

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

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

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

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

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

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

Не требуется подпись на этапе;

Пользователь - текущий участник этапа маршрута;

Документооборот еще не завершен.

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

ER-20105 - Документ не может быть передан получателю без ЭП. Пожалуйста, добавьте в маршрут согласования

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

Document.Add

Создаёт документ в статусе "Черновик".

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

HTTP Method: POST

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

Элемент

Тип

Размер

Описание

string

4-46

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

document

DocumentCard

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

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

Рекомендовано в элемент Date (Дата документа) и в элемент Content (Содержимое документа при работе со структурированным

документом), передавать идентичные значения Даты документа.

Если

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

и на первом этапе маршрута присутствует обязательность подписи,

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

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

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

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

взаимосвязь с контрагентом;

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

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

Если документ передаётся с подписью (document.Signature), то документ подписывается и продвигается дальше по

маршруту. Если подпись не передаётся, то документ сохраняется в статусе Черновик;

Системе известен контрагент с таким receiverCode;

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

Если документ является структурированным, то он должен соответствовать xsd-схеме;

Если элемент Date 01.07.2017, а элемент TypeCode принимает значение SF, значение SF заменяется на UPD_SF.

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

ER-20005 - Некорректное значение для обязательного атрибута: "{0}";

ER-12105 - Неизвестный абонент: {0};

ER-12109 - Не заполнены некоторые обязательные свойства добавляемого документа. (Обязательны к заполнению:

document.Date, document.Content.MimeType, document.Content.Filename, document.Content.Content);

ER-12104 - Неизвестный код типа документа: {0};

ER-12106 - {список ошибок при валидации документа}. (Документа не прошёл проверку на валидность.);

ER-12107 - Не настроена взаимосвязь с получателем {0} по типу документа {1};

ER-10101 - Ошибка при добавлении подписи документа, у пользователя не задан активный сертификат;

ER-10103 - Невозможно проверить ЭЦП у документа, т.к. в системе не зарегистрирован сертификат пользователя;

ER-12001 - Вы не можете подписать этот документ. (У документа не установлен флаг Actions.Sign (возможность

подписания документа));

ER-12108 - Подписание возможно только одновременно с формированием титула покупателя. (У документа установлен

флаг Actions.AcceptWithTicket, при этом документ не является ТОРГ-12 или Актом);

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

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

ticket.Signature);

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

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

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

причине);

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

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

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

Document.AddAttachment

Добавляет приложение к документу в статусе "Черновик".

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

HTTP Method: POST

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

Элемент

Тип

Размер

Описание

long

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

attachment

FileContent

Данные приложения

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

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

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

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

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

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

Приложение добавляется к документу если документ в статусе "Черновик";

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

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

ER-12119 - Приложение можно добавить только для документа с статусом "Черновик";

ER-20103 - Вы не имеете прав для просмотра этого документа;

ER-12408 - Для данного типа документа невозможно добавить дополнительное приложение;

ER-10333 - Имя файла {0} содержит запрещенные символы "/", "\", ":", "?", "*" или превышает 250 символов.

Document.AddBatch

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

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

HTTP Method: POST

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

Элемент

Тип

Размер

Описание

string

4-46

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

batch

DocumentBatch

Данные пачки документов

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

Элемент Relation не возвращается.

документом), передавать идентичные значения Даты документа.

Если

присутствует подпись под документом;

на первом этапе маршрута присутствует обязательность подписи,

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

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

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

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

взаимосвязь с контрагентом;

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

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

Если документ передаётся с подписью (document.Signature), то документ подписывается и продвигается дальше по

маршруту. Если подпись не передаётся, то документ сохраняется в статусе Черновик;

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

Системе известен контрагент с таким receiverCode;

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

Если документ является структурированным, то он должен соответствовать xsd-схеме;

Если документ имеет прямой идентификатор участника ЭДО и не передавался (должен передаться) в роуминге.

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

ER-20005 - Некорректное значение для обязательного атрибута: "{0}";

ER-12105 - Неизвестный абонент: {0};

ER-12109 - Не заполнены некоторые обязательные свойства добавляемого документа. (Обязательны к заполнению:

document.Date, document.Content.MimeType, document.Content.Filename, document.Content.Content);

ER-12104 - Неизвестный код типа документа: {0};

ER-12106 - {список ошибок при валидации документа} (документ не прошёл проверку на валидность);

ER-12107 - Не настроена взаимосвязь с получателем {0} по типу документа {1};

ER-10101 - Ошибка при добавлении подписи документа, у пользователя не задан активный сертификат;

ER-10103 - Невозможно проверить ЭЦП у документа, т.к. в системе не зарегистрирован сертификат пользователя;

ER-12001 - Вы не можете подписать этот документ. (У документа не установлен флаг Actions.Sign (возможность

подписания документа));

ER-12108 - Подписание возможно только одновременно с формированием титула покупателя. (У документа установлен

флаг Actions.AcceptWithTicket, при этом документ не является ТОРГ-12 или Актом);

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

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

ticket.Signature);

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

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

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

причине);

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

Document.ChangeRoute

Задает участника маршрута для заданного этапа маршрута.

URL: /api/document/changeRoute

HTTP Method: POST

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

Элемент

Тип

Размер

Описание

docId

long

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

stepNumber

int

Номер этапа маршрута.

string

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

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