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

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

437

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

}

439

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

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

444

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"

}

448

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

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

450

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

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

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

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

Document.CreateInvoice

Примеры

</ProductGroup>

<Name>XXXXXXXXXX</Name>

<Inn>XXXXXXXXXX</Inn>

<Kpp>XXXXXXXXX</Kpp>

451

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

452

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

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

Описание

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

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

457

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

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

документ.

462

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

463

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

Примеры

473

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

476

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

477

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

479

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

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

483

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

484

RequestRelationStatus

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

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

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

Описание

элемента в XML

элемента в JSON

NoExists

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

Confirmation

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

Exists

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

Sent

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

Rejected

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

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

ClientExists

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

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

MatchClient

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

Blocked

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

v2.0.client.discover/ClientRelation

490

SignerStatus

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

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

Описание

в XMl

в JSON

GoodsDealer

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

AuthorizedEntity

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

AuthorizedIndivid

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

ual

GoodsBuyer

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

BuyerInformation

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

File

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

Ticket.CreatePriRasxAdditionalInfoTicket v.2/ PriRasxAdditionalInfo/ SignerInfo

495

TransportDocumentType

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

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

Описание

элемента в XML

элемента в

JSON

ReceiveNotice

Извещение о получении электронного документа (КНД 1115110)

SendConfirmation

Подтверждение даты отправки (КНД 1115111)

ReceiveConfirmati

Подтверждение даты получения (КНД 1115112)

ClarificationNotice

Уведомление об уточнении (КНД 1115113)

Invoice

Счёт-фактура (основной)

CorrectionInvoice

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

Torg12SellerTitle

Товарно-транспортная накладная (ТОРГ-12) - Титул продавца

Torg12BuyerTitle

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

AcceptanceCertific

Акт о выполненных работах (услугах) - титул исполнителя

atePerformerTitle

AcceptanceCertific

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

ateCustomerTitle

Document

Прочий тип документа (неструктурированный и тд)

RejectSignature

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

AvoidanceRequest

Предложение об аннулировании электронного документа

AcceptSignature

Уведомление о принятии (УОП), которое представляет собой электронную подпись

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

ReceiveNoticeRoa

Извещение о получении (роуминг)

ming

ClarificationNotice

Уведомление об уточнении (роуминг)

Roaming

UpdInvoice

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

Документ с функцией «СЧФ».

UpdInvoiceSellerI

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

nfo

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

Документ с функцией «СЧФДОП», информация продавца.

UpdInvoiceBuyerI

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

nfo

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

Документ с функцией «СЧФДОП», информация покупателя.

UpdSellerInfo

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

имущественных прав). Документ с функций «ДОП», информация продавца.

UpdBuyerInfo

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

имущественных прав). Документ с функций «ДОП», информация покупателя.

UpdCorrectionInv

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

oice

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

UpdCorrectionInv

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

oiceSellerInfo

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

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

UpdCorrectionInv

499

oiceBuyerInfo

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

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

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

покупателя.

UpdCorrectionSell

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

erInfo

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

продавца.

UpdCorrectionBuy

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

erInfo

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

покупателя.

DocumentOfTrans

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

ferOfWorkResults

PerformerInfo

DocumentOfTrans

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

ferOfWorkResults

CustomerInfo

DocumentOfTrans

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

ferOfGoodsSellerI

nfo

DocumentOfTrans

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

ferOfGoodsBuyerI

nfo

AcceptanceDiscre

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

pancyDocumentS

pecifying

Contract

Договор

BlrWayBillSenderT

Транспортная накладная Республики Беларусь - титул отправителя

itle

BlrWayBillReceive

Транспортная накладная Республики Беларусь - титул получателя

rTitle

ActMh1KeeperInfo

Акт о приеме-передаче товарно-материальных ценностей на хранение (МХ-1) (ACT_MH1

). Титул хранителя (отправителя)

ActMh1DepositorI

Акт о приеме-передаче товарно-материальных ценностей на хранение (МХ-1) (ACT_MH1

nfo

). Ответный титул (поклажедателя)

