Organization¶

Организация на сервере Диадок

Свойства

Name:	Строка, чтение - наименование организации
Inn:	Строка, чтение - ИНН организации
Kpp:	Строка, чтение - КПП организации
Departments:	Коллекция объектов Department , чтение - подразделения, родительским подразделением которых является «Головное» подразделение
FnsParticipantId:	Строка, чтение - идентификатор организации-участника документооборота
FnsRegistrationDate:	Дата, чтение - дата подачи заявляения в ФНС на регистрацию данной организации в качестве участника документооборота ЭСФ
Guid:	Строка, чтение - идентификатор ящика организации в Диадоке Добавлено в версии 5.31.0.
IsTest:	Булево, чтение - организация работает в тестовом режиме
IsPilot:	Булево, чтение - организация работает в пилотном режиме
IsLiquidated:	Булево, чтение - организация ликвидирована Добавлено в версии 5.31.0.
AuthenticateType:	Строка, чтение - тип авторизации
Login:	Строка, чтение - логин, по которому произошла авторизация к данной организации
Certificate:	PersonalCertificate , чтение - сертификат, по которому произошла авторизация в данной организации

Методы

Organization.GetDocumentById(DocumentId, WithExternalId=FALSE)¶

DocumentId:	`строка` идентифкатор документа
WithExternalId:	`булево` нужно ли запрашивать дополнительный идентификатор учётной системы

Возвращает документ в ящике по его идентификатору. При WithExternalId == TRUE у документа будет заполнено поле OneSDocumentId, если оно установлено для него, но сам метод отработает медленнее

Organization.GetDocumentsTask()¶: Возвращает объект для поиска документов в ящике

Organization.CreatePackageSendTask2()¶: Возвращает объект, с помощью которого можно отправить документы

Добавлено в версии 5.27.0.

Organization.GetReceiptGenerationProcess()¶: Возвращает объект, с помощью которого можно запустить процесс автоматической отправки извещений о получении документов в текущем ящике

Organization.SaveUserDataXSD(TitleName, Function, Version, DocflowSide, FilePath)¶

TitleName:	`строка` название типа документа
Function:	`строка` функция документа
Version:	`строка` версия документа
DocflowSide:	`строка` сторона документооборота. Возможные значения
FilePath:	`строка` полное имя файла, в который нужно сохранить описание контента

Сохраняет описание представления контента документа на диск. Значения для TitleName, Function, Version можно получить в ответе метода Organization.GetDocumentTypes()

Добавлено в версии 5.27.0.

Organization.GetBase64UserDataXSD(TitleName, Function, Version, DocflowSide)¶

TitleName:	`строка` название типа документа
Function:	`строка` функция документа
Version:	`строка` версия документа
DocflowSide:	`строка` сторона документооборота. Возможные значения

Возвращает Base64-строку описания представления контента документа. Значения для TitleName, Function, Version можно получить в ответе метода Organization.GetDocumentTypes()

Добавлено в версии 5.28.3.

Organization.RestoreDocument(DocumentId)¶

DocumentId:	`строка` идентификатор документа

Восстанавливает удалённый документ

Organization.CreateSendDraftTask(MessageId)¶

MessageId:	`строка` идентификатор сообщения черновика

Создаёт объект, с помощью которого можно отправить черновик. MessageId - первая половина из DocumentId черновика

Добавлено в версии 5.18.0.

Organization.RecycleDraft(MessageId)¶

MessageId:	`строка` идентификатор сообщения черновика

Метод удаляет черновик. Восстановить черновик невозможно. MessageId - первая половина из DocumentId черновика

Добавлено в версии 5.25.0.

Organization.GetDocumentEventList([AfterEventId])¶

AfterEventId:	`строка` Идентификатор события, после которого будет вычитываться лента событий

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

Organization.GetTemplate(TemplateId)¶

TemplateId:	`строка` идентификатор шаблона

Возвращает шаблон документа по его идентификатору

Добавлено в версии 5.24.0.

Organization.CreateTemplateSendTask()¶: Возвращает объект, с помощью которого можно отправить шаблон документ

Добавлено в версии 5.24.0.

Organization.CreateTransformTemplateTask(TemplateId)¶

TemplateId:	`строка` идентификатор шаблона

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

Добавлено в версии 5.24.0.

Organization.GetCounteragentById(BoxId)¶

BoxId:	`строка` идентификатор ящика

Возвращает контрагента по идентификатору ящика. Идентификатор может быть как в виде GUID, так и в виде ...@diadoc.ru

