Organization¶
Организация на сервере Диадок
Свойства
Id: | Строка, чтение - идентификатор ящика организации в Диадоке |
---|---|
Name: | Строка, чтение - наименование организации |
Inn: | Строка, чтение - ИНН организации |
Kpp: | Строка, чтение - КПП организации |
Departments: | Коллекция объектов Department , чтение - подразделения, родительским подразделением которых является «Головное» подразделение |
AuthenticateType: | Строка, чтение - тип авторизации |
Login: | Строка, чтение - логин, по которому произошла авторизация к данной организации |
Certificate: | PersonalCertificate , чтение - сертификат, по которому произошла авторизация в данной организации |
FnsParticipantId: | Строка, чтение - идентификатор организации-участника документооборота |
FnsRegistrationDate: | Дата, чтение - дата подачи заявляения в ФНС на регистрацию данной организации в качестве участника документооборота ЭСФ |
IsTest: | Булево, чтение - организация работает в тестовом режиме |
IsPilot: | Булево, чтение - организация работает в пилотном режиме |
EncryptedDocumentsAllowed: | Булево, чтение - организации разрешена отправка зашифрованных документов |
Методы
-
Organization.
GetUsers
()¶ Возращает коллекцию пользователей организации
-
Organization.
GetUserPermissions
()¶ Возвращает описание прав пользователя, в контексте которого произошла авторизация, для данной организации
-
Organization.
GetCounteragentById
(BoxId)¶ BoxId: строка
идентификатор ящикаВозвращает контрагента по идентификатору ящика
-
Organization.
GetCounteragentByOrgId
(OrgId)¶ OrgId: строка
идентификатор организации в ДиадокВозвращает контрагента по идентификатору организации
-
Organization.
GetCounteragentListByStatus
([CounteragentStatus])¶ CounteragentStatus: строка
статус, по которому производится выборка контрагентов. Возможные значенияВозвращает коллекцию контрагентов, с указанным в запросе статусом. Если параметр не задан, вернётся весь список контрагентов
-
Organization.
GetCounteragentListByStatusAsync
([CounteragentStatus])¶ CounteragentStatus: строка
статус, по которому производится выборка контрагентов. Возможные значенияАсинхронный запрос контрагентов с указанным статусом. Если параметр не задан, вернётся весь список контрагентов. Возвращает AsyncResult с коллекцией контрагентов в качестве результата
-
Organization.
GetCounteragentListByInnKpp
(Inn[, Kpp])¶ Inn: строка
ИНН для поискаKpp: строка
КПП для поискаВозвращает коллекцию контрагентов, с указанными ИНН-КПП
-
Organization.
GetCounteragentListByInnList
(INNs)¶ INNs: строка
ИНН, перечисленные через запятую без пробеловAсинхронный запрос контрагентов с перечисленными ИНН. Возвращает AsyncResult с коллекцией контрагентов в качестве результата
-
Organization.
CreateAcquireCounteragentTask
([FilePath])¶ FilePath: строка
путь до файла-вложенияСоздает запрос на приглашение контрагента к сотрудничеству. Если FilePath задан, то вместе с приглашением будет отправлен и этот файл
-
Organization.
GetDocumentById
(DocumentId, WithOneSId=falst)¶ DocumentId: строка
идентифкатор документаWithOneSId: булево
нужно ли запрашивать дополнительный идентификатор учётной системыВозвращает документ в ящике по его идентификатору. При WithOneSId ==
TRUE
у документа будет заполнено поле OneSDocumentId, если оно установлено для него, но сам метод отработает медленнее
-
Organization.
GetDocumentsTask
()¶ Возвращает задачу поиска документов в ящике
-
Organization.
RestoreDocument
(DocumentId)¶ DocumentId: строка
идентификатор документаВосстанавливает удалённый документ
-
Organization.
GetReceiptGenerationProcess
()¶ Возвращает объект, с помощью которого можно запустить процесс автоматической отправки извещений о получении документов в текущем ящике
-
Organization.
GetDocumentEventList
([AfterEventId])¶ AfterEventId: строка
Идентификатор события, после которого будет вычитываться лента событийВозвращает список событий, произошедших с документами в текущем ящике. Если AfterEventId не задан, то события начнут вычитываться с момента создания ящика Диадок
-
Organization.
CreateSendTask
(FormalDocumentType)¶ DocumentType: строка
тип документа на отправку. Возможные значенияСоздаёт задание на отправку отдельного документа
Не рекомендуется, начиная с версии 5.5.0: Используйте
Organization.CreatePackageSendTask()
-
Organization.
CreateSendTaskFromFile
(DocumentType, FilePath)¶ DocumentType: строка
тип документа на отправку. Возможные значенияFilePath: строка
путь до файла контента документаСоздаёт задание на отправку отдельного документа. Контент файл будет представлен в виде объектой модели, и при отправке, возможно, пропатчен недостающими данными
Не рекомендуется, начиная с версии 5.5.0: Используйте
Organization.CreatePackageSendTask()
-
Organization.
CreateSendTaskFromFileRaw
(DocumentType, FilePath)¶ DocumentType: строка
тип документа на отправку. Возможные значенияFilePath: строка
путь до файла контента документаСоздаёт задание на отправку отдельного документа. Контент файл будет отправлен без изменений. Попытки разбора в объектную модель не будет
Не рекомендуется, начиная с версии 5.5.0: Используйте
Organization.CreatePackageSendTask()
-
Organization.
CreatePackageSendTask
()¶ Возвращает объект, с помощью которого можно отправить пакет документов
Добавлено в версии 5.5.0.
Не рекомендуется, начиная с версии 5.27.0: Используйте
Organization.CreatePackageSendTask2()
-
Organization.
CreatePackageSendTask2
()¶ Возвращает объект, с помощью которого можно отправить пакет документов
Добавлено в версии 5.27.0.
-
Organization.
CreateSendDraftTask
(MessageId)¶ MessageId: строка
идентификатор сообщения черновикаСоздаёт задание для отправки черновика документа
Добавлено в версии 5.18.0.
-
Organization.
SendDraftAsync
(MessageId)¶ MessageId: строка
идентификатор сообщения черновикаАсинхронно отправляет черновики. Возвращает AsyncResult с коллекцией объектов, производных от Document в качестве результата
Добавлено в версии 4.1.0.
Не рекомендуется, начиная с версии 5.18.0: Используйте объект SendDraftTask, создаваемый методом
Organization.SendDraftAsync()
-
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.5.0: Используйте
Organization.SetData()
Изменено в версии 5.29.0: Вовзращаемая коллекция всегда пустая. Валидации не происходит
-
Organization.
GetAddressForCounteragent
(key1S, AddressTypeKey)¶ Key1S: строка
идентификатор адресной информацииAddressTypeKey: строка
тип адресной информацииВозвращает адресную информацию из хранилища
Не рекомендуется, начиная с версии 5.5.0: Используйте
Organization.GetData()
-
Organization.
GetSentDocuments
(OneSId, AsDiadocDocumentId=False)¶ OneSId: строка
идентификаторы учётной системы, перечисленные через;
AsDiadocDocumentId: булево
возвращать идентификаторы документов в ДиадокВозвращает коллекцию строк - идентификаторов отправленных документов для запрашиваемых идентификаторов OneSId. Тип возвращаемых идентификаторов определяется параметром AsDiadocDocumentId: Если AsDiadocDocumentId ==
FALSE
, то будут возвращены идентификаторы учётной системы; Если AsDiadocDocumentId ==TRUE
, то будут возвращены идентификаторы документов в ДиадокНе рекомендуется, начиная с версии 5.5.0: Используйте
Organization.GetData()
-
Organization.
SetData
(Key, Value)¶ Key: строка
уникальный ключ в хранилищеValue: строка
значение, соответствующее ключуДобавляет пару ключ-значение в хранилище
-
Organization.
GetData
(Key)¶ Key: строка
уникальный ключ в хранилищеВозвращает значение, соответствующее ключу
-
Organization.
CreateSetExtendedSignerDetailsTask
(Thumbprint)¶ Thumbprint: строка
отпечаток сертификатаВозвращает задание для установки параметры подписанта
-
Organization.
GetExtendedSignerDetails
(Thumbprint, IsSeller=false, forCorrection=false)¶ Thumbprint: строка
отпечаток сертификатаIsSeller: булево
подписант для титула продавцаForCorrection: булево
подписант для титула корректировочного документаВозвращает данные подписанта из базы Диадок. Метод может быть запрошен самим пользователем или администратором организации
Не рекомендуется, начиная с версии 5.19.0: Используйте
Organization.GetExtendedSignerDetails2()
-
Organization.
GetExtendedSignerDetails2
(Thumbprint, TitleType)¶ Thumbprint: строка
отпечаток сертификатаTitleType: строка
тип титула документа. Возможные значенияВозвращает данные подписанта из базы Диадок. . Метод может быть запрошен самим пользователем или администратором организации
-
Organization.
SendFnsRegistrationMessage
(Thumbprint)¶ Thumbprint: строка
отпечаток сертификатаДобавление в сообщение ФНС нового сертификата
-
Organization.
CanSendInvoice
(Thumbprint)¶ Thumbprint: строка
отпечаток сертификатаВозвращает пустую строку, если указанный сертификат может использоваться для подписания счетов-фактур в текущей организации, или строку с причиной невозможности такого использования
-
Organization.
GetDocumentTypes
()¶ Возвращает коллекцию типов документов, доступных в ящике организации
-
Organization.
GetResolutionRoutes
()¶ Возвращает коллекцию маршрутов согласования, настроенных в ящике
-
Organization.
CreateTemplateSendTask
()¶ Возвращает задание для отправки шаблонов документов
-
Organization.
GetTemplate
(TemplateId)¶ TemplateId: строка
идентификатор шаблонаВозвращает шаблон документа по его идентификатору
-
Organization.
CreateTransformTemplateTask
(TemplateId)¶ TemplateId: строка
идентификатор шаблонаВозвращает задание для создания документов из шаблона
-
Organization.
RecycleDraft
(DraftId)¶ DraftId: строка
идентификатор черновикаудаляет черновик
-
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.
Дополнительная информация
Значение CounteragentStatus | Описание |
---|---|
IsMyCounteragent | отношение партнерства установлено и действует |
InvitesMe | контрагент прислал запрос на установление отношения партнерства |
IsInvitedByMe | в адрес контрагента был отправлен запрос на установление отношения партнерства |
Rejected | отношение партнерства было разорвано или запрос партнёрства был отклонен |
Значение FormalDocumentType | Описание |
---|---|
InvoiceContent | счет-фактура или исправительный счет-фактура в формате 93 приказа ФНС |
InvoiceCorrectionContent | корректировочный счет-фактура или исправление корректировочного счета-фактуры в формате 93 приказа ФНС |
XmlAcceptanceCertificateContent | акт о выполнении работ в формате 172 приказа ФНС |
XmlTorg12Content | ТОРГ-12 в формате 172 приказа ФНС |
UniversalTransferDocument | универсальный передаточный документ в формате 155 приказа ФНС |
UniversalCorrectionDocument | универсальный корректировочный документ в формате 189 приказа ФНС |
UtdTorg12 | формализованный ТОРГ-12 в формате 155 приказа ФНС |
UtdAcceptanceCertificate | формализованный акт о выполнении работ в формате 155 приказа ФНС |
UtdInvoice | счет-фактура в формате 155 приказа ФНС |
UcdInvoiceCorrection | корректировка счета-фактуры в формате 189 приказа ФНС |
TovTorg | Торг-12 в формате 551-го приказа ФНС |
XmlAcceptanceCertificate552 | акт в формате 552-го приказа ФНС |
Значение DocumentType | Описание |
---|---|
InvoiceContent | счет-фактура, исправление счета-фактуры в формате 93 приказа ФНС |
UtdInvoice | счет-фактура в формате 155 приказа ФНС |
InvoiceCorrectionContent | корректировочный счет-фактура, исправление корректировочного счета-фактуры в формате 93 приказа ФНС |
UcdInvoiceCorrection | корректировка счета-фактуры в формате 189 приказа ФНС |
AcceptanceCertificateContent | неформализованный акт о выполнении работ |
XmlAcceptanceCertificateContent | акта в формате 172 приказа ФНС |
UtdAcceptanceCertificate | формализованный акт о выполнении работ в формате 155 приказа ФНС |
XmlAcceptanceCertificate552 | акт в формате 552-го приказа ФНС |
Torg12Content | неформализованный ТОРГ-12 |
XmlTorg12Content | Торг-12 в формате 172 приказа ФНС |
UtdTorg12 | формализованный ТОРГ-12 в формате 155 приказа ФНС |
TovTorg | Торг-12 в формате 551 приказа ФНС |
UniversalTransferDocument | УПД в формате 155 приказа ФНС |
NonformilizedDocumentContent | произвольный неформализованный документ |
ProformaInvoiceContent | неформализованный счета на оплату |
XmlContent | произвольный формализованный документ в формате xml |
Contract | договор |
CertificateRegistry | реестр сертификатов |
PriceListAgreement | протокол согласования цены |
ReconciliationAct | акт сверки |
ServiceDetails | детализация |
Значение TitleType | Описание |
---|---|
UtdSeller | титул продавца УПД, сформированного по 155 приказу |
UtdBuyer | титул покупателя УПД, сформированного по 155 приказу |
Utd820Buyer | титул покупателя УПД, сформированного по 820 приказу |
UcdSeller | титул продавца УКД |
UcdBuyer | титул покупателя УКД |
TovTorg551Seller | титул продавца торг-12 в формате 551-го приказа ФНС |
TovTorg551Buyer | титул покупателя торг-12 в формате 551-го приказа ФНС |
AccCert552Seller | титул продавца акта в формате 552-го приказа ФНС |
AccCert552Buyer | титул покупателя акта в формате 552-го приказа ФНС |
Значение DocflowSide | Описание |
---|---|
Seller | Титул отправителя |
Buyer | Титул получателя |