ActMh3KeeperInfo

Акт о возврате товарно-материальных ценностей, сданных на хранение (МХ-3) (ACT_MH

3). Титул хранителя (отправителя)

ActMh3DepositorI

Акт о возврате товарно-материальных ценностей, сданных на хранение (МХ-3) (ACT_MH

nfo

3). Ответный титул (поклажедателя)

OrderRequest

Заказ

AcceptanceDiscre

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

pancyDocumentB

их приемке (информация покупателя) (PRIRASXPRIN)

uyerInfo

BlrDiscrepancyAct

Акт приемки товаров по количеству и качеству (акт расхождений) в РБ (BLRADF)

InvoiceRA

Счет-фактура Республики Армения

InvoiceRARs

Счет-фактура Республики Армения. Ответ

UpdSvrk

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

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

функцией СвРК

UpdSvzk

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

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

функцией СвЗК

500

UcdSvisrk

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

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

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

СвИСРК

UcdSviszk

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

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

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

EtrnSenderTitle

101

Титул отправителя, ЭТрН

EtrnTransporterTit

102

Титул перевозчика, ЭТрН

EtrnReceiverTitle

103

Титул грузополучателя, ЭТрН

EtrnUnloadTransp

104

Титул грузополучателя, ЭТрН

orterTitle

EtrnRedirectTrans

105

Титул переадресовки, ЭТрН

porterTitle

EtrnRelayTitle

106

Титул корректировочный, ЭТрН

EtrnOperatorTitle

107

Титул оператора, ЭТРН

AktSverOtp

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

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

AktSverPol

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

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

Document.Add

Document.Add/Document,

Document.List/Document,

Document.Card/Document

Document.Card v.2/Document,

Document.Details/Document,

Document.Pdf

Document.RequestClarification

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

501

UserDirectory

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

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

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

Описание

None

Неопределенный каталог пользователя

Sbbol

Каталог пользователей СББОЛ

Local

Внутренний каталог пользователей

Sbrf

Каталог пользователей Сбербанка

Ast

Каталог пользователей Сбербанка-АСТ

Beeline

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

Leasing

Пользователи системы Сбербанк Лизинг

Logine

Пользователи системы Логинет

Alfabank

Пользователи системы АЛБО

SbProvision

Пользователи системы АС УС

Finline

Пользователи системы Финлайн

WorldJudge

Пользователи Мировые Судьи

Tochka

Пользователи Точка Банк

Document.ChangeRoute,

Helper.UserIdByLogin,

Helper.UserList/UserDetails

503

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

Прежде, чем начать работу с документами, необходимо аутентифицироваться и определить получателя документа.

Более подробно об этом сказано в разделе Аутентификация.

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

URL: http://courier-test.esphere.ru/api/auth/logon

НTTP Method:

POST

Headers:

Content-Type: application/xml

Data:

</Credentials>

В ответной информации от сервера в тэге <Token> возвращается авторизационный токен (Auth-token), который необходимо

передавать в заголовке во всех методах API::

</LogonResponse>

506

Поиск контрагента и определение идентификатора

участника ЭДО

Для отправки документов необходимо знать id контрагента - получателя документа или его идентификатор участника ЭДО. Для

этого нужно воспользоваться методом FindClient. Поиск клиента можно осуществить по ИНН и КПП.

Более подробно об этом сказано в разделе Методы для работы со справочниками.

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

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

HTTP Метод: POST

ВАЖНО!

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

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

Headers:

Content-Type: application/xml

Auth-token: 12E33AE704161856F7716E9CA12DC3B29498A16F0F...

Data:

<Inn>XXXXXXXXXX</Inn>

<kpp>XXXXXXXXX</kpp>

</ClientSearchInfo>

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

<CompanyType>Individual</CompanyType> <FirstName>sample string 7</FirstName>

<FullName>sample string 5</FullName>

<Inn>sample string 9</Inn>

<Kpp>sample string 10</Kpp>

<LastName>sample string 6</LastName>

