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

SignerInfo

SignerInfo / Сведения о подписанте

Элемент

Тип

Размер

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

Описание

XPath

Physical

PhysicalSigner

Обязательно передать только

Физическое лицо

/Файл/Документ

Info

один из трех элементов

/Подписант/ФЛ

Individual

IndividualSign

Индивидуальный

/Файл/Документ

erInfo

предприниматель

/Подписант/ИП

OrganizationSigner

OrganizationSi

Организация (подписант)

/Файл/Документ

Info

gnerInfo

/Подписант/ЮЛ

PowersArea

SignerRole

Область полномочий

/Файл/Документ

(Enum)

подписанта

/Подписант/@ОблПолн

SignerStatus

Статус подписанта

/Файл/Документ

(Enum)

/Подписант/@Статус

PowersBase

string

1-255

Основание полномочий

/Файл/Документ

(доверия)

/Подписант/@ОснПолн

OrganizationPower

string

1-255

Основание полномочий

/Файл/Документ

sBasement

(доверия) организации

/Подписант/@ОснПолнОрг

Ticket.CreatePriRasxAdditionalInfoTicket v.2/ PriRasxAdditionalInfo

Примеры

{

"Individual":

{

"Inn": "XXXXXXXXXXXX",

"RegistrationRequisites": "353535XXXX",

"OtherInfo": " ",

"Person":

{

"LastName": "XXXXXXXXXX",

"FirstName": "XXXXXXXXXX",

"MiddleName": "XXXXXXXXXX"

}

"PowersArea": "21",

"SignerStatus": "1",

"PowersBase": " ",

"OrganizationPowersBasement": " 32"

}

402

SignatureMchdIdentify

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

Элемент

Тип элемента

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

Описание

MchdUuid

string

- *

Идентификатор МЧД.

MchdAccessMode

string

- *

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

MchdInn

string

- * **

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

MchdFileName

string

- *

Название файла МЧД

MchdFile

byte[]

- *

Содержимое файла МЧД

MchdSignature

byte[]

- *

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

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

(MchdFileName, MchdFile, MchdSignature)

** - MchdInn не обязательный параметр при передаче. В случае отсутствия будет использован ИНН компании текущего

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

403

Stage

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

Элемент

Тип данных

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

Описание

long?

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

Number

int

Номер этапа в маршруте.

RoleId

long

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

IsMandatory

bool

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

UserId

long?

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

UserLogin

string

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

Period

int

Срок подписания в рабочих днях.

Document.EditDocumentRoute/DocumentRouteEditSimpleModel

Примеры

<Stage>

</Stage>

404

StateInformationLabelingSystem

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

квитанции

Элемент

Тип

Описание

transportPackageHashAmount

string

Хэш сумма входящего ТП (ХэшТП)

transportPackageIdInternal

string

Идентификатор входящего ТП в ГИС МТ (ИдТПВнутренний)

logicalMessages

logicalMessages []

Логическое сообщение

processingError

string

Ошибка Обработки

Document.TransportTicket

Примеры

"stateInformationLabelingSystem": {

"transportPackageHashAmount": "gost3411-2012-256:f465798a011edfba991f414cfc8aac9...

47e41d74096dd35e8d86c72",

"transportPackageIdInternal": "UCMS000000000000000000XX-XXXX",

"logicalMessages": [

{

"technologicalTicketId": "UINT04TXMNGR0000000000000000XXXX-XXXX",

"logicalMessageIdExternal": "1b9e4d1c96274b24b73a4...563db80",

"logicalMessageIdInternal": "UUD000000000000000000XX-XXXX",

"fileId": "ON_NSCHFDOPPRMARK_2BK-2465310432-62289_2BK-7713026678-62288_20

-7F54-41D5-

B738- 350098DA22D4",

"documentId": "fa9db0efd9f743b48e1d

c5338f1"

{

"technologicalTicketId": "UINT04TXMNGR0000000000000000XXXX-XXXX",

"logicalMessageIdExternal": "3501e5fc8b734dfd96abd...d3857d9",

"logicalMessageIdInternal": "UUD000000000000000000XX-XXXX",

"fileId": "ON_NSCHFDOPPRMARK_2BK-2465310432-62289_2BK-7713026678-62288_20200727_

-0D69-

4DEF- A1E8-0628AEE7C7A1",

"documentId": "9da0a0d5a86f4a85ae

a9de8"

}

"processingError": null

}

405

StateOrderInfo

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

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

Элемент

Тип

Описание

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

OrderId

string

Идентификационный код закупки

BuyerPersonalAcc

string

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

FinAuthorityName

string

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

BuyerRegistryNumber

string

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

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

BuyerLiabilityNumber

string

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

TotalTerritorialTreas

string

Код территориального органа Федерального казначейства покупателя

uryCode

TotalTerritorialTreas

string

Наименование территориального органа Федерального казначейства покупателя

uryName

BuyerTotalTerritorial

string

Код покупателя в Общероссийском классификаторе территорий муниципальных

MunicipalityCode

образований

DeliveryTotalTerritori

string

Код места поставки в Общероссийском классификаторе территорий муниципальных

alMunicipalityCode

образований

FinalPaymentDate

date

Предельная дата оплаты

CashLiabilityNumber

string

Учетный номер денежного обязательства

PaymentOrder

string

Очередность платежа

PaymentType

StateOrderP

Вид платежа

aymentType

CashLiabilityInfo

CashLiability

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

Info[]

Document.AcceptTitle v.2/UniversalDocumentAcceptInfo

Примеры

"stateOrderInfo": {

"orderId": "sample string 8",

"buyerPersonalAcc": "sample string 9",

"finAuthorityName": "sample string 10",

"buyerRegistryNumber": "sample string 11",

"buyerLiabilityNumber": "sample string 12",

"totalTerritorialTreasuryCode": "sample string 13",

"totalTerritorialTreasuryName": "sample string 14",

"buyerTotalTerritorialMunicipalityCode": "sample string 15",

"deliveryTotalTerritorialMunicipalityCode": "sample string 16",

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

"cashLiabilityNumber": "sample string 17",

"paymentOrder": "sample string 18",

"paymentType": "4",

"cashLiabilityInfo": {

"sellerInfoNumber": 2,

"issueCode": "sample string 19",

"cashType": 1,

"buyerBudgetCode": "sample string 20",

"buyerPurposeCode": "sample string 21",

"advancePaymentSum": null

406

StringKeyValue

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

Элемент

Тип данных

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

Размер

Описание

Key

string

Ключ элемента.

Value

string

Значение элемента.

Document.Add/DocumentCard,

Document.AddBatch/DocumentBatch/DocumentCard,

Document.AddProperty v.2,

Document.GetProperty v.2

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

Примеры

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

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

<Key>sample string 1</Key>

<Value>sample string 2</Value>

</StringKeyValue>

<Key>sample string 1</Key>

<Value>sample string 2</Value>

</StringKeyValue>

</ArrayOfStringKeyValue>

[

{

"key": "sample string 1",

"value": "sample string 2"

{

"key": "sample string 1",

"value": "sample string 2"

}

]

408

Subscription

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

Элемент

Тип данных

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

Описание

Created

date

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

Token

string

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

string

Логин пользователя - создателя подписки

isRestricted

bool

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

UserId

long

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

Subscription.Add v.2.0,

Subscription.GetSubscriptionDetails v.2.0,

Subscription.GetSubscriptions v.2.0

Примеры

<Token>sample string 1</Token>

</Subscription>

{

token: "8F3B1A8A40C548D29EF8229399F572B6"

created: "2015-10-06T09:10:54.692125Z"

}

410

TaskInfoModel

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

Элемент

Тип

Описание

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

TaskId

integer

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

DocumentId

integer

ID документа

Created

date

Дата создания задачи

UserId

integer

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

Document.GetIncompletePrintTaskInfoList v.2

Примеры

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

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

</TaskInfoModel>

</TaskInfoModel>

</ArrayOfTaskInfoModel>

[

{

"taskId": 1,

"documentId": 2,

"created": "2024-03-28T14:48:18.4157235+03:00",

"userId": 1

{

"taskId": 1,

"documentId": 2,

"created": "2024-03-28T14:48:18.4157235+03:00",

"userId": 1

}

]

412

Ticket

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

Элемент

Тип данных

Описание

long

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

DocumentId

long

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

Uuid

string

UUID документа

ParentUuid

string

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

Direction

DocumentDirection

Направление квитанции

Type

TransportDocumentType

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

ExtendedType

ExtendedDocumentType

Расширенный тип документа

Date

DateTime

Дата формирования транспортного документа

Ticket.Index

Примеры

<Uuid>3db4eb39b5244e66b16

411da8</Uuid>

<ParentUuid>076a14f7552

eeca29229032a</ParentUuid>

<Type>ClarificationNotice</Type>

<ExtendedType>ClarificationNotice</ExtendedType>

</Ticket>

{id:584,documentId:1003,uuid:"3db4eb39b5244e

0d4411da8",parentUuid:"076a14f7552d4f9f9b

8eeca29229032a"

, direction:0,type:4,extendedType:9,date:"2012-12-10"}

414

TicketDetails

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

Элемент

Тип данных

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

Описание

long

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

DocumentId

long?

Идентификатор документа. Заполняется только для документов, не для квитанций.

Uuid

string

UUID документа

ParentUuid

string

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

Direction

DocumentDirection

Направление квитанции

Type

TransportDocumentType

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

ExtendedType

ExtendedDocumentType

Расширенный тип документа

Date

DateTime

Дата формирования транспортного документа

RootDate

DateTime

Дата формирования основного транспортного документа

Content

FileContent

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

Signature

Signature[]

Список подписей под документом.

NeedReply

bool

Признак того что на квитанцию необходим ответ.

Tickets.Ticket,

Tickets.Tickets

Примеры

<Type>SendConfirmation</Type>

<ExtendedType>SendConfirmation</ExtendedType>

<FileName>ON_SFAKT_1BK000012345678901_1BK000798546712397_20120601_693EAC6F-8878-497C-957E-C150BAD00E35.

xml</FileName>

<Content>MIIETTCCA/qgAwIBAgIKKEwQmQAAAAAAejAKBgYqhQMCAgMFADCBsDEfMB0GCSqG

OQ==</Content>

</Content>

<Content>MIIETTCCA/qgAwIBAgIKKEwQmQAAAAAAejAKBgYqhQMCAgMFADCBsDEfMB0GCSqG

OQ==</Content>

</TicketDetails>

{

id: 141107,

documentId: null,

uuid: "6f05c2841f8042ac83e8d5ff251fef9f",

parentUuid: "2fc9fe62f170461f8bee74f6e87ff288",

416

TicketInfo

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

Элемент

Тип данных

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

Описание

long

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

DocumentId

long?

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

Uuid

string

UUID документа

ParentUuid

string

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

Direction

DocumentDirection

Направление квитанции

Type

TransportDocumentType

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

ExtendedType

ExtendedDocumentType

Расширенный тип документа

Date

DateTime

Дата формирования транспортного документа

Filename

string

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

DocumentTypeName

string

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

DocumentDescription

string

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

SenderType

string

Отправитель (тип)

SenderName

string

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

ReplyType

TransportDocumentType

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

ReplyDocumentTypeNa

string

Наименование требуемой ответной квитанции

ReplyExtendedType

ExtendedDocumentType

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

(квитанции)

Status

DocumentStatus

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

ReplyExtendedTypeName

string

Наименование ответного транспортного документа (квитанции)

Ticket.Unreplied v.2

Примеры

<Uuid>6f05c2841f8042ac83e8d5f

f</Uuid>

<ParentUuid>2fc9fe62f170461f8b

7ff288</ParentUuid>

<Type>SendConfirmation</Type>

<ExtendedType>SendConfirmationOfReceiveNotificationOfDocument</ExtendedType>

<Filename>DP_PDOTPR_TST-9656011041-1442_TST_20171109_ffde8701-3

4-b296-2d2a9af40a78.xml</Filename>

</DocumentTypeName>

<DocumentDescription>. - UPD_SF09.11.2017 21:09:51

09.11.2017</DocumentDescription>

</SenderName>

<ReplyType>ReceiveNotice</ReplyType>

</ReplyDocumentTypeName>

<ReplyExtendedType>ReceiveNotificationOfSendConfirmationOfReceiveNotificationOfDocument</ReplyExtendedType>

<Status>Received</Status>

<ReplyExtendedTypeNamei:nil="true"/>

</TicketInfo>

418

TicketFilter

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

Элемент

Тип данных

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

Описание

ParticipantId

integer

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

DocumentTypeId

integer

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

DocumentNumber

string

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

From

date

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

date

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

Query

string

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

Skip

integer

Параметры постраничной выборки данных.

Take

integer

Параметры постраничной выборки данных.

Ticket.Unreplied v.2

Примеры

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

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

<DocumentNumber>sample string 1</DocumentNumber>

<Query>sample string 2</Query>

</TicketFilter>

{

"participantId": 1,

"documentTypeId": 1,

"documentNumber": "sample string 1",

"from": "2017-07-24T16:38:43.124375+03:00",

"to": "2017-07-24T16:38:43.124375+03:00",

"query": "sample string 2",

"skip": 3,

"take": 4

}

420

Torg12AcceptInfo

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

Элемент

Тип данных

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

Размер

Описание

Date

DateTime

Дата получения груза.

Comment

string

0-2000

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

Warrant

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

Acceptor

Signer

Груз принял.

Consignee

Signer

Груз получил.

Ticket.CreateTorg12AcceptTicket

Примеры

<LastName>XXXXXXXXXX</LastName>

<FirstName>XXXXXXXXXX</FirstName>

<MiddleName>XXXXXXXXXX</MiddleName>

</Person>

<Organization>XXXXXXXXXX</Organization>

</WarrantIssuer>

<LastName>XXXXXXXXXX</LastName>

<FirstName>XXXXXXXXXX</FirstName>

<MiddleName>XXXXXXXXXX</MiddleName>

</Person>

<Info>XXXXXXXXXX</Info>

</WarrantSubject>

</Warrant>

<LastName>XXXXXXXXXX</LastName>

<FirstName>XXXXXXXXXX</FirstName>

<MiddleName>XXXXXXXXXX</MiddleName>

</Person>

</Acceptor>

<LastName>XXXXXXXXXX</LastName>

<FirstName>XXXXXXXXXX</FirstName>

<MiddleName>XXXXXXXXXX</MiddleName>

</Person>

</Consignee>

</Torg12AcceptInfo>

422

TraceableProductInformation

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

Элемент

Тип

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

Размер

Описание

данных

AdditionalI

string

1-255

Дополнительный показатель для идентификации товаров, подлежащих

ndicator

прослеживаемости

TraceableP

string

3-4

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

roductUnit

прослеживаемости

TraceableP

decimal

N(26.11)

Количество товара в единицах измерения прослеживаемого товара

roductUnit

Amount

TraceableP

string

1-255

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

roductUnit

осуществления прослеживаемости

Name

ProductBat

string

27-29

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

chRegister

товаров до подачи декларации на товары (регистрационный номер декларации на

Number

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

присваиваемый налоговым (таможенным) органом товару, подлежащему

прослеживаемости

CostProduc

integer

N(19)

Стоимость товара, подлежащего прослеживаемости, без налога на добавленную

tUnitName

стоимость, в рублях (графа 14 счета-фактуры)

Document.CreateInvoice/ Invoice/ InvoiceRow

Примеры

<TraceableProducts ProductBatchRegisterNumber="" TraceableProductUnit="006"

TraceableProductUnitName="" AdditionalIndicator="" TraceableProductUnitAmount="5"

CostProductUnitName="23" />

"TraceableProducts": [{

"AdditionalIndicator": "",

"TraceableProductUnit": "006",

"TraceableProductUnitAmount": 5,

"TraceableProductUnitName": "",

"ProductBatchRegisterNumber": "",

"CostProductUnitName": "23"

}]

424

TraceableProductInformationCorr

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

Элемент

Тип

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

Размер

Описание

данных

AdditionalIndicator

string

1-255

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

подлежащих прослеживаемости

TraceableProductUnit

string

3-4

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

осуществления прослеживаемости

ProductBatchRegisterNumb

string

1-29

Регистрационный номер партии товаров

TraceableProductUnitAmou

decimal

26.11

Количество товара в единицах измерения прослеживаемого товара

ntBefore

TraceableProductUnitAmou

decimal

26.11

Количество товара в единицах измерения прослеживаемого

ntAfter

товара после изменения

Document.CreateInvoice/ Invoice/ InvoiceRow

Примеры

<TraceableProducts ProductBatchRegisterNumber="" TraceableProductUnit="006"

TraceableProductUnitAmountBefore="1" AdditionalIndicator="" TraceableProductUnitAmountAfter="5"

"TraceableProducts": [{

"AdditionalIndicator": "",

"TraceableProductUnit": "006",

"TraceableProductUnitAmountAfter": 5,

"TraceableProductUnitAmountBefore": "1",

"ProductBatchRegisterNumber": ""

}]

425

UcdCorrectionInvoice

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

Элемент

Тип

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

Размер

Описание

данных

FormatVersion

string

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

string

1-200

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

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

FormatCode

string

Код Формата Документа. Атрибут <КНД>

Значение = 1115133

DocumentFun

string

Функция документа.

ction

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

"UCD_CSF" , если создается документ

типа "UCD_CSF". Атрибут <Функция> будет равен "КСЧФ",

"UCD_CSF_DIC" , если создается документ

типа "UCD_CSF_DIC". Атрибут <Функция> будет равен "КСЧФДИС",

"UCD_DIC" , если создается документ

типа "UCD_DIC". Атрибут <Функция> будет равен "ДИС".

Number

string

1-256

Порядковый номер документа УКД

Date

DateTime

Дата составления документа УКД

InvoiceNumber

string

1000

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

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

InvoiceDate

DateTime

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

InvoiceRevisio

number

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

nNumber

InvoiceRevisio

DateTime

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

nDate

RevisionNumb

number

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

RevisionDate

DateTime

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

CurrencyCode

string

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

Seller

BuyerSeller

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

Buyer

BuyerSeller

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

Row

CorrectionInv

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

oiceRow[]

Info

InfoField

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

Invoices

UcdInvoiceInfo

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

[]

фактура

Document.CreateUcdDocument

Примеры

<Buyer>

426

<Address>Address</Address>

</Foreign>

<Local>

<Building>building</Building>

<District>District</District>

<House>House</House>

<Locality>Locality</Locality>

<Street>Street</Street>

</Local>

</Address>

<Name>

</Name>

</Individual>

</Organization>

</IdentificationInfo>

<Account>Account</Account>

<Bank>

<Account>Account</Account>

</Bank>

</Requisites>

</Buyer>

<Info>

</Info>

<InvoiceNumber>sample string 7</InvoiceNumber>

<InvoiceRevisionNumber>sample string 8</InvoiceRevisionNumber>

<InvoiceNumber>sample string 1</InvoiceNumber>

<InvoiceRevisionNumber>sample string 1</InvoiceRevisionNumber>

</UcdInvoiceRevisionInfo>

<InvoiceRevisionNumber>sample string 1</InvoiceRevisionNumber>

</UcdInvoiceRevisionInfo>

</InvoiceRevisions>

</UcdInvoiceInfo>

<InvoiceNumber>sample string 1</InvoiceNumber>

427

<InvoiceRevisionNumber>sample string 1</InvoiceRevisionNumber>

</UcdInvoiceRevisionInfo>

<InvoiceRevisionNumber>sample string 1</InvoiceRevisionNumber>

</UcdInvoiceRevisionInfo>

</InvoiceRevisions>

</UcdInvoiceInfo>

</Invoices>

<RevisionNumber>sample string 9</RevisionNumber>

<Rows>

<Info>sample string 6</Info>

<Name>sample string 1</Name>

<UnitAfter>sample string 3</UnitAfter>

<UnitBefore>sample string 2</UnitBefore>

<VatTypeAfter>sample string 5</VatTypeAfter>

<VatTypeBefore>sample string 4</VatTypeBefore>

1</CheckMarks>

2</CheckMarks>

</ProductIdentificationNumber>

1</CheckMarks>

2</CheckMarks>

</ProductIdentificationNumber>

</ProductIdentificationNumbersAfter>

1</CheckMarks>

2</CheckMarks>

</ProductIdentificationNumber>

1</CheckMarks>

2</CheckMarks>

</ProductIdentificationNumber>

428

</ProductIdentificationNumbersBefore>

<UcdTraceableProductInfo AdditionalIndicator="0000" ProductBatchRegisterNumber="

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

TraceableProductUnitAmountBefore="00">

</UcdTraceableProductInfo>

<UcdTraceableProductInfo AdditionalIndicator="0000" ProductBatchRegisterNumber="

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

TraceableProductUnitAmountBefore="00">

</UcdTraceableProductInfo>

</TraceableProducts>

</Rows>

<Rows>

<Info>sample string 6</Info>

<Name>sample string 1</Name>

<UnitAfter>sample string 3</UnitAfter>

<UnitBefore>sample string 2</UnitBefore>

<VatTypeAfter>sample string 5</VatTypeAfter>

<VatTypeBefore>sample string 4</VatTypeBefore>

1</CheckMarks>

2</CheckMarks>

</ProductIdentificationNumber>

1</CheckMarks>

2</CheckMarks>

</ProductIdentificationNumber>

</ProductIdentificationNumbersAfter>

1</CheckMarks>

2</CheckMarks>

</ProductIdentificationNumber>

1</CheckMarks>

2</CheckMarks>

</ProductIdentificationNumber>

</ProductIdentificationNumbersBefore>

<UcdTraceableProductInfo AdditionalIndicator="0000" ProductBatchRegisterNumber="

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

429

</UcdTraceableProductInfo>

<UcdTraceableProductInfo AdditionalIndicator="0000" ProductBatchRegisterNumber="

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

</UcdTraceableProductInfo>

</TraceableProducts>

</Rows>

<Address>Address</Address>

</Foreign>

<Local>

<Building>building</Building>

<District>District</District>

<House>House</House>

<Locality>Locality</Locality>

<Street>Street</Street>

</Local>

</Address>

<Name>

</Name>

</Individual>

</Organization>

</IdentificationInfo>

<Account>Account</Account>

<Bank>

<Account>Account</Account>

</Bank>

</Requisites>

</Seller>

</UcdCorrectionInvoice>

{

"UcdCorrectionInvoice": {

"formatVersion": "5.01",

"documentFunction": "UCD_DIC",

"FormatCode": "1115133",

"Number": "111",

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

"InvoiceNumber": "11111",

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

"InvoiceRevisionNumber": "222",

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

"Invoices": [

{

InvoiceNumber: 1,

InvoiceDate: 2023-02-10T12:46:06.747Z,

InvoiceRevisions:

[

{InvoiceRevisionNumber: 1, InvoiceRevisionDate: 2023-02-10T12:46:06.747Z}

430

]

}

]

"RevisionNumber": "13",

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

"CurrencyCode": "643",

"Seller": {

"IdentificationInfo": {

"Organization": {

"Name": " -",

"Inn": "5260418864",

"Kpp": "529001001"

}

"Address": {

"Local": {

"Zip": "603000",

"RegionCode": "52",

"District": null,

"City": " ",

"Locality": null,

"Street": " ",

"House": " 3",

"Building": null,

"Flat": " 15"

}

"Buyer": {

"IdentificationInfo": {

"Individual": {

"Inn": "351700096973",

"Name": {

"LastName": "",

"FirstName": "",

"MiddleName": ""

}

"Address": {

"Foreign": {

"CountryCode": "010",

"Address": ""

}

"Rows": [

{

"NAME": "",

"UNITBEFORE": "796",

"UNITAFTER": "796",

"AMOUNTBEFORE": 22,

"AMOUNTAFTER": 21,

"PRICEBEFORE": 100,

"PRICEAFTER": 100,

"NETSUMBEFORE": 2200,

"NETSUMAFTER": 2100,

"EXCISESUMBEFORE": 2,

"EXCISESUMAFTER": 1,

"VATTYPEBEFORE": "20%",

"VATTYPEAFTER": "20%",

"VATSUMBEFORE": 123123,

"VATSUMAFTER": 123,

"TOTALSUMBEFORE": 2200,

"TOTALSUMAFTER": 2100,

"INFO": "SOME IFNO",

"TRACEABLEPRODUCTS": [

{

"ADDITIONALINDICATOR": "1",

"TRACEABLEPRODUCTUNIT": "356",

"PRODUCTBATCHREGISTERNUMBER": "0747",

431

UcdEventContent

Содержание события (факта хозяйственной жизни) 3 - сведения о факте согласования (уведомления).

Элемент

Тип элемента

Размер

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

Описание

OtherCostInforma

string

1-255

Иные сведения об изменении стоимости

tion

TransferDocument

string

1-255

Реквизиты передаточных (отгрузочных) документов, к которым

относится корректировка

OperationContent

string

1-255

Содержание операции

Date

DateTime

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

Reasons

List<OperationReas

Основание корректировки

on>

433

UcdInvoiceInfo

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

Элемент

Тип данных

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

Размер

Описание

InvoiceNumb

string

1000

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

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

InvoiceDate

DateTime

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

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

InvoiceRevisi

UcdInvoiceRevisionIn

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

ons

fo[]

UcdCorrectionInvoice

CreateUcdDocument

Примеры

</UcdInvoiceRevisionInfo>

</InvoiceRevisions>

</UcdInvoiceInfo>

{

invoiceNumber: 1,

invoiceDate: 2023-02-10T12:46:06.747Z,

invoiceRevisions:

[

{invoiceRevisionNumber: 1, invoiceRevisionDate: 2023-02-10T12:46:06.747Z}

]

}

434

UniversalDocumentAcceptInfo

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

Элемент

Тип

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

Описание

Acceptanc

Обязателен если обрабатываем

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

eCode

УПД_ДОП, УПД_СЧФ_ДОП 970

приказа.

Date

date

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

DealSumm

string

Содержание операции

ary

Document

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

Signer

SignerInfo

[]

StateOrder

StateOrde

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

Info

rInfo

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

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

UID

string

Уникальный идентификатор документа

Document.AcceptTitle v.2

Примеры

{

"date": "2019-12-23T09:22:50",

"dealSummary": "",

"acceptanceCode": {

"resultCode": "1"

"documentSigner": [

{

"SignatureType": "1",

"SigningDate": "2024-03-14",

"AuthorityMethod": "1",

"LastName": "",

"FirstName": "",

"MiddleName": "",

"MchdPaper": "9ffc2744-ba4a-4227-90ce-442f265c8709"

}

]

}

436

UpdCorrectionInvoice

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

Элемент

Тип

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

Размер

Описание

данных

FormatVersion

string

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

string

1-255

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

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

FormatCode

string

1-7

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

Допустимые значения 1115127, 1115133

если значение не передано и Date ≤ 01.10.2021, то по умолчанию

указывается значение 1115127, УКД формируется по формату приказа 189

(176)

если значение не передано и Date > 01.10.2021, то по умолчанию

указывается значение 1115133, УКД формируется по формату приказа 736

Number

string

1-256

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

Date

DateTime

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

InvoiceNumb

string

1000

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

фактура

InvoiceDate

DateTime

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

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

InvoiceRevisi

number

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

onNumber

InvoiceRevisi

DateTime

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

onDate

RevisionNum

number

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

ber

RevisionDate

DateTime

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

CurrencyCode

string

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

Seller

BuyerSeller

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

Buyer

BuyerSeller

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

Rows

CorrectionInv

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

oiceRow[]

Info

InfoField

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

EventContent

UcdEventCon

Содержание события (факта хозяйственной жизни) 3 - сведения о факте

tent

согласования

(уведомления).

Примеры

<Buyer>

<Address>sample string 2</Address>

<CountryCode>sample string 1</CountryCode>

</Foreign>

437

<Local>

<Building>sample string 8</Building>

<City>sample string 4</City>

<District>sample string 3</District>

<Flat>sample string 9</Flat>

<House>sample string 7</House>

<Locality>sample string 5</Locality>

<RegionCode>sample string 2</RegionCode>

<Street>sample string 6</Street>

<Zip>sample string 1</Zip>

</Local>

</Address>

<Inn>sample string 1</Inn>

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

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

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

</Name>

</Individual>

<Inn>sample string 2</Inn>

<Kpp>sample string 3</Kpp>

<Name>sample string 1</Name>

</Organization>

</IdentificationInfo>

<Account>sample string 1</Account>

<Bank>

<Code>sample string 4</Code>

<Name>sample string 3</Name>

<Account>sample string 1</Account>

<City>sample string 2</City>

</Bank>

</Requisites>

</Buyer>

<CurrencyCode>sample string 9</CurrencyCode>

<OperationContent>sample string 3</OperationContent>

<OtherCostInformation>sample string 1</OtherCostInformation>

<DocumentName>sample string 1</DocumentName>

</OperationReason>

<DocumentName>sample string 1</DocumentName>

</OperationReason>

</Reasons>

<TransferDocument>sample string 2</TransferDocument>

</EventContent>

<Id>sample string 3</Id>

<Info>

<Id>sample string 1</Id>

<Id>sample string 1</Id>

<Value>sample string 2</Value>

</IdValuePair>

<Id>sample string 1</Id>

<Value>sample string 2</Value>

</IdValuePair>

</TextInfo>

<Text>sample string 2</Text>

</Info>

438

<InvoiceNumber>sample string 6</InvoiceNumber>

<InvoiceRevisionNumber>sample string 7</InvoiceRevisionNumber>

<Number>sample string 4</Number>

<RevisionNumber>sample string 8</RevisionNumber>

<Row>

<Info>sample string 6</Info>

<Name>sample string 1</Name>

<UnitAfter>sample string 3</UnitAfter>

<UnitBefore>sample string 2</UnitBefore>

<VatTypeAfter>sample string 5</VatTypeAfter>

<VatTypeBefore>sample string 4</VatTypeBefore>

1</CheckMarks>

2</CheckMarks>

</ProductIdentificationNumber>

1</CheckMarks>

2</CheckMarks>

</ProductIdentificationNumber>

</ProductIdentificationNumbersAfter>

1</CheckMarks>

2</CheckMarks>

</ProductIdentificationNumber>

1</CheckMarks>

2</CheckMarks>

</ProductIdentificationNumber>

</ProductIdentificationNumbersBefore>

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

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

</UcdTraceableProductInfo>

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

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

</UcdTraceableProductInfo>

439

</TraceableProducts>

</Row>

<Row>

<Info>sample string 6</Info>

<Name>sample string 1</Name>

<UnitAfter>sample string 3</UnitAfter>

<UnitBefore>sample string 2</UnitBefore>

<VatTypeAfter>sample string 5</VatTypeAfter>

<VatTypeBefore>sample string 4</VatTypeBefore>

1</CheckMarks>

2</CheckMarks>

</ProductIdentificationNumber>

1</CheckMarks>

2</CheckMarks>

</ProductIdentificationNumber>

</ProductIdentificationNumbersAfter>

1</CheckMarks>

2</CheckMarks>

</ProductIdentificationNumber>

1</CheckMarks>

2</CheckMarks>

</ProductIdentificationNumber>

</ProductIdentificationNumbersBefore>

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

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

</UcdTraceableProductInfo>

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

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

</UcdTraceableProductInfo>

</TraceableProducts>

</Row>

440

<Address>sample string 2</Address>

<CountryCode>sample string 1</CountryCode>

</Foreign>

<Local>

<Building>sample string 8</Building>

<City>sample string 4</City>

<District>sample string 3</District>

<Flat>sample string 9</Flat>

<House>sample string 7</House>

<Locality>sample string 5</Locality>

<RegionCode>sample string 2</RegionCode>

<Street>sample string 6</Street>

<Zip>sample string 1</Zip>

</Local>

</Address>

<Inn>sample string 1</Inn>

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

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

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

</Name>

</Individual>

<Inn>sample string 2</Inn>

<Kpp>sample string 3</Kpp>

<Name>sample string 1</Name>

</Organization>

</IdentificationInfo>

<Account>sample string 1</Account>

<Bank>

<Code>sample string 4</Code>

<Name>sample string 3</Name>

<Account>sample string 1</Account>

<City>sample string 2</City>

</Bank>

</Requisites>

</Seller>

</Decrease>

</Increase>

</Totals>

</UpdCorrectionInvoice>

{

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

"updCorrectionInvoice": {

"number": "123",

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

"currencyCode": "XXX",

"invoiceNumber": "321",

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

"seller": {

"identificationInfo": {

"organization": {

"name": "XXXXXXXXXX",

"inn": "XXXXXXXXXX",

"kpp": "XXXXXXXXX"

441

}

"address": {

"local": {

"regionCode": "XX"

}

"buyer": {

"identificationInfo": {

"organization": {

"name": "XXXXXXXXXX",

"inn": "XXXXXXXXXX",

"kpp": "XXXXXXXXX"

}

"address": {

"local": {

"regionCode": "XX"

}

"rows": [

{

"name": "",

"unitBefore": "018",

"unitAfter": "018",

"amountBefore": "5",

"amountAfter": "5",

"priceBefore": "10",

"priceAfter": "11",

"netSumBefore": "50",

"netSumAfter": "55",

"vatTypeBefore": "18%",

"vatTypeAfter": "18%",

"vatSumBefore": "9",

"vatSumAfter": "9",

"totalSumBefore": "59",

"totalSumAfter": "64.90",

"netsum": 10,

"exciseSumBefore": 35,

"exciseSumAfter": 41,

"exciseSumIncrease": 1,

"exciseSumDecrease": 0

}

"eventContent": {

"operationContent": "some super operation",

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

"transferDocument": "some doc",

"reasons": [

{

"documentName": "Doc",

"documentDate": "2020-01-01"

}

]

}

442

UpdInfo

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

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

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

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

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

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

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

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

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

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

Структура по приказу № ММВ-7-15/820@

Элемент

Тип

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

Размер

Описание

данных

FormatVer

string

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

sion

Атрибут к элементу <Invoice>.

string

1-255

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

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

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

Допустимые маски имени файла: ON_SCHFDOPPR, ON_NSCHFDOPPR,

ON_NSCHFDOPPRMARK, ON_NSCHFDOPPRPROS

FormatCode

string

1-7

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

Допустимые значения: 1115131

Атрибут к элементу <Invoice>.

ProductGro

ProductGr

Группы товаров. Заполняется только для документов типа УПД по формату приказа №

oup

ЕД-7-26/970@

Number

string

1-1000

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

Date

DateTime

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

CurrencyC

string

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

ode

Correction

string

1-3

Исправление: №. Принимает значения от 1 и более.

Number

Если необходимо передать в документ Дефис вместо номера исправления, то передать

null в CorrectionNumber

Невозможно передать без CorrectionDate

Correction

DateTime

Исправление: Дата. Дата в формате ДД.ММ.ГГГГ

Date

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

null в CorrectionDate

Невозможно передать без CorrectionNumber

Seller

BuyerSell

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

Shipper

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

Consignee

ShipperCo

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

nsignee

Payments

PaymentI

Сведения о платежно-расчетном документе, не более 10 элементов.

nfo[]

Buyer

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

444

BuyerSell

Info

InfoField

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

Rows

InvoiceRo

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

w[]

shipmentD

shipment

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

ocumentRe

Document

quisites

Requisites

[]

Document

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

SignerInfo

SignerInf

o[]

IdContract

string

1-255

Идентификатор государственного контракта:

Для УПД по формату приказа 155/176, длина значения 1-255 символов

Для УПД по формату приказа 820 длина значения 20-25 символов.

Circumsta

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

ncesInvoic

ncesInvoi

добавленную стоимость Элемент принимает следующие значения: Для

eFormation

ceFormati

<Функция>=СЧФ:

0 - Информации нет, не сериализуется;

1 - счет-фактура, выставляемый при реализации товаров (работ, услуг), передаче

имущественных прав;

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

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

имущественных прав;

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

экспедитором, застройщиком или заказчиком, выполняющим функции застройщика)

двум и более покупателям (приобретения у двух и более продавцов) товаров (работ,

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

EconomyCo

UpdEcono

Содержание факта хозяйственной жизни. Сведения о факте отгрузки товаров

ntent

myContent

(выполнения работ), передачи имущественных прав (о предъявлении связанных услуг).

UID

string

1-1000

Уникальный идентификатор документа

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

Чтобы передать null в элемент XML, необходимо указать к элементу xsi:nil="true", а в корневом элементе указать namespace:

Document.CreateInvoice

Примеры

</ProductGroup>

<Name>XXXXXXXXXX</Name>

<Inn>XXXXXXXXXX</Inn>

445

<Kpp>XXXXXXXXX</Kpp>

</Organization>

</IdentificationInfo>

<Local>

<RegionName>XXXXXXXXXXXXXXXXXXXXX</RegionName>

</Local>

</Address>

</Seller>

</Shipper>

<Name>

<OrganizationName>XXXXXXXXXX</OrganizationName>

</Name>

<Local>

<RegionName>XXXXXXXXXXXXXXXXXXXXX</RegionName>

</Local>

</Address>

</Consignee>

</PaymentInfo>

</Payments>

<Buyer>

<Name>XXXXXXXXXX</Name>

<Inn>XXXXXXXXXX</Inn>

<Kpp>XXXXXXXXX</Kpp>

</Organization>

</IdentificationInfo>

<Local>

<RegionName>XXXXXXXXXXXXXXXXXXXXX</RegionName>

</Local>

</Address>

</Buyer>

<Info>

</Info>

<Rows>

<Row>

</Row>

</Rows>

</shipmentDocumentRequisites>

<IdContract> XXXXXXXXXX</IdContract>

</Invoice>

446

{

FormatVersion: "5.01",

FormatCode: "1115131",

number: "XXX",

date: "2019-12-12",

currencyCode: "XXX",

"ProductGroup": {

"N4": "1",

"N5": "0",

"N6": "0"

seller: {

identificationInfo: {

organization: {

inn: "XXXXXXXXXX",

kpp: "XXXXXXXXX"

}

address: {

local: {

regionCode: "78",

regionName: "XXXXXXXXXXXXXXXXXXXXX"

}

shipper: {

isSame: "true"

consignee: {

organizationName: "XXXXXXXXXX"

address: {

local: {

regionCode: "XX",

regionName: "XXXXXXXXXXXXXXXXXXXXX"

}

payments: {

paymentInfo: {

number: "456789",

date: "2012-12-01"

}

buyer: {

identificationInfo: {

organization: {

inn: "XXXXXXXXXX",

kpp: "XXXXXXXXX"

}

address: {

local: {

regionCode: "XX",

regionName: "XXXXXXXXXXXXXXXXXXXXX"

}

rows: [{

unit: "018",

amount: 5,

price: 10,

netsum: 8,

totalsum: 12,

vattype: "18",

447

User

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

Элемент

Тип данных

Описание

long

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

Uid

string (255)

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

string (80)

Учетная запись пользователя

Person

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

Title

string (128)

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

ClientId

long

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

Company

string (64)

Наименование компании пользователя

Dictionary.UserInfo

Примеры

<User>

<LastName>XXXXXXXXXX</LastName>

<FirstName>XXXXXXXXXX</FirstName>

<MiddleName>XXXXXXXXXX</MiddleName>

</Person>

<Title>

</Title>

<Uid>uid=login,ou=people,ou=sso-users,ou=courier,dc=sso,dc=esphere,dc=local</Uid>

<Login>login</Login>

<Company>XXXXXXXXXX</Company>

</User>

{

"id": 118,

"uid": "uid=login,ou=people,ou=sso-

users,ou=courier,dc=sso,dc=esphere,dc=local", "login": "XXXXXXXXXX",

"clientId": 1,

"company": "XXXXXXXXXX",

"person": {

"lastName": "XXXXXXXXXX",

"firstName": "XXXXXXXXXX",

"middleName": "XXXXXXXXXX"

"title": " "

}

449

UserAdminFilter

Фильтр поиска по пользователям

Элемент

Тип данных

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

Описание

ClientId

long

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

LastName

string

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

FirstName

string

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

string

Email пользователя.

string

Логин пользователя (частично или полный).

DateStart

DateTime

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

DateEnd

DateTime

Окончание периода окончания действия сертификата.

SubId

UserDirectory

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

IsExistsCertificate

bool

Признак наличия сертификата.

IsActive

bool

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

450

UserDetails

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

Свойство

Тип

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

Описание

PhoneNumber

String (255)

Номер телефона пользователя.

Contacts

String (255)

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

String (255)

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

Roles

Role[]

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

Groups

Role[]

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

IsActive

Boolean

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

DirectoryName

String

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

(1024)

Directory

UserDirectory

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

DirectoryName

string

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

ClientInfo

ClientShortInfo[]

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

CertificateId

int

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

Thumbprint

string

Отпечаток активного сертификата.

CertificateBegin

DateTime

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

CertificateEnd

DateTime

Дата окончания срока действия активного сертификата.

UserUid

string

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

Person

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

454

WarrantIssuer

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

Элемент

Тип данных

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

Описание

Person

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

Title

string

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

Info

string

Дополнительные сведения о доверенном лице.

Organization

string

Наименование организации, выдавшей доверенность.

Ticket.CreateAcceptenceCertificateAcceptTicket/AcceptanceCertificateAcceptInfo/Warrant,

Ticket.CreateTorg12AcceptTicket/Torg12AcceptInfo/Warrant

Примеры

<LastName>XXXXXXXXXX</LastName>

<FirstName>XXXXXXXXXX</FirstName>

<MiddleName>XXXXXXXXXX</MiddleName>

</Person>

<Title>

</Title>

<Info>XXXXXXXXXX</Info>

<Organization>XXXXXXXXXX</Organization>

</WarrantIssuer>

{

"person": {

"lastName": "XXXXXXXXXX",

"firstName": "XXXXXXXXXX",

"middleName": "XXXXXXXXXX"

"title": " ",

"info": "XXXXXXXXXX",

"organization": "XXXXXXXXXX"

}

458

WarrantSubject

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

Элемент

Тип данных

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

Описание

Person

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

Title

string

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

Info

string

Дополнительные сведения о доверенном лице.

Ticket.CreateAcceptenceCertificateAcceptTicket/AcceptanceCertificateAcceptInfo/Warrant,

Ticket.CreateTorg12AcceptTicket/Torg12AcceptInfo/Warrant

Примеры

<LastName>XXXXXXXXXX</LastName>

<FirstName>XXXXXXXXXX</FirstName>

<MiddleName>XXXXXXXXXX</MiddleName>

</Person>

<Title>

</Title>

<Info>XXXXXXXXXX</Info>

</WarrantSubject>

{

"person": {

"lastName": "XXXXXXXXXX",

"firstName": "XXXXXXXXXX",

"middleName": "XXXXXXXXXX"

"title": " ",

"info": "XXXXXXXXXX"

}

459

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

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

Описание

AcceptanceDocumentType

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

AcceptanceResultCode

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

AccessType

Тип доступа к ЭДО филиалов.

Actions

Флаги доступных действия для документа

BarcodeType

Тип баркода

CompanyType

Тип компании

CreditTransactionStatusType

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

DirectDebitPaymentStatus

Статус оплаты ЭСФ (по договору автоматической оплаты)

Directories

Флаги подсистем, которые могут быть у клиента

DocumentCommentVisibility

Видимость комментария в документообороте

DocumentDirection

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

DocumentEventType

События ленты документов

DocumentFolder

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

DocumentFormType

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

DocumentRelationType

Режим передачи документа

DocumentStatus

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

DzoDealState

Статусы сделки ДЗО

DzoDealType

Виды сделки ДЗО

EdiCodeType

Признаки EDI кодов

ExtendedDocumentType

Расширенный тип документа

LiabilityCashType

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

Participant

Участник документооборота

RelationRequestSide

Сторона запроса на сертификат

RelationRequestStatus

Статусы взаимосвязей клиента

RelationType

Типы связей документов

RequestRelationStatus

Статус запроса на взаимосвязь

RequestStatus

Статусы запросов

RoleType

Типы ролей в системе

RoamingStatus

Статусы отправки в роуминг Транспортного документа / Подписи

SignerType

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

StateOrderPaymentType

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

TransportDocumentType

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

TypeEvent

Тип события

UserDirectory

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

TicketPurpose

Тип назначения транспортного документа (квитанции)

460

Actions

Флаги доступных действия для документа

Возможные значения:

Представление

Описание

элемента в XML

элемента в JSON

None

Для пользователя нет доступных действий.

Add

Пользователь может добавить документ на основании существующего.

Reject

Пользователь может отклонить документ.

Submit

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

Исключен как неиспользуемый (БД никогда его не устанавливает).

AcceptRevoke

Пользователь может подтвердить отзыв документа.

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

Revoke

Пользователь может отозвать документ.

Sign

Пользователь может подписать документ.

Send

128

Пользователь может отправить документ.

Trash

256

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

Edit

512

Пользователь может сохранить документ.

RejectWithTicket

1024

Пользователь может отклонить документ только подписав квитанцию.

Delete

2048

Пользователь может удалить/восстановить документ.

EditableRoute

4096

Можно редактировать маршрут документа.

AcceptWithTicket

8192

Принятие с квитанцией.

SubstituteSigner

16384

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

подписант.

CreateSignatureTicket

32768

Признак добавления квитанции с подписью (УОП).

AvoidanceRequest

65536

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

документа.

RejectAvoidance

131072

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

документа.

AcceptAvoidance

262144

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

PackageRouteSync

524288

Признак принадлежности документа к пакету с синхронизацией

маршрутов.

RemoveFromPackage

1048576

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

AssignableToSelf

2097152

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

самому себе.

AcceptWithoutSign

4194304

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

SignReplyTicket

8388608

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

сформированного.

SignReceiveNotification

16777216

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

документ.

465

AddPaymentRequestOrder

33554432

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

DeleteDraft

67108864

признак физического удаления любого черновика

IsPrintable

134217728

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

AddRoute

268435456

признак возможности создания маршрута

AddAdditionalInfo

536 870 912

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

CancelWithBlrTicket

1 073 741 824

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

формированием ответной квитанции.

SendSignWithSourceDocu

2 147 483 648

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

ment

документом.

SignReceiveAnotherNotific

4 294 967 296

Признак подписания квитанций ИОП НЕ к основному документу.

ation

EnableEditAnyRoute

8 589 934 592

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

привилегии.

Document.Add/Document,

Document.List/Document,

Document.Card/Document,

Document.Card v.2/Document,

Document.Details/Document,

Document.PackageDetails v.2/PackageCard/PackageDocument,

Ticket.CreateAcceptenceCertificateAcceptTicket/AcceptanceCertificateAcceptInfo

466

DocumentEventType

События ленты документов.

Элемент

Номер

Описание

Отправитель

Получатель

позиции

Created

Создание документа

Delivered

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

Accepted

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

Signed

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

Rejected

Отклонение документа

TicketReceived

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

Received

Документ переведен в статус "Получен". Для сф, ксф, документов, полученных

по роумингу, подписано извещение о получении документа (ИОП)

TicketSended

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

MovedToTrash

Документ перемещён в корзину

Deleted

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

Sended

Документ переведен в статус "Отправлен" (только для отправителя)

DeliveredForR

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

eciever

Revoked

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

ReceivedRequ

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

estReview

RequestedAvo

Получено предложение об аннулировании

idance

RejectedAvoid

Отправлен/получен отказ в аннулировании (предложение об аннулировании

ance

отклонено)

AcceptedAvoi

Документ аннулирован

dance

SignatureReje

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

RestoredFrom

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

Trash

MarkingDocu

Документ отправлен Оператору Маркировки

mentSent

MarkingTicket

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

Received

events-index/DocumentEvent,

GetDocumentEvents/DocumentEvent,

Subscription.Events.Totals v.2.0/DocumentEvents/DocumentEvent,

Subscription.Events v.2.0/DocumentEvent

Примеры

476

DocumentFormType

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

Представление

Описание

элемента в XML

элемента в

JSON

Other

Прочий документ.

Invoice

Тип документа: Счет-фактура.

CorrectionInvoice

Тип документа: Корректировочный счет-фактура.

Bill

Тип документа: Счёт.

Torg12

Товарная накладная (ТОРГ-12).

AcceptanceCertific

Акт выполненных работ (структурированный).

ate

Act

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

ReconciliationRep

Акт сверки.

ort

Agreement

Тип документа: Договор.

Document

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

PriceList

Тип документа: Прайс-лист.

PriceListReconcilia

Прайс-лист согласование.

tion

ActAdd

Приложение к акту о выполнении работ (оказании услуг).

PlainBill

Счет (неструктурированный).

NoticeDiscounts

Уведомление о расчёте скидки.

Infsoob

Заявление об участнике ЭДО.

DirectDebitContra

Договор автоматической оплаты счетов-фактур.

Delivery

Тип документа: Поставка.

RegistryUdt

Тип документа: Реестр переданных денежных требований.

RegistryPdt

Тип документа: Реестр подтвержденных денежных требований.

Desadv

Тип документа: Уведомление об отгрузке.

Recadv

Тип документа: Уведомление о приемке.

CreditRequest

Тип документа: Запрос на получение кредита/гарантии.

CreditApplication

Тип документа: Заявка/изменение на кредит, гарантию.

CreditRequestReply

Тип документа: Ответ на требование.

CreditDocumentat

Тип документа: Кредитно-обеспечительная документация.

ion

CreditDocumentat

Тип документа: Кредитно-обеспечительная документация - подтверждение.

ionConf

UpdInvoice

УПД. Счёт-фактура.

FeesRegisterInves

Тип документа: Реестр платежей (инвест-проекты).

tment

479

UpdInvoiceInfo

УПД. Счёт-фактура доп.

UpdInfo

УПД. Акт-торг.

UpdCorrectionInv

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

oice

добавленную стоимость. Документ с функцией «КССЧФª.

UpdCorrectionInv

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

oiceInfo

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

услуг, имущественных прав). Документ с функцией «КСЧФДИСª.

UpdCorrectionInfo

Корректировочный первичный учетный документ для оформления факта передачи

товаров (работ, услуг, имущественных прав). Документ с функций «ДИСª.

ServiceRequest

Форма документа: запрос на оценку.

AdditionalFinancin

Заявка на дофинансирование.

gRequest

CancelFinancingR

Заявка на отмену финансирования.

equest

GoodsDeliveryRep

Документ о передаче товаров.

ort

WorksDeliveryRep

Документ о передаче результатов работ.

ort

ServiceKP

Коммерческое предложение.

ServiceTask

Задание на проведение оценки в целях залога.

ServiceContract

Договор оценки в целях залога.

ServiceDocRequest

Запрос дополнительных документов.

PaymentOrder

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

ServiceDocRespon

Дополнительный документ.

ServiceReportProj

Проект отчета об оценке.

ect

ServiceReport

Отчет об оценке.

Document.Add/Document,

Document.List/Document,

Document.Card/Document,

Document.Card v.2/Document,

Document.Details/Document

480

DocumentStatus

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

Представление

Описание

элемента в XML

элемента в JSON

None

Неопределенный статус

Draft

Черновик документа

ToSign

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

Prepared

Документ подготовлен

IsRead

Документ прочитан

OnAgreement

Документ на согласовании

Signed

Статус подписан (Подписан на стороне получателя)

Rejected

Статус отклонен

Accepted

Документ принят (Принят на стороне получателя)

OnRevocation

На отзыве

Revoked

Документ отозван

Sended

Документ отправлен

Delivered

Статус доставлен

Received

Документ получен

NoRoute

Документ без маршрута

RequestedAvoidance

Предложено аннулирование

RejectedAvoidance

Отклонено аннулирование документа

AcceptedAvoidance

Документ аннулирован

ClarificationRequested

С уточнением (используется для документов СФ/КСФ при формировании

УОУ вместо статутса Отклонен)

WaitingForSend

Документ ожидает отправки

Document.Add/Document,

Document.List/Document,

Document.SearchByParams/SearchResult,

Document.Card/Document,

Document.Card v.2/Document,

Document.Details/Document,

Document.History v.2/DocumentHistory,

Document.PackageDetails v.2/PackageCard/PackageDocument,

Ticket.Unreplied v.2/TicketInfo

482

ExtendedDocumentType

Расширенный тип документа.

Представление элемента в XML

Представление

Описание

элемента в JSON

Document

Документ (основной документ)

ReceiveConfirmation

Подтверждение получения

SendConfirmation

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

ReceiveNotificationOfReceiveConfirmation

Извещение о получении подтверждения получения

ReceiveNotificationOfDocument

Извещение о получении документа

SendConfirmationOfReceiveNotificationOf

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

Document

ReceiveNotificationOfSendConfirmation

Извещение о получении подтверждения отправки

ReceiveNotificationOfSendConfirmationOf

Извещение о получении подтверждения отправки извещения о

ReceiveNotificationOfDocument

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

ClarificationNotice

Уведомление об уточнении

ReceiveNotificationOfClarificationNotice

Извещение о получении уведомления об уточнении

AcceptDocument

Документ покупателя (титул покупателя)

RejectSignature

Отказ от подписи

AvoidanceRequest

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

AvoidanceRequestClarificationNotice

Уведомление об уточнении к предложению об аннулировании

AvoidanceRequestAcceptSignature

SpecifyingDocument

()

ReceiveConfirmationOfReceiveNotification

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

OfDocument

ReceiveConfirmationOfClarificationNotice

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

SendConfirmationOfClarificationNotice

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

SendConfirmationOfClarificationNoticeFor

Подтверждение отправки уведомления об уточнении (ПДО

Operator

УОУ), направляемое в адрес оператора

SendConfirmationForOperator

Подтверждение отправки (ПДО СЧФ), направляемое в адрес

оператора

SendConfirmationOfReceiveNotificationOf

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

DocumentForOperator

(ПДО ИОП СЧФ), направляемое в адрес оператора

BlrAvoidanceRequest

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

Республики Беларусь

BlrAvoidanceConfirmation

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

Республики Беларусь

SendConfirmationOfAcceptDocument

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

покупателя)

ReceiveConfirmationOfAcceptDocument

Подтверждение даты получения документа покупателя (титул

покупателя)

ReceiveNotificationOfSendConfirmationOf

Извещение о получении подтверждения даты отправки докумен

486

AcceptDocument

та покупателя (титул покупателя)

SendConfirmationOfAcceptDocumentForO

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

perator

покупателя), направляемое в адрес оператора

ReceiveNotificationOfAcceptDocument

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

покупателя)

ReceiveConfirmationOfSpecifyingDocume

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

SendConfirmationOfSpecifyingDocument

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

SendConfirmationOfSpecifyingDocumentF

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

orOperator

равляемое в адрес оператора

ReceiveNotificationOfSpecifyingDocument

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

Ticket.Index/Ticket,

Ticket.Unreplied v.2/TicketInfo,

Tickets.Ticket/TicketDetails,

Tickets.Tickets/TicketDetails,

events-index/DocumentEvent,

GetDocumentEvents/DocumentEvent,

Subscription.Events.Totals v.2.0/DocumentEvents/DocumentEvent,

Subscription.Events v.2.0/DocumentEvent

487

LiabilityCashType

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

Представление

Описание

элемента в XML

элемента в JSON

Budget

Средства бюджета

AdditionalBudget

Средства дополнительного бюджетного финансирования

SpecialOperation

Средства для финансирования мероприятий по оперативно-розыскной

деятельности

Temporary

Средства, поступающие во временное распоряжение казенных учреждений

Organization

Средства юридических лиц. Источник средств, за счет которого должна

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

Document.AcceptTitle

v.2/UniversalDocumentAcceptInfo/StateOrderInfo/CashLiabilityInfo

488

RequestRelationStatus

Статус запроса на взаимосвязь.

Возможные значения:

Представление

Описание

элемента в XML

элемента в JSON

NoExists

Взаимосвязи не существует

Confirmation

Существует встречный запрос, необходимо подтверждение

Exists

Уже существует взаимосвязь (Активная)

Sent

Существует запрос, направленный данному контрагенту

Rejected

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

о повторной отправке

ClientExists

Контрагент уже существует в БД, но попытка добавить как

несуществующий

MatchClient

Отправитель совпадает с получателем

Blocked

Уже существует взаимосвязь (Заблокированная)

v2.0.client.discover/ClientRelation

493

SignerRole

Область полномочий подписанта.

XML

JSON

Описание

Approval

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

хозяйственной жизни)

Confirmation

Лицо, в полномочия которого входит подтверждение оформленного события (факта хозяйственной

жизни)

Agreement

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

хозяйственной жизни)

OtherScop

Лицо с иными полномочиями

Ticket.CreatePriRasxAdditionalInfoTicket v.2/ PriRasxAdditionalInfo/ SignerInfo

497

SignerStatus

Статус подписанта.

Представление

Описание

в XMl

в JSON

GoodsDealer

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

AuthorizedEntity

Работник иной уполномоченной организации

AuthorizedIndivid

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

ual

GoodsBuyer

Работник организации - покупателя

BuyerInformation

Работник организации - составителя файла обмена информации покупателя, если

File

составитель файла обмена информации покупателя не является покупателем

Ticket.CreatePriRasxAdditionalInfoTicket v.2/ PriRasxAdditionalInfo/ SignerInfo

498

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