Organization.GetCounteragentByOrgId(OrganizationId)¶

OrganizationId:	`строка` идентификатор организации в Диадок

Возвращает контрагента по идентификатору организации

Organization.GetCounteragentListByStatus([CounteragentStatus])¶

CounteragentStatus:	`строка` статус, по которому производится выборка контрагентов. Возможные значения

Возвращает коллекцию контрагентов, с указанным в запросе статусом. Если CounteragentStatus не задан или пустой, вернётся весь список контрагентов

Organization.GetCounteragentListByStatusAsync([CounteragentStatus])¶

CounteragentStatus:	`строка` статус, по которому производится выборка контрагентов. Возможные значения

Асинхронный запрос контрагентов с указанным статусом. Если CounteragentStatus не задан или пустой, вернётся весь список контрагентов. Возвращает AsyncResult с коллекцией контрагентов в качестве результата

Organization.GetCounteragentListByInnKpp(Inn[, Kpp])¶

Inn:	`строка` ИНН для поиска
Kpp:	`строка` КПП для поиска

Возвращает коллекцию контрагентов с указанными ИНН-КПП

Organization.GetCounteragentListByInnKppAsync(Inn[, Kpp])¶

Inn:	`строка` ИНН для поиска
Kpp:	`строка` КПП для поиска

Возвращает AsyncResult с коллекцией контрагентов с указанными ИНН-КПП в качестве результата

Organization.GetCounteragentListByInnList(INNs)¶

INNs:	`строка` ИНН, перечисленные через запятую без пробелов

Aсинхронный запрос контрагентов с перечисленными ИНН. Возвращает AsyncResult с коллекцией контрагентов в качестве результата

Organization.CreateAcquireCounteragentTask([FilePath])¶

FilePath:	`строка` путь до файла-вложения

Создает запрос на приглашение контрагента к сотрудничеству. Если FilePath задан, то вместе с приглашением будет отправлен и этот файл

Organization.GetDocumentTypes()¶: Возвращает коллекцию с описанием типов документов, доступных в ящике организации

Добавлено в версии 5.20.0.

Organization.GetFeatures()¶: Возвращает коллекцию строк - включённых у организации возможностей. Возможные значения

Добавлено в версии 5.32.4.

Organization.GetUsers()¶: Возращает коллекцию сотрудников организации

Organization.GetResolutionRoutes()¶: Возвращает коллекцию маршрутов согласования, настроенных в ящике

Organization.SendFnsRegistrationMessage(Thumbprint)¶

Thumbprint:	`строка` отпечаток сертификата

Добавление в сообщение ФНС нового сертификата

Organization.CreateDataTask()¶: Возвращает объект для работы с хранилищем ключей-значений

Добавлено в версии 5.29.9.

Organization.GetUserPermissions()¶: Возвращает описание прав пользователя, в контексте которого произошла авторизация, для данной организации

Organization.CanSendInvoice(Thumbprint)¶

Thumbprint:	`строка` отпечаток сертификата

Проверяет можно ли подписывать счёт-фактуры в текущей организации, используя сертификат с указанным отпечатком. Если возможно, то вернётся пустая строка. Если подписание невозможно, то вернётся текст с причиной невозможности это сделать

Organization.GetExtendedSignerDetails2(Thumbprint, TitleType)¶

Thumbprint:	`строка` отпечаток сертификата
TitleType:	`строка` тип титула документа. Возможные значения

Возвращает параметры подписанта в текущей организации для указанного сертификата и указанного типа титула. Получить значение для TitleType можно из объекта DocumentTitle в ответе метода Organization.GetDocumentTypes() Для TitleType == Absent и TitleType == UNKNOWN вызов невозможен. Метод может быть запрошен самим пользователем или администратором организации

Organization.CreateSetExtendedSignerDetailsTask(Thumbprint)¶

Thumbprint:	`строка` отпечаток сертификата

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

Устаревшие методы