<MiddleName>sample string 8</MiddleName>

<Name>sample string 4</Name>

<RegistrationRequisites>sample string 12</RegistrationRequisites>

<RegistryNumber>sample string 11</RegistryNumber>

<Code>sample string 2</Code>

<OperatorCode>sample string 1</OperatorCode>

</Company>

ВАЖНО!

Идентификатор участника ЭДО (Code) необходим для дальнейшей работы. Он указывается, например, при отправке

документа.

507

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

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

документов, которыми можем обмениваться.

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

URL:/ http://courier-test.esphere.ru/api/dictionary/contractorDocumentTypes

HTTP Method:

POST

ВАЖНО!

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

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

Headers:

Content-Type: application/xml

Auth-token: 12E33AE704116F0FBB0357D9...

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

<Kpp>XXXXXXXXX</Kpp>

<Inn>XXXXXXXXXX</Inn>

</DocumentTypeClientRelationApi>

<Code>COURIER_POD_DOC</Code>//

<Name> </Name>//

</DocumentTypeClientRelationApi>

</SenderDocumentTypes>

</DocumentTypeClientRelationApi>

</ReceiverDocumentTypes>

</ContractorDocumentTypes>

</ArrayOfContractorDocumentTypes>

508

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

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

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

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

URL: http://courier-test.esphere.ru/api/classifier/template

HTTP Method:

POST

ВАЖНО!

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

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

Headers:

Content-Type: application/xml

Auth-token: 12E33AE704161856F7716EC6940D4AEAC3...

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

<Name>

</Name>//

<IsRequired>false</IsRequired>

<Participant>Receiver</Participant>

// /

</ClassifierTemplate>

<Name>

()</Name>

<IsRequired>false</IsRequired>

<Participant>Receiver</Participant>

</ClassifierTemplate>

<Name>

</Name>

<IsRequired>false</IsRequired>

<Participant>Receiver</Participant>

</ClassifierTemplate>

<Name>

</Name>

<IsRequired>false</IsRequired>

<Participant>Receiver</Participant>

</ClassifierTemplate>

</ArrayOfClassifierTemplate>

509

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

Создать документ в системе можно несколькими способами:

документ ( метод Document.Add параметр Signature пустой);

документ с подписью ( метод Document.Add параметр Signature содержит информацию о подписи);

добавить пачку документов в систему (метод Document.AddBatch )

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

Загрузка документа

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

документу Document.Sign. После добавления подписи документ попадет в папку "исходящие" при соответствующей настройке

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

Маршруты документа - этапы обработки документа на стороне компании.

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

1) Необходимо получить шаблон заполнения справочников для конкретного типа документа и получателя документа. Для этого

необходимо воспользоваться методом Classifier.Template. В результате выполнения метода получаем перечень справочников для

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

Participant=Receiver. Справочники со стороны отправителя имеют атрибут Participant=Sender. Возвращаемая структура также

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

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

2) Необходимо получить значения справочника/-ов полученного/-ых в п.1. Для этого используем метод Classifier.ClassifierValues.

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

3) Выбираем нужное значение из справочника.

4) Все необходимые параметры атрибута есть, теперь можно добавить документ. Для этого используем метод Document.Add. В

структуре данных DocumentCard добавляем необходимые параметры атрибута используя для этого структуру KeyValueObject. В

атрибут Key добавляем значение из атрибута ClassifierId (полученного в п.2, он же равен id из п.1), в атрибут Value добавляем

значение из атрибута Value (полученного в п.2)

Чтобы загрузить документ через API необходимо произвести конвертацию содержимого документа в кодировку base64.

При загрузке документа без подписи методом Document.Add, он попадает в папку "Черновики", далее к документу может быть

добавлено приложение методом Document.AddAttachment и добавлена подпись к документу методом Document.Sign.

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

URL: http://courier-test.esphere.ru/api/document/add/{id}

HTTP Method:

POST

ВАЖНО!

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

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

Headers:

Content-Type: application/xml

Auth-token: 12E33AE704161856F7716EC6940B204EA7ABCAC3...

Data:

<TypeCode>COURIER_POD_DOC</TypeCode>//

//Mime

Base64

511

</Content>

</KeyValueObject>

</KeyValueObject>

</KeyValueObject>

</KeyValueObject>

</Attributes>

</DocumentCard>

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

<DocumentTypeCode>COURIER_POD_DOC</DocumentTypeCode>

06.08.2015</Description>

<SenderName>XXXXXXXXXX</SenderName>

<SenderInn>XXXXXXXXXX</SenderInn>

<SenderKpp>XXXXXXXXX</SenderKpp>

<ReceiverName>XXXXXXXXXX</ReceiverName>

<ReceiverInn>XXXXXXXXXX</ReceiverInn>

<ReceiverKpp>XXXXXXXXX</ReceiverKpp>

<Status>Draft</Status>

<FormType>Other</FormType>

<RequestSign>false</RequestSign>

<ExistRouteSigner>false</ExistRouteSigner>

<Actions>Add Send Trash Edit EditableRoute</Actions>

<IsMarked>false</IsMarked>

<IsDocflowCompleted>false</IsDocflowCompleted>

</Content>

<IsPrintable>false</IsPrintable>

512

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

"Черновик"

К документу в статусе "Черновик" можно добавить приложение с помощью запроса Document.AddAttachment.

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

URL: http://courier-test.esphere.ru/api/document/addAttachment/{id}

HTTP Method:

POST

ВАЖНО!

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

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

Headers:

Content-Type: application/xml

Auth-token: 12E33AE704161856F7716EC6940B204EA7ABCAFB6329E5E6A4AB22D5FFDB1E4047ACC3...

Data:

</FileContent>

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

514

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

дальше по маршруту

Сгенерировать подпись под документом можно несколькими способами:

1. Подписать документ на веб-интерфейсе СФЕРА Курьер и выгрузить подпись;

2. Воспользоваться сторонней утилитой по генерации файла подписи.

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

URL: http://courier-test.esphere.ru/api/document/sign/{id}

HTTP Method:

POST

ВАЖНО!

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

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

Headers:

Content-Type: application/xml

Auth-token: 12E33AE704161856F7716EC6940C3...

Data:

<Content>+0LLQtdGA0Y/RjtGJ0LjQuSDRhtL..</Content>

<---- * *

</SignatureWithTicket>

Ответ от сервера:

515

Лента событий

При совершении какого-либо действия над документом в системе происходит событие. Например, когда получатель

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

В Ленте событий отображаются все события-действия над документом.

Для того чтобы прочитать ленту событий, необходимо воспользоваться методом events-index.

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

vent

id последнего события возможно получить методом GetLastEventId.

ВАЖНО!

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

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

Список возможных событий:

Элемент

Номер

Описание

Отправитель

Получатель

позиции

Created

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

Delivered

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

Accepted

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

Signed

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

Rejected

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

TicketReceived

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

Received

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

TicketSended

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

MovedToTrash

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

Deleted

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

Sended

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

DeliveredForReciev

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

Revoked

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

ReceivedRequestRe

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

view

RequestedAvoidance

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

RejectedAvoidance

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

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

AcceptedAvoidance

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

SignatureReject

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

RestoredFromTrash

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

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

Пример:

Если получатель хочет определить какие документы ему необходимо обработать (подписать, принять, отклонить), то ему

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

517

Папки системы

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

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

В системе существуют следующие папки:

Папка

Элемент

Описание

На

InWork

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

обработ

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

ку

Входящ

Inbox

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

ие

Избран

Favorite

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

ное

«Избранное» должно происходить лишь копирование документа, оригинал документа должен остаться

на прежнем месте

Исходя

Outbox

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

щие

Чернов

Draft

В папке отображены все документы, созданные пользователем, но не отправленные по маршруту

ики

Архив

Archive

В папке отображены документы, которые завершили движение по маршруту

Для получения списка документов из какой-либо папки используется метод Document.List.

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

