Box
Организация на сервере Диадок
Свойства
- Name:
Строка, чтение - наименование организации
- Inn:
Строка, чтение - ИНН организации
- Kpp:
Строка, чтение - КПП организации
- DepartmentsTree:
Department , чтение - коллекция подразделений организаций, представленная в виде дерева, начиная с головного подразделения
Добавлено в версии 5.47.0.
- FnsParticipantId:
Строка, чтение - идентификатор организации-участника документооборота
- FnsRegistrationDate:
Дата, чтение - дата подачи заявляения в ФНС на регистрацию данной организации в качестве участника документооборота ЭСФ
- Guid:
Строка, чтение - идентификатор ящика организации в Диадоке
Добавлено в версии 5.31.0.
- IsTest:
Булево, чтение - организация работает в тестовом режиме
- IsPilot:
Булево, чтение - организация работает в пилотном режиме
- IsLiquidated:
Булево, чтение - организация ликвидирована
Добавлено в версии 5.31.0.
- MyEmployee:
MyEmployee , чтение - Информация о собственном сотруднике
Добавлено в версии 5.37.0.
Предупреждение
Поля устарели
Поле |
Рекомендуемая альтернатива |
Когда устарел |
Когда удалён |
---|---|---|---|
Id |
Guid |
||
EncryptedDocumentsAllowed |
|||
AuthenticateType |
MyEmployee.SessionInfo.AuthenticationType |
||
Login |
MyEmployee.SessionInfo.Login |
||
Certificate |
MyEmployee.SessionInfo.Certificate |
||
Departments |
DepartmentsTree |
- Id:
Строка, чтение - идентификатор ящика организации в Диадоке в форме
...@diadoc.ru
- EncryptedDocumentsAllowed:
Булево, чтение - для организации включена возможность отправки зашифрованных документов
- AuthenticateType:
Строка, чтение - тип авторизации. Возможные значения
- Login:
Строка, чтение - логин, по которому произошла авторизация
- Certificate:
CertificateInfo , чтение - информация о сертификате, использованном для авторизации. Если авторизация произошла не по сертификату, то будет содержать Пустой COM-объект
- Departments:
Коллекция объектов Department , чтение - подразделения, родительским подразделением которых является «Головное» подразделение
Методы
Работа с документами |
Работа с контрагентами |
Работа с организацией |
---|---|---|
Метод |
Рекомендуемая альтернатива |
Когда устарел |
Когда удалён |
---|---|---|---|
|
|||
|
|||
|
|||
MyEmployee.EmployeeInfo.Permissions |
|||
|
|||
- Box.CreateSendTask(FormalDocumentType)
- DocumentType:
Строка - тип документа на отправку. Возможные значения
Возвращает задание отправки документа
- Box.CreateSendTaskFromFile(DocumentType, FilePath)
- DocumentType:
Строка - тип документа на отправку. Возможные значения
- FilePath:
Строка - путь до файла контента документа
Возвращает задание отправки документа. Контент документа берётся из файла. Происходит попытка представить его в виде объектой модели
- Box.CreateSendTaskFromFileRaw(DocumentType, FilePath)
- DocumentType:
Строка - тип документа на отправку. Возможные значения
- FilePath:
Строка - путь до файла контента документа
Возвращает задание отправки документа. Контент документа берётся из файла. Представления контента в виде объектой модели не происходит
- Box.CreatePackageSendTask()
Возвращает задание отправки пакета документов
- Box.SendDraftAsync(MessageId)
- MessageId:
Строка - идентификатор сообщения черновика
Асинхронно отправляет черновики. Возвращает AsyncResult с коллекцией объектов, производных от Document в качестве результата
Изменено в версии 5.33.0: Метод ничего не делает
- Box.SetAndValidateAddressForCounteragent(key1S, addressTypeKey, isForeign, zipCode, regionCode, territory, city, locality, street, building, block, apartment)
- Key1S:
Строка - идентификатор адресной информации
- AddressTypeKey:
Строка - тип адресной информации
- IsForeign:
Строка - признак того, что адрес является иностранным (за пределами РФ)
- ZipCode:
Строка - индекс
- RegionCode:
Строка - код региона РФ
- Territory:
Строка - район
- City:
Строка - город
- Locality:
Строка - населенный пункт
- Street:
Строка - улица
- Building:
Строка - дом
- Block:
Строка - корпус
- Apartment:
Строка - квартира
Валидирует и загружает адресную информацию в хранилище. Возвращает коллекцию ошибок. Параметр isForeign ни на что не влияет, адрес можно задать только как российский
Изменено в версии 5.29.0: Вовзращаемая коллекция всегда пустая. Валидации не происходит
- Box.GetAddressForCounteragent(key1S, AddressTypeKey)
- Key1S:
Строка - идентификатор адресной информации
- AddressTypeKey:
Строка - тип адресной информации
Возвращает адресную информацию из хранилища
- Box.GetSentDocuments(OneSId, AsDiadocDocumentId=False)
- OneSId:
Строка - идентификаторы учётной системы, перечисленные через
;
- AsDiadocDocumentId:
Булево - возвращать идентификаторы документов в Диадок
Возвращает коллекцию строк - идентификаторов отправленных документов для запрашиваемых идентификаторов OneSId. Тип возвращаемых идентификаторов определяется параметром AsDiadocDocumentId: * Если
AsDiadocDocumentId == False
, то будут возвращены идентификаторы учётной системы; * ЕслиAsDiadocDocumentId == True
, то будут возвращены идентификаторы документов в Диадок
- Box.SetData(Key, Value)
- Key:
Строка - уникальный ключ в хранилище
- Value:
Строка - значение, соответствующее ключу
Добавляет пару ключ-значение в хранилище
- Box.GetData(Key)
- Key:
Строка - уникальный ключ в хранилище
Возвращает значение, соответствующее ключу
- Box.GetExtendedSignerDetails(Thumbprint, IsSeller=False, forCorrection=False)
- Thumbprint:
Строка - отпечаток сертификата
- IsSeller:
Булево - подписант для титула продавца
- ForCorrection:
Булево - подписант для титула корректировочного документа
Возвращает данные подписанта из базы Диадок. Метод может быть запрошен самим пользователем или администратором организации
- Box.GetExtendedSignerDetails2(Thumbprint, TitleType)
- Thumbprint:
Строка - отпечаток сертификата
- TitleType:
Строка - тип титула документа. Возможные значения
Возвращает параметры подписанта в текущей организации для указанного сертификата и указанного типа титула. Получить значение для TitleType можно из объекта DocumentTitle в ответе метода
Box.GetDocumentTypes()
. ДляTitleType == "Absent"
иTitleType == "UNKNOWN"
вызов невозможен. Метод может быть запрошен самим пользователем или администратором организации
- Box.CreateSetExtendedSignerDetailsTask(Thumbprint)
- Thumbprint:
Строка - отпечаток сертификата
Возвращает объект, с помощью которого можно установить параметры подписанта
- Box.GetUsers()
Возращает коллекцию сотрудников организации
- Box.GetUserPermissions()
Возвращает описание прав пользователя, в контексте которого произошла авторизация, для данной организации
- Box.CanSendInvoice(Thumbprint)
- Thumbprint:
Строка - отпечаток сертификата
Проверяет можно ли подписывать счёт-фактуры в текущей организации, используя сертификат с указанным отпечатком. Если возможно, то вернётся пустая строка. Если подписание невозможно, то вернётся текст с причиной невозможности это сделать
- Box.SendFnsRegistrationMessage(Thumbprint)
- Thumbprint:
Строка - отпечаток сертификата
Добавление в сообщение ФНС нового сертификата
- Box.SaveUserDataXSD(TitleName, Function, Version, DocflowSide, FilePath)
- TitleName:
Строка - название типа документа
- Function:
Строка - функция документа
- Version:
Строка - версия документа
- DocflowSide:
Строка - сторона документооборота. Возможные значения
- FilePath:
Строка - полное имя файла, в который нужно сохранить описание контента
Сохраняет описание представления контента документа на диск. Значения для TitleName, Function, Version можно получить в ответе метода
Box.GetDocumentTypes()
Добавлено в версии 5.27.0.
- Box.GetBase64UserDataXSD(TitleName, Function, Version, DocflowSide)
- TitleName:
Строка - название типа документа
- Function:
Строка - функция документа
- Version:
Строка - версия документа
- DocflowSide:
Строка - сторона документооборота. Возможные значения
Возвращает Base64 строку описания представления контента документа. Значения для TitleName, Function, Version можно получить в ответе метода
Box.GetDocumentTypes()
Добавлено в версии 5.28.3.
- Box.GetDocumentById(DocumentId, WithExternalId=False)
- DocumentId:
Строка - идентифкатор документа
- WithExternalId:
Булево - нужно ли запрашивать дополнительный идентификатор учётной системы
Возвращает документ в ящике по его идентификатору. При
WithExternalId == True
у документа будет заполнено поле OneSDocumentId, если оно установлено для него, но сам метод отработает медленнее. Получить этот идентификатор также можно с помощью DataTask
- Box.CreatePackageSendTask2()
Возвращает объект, с помощью которого можно отправить документы
Добавлено в версии 5.27.0.
- Box.GetReceiptGenerationProcess()
Возвращает объект, с помощью которого можно запустить процесс автоматической отправки извещений о получении документов в текущем ящике
- Box.CreatePatchTask()
Возвращает PatchTask - задание для изменения состояния документа (на данный момент реализовано только подписание)
- Box.SaveTitleDynamicContentXSD(TitleName, Function, Version, DocflowSide, FilePath)
- TitleName:
Строка - название типа документа
- Function:
Строка - функция документа
- Version:
Строка - версия документа
- DocflowSide:
Строка - сторона документооборота. Возможные значения
- FilePath:
Строка - полное имя файла, в который нужно сохранить описание контента
Сохраняет описание представления контента документа на диск. Значения для TitleName, Function, Version можно получить в ответе метода
Box.GetDocumentTypes()
Добавлено в версии 5.43.0.
- Box.GetBase64TitleDynamicContentXSD(TitleName, Function, Version, DocflowSide)
- TitleName:
Строка - название типа документа
- Function:
Строка - функция документа
- Version:
Строка - версия документа
- DocflowSide:
Строка - сторона документооборота. Возможные значения
Возвращает Base64 строку описания представления титула контента документа. Значения для TitleName, Function, Version можно получить в ответе метода
Box.GetDocumentTypes()
Добавлено в версии 5.43.0.
- Box.SaveSignersDynamicContentXSD(TitleName, Function, Version, DocflowSide, FilePath)
- TitleName:
Строка - название типа документа
- Function:
Строка - функция документа
- Version:
Строка - версия документа
- DocflowSide:
Строка - сторона документооборота. Возможные значения
- FilePath:
Строка - полное имя файла, в который нужно сохранить описание контента
Сохраняет описание представления подписанта титула документа на диск. Подписант титула используется для патчинга контента титула черновиков и неотправленных документов. Значения для TitleName, Function, Version можно получить в ответе метода
Box.GetDocumentTypes()
Добавлено в версии 5.43.0.
- Box.GetBase64SignersDynamicContentXSD(TitleName, Function, Version, DocflowSide)
- TitleName:
Строка - название типа документа
- Function:
Строка - функция документа
- Version:
Строка - версия документа
- DocflowSide:
Строка - сторона документооборота. Возможные значения
Возвращает Base64 строку описания представления подписанта титула документа. Подписант титула используется для патчинга контента титула черновиков и неотправленных документов. Значения для TitleName, Function, Version можно получить в ответе метода
Box.GetDocumentTypes()
Добавлено в версии 5.43.0.
- Box.RestoreDocument(DocumentId)
- DocumentId:
Строка - идентификатор документа
Восстанавливает удалённый документ
- Box.RecycleDraft(MessageId)
- MessageId:
Строка - идентификатор сообщения черновика
Метод удаляет черновик. Восстановить черновик невозможно
Добавлено в версии 5.25.0.
- Box.GetDocumentEventList([AfterEventId])
- AfterEventId:
Строка - идентификатор события, после которого будет вычитываться лента событий
Возвращает список событий, произошедших с документами после события с переданным идентификатором.
События возвращаются в хронологическом порядке.
Гарантии на количество возвращаемых событий нет, кроме той, что возврат пустого списка означает отсутствие новых событий в ящике.
Предполагается, что интеграционное решение будет хранить идентификтаор последнего полученного события для получения списка следующих событий.
Если AfterEventId пустой, то события начнут вычитываться с момента создания ящика организации в Диадок
- Box.GetTemplate(TemplateId)
- TemplateId:
Строка - идентификатор шаблона
Возвращает шаблон документа по его идентификатору
Добавлено в версии 5.24.0.
- Box.CreateTemplateSendTask()
Возвращает объект, с помощью которого можно отправить шаблон документ
Добавлено в версии 5.24.0.
- Box.CreateTransformTemplateTask(TemplateId)
- TemplateId:
Строка - идентификатор шаблона
Возвращает задание для создания документов из шаблона
Добавлено в версии 5.24.0.
- Box.GetCounteragentById(BoxId)
- BoxId:
Строка - идентификатор ящика
Возвращает контрагента по идентификатору ящика. Идентификатор может быть как в виде GUID, так и в виде
...@diadoc.ru
- Box.GetCounteragentByFNSParticipantId(FNSParticipantId)
- FNSParticipantId:
Строка - идентификатор участника ЭДО
Возвращает контрагента по участника ЭДО
- Box.GetCounteragentByOrgId(OrganizationId)
- OrganizationId:
Строка - идентификатор организации в Диадок
Возвращает контрагента по идентификатору организации
- Box.GetCounteragentListByStatus(CounteragentStatus)
- CounteragentStatus:
Строка - статус, по которому производится выборка контрагентов. Возможные значения
Возвращает коллекцию контрагентов, с указанным в запросе статусом. Если CounteragentStatus пустой, вернётся весь список контрагентов
- Box.GetCounteragentListByStatusAsync(CounteragentStatus)
- CounteragentStatus:
Строка - статус, по которому производится выборка контрагентов. Возможные значения
Асинхронный запрос контрагентов с указанным статусом. Если CounteragentStatus пустой, вернётся весь список контрагентов. Возвращает AsyncResult с коллекцией контрагентов в качестве результата
- Box.GetCounteragentListByInnKpp(Inn[, Kpp])
- Inn:
Строка - ИНН для поиска
- Kpp:
Строка - КПП для поиска
Возвращает коллекцию контрагентов с указанными ИНН-КПП
- Box.GetCounteragentListByInnKppAsync(Inn[, Kpp])
- Inn:
Строка - ИНН для поиска
- Kpp:
Строка - КПП для поиска
Возвращает AsyncResult с коллекцией контрагентов с указанными ИНН-КПП в качестве результата
- Box.GetCounteragentListByInnList(INNs)
- INNs:
Строка - ИНН, перечисленные через запятую без пробелов
Aсинхронный запрос контрагентов с перечисленными ИНН. Возвращает AsyncResult с коллекцией контрагентов в качестве результата
- Box.CreateAcquireCounteragentTask([FilePath])
- FilePath:
Строка - путь до файла-вложения
Создает запрос на приглашение контрагента к сотрудничеству. Если FilePath задан, то вместе с приглашением будет отправлен и этот файл
- Box.CreateAdminTools()
Создаёт объект для администрирования организации
Добавлено в версии 5.37.0.
- Box.GetFeatures()
Возвращает коллекцию строк - включённых у организации возможностей. Возможные значения
Добавлено в версии 5.32.4.
- Box.GetEmployees()
Возвращает коллекцию сотрудников организации
Добавлено в версии 5.37.0.
- Box.GetResolutionRoutes()
Возвращает коллекцию маршрутов согласования, настроенных в ящике
- Box.CreateDataTask()
Возвращает объект для работы с хранилищем ключей-значений
Добавлено в версии 5.29.9.
- Box.RegisterPowerOfAttorneyById(RegNumber, IssuerInn)
- RegNumber:
Строка - регистрационный номер МЧД
- IssuerInn:
Строка - ИНН доверителя
Регистрирует МЧД, в сервисе Диадок по её регистрационному номеру и ИНН доверителя. Возвращает AsyncResult c результат регистрации в качестве результат
Добавлено в версии 5.37.0.
- Box.RegisterPowerOfAttorneyByContent(XmlContent, XmlSignature)
- XmlContent:
Строка - контент МЧД в виде base64 строки
- XmlSignature:
Строка - контент подписи МЧД в виде base64 строки
Регистрирует МЧД, в сервисе Диадок с помощью файла МЧД и подписи, которой она была подписана. Для XmlSignature используется контент файла подписи (
*.sgn
,*.sig
), сформированного в момент выпуска доверенности.Возвращает AsyncResult c результат регистрации в качестве результат
Добавлено в версии 5.37.0.
- Box.GetDocumentTypes()
Возвращает коллекцию с описанием типов документов, доступных в ящике организации
Добавлено в версии 5.20.0.
- Box.GetFlatDocumentTypes()
Возвращает коллекцию с описанием типов документов, доступных в ящике организации В отличии от
Box.GetDocumentTypes()
возвращает типы в формате FlatDocumentTypeInfo, а не DocumentTypeDescription.Добавлено в версии 5.50.0.
- Box.GetDocumentType(Type, Function, Version)
- Type:
Строка - уникальный строковый идентификатор типа, соответствует полю DocumentTypeId.Type
- Function:
Строка - строковый идентификатор функции, уникальный в рамках типа документов, соответствует полю DocumentTypeId.Function
- Version:
Строка - строковый идентификатор версии, уникальный в рамках функции документа, соответствует полю DocumentTypeId.Version
Возвращает описание типа документов, доступных в ящике организации, по идентификаторам type, function, version
Добавлено в версии 5.50.0.