Метод	Когда устарел	Когда удалён	Рекомендуемая альтернатива
`Organization.CreateSendTask()`	5.5.0	5.33.4	`Organization.CreatePackageSendTask2()`
`Organization.CreateSendTaskFromFile()`	5.5.0	5.33.4	`Organization.CreatePackageSendTask2()`
`Organization.CreateSendTaskFromFileRaw()`	5.5.0	5.33.4	`Organization.CreatePackageSendTask2()`
`Organization.CreatePackageSendTask()`	5.27.0		`Organization.CreatePackageSendTask2()`
`Organization.SendDraftAsync()`	5.18.0		`Organization.CreateSendDraftTask()`
`Organization.SetAndValidateAddressForCounteragent()`	5.5.0		`Organization.CreateDataTask()`
`Organization.GetSentDocuments()`	5.5.0		`Organization.CreateDataTask()`
`Organization.SetData()`	5.29.9		`Organization.CreateDataTask()`
`Organization.GetData()`	5.29.9		`Organization.CreateDataTask()`
`Organization.GetAddressForCounteragent()`	5.5.0		`Organization.CreateDataTask()`
`Organization.GetExtendedSignerDetails()`	5.33.0		`Organization.GetExtendedSignerDetails2()`

Organization.CreateSendTask(FormalDocumentType)¶

DocumentType:	`строка` тип документа на отправку. Возможные значения

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

Organization.CreateSendTaskFromFile(DocumentType, FilePath)¶

DocumentType:	`строка` тип документа на отправку. Возможные значения
FilePath:	`строка` путь до файла контента документа

Возвращает задание отправки документа. Контент документа берётся из файла. Происходит попытка представить его в виде объектой модели

Organization.CreateSendTaskFromFileRaw(DocumentType, FilePath)¶

DocumentType:	`строка` тип документа на отправку. Возможные значения
FilePath:	`строка` путь до файла контента документа

Возвращает задание отправки документа. Контент документа берётся из файла. Представления контента в виде объектой модели не происходит

Organization.CreatePackageSendTask()¶: Возвращает задание отправки пакета документов

Organization.SendDraftAsync(MessageId)¶

MessageId:	`строка` идентификатор сообщения черновика

Асинхронно отправляет черновики. Возвращает AsyncResult с коллекцией объектов, производных от Document в качестве результата

Изменено в версии 5.33.0: Метод ничего не делает

Organization.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: Вовзращаемая коллекция всегда пустая. Валидации не происходит

Organization.GetAddressForCounteragent(key1S, AddressTypeKey)¶

Key1S:	`строка` идентификатор адресной информации
AddressTypeKey:	`строка` тип адресной информации

Возвращает адресную информацию из хранилища

Organization.GetSentDocuments(OneSId, AsDiadocDocumentId=False)¶

OneSId:	`строка` идентификаторы учётной системы, перечисленные через `;`
AsDiadocDocumentId:	`булево` возвращать идентификаторы документов в Диадок

Возвращает коллекцию строк - идентификаторов отправленных документов для запрашиваемых идентификаторов OneSId. Тип возвращаемых идентификаторов определяется параметром AsDiadocDocumentId: Если AsDiadocDocumentId == FALSE, то будут возвращены идентификаторы учётной системы; Если AsDiadocDocumentId == TRUE, то будут возвращены идентификаторы документов в Диадок

Organization.SetData(Key, Value)¶

Key:	`строка` уникальный ключ в хранилище
Value:	`строка` значение, соответствующее ключу

Добавляет пару ключ-значение в хранилище

Organization.GetData(Key)¶

Key:	`строка` уникальный ключ в хранилище

Возвращает значение, соответствующее ключу

Organization.GetExtendedSignerDetails(Thumbprint, IsSeller=false, forCorrection=false)¶

Thumbprint:	`строка` отпечаток сертификата
IsSeller:	`булево` подписант для титула продавца
ForCorrection:	`булево` подписант для титула корректировочного документа

Возвращает данные подписанта из базы Диадок. Метод может быть запрошен самим пользователем или администратором организации

GetDocumentById()	GetCounteragentById()	GetDocumentTypes()	GetUserPermissions()
GetDocumentsTask()	GetCounteragentByOrgId()	GetFeatures()	CanSendInvoice()
CreatePackageSendTask2()	GetCounteragentListByStatus()	GetUsers()	GetExtendedSignerDetails2()
GetReceiptGenerationProcess()	GetCounteragentListByStatusAsync()	GetResolutionRoutes()	CreateSetExtendedSignerDetailsTask()
SaveUserDataXSD()	GetCounteragentListByInnKpp()	SendFnsRegistrationMessage()
GetBase64UserDataXSD()	GetCounteragentListByInnKppAsync()	CreateDataTask()
RestoreDocument()	GetCounteragentListByInnList()
CreateSendDraftTask()	CreateAcquireCounteragentTask()
RecycleDraft()
GetDocumentEventList()
GetTemplate()
CreateTemplateSendTask()
CreateTransformTemplateTask()