ВАЖНО!

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

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

518

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

ВАЖНО!

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

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

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

документа и его содержимое в кодировке Base64.

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

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

519

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

Следующие документы имеют утвержденный формат ФНС:

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

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

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

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

УПД. Счет-фактура и документ об отгрузке товаров (выполнении работ), передаче имущественных прав (об оказании

услуг),

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

При загрузке этих документов в систему они автоматически проверяются на соответствие формату ФНС.

Документооборот электронными документами Счет-фактура, УПД. Счет-фактура, УПД. Счет-фактура и документ об отгрузке

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

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

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

Более подробную информацию о порядке обмена квитанциями, а также методах работы с ними можно найти в разделах Счет-

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

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

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

работы с квитанциями

520

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

Общая схема документооборота Неструктурированного документа

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

В случае роуминга при принятии Неструктурированного документа осуществляется формирование, подписание и

отправка Отправителю квитанции Извещение о получении.

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

получателю и переходит в статус Подготовлен, в силу отсутствия унифицированного для Операторов формата

сообщения об отзыве.

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

Документ может быть создан:

1. локально (в учетной системе и т.д.) и добавлен систему методом Document.Add с подписью. Либо сначала добавлен, а затем

подписан методом Document.Sign

2. через веб-интерфейс системы (сохранен в черновики), а затем подписан методом Document.Sign

521

В случае роуминга отзыв Счет-фактуры недоступен после того, как Счет-Фактура отправляется получателю и

переходит в статус Подготовлен, в силу отсутствия унифицированного для Операторов формата сообщения об отзыве.

Создание и отправка счета-фактуры.

Отправитель СФ:

Счет-фактура продавца может быть создан:

1. локально (в учетной системе и т.д.) и добавлен систему методом Document.Add с подписью. Либо сначала добавлен, а

затем подписан методом Document.Sign. Документ может быть создан в одном из двух форматов:

в упрощенном формате ФНС. В этом случае перед загрузкой требуется провести трансляцию документа в полный

формат ФНС методом Document.CreateInvoice

в полном формате ФНС

2. через веб-интерфейс системы (сохранен в папке "Черновики"), а затем подписан методом Document.Sign

При использовании метода Document.Add происходит проверка структурированного документа на соответствие xsd-схеме,

назначенной для данного типа документа.

Отправка Извещения о получении счета-фактуры.

Получатель СФ:

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

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

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

Извещение о получении СФ создается с помощью метода Ticket.CreateReply, подписывается Получателем в его системе и вместе

с подписью загружается в Курьер методом Ticket.Add.

Подписание операторских квитанций.

525

В ответ на квитанции Оператора на стороне как Отправителя (Подтверждение даты получения счета-фактуры), так и Получателя

(Подтверждение даты отправки счета-фактуры и Подтверждение даты отправки Извещения о получении счета-фактуры)

создаются Извещения об их получении аналогично предыдущему примеру. При вызове метода Ticket.CreateReply в качестве

входного параметра ему передается id операторской квитанции (транспортного документа), на которую требуется создать

Извещение.

Принятие счета-фактуры.

Получатель СФ:

Если Получатель СФ принимает полученный счет-фактуру к оплате без корректировок, он принимает документ с помощью

метода Document.Accept. После использования этого метода документооборот по данному счету-фактуре завершается как на

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

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

Получатель СФ:

Если Получатель СФ не согласен с данными, указанными в счете-фактуре и не принимает его к оплате, он формирует

Уведомление об уточнении с помощью метода Ticket.CreateClarification, указав в нем причину отклонения счета-фактуры,

подписывает его и затем добавляет с помощью метода Document.RequestClarification.

Отправитель СФ:

В ответ на Уведомление об уточнении на стороне Отправителя должно быть создано Извещение о получении Уведомления, как и

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

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

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

526

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

Общая схема документооборота Товарной накладной

Общая схема документооборота в Курьере для юридически значимого электронного документа "Товарная накладная" (ТОРГ12)

представлена на рисунке ниже.

В случае роуминга при принятии документа Товарная накладная (ТОРГ-12) осуществляется формирование, подписание

и отправка Отправителю квитанции Извещение о получении.

В случае роуминга отзыв документа Товарная накладная (ТОРГ-12) недоступен после того, как документ отправляется

получателю и переходит в статус Подготовлен, в силу отсутствия унифицированного для Операторов формата

сообщения об отзыве.

Создание и отправка Товарной накладной (титула продавца).

Отправитель:

Титул продавца может быть создан:

подписан методом Document.Sign

2. через веб-интерфейс системы (сохранен в черновики), а затем подписан методом Document.Sign

Создание и отправка Товарной накладной (титула покупателя).

527

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

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

Общая схема документооборота в Курьере для юридически значимого электронного документа Акт о выполнении работ

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

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

исключением:

1. Используется тип документа ACTFNS

2. Для получателя для создания титула заказчика используется метод Ticket.CreateAcceptenceCertificateAcceptTicket

3. При добавлении титула заказчика используется тип квитанции TransportDocumentType = AcceptanceCertificateCustomerTitle

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

подписание и отправка Отправителю квитанции Извещение о получении.

В случае роуминга отзыв документа Акт о выполнении работ (оказании услуг) недоступен после того, как документ

отправляется получателю и переходит в статус Подготовлен, в силу отсутствия унифицированного для Операторов

формата сообщения об отзыве.

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

529

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

Общая схема документооборота «Подтверждающий документ»

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

В случае роуминга при принятии документа Подтверждающий документ осуществляется формирование, подписание и

отправка Отправителю квитанции Извещение о получении.

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

получателю и переходит в статус Подготовлен, в силу отсутствия унифицированного для Операторов формата

сообщения об отзыве.

530

В случае роуминга отзыв документа УПД Счет-фактура недоступен после того, как документ отправляется получателю

и переходит в статус Подготовлен, в силу отсутствия унифицированного для Операторов формата сообщения об отзыве.

Создание и отправка УПД Счет-фактура.

Отправитель УПД СФ: УПД Счет-фактура продавца может быть создан:

1. локально (в учетной системе и т.д.) и добавлен систему методом Document.Add с подписью. Либо сначала добавлен, а

затем подписан методом Document.Sign.

2. через веб-интерфейс системы (сохранен в папке "Черновики"), а затем подписан методом Document.Sign

При использовании метода Document.Add происходит проверка структурированного документа на соответствие xsd-схеме,

назначенной для данного типа документа.

Отправка Извещения о получении УПД Счет-фактура.

Получатель УПД СФ: Для того, чтобы совершить действие с документом, необходимо знать его id. Подробнее об этом в разделе О

пределение наличия документа на обработку. Далее необходимо создать Извещение о получении документа Счет-фактура.

Извещение о получении документа создается с помощью метода Ticket.CreateReply, подписывается Получателем в его системе и

вместе с подписью загружается в Курьер методом Ticket.Add.

Подписание операторских квитанций.

533

В ответ на квитанции Оператора на стороне как Отправителя (Подтверждение даты получения Счета-фактуры), так и Получателя

(Подтверждение даты отправки Счета-фактуры и Подтверждение даты отправки Извещения о получении Счета-фактуры)

создаются Извещения об их получении аналогично предыдущему примеру. При вызове метода Ticket.CreateReply в качестве

Извещение.

Принятие УПД Счет-фактура.

Получатель УПД СФ: Если Получатель УПД СФ принимает полученный документ УПД Счет-фактура к оплате без корректировок,

он принимает документ с помощью метода Document.Accept. После использования этого метода документооборот по данному

УПД Счет-фактура завершается как на стороне Получателя, так и на стороне Отправителя.

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

Получатель УПД СФ: Если Получатель УПД. СФ не согласен с данными, указанными в УПД Счет-фактура и не принимает его к

оплате, он формирует Уведомление об уточнении с помощью метода Ticket.CreateClarification, указав в нем причину отклонения

УПД Счет-фактура, подписывает его и затем добавляет с помощью метода Document.RequestClarification.

Отправитель УПД СФ: В ответ на Уведомление об уточнении на стороне Отправителя должно быть создано Извещение о

получении Уведомления, как и для любой другой квитанции. О том, как определить наличие документа, требующего подписания

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

534

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

товаров (выполнении работ), передаче

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

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

услуг) (далее УПД ДОП) в соответствии с приказом ФНС № ММВ-7-15/155@ состоит из 2х файлов:

Файл обмена продавца

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

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

Файл обмена продавца подписывается пользователями компании-составителя файла обмена продавца.

Файл обмена покупателя

Документ, соответствующий файлу обмена покупателя, создается через API.

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

Схема документооборота

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

работ), передаче имущественных прав (об оказании услуг) (УПД ДОП) представлена на рисунке ниже.

535

В случае роуминга при принятии документа УПД. ДОП осуществляется формирование, подписание и отправка

Отправителю квитанции Извещение о получении.

В случае роуминга отзыв документа УПД. ДОП недоступен после того, как документ отправляется получателю и

Создание и отправка УПД ДОП (Продавца).

Отправитель:

УПД. ДОП (Продавца) может быть создан локально (в учетной системе и т.д.) и добавлен систему методом Document.Add, а

затем подписан методом Document.Sign

Отправка УПД ДОП (Покупателя).

Получатель:

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

Далее необходимо сформировать и подписать УПД. ДОП (Покупателя).

УПД. ДОП (Покупателя) может быть добавлен в систему с подписью покупателя методом Document.Accept

536

Пример добавления УПД ДОП (Покупателя) с подписью покупателя методом Document.

<Signature>MIIETTCCA/qgAwBAgIKKEwAejAKBgYqhQMCMFADCBDEfMB0GCSqG

OQ==</Signature>

</SignedContent>

Signature - подпись покупателя под файлом обмена покупателя

Отзыв документов

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

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

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

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

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

537

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

товаров (выполнении работ), передаче

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

включающий счет-фактуру

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

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

включающего счет-фактуру

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

товаров (выполнении работ), передаче имущественных прав (об оказании услуг), включающего счет-фактуру (далее УПД СФ

ДОП) представлена на рисунке ниже.

538

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

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

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

Код

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

Структурированный

Акт взаимозачета

ACT_VZAIMOZACHETA

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

ACT

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

ACTFNS

Акт расхождений (ТОРГ-2)

DIVERGENCE_ACT

127

Акт сверки

VERIFICATION

Договор

AGREEMENT

Документ

DOCUMENT

Заказ (EDI)

ORDERS

330

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

INFSOOB

Комплект закрывающих документов

DOCUMENT_CLOSING

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

CSF

Отчет

REPORT

Партнерский документ (КОРУС)

KORUS_DOCUMENT

План

PROJECT

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

EXPLANATORY_NOTE

107

Прайс-лист

PRICAT

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

PRICAT_validation

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

ACTADD

Спецификация к договору поставки

SPEC_DELIVERY_AGR

148

EEMENT

Счет

BILL

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

ACCOUNT

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

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

WAYBILL

Товарная накладная (неструктурированная)

Уведомление о выставлении штрафных санкций

LEVEL_FINE

Уведомление о приемке (EDI)

RECADV

331

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

LEVEL

Уведомление о расчете суммы премии (вознаграждения)

LEVEL_BONUS

541

Уведомление об отгрузке (EDI)

DESADV

332

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

UO_DPINFSOOB

УПД. Документ об отгрузке товаров (выполнении работ),

UPD_DOP

907

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

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

UPD_SF

887

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

UPD_SF_DOP

908

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

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

UCD_CSF

927

УКД. Корректировочный счет-фактура и документ об изменении стоимости

UCD_CSF_DIC

929

отгруженных товаров

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

УКД. Документ об изменении стоимости отгруженных товаров

UCD_DIC

928

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

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

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

TOVTORG

1072

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

REZRU

1073

ВАЖНО!

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

542

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