EDoc v3: Документация

Appearance

DocumentRepository ​

Документация для класса DocumentRepository.

Методы ​

getDocuments ​

Описание

Получение любых документов.

HTTP метод: GET

URL: /api/v1/document

Параметры:

ИмяТипОписание
payloadIGetDocumentsPayload & { ref_document_types_id?: number | null }

Возвращает: Promise<IPaginationShell<IDocument[]>>

getDocumentsByTask ​

Описание

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

HTTP метод: GET

URL: /api/v1/document/by-task

Параметры:

ИмяТипОписание
taskTypeETaskTypeRequestAlias
payloadIGetDocumentsPayload

Возвращает: Promise<IPaginationShell<IDocument[]>>

getDocumentsByFolder ​

Описание

Получение документов по типУ папки к которой оно прикреплено.
Как всех, так и конткретно по типам.

HTTP метод: GET

URL: /api/v1/document/by-folder${ folderType ?

Параметры:

ИмяТипОписание
folderTypeEDocumentFolderAlias
payloadIGetDocumentsPayload

Возвращает: Promise<IPaginationShell<IDocument[]>>

getDocumentsForRelate ​

Описание

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

HTTP метод: GET

URL: /api/v1/document/{param}/linkable-docs

Параметры:

ИмяТипОписание
documentIdIDocument['id']
payloadIGetDocumentsForRelatePayload

Возвращает: Promise<IPaginationShell<IDocument[]>>

getRelatedDocuments ​

Описание

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

HTTP метод: GET

URL: /api/v1/document/{param}/linked-docs

Параметры:

ИмяТипОписание
documentIdIDocument['id']
payloadIPaginationPayload

Возвращает: Promise<IPaginationShell<RelatedDocumentT[]>>

getDocumentById ​

Описание

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

HTTP метод: GET

URL: /api/v1/document/{param}

Параметры:

ИмяТипОписание
documentIdIDocument['id']

Возвращает: Promise<IDocument>

getDocumentByUUID ​

Описание

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

HTTP метод: GET

URL: /api/v1/document/show-by-uuid/{param}

Параметры:

ИмяТипОписание
uuidRefUUID

Возвращает: Promise<IDocument>

getAllFilesInZIP ​

Описание

Получение всех вложений документа в архиве

HTTP метод: GET

URL: /api/v1/document/{param}/zip-files

Параметры:

ИмяТипОписание
documentIdIDocument['id']

Возвращает: Promise<File>

getHashForSign ​

Описание

Получение хэша для отправки в программу NCA LAYER для подписания

HTTP метод: GET

URL: /api/v1/document/{param}/sign-hash

Параметры:

ИмяТипОписание
documentIdIDocument['id']

Возвращает: Promise<RefHash>

createDocument ​

Описание

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

HTTP метод: POST

URL: /api/v1/document

Параметры:

ИмяТипОписание
payloadICreateDocumentPayload

Возвращает: Promise<CreatedDocumentT>

editDocument ​

Описание

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

HTTP метод: POST

URL: /api/v1/document/{param}

Параметры:

ИмяТипОписание
documentIdIDocument['id']
payloadIEditDocumentPayload

Возвращает: Promise<IDocument>

saveToDraft ​

Описание

Сохранение документа в черновик

HTTP метод: POST

URL: /api/v1/document/{param}/save-draft

Параметры:

ИмяТипОписание
documentIdIDocument['id']
payloadIEditDocumentPayload

Возвращает: Promise<IDocument>

sendDocumentByRouter ​

Описание

Отправка документа по выставленному маршруту

HTTP метод: POST

URL: /api/v1/stage/create

Параметры:

ИмяТипОписание
documentIdIDocument['id']
payloadISendDocumentByRouterPayload

Возвращает: Promise<IDocument>

updateDocumentByRouter ​

Описание

Обновление действуиющего маршрута документа

HTTP метод: PUT

URL: /api/v1/stage/update

Параметры:

ИмяТипОписание
documentIdIDocument['id']
payloadISendDocumentByRouterPayload

Возвращает: Promise<IDocument>

deleteDocument ​

Описание

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

HTTP метод: DELETE

URL: /api/v1/document/{param}

Параметры:

ИмяТипОписание
documentIdIDocument['id']

Возвращает: Promise<void>

relateDocuments ​

Описание

Связывание документа с другими документами по ID.

HTTP метод: POST

URL: /api/v1/document/{param}/link

Параметры:

ИмяТипОписание
documentIdIDocument['id']
payloadIRelateDocumentsPayload

Возвращает: Promise<IPaginationShell<RelatedDocumentT[]>>

unrelateDocument ​

Описание

Открепление связанного документа до ID.

HTTP метод: POST

URL: /api/v1/document/{param}/unlink

Параметры:

ИмяТипОписание
documentIdIDocument['id']
relatedDocumentIdRelatedDocumentT['id']

Возвращает: Promise<IPaginationShell<RelatedDocumentT[]>>

withdrawDocument ​

Описание

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

HTTP метод: POST

URL: /api/v1/document/{param}/revoke

Параметры:

ИмяТипОписание
documentIdIDocument['id']
payloadIWithdrawDocumentPayload

Возвращает: Promise<IDocument>

reassignExecutorDocument ​

Описание

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

HTTP метод: POST

URL: /api/v1/document/{param}/change-executor

Параметры:

ИмяТипОписание
documentIdIDocument['id']
payloadIReassignExecutorDocumentPayload

Возвращает: Promise<IDocument>

executeDocument ​

Описание

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

HTTP метод: POST

URL: /api/v1/document/{param}/execute

Параметры:

ИмяТипОписание
documentIdIDocument["id"]
payloadIExecuteDocumentPayload

Возвращает: Promise<IDocument>

getResolutionsChain ​

Описание

Получение всей цепочки резолюций. Без разницы на каком уровне резолюции ты находишься. А так же всегда получаешь главного родителя - Служебная записка

HTTP метод: GET

URL: /api/v1/document/{param}/resolution-chain

Параметры:

ИмяТипОписание
documentIdIDocument["id"]

Возвращает: Promise<IGetResolutionsChainResponse>

approveResolutionDocument ​

Описание

Одобрение документа "Резолюция". Используется для автора резолюции. А-ля сущности роли "Исполнитель документа"

HTTP метод: POST

URL: /api/v1/document/{param}/execute

Параметры:

ИмяТипОписание
documentIdIDocument['id']
payloadIApproveResolutionDocumentPayload

Возвращает: Promise<IDocument>

rejectResolutionDocument ​

Описание

Отклонение документа "Резолюция" Используется для отправки резолюции "На доработку" автором резолюции(А-ля сущности роли "Исполнитель документа")

HTTP метод: POST

URL: /api/v1/document/{param}/resolution/reject

Параметры:

ИмяТипОписание
documentIdIDocument['id']
payloadIRejectResolutionDocumentPayload

Возвращает: Promise<IDocument>

getDocumentPreview ​

Описание

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

HTTP метод: GET

URL: /api/v1/document/{param}/preview-template

Параметры:

ИмяТипОписание
idnumber

Возвращает: Promise<Blob>

addDocumentParticipants ​

Описание

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

HTTP метод: POST

URL: /api/v1/document/{param}/participants

Параметры:

ИмяТипОписание
documentIdIDocument['id']
payloadIParticipantModel[]

Возвращает: Promise<IDocument>

prefillingTemplateDocument ​

Описание

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

HTTP метод: POST

URL: /api/v1/document/{param}/template-values/fill

Параметры:

ИмяТипОписание
documentIdIDocument['id']
payloadIPrefillingTemplateDocument

Возвращает: Promise<IDocument>

unilateralTerminateDocument ​

Описание

Одностороннее расторжение

HTTP метод: POST

URL: /api/v1/document/{param}/terminate

Параметры:

ИмяТипОписание
documentIdIDocument['id']
payloadITerminateDocumentPayload

Возвращает: Promise<IDocument>

bilateralTerminateDocument ​

Описание

Двустороннее расторжение

HTTP метод: POST

URL: /api/v1/document/{param}/bilateral-terminate

Параметры:

ИмяТипОписание
documentIdIDocument['id']
payloadITerminateDocumentPayload

Возвращает: Promise<IDocument>

refusalTerminateDocument ​

Описание

Отзыв "Расторжение"

HTTP метод: POST

URL: /api/v1/document/{param}/terminate/cancel

Параметры:

ИмяТипОписание
documentIdIDocument['id']
payloadIRefusalTerminateDocumentPayload

Возвращает: Promise<IDocument>

resendTerminateNotificationToCounterparty ​

Описание

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

HTTP метод: POST

URL: /api/v1/document/{param}/notifications/terminate/resend

Параметры:

ИмяТипОписание
documentIdIDocument['id']
payloadIResendTerminateNotificationToCounterparty

Возвращает: Promise<IDocument>

migrationToUnilateralTerminate ​

Описание

Переход с двустороннего в одностороннее расторжение

HTTP метод: POST

URL: /api/v1/document/{param}/convert-to-unilateral-termination

Параметры:

ИмяТипОписание
documentIdIDocument['id']
payloadIMigrationToUnilateralTerminatePayload

Возвращает: Promise<IDocument>

getByTaskRelatedDocuments ​

Описание

Получение всех документов к которым ты имел когда-либо отношение

HTTP метод: GET

URL: /api/v1/document/by-task/related

Параметры:

ИмяТипОписание
payloadIGetDocumentsPayload

Возвращает: Promise<IDocument[]>

notConclude ​

Описание

Отказ в заключении документа

HTTP метод: POST

URL: /api/v1/document/{param}/non-conclusion

Параметры:

ИмяТипОписание
documentIdIDocument['id']
payloadINotConcludePayload

Возвращает: Promise<void>

additionalFileAttachments ​

Описание

Дополнительное прикрепление файлов к документу

HTTP метод: POST

URL: api/v1/document/{param}/attachments

Параметры:

ИмяТипОписание
documentIdIDocument['id']
payloadIAdditionalFileAttachmentsPayload

Возвращает: Promise<void>

getHistory ​

Описание

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

HTTP метод: GET

URL: /api/v1/document/{param}/history

Параметры:

ИмяТипОписание
documentIdIDocument['id']
payloadIGetDocumentHistoryPayload

Возвращает: Promise<IPaginationShell<IDocumentHistory[]>>

getDocumentUnits ​

Описание

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

HTTP метод: GET

URL: /api/v1/document/{param}/document-units

Параметры:

ИмяТипОписание
documentIdIDocument['id']
payloadIGetDocumentUnitsPayload

Возвращает: Promise<IPaginationShell<IDocumentUnit[]>>

Описание

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

HTTP метод: POST

URL: /api/v1/document/{param}/notifications/sign-by-link/resend

Параметры:

ИмяТипОписание
documentIdIDocument['id']
payloadIResendNotificationSignByLinkPayload

Возвращает: Promise<void>

Определения типов ​

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

IAdditionalFileAttachmentsPayload ​

СвойствоТипОписание
attach`{
    file_ids: IFile['id'][]
}[]` |  |

| unattach | { document_file_ids: IFile['id'][] }[] | |

IApproveResolutionDocumentPayload ​

СвойствоТипОписание
comment (опц.)string

IArgRegistry ​

СвойствоТипОписание
amount_factstring
amount_fact_ndsstring
amount_guarantee_contractstring
amount_guarantee_prepaymentstring
amount_guarantee_totalstring
amount_plan_totalstring
amount_result_ndsstring
amount_result_totalstring
aux_orders_idnull
codestring
contract_datenull | string
create_datestring
customer_addressstring
customer_address_kzstring
customer_bankstring
customer_bikstring
customer_bill_pidnumber
customer_emailnull | string
customer_idnumber
customer_iikstring
customer_leader_basis_kznumber
customer_leader_basis_runumber
customer_leader_namestring
customer_leader_pidnumber
customer_leader_titlestring
customer_leader_title_kzstring
customer_phonenumber
execute_datenull
fact_trade_methodnumber
finish_datestring
idnumber
is_additionalnumber
is_contract_procuring_confirmednumber
is_deletednumber
is_longtermnumber
is_manualnumber
is_offer_procuring_confirmednumber
is_quasinumber
is_sent_edocnumber
is_typicalnumber
is_uninterruptednumber
name_kzstring
name_rustring
ndsnumber
notify_daysnumber
numbernumber
parent_idnull
plan_trade_methodnumber
ref_agreement_types_idnumber
ref_agreements_statuses_idnumber
ref_buys_types_idnumber
ref_currency_codestring
ref_guarantee_reasons_idnull
ref_procuring_types_idnull
ref_subject_types_codestring
result_datenull
root_idnull
supplier_addressstring
supplier_address_kzstring
supplier_bankstring
supplier_bikstring
supplier_bill_pidnumber
supplier_emailstring
supplier_idnumber
supplier_iikstring
supplier_leader_basis_kznumber
supplier_leader_basis_runumber
supplier_leader_namestring
supplier_leader_pidnumber
supplier_leader_titlestring
supplier_leader_title_kzstring
supplier_ndsnumber
supplier_phonestring
sys_users_idnumber
trd_buy_idnull
update_datestring
update_statuses (опц.)`{
    id: number
    attempts: 'attempts'
    status: EDocumentStatusIds
    sent: boolean
}` |  |

IAttribute ​

СвойствоТипОписание
idnumber
filesIFile[]
is_activeRefNumericBoolean
is_hiddenRefNumericBoolean
is_readonlyRefNumericBoolean
numbernumber
namestring
valueAttributeValueT
attributeIAttributeMeta
template (опц.)ITemplate
template_values (опц.)ITemplateValue[]

IAttributeEditor ​

СвойствоТипОписание
idIAttribute['id']
labelstring
nameEAttributeAlias
files(IFile | NewFileT)[]
valueAttributeValueT
typeEAttributeTypeAlias
templateId (опц.)number

IAttributeMeta ​

СвойствоТипОписание
is_activeRefNumericBoolean
namestring
numbernumber
aliasEAttributeAlias
attribute_typeIAttributeType

IAttributeType ​

СвойствоТипОписание
namestring
aliasEAttributeTypeAlias

IBank ​

СвойствоТипОписание
idnumber
namestring
addressstring
bikstring
codenumber
countryICountry
is_activeboolean
is_headboolean

IBasicInformationForm ​

СвойствоТипОписание
nameIDocument['name']
descriptionIDocument['description']
dateIDocument['date']
numberIDocument['number']
link_to_id (опц.)IDocument['id']

IBill ​

СвойствоТипОписание
idnumber
iikstring
is_defaultboolean
kbeRefNumberInString
sys_subjects_idnumber
countryICountry
currencyICurrency
bankIBank
bill_typeOmit<RefEntityShell<undefined, EBillTypeId>, 'alias'>

IComment ​

СвойствоТипОписание
idnumber
created_atRefDateTime
updated_at (опц.)RefDateTime
userRefBaseUserProfile
contentstring
typeRefEntityShell
files (опц.)IFile[]

IContact ​

СвойствоТипОписание
idnumber
fulladdressstring
is_defaultboolean
phonestring
postalstring
sys_subjects_idnumber
contact_typeRefEntityShell
countryICountry
kato (опц.)IKATO

IContextAttributeEditor ​

Наследует: RefEntityShell

СвойствоТипОписание
templateIdIDocumentTemplateInfo['id'] | null

ICountry ​

СвойствоТипОписание
alpha2CountryIsoCode
codeRefNumberInString
idnumber
is_activeboolean
namestring

ICreateDocumentPayload ​

СвойствоТипОписание
type_idEDocumentTypeIds
parent_id (опц.)IDocument['id']
template_id (опц.)number
document_type_context_id (опц.)EDocumentContextTypeIds
plan_point_id (опц.)IPointPlan['id']
link_to_id (опц.)IDocument['id']
terminate (опц.)`{
    type: EDocumentTerminateTypeIds,
    comment: string
}` |  |

ICurrency ​

СвойствоТипОписание
idRefNumberInString
namestring
codenumber
is_activeboolean
current`{
    id: number
    code: string
    publish_date: string
    amount: string
    description: string
}` |  |

IDocument ​

СвойствоТипОписание
idnumber
namestring
numberstring
active_task (опц.)Omit<ITask, 'author' | 'task_status' | 'executors'>
active_task_comment (опц.)IDocumentActiveTaskComment
attributesIAttribute[]
authorIUser
currentSubjectIdnumber
dateRefDate
descriptionstring
executorIUser
progressBarIDocumentProgressBarItem[]
propertiesIDocumentProperty[]
selfStagesIDocumentSelfStage[]
root (опц.)IDocument
statusRefEntityShell
typeRefEntityShell
subjectISubject
signedForms (опц.)`{
    created_at: RefDateTime
    name: string
    url: string
}[]` |  |

| templatedForm (опц.) | { name: string url: string } | | | formForSign (опц.) | { name: string url: string } | | | counterparties (опц.) | { id: number identifier: string name: string }[] | | | rejection_reason (опц.) | IComment | | | revocation_reason (опц.) | IComment | | | children (опц.) | IDocument[] | | | template | ITemplate | | | template_values | ITemplateValue[] | | | coExecutings (опц.) | IDocumentParticipantShell[] | | | observers (опц.) | IUser[] | | | receiver (опц.) | IUser | | | receiver_subject (опц.) | ISubject | | | comments (опц.) | IComment[] | | | context (опц.) | IContext[] | | | context_attributes (опц.) | IAttribute[] | | | files_history (опц.) | IHistoryFile[] | | | document_type_context (опц.) | RefEntityShell | | | is_external | boolean | | | agr_registry (опц.) | IArgRegistry | |

IDocumentActiveTaskComment ​

СвойствоТипОписание
idnumber
contentstring

IDocumentParticipantShell ​

СвойствоТипОписание
idnumber
comments (опц.)IComment[]
document (опц.)null
due_dateRefSystemDateTime
executed_at (опц.)RefSystemDateTime
executoruserT
task_executing`{
    assigned_at: RefDateTime
    due_date: RefDateTime
    executed_at: RefDateTime
    result: boolean \| null
    task_id: ITask['id']
}` |  |

IDocumentProgressBarItem ​

СвойствоТипОписание
namestring
successRefEntitySuccess

IDocumentProperty ​

СвойствоТипОписание
idnumber
ref_document_properties_codeEDocumentPropertyAlias
valuestring
propertyRefEntityShell

IDocumentRepository ​

Интерфейс не содержит собственных свойств и не наследует другие локальные интерфейсы.

IDocumentSelfStage ​

СвойствоТипОписание
idnumber
namenull
numbernumber
stage_typeRefEntityShell
stage_statusRefEntityShell
tasksITask[]

IDocumentTemplateEditorValue ​

СвойствоТипОписание
attr_idnumber
valuestring | string[] | number | number[] | (string | number)[] | null

IEditDocumentPayload ​

СвойствоТипОписание
basicInformation (опц.)IBasicInformationForm
additionalInformation (опц.)IAttributeEditor[]
attachments (опц.)IAttributeEditor[]
templateValues (опц.)IDocumentTemplateEditorValue[]
contextAttributes (опц.)IContextAttributeEditor[]
replacingAttachments (опц.)IReplacingFile[]
templates (опц.)ITemplateEditor[]
documentExecutorId (опц.)IDocument['executor']['id']
documentExecutorSubjectId (опц.)ISubject['id']
documentUnits (опц.)IDocumentUnit['id'][]
parentId (опц.)IDocument['id']

IExecuteDocumentPayload ​

СвойствоТипОписание
action (опц.)'execute' | 'send_to_check' | 'approve' | 'reject'
commentstring
executor_id (опц.)number
file_ids (опц.)number[]

IFile ​

СвойствоТипОписание
idnumber
namestring
is_activeRefNumericBoolean
created_at (опц.)RefSystemDateTime
sys_file`{
    id: number
    name: string
    full_path: string
    mime: RefMimeTypeFromDb
    path: string
    size: number
}` |  |

IFillableAttributeTableData ​

СвойствоТипОписание
columnRefNumberInString
tableRefNumberInString

IGetDocumentHistoryPayload ​

Наследует: IPaginationPayload

СвойствоТипОписание
sortEDocumentHistorySort
orderEPaginationOrder

IGetDocumentsForRelatePayload ​

Наследует: IPaginationPayload

СвойствоТипОписание
name (опц.)string
sys_folders_id (опц.)number
ref_document_types_id (опц.)EDocumentTypeIds | null
ref_document_statuses_id (опц.)EDocumentStatusIds
sort (опц.)EDocumentSortTypeAlias
order (опц.)EDocumentOrderTypeAlias

IGetDocumentsPayload ​

Наследует: IPaginationPayload

СвойствоТипОписание
q (опц.)string
ref_document_types_id (опц.)EDocumentTypeIds | null
ref_document_statuses_id (опц.)EDocumentStatusIds | null
created_from (опц.)RefSystemDate | string
created_to (опц.)RefSystemDate | string
due_from (опц.)RefSystemDate | string
due_to (опц.)RefSystemDate | string
sort (опц.)EDocumentSortTypeAlias | null
order (опц.)EDocumentOrderTypeAlias | null
author_id (опц.)RefBaseUserProfile['id'] | null
sys_subjects_id (опц.)ISubject['id'] | null
sys_subjects_identifier (опц.)ISubject['identifier']

IGetDocumentUnitsPayload ​

Наследует: IPaginationPayload

СвойствоТипОписание
name (опц.)string
from (опц.)RefSystemDate
to (опц.)RefSystemDate
order (опц.)EPaginationOrder
sort (опц.)EDocumentUnitSort

IGetResolutionsChainResponse ​

СвойствоТипОписание
root_documentIDocument
resolution_chainIDocument[]
total_resolutionsnumber
max_depthnumber

IHistoryFile ​

СвойствоТипОписание
idnumber
authorRefBaseUserProfile | null
created_atRefSystemDateTime
is_activeRefNumericBoolean
is_actualboolean
namestring
sys_fileIFile
updated_atRefSystemDateTime
versionnumber

IKATO ​

СвойствоТипОписание
idnumber
full_namestring
namestring
testring

IMigrationToUnilateralTerminatePayload ​

СвойствоТипОписание
datestring
commentstring

INotConcludePayload ​

СвойствоТипОписание
commentstring
СвойствоТипОписание
firststring | null
laststring | null
nextstring | null
prevstring | null

IPaginationMeta ​

СвойствоТипОписание
pathstring
current_pagenumber
per_pagenumber
tonumber
fromnumber
totalnumber
linksIPaginationMetaLink[]
last_pagenumber
СвойствоТипОписание
activeboolean
labelstring
urlstring | null

IPaginationPayload ​

СвойствоТипОписание
pagenumber
per_pagenumber

IPaginationShell ​

СвойствоТипОписание
linksIPaginationLinks[]
metaIPaginationMeta
datalist

IParticipantModel ​

Модельки данных при добавлении участников

СвойствоТипОписание
elementIdnumber
typeEDocumentParticipantAlias
participantsCreateParticipantT[]

IPrefillingTemplateDocument ​

СвойствоТипОписание
link_to_idnumber

IReassignExecutorDocumentPayload ​

СвойствоТипОписание
user_idRefBaseUserProfile['id']
commentstring

IRefusalTerminateDocumentPayload ​

СвойствоТипОписание
commentstring

IRejectResolutionDocumentPayload ​

СвойствоТипОписание
commentstring

IRelateDocumentsPayload ​

СвойствоТипОписание
idsnumber[]

IReplacingFile ​

СвойствоТипОписание
attributeNameIAttribute['name']
attributeIdIAttribute['id']
attributeAliasEAttributeAlias
files`{
    /**
     * Новый файл
     */
    to: IFile \| null
    /**
     * Текущих файл
     */
    from: IFile
}[]` |  |

IResendNotificationSignByLinkPayload ​

СвойствоТипОписание
task_executor_idnumber

IResendTerminateNotificationToCounterparty ​

СвойствоТипОписание
comment (опц.)string

ISendDocumentByRouterPayload ​

СвойствоТипОписание
stagesIStageModel[]

IStageModel ​

Модельки данных при добавлении этапа по каждому этапу

СвойствоТипОписание
elementIdnumber
type_idEDocumentStageTypeIds
tasksCreateTaskT[]

ISubject ​

СвойствоТипОписание
idnumberId компании
namestring
name_rustring
name_kzstring
name_enstring
created_atRefDate
identifierstring
parent_id (опц.)RefParentId
billsIBill[]
contactsIContact[]
countryICountry
logo`{
    default: boolean
    url: string
}` |  |

| kopf | { id: number name: number alias: string code: string } | | | available_document_types | Omit<RefEntityShell<EDocumentTypeAlias, EDocumentTypeIds>, 'name'>[] | | | is_customer (опц.) | boolean | | | is_supplier (опц.) | boolean | |

ISubjectRole ​

СвойствоТипОписание
idnumber
namestring
currentboolean
identifierstring
kopfISubject['kopf']
permissionsstring[]
rolesIUserRole[]

ITask ​

СвойствоТипОписание
idnumber
assigned_at (опц.)RefDateTime
due_dateRefDateTime
executed_at (опц.)RefDateTime
authorRefBaseUserProfile
task_statusRefEntityShell
task_typeRefEntityShell
executorsITaskExecutor[]

ITaskExecutor ​

СвойствоТипОписание
idnumber
assigned_atRefDateTime
due_dateRefDateTime
executed_atRefDateTime
resultRefEntitySuccess
signByLink (опц.)ITaskSignByLink
userRefBaseUserProfile
subjectISubject
СвойствоТипОписание
comment (опц.)string
due_dateRefDateTime
emailstring
full_namestring
idnumber
identifierstring
iinstring
subject_identifierstring
subject_namestring
sys_documents_idnumber
sys_stages_idnumber
sys_task_executors_idnumber
sys_tasks_idnumber
ttlnumber
uuidstring

ITemplate ​

СвойствоТипОписание
idnumber
namestring
fillableAttributesITemplateFillableAttribute[]

ITemplateEditor ​

СвойствоТипОписание
idnumber
namestring
contextAttributeId (опц.)IAttribute['id']
contextAttributeAlias (опц.)EAttributeAlias
contextAttributeLabel (опц.)string
variablesITemplateFillableAttributeEditor[]
references (опц.)ITheSelectList[]

ITemplateFillableAttribute ​

СвойствоТипОписание
default_valueFillableAttributeValueT
descriptionstring | null
groupnumber
idnumber
is_requiredboolean
labelstring
languageRefEntityShell
place_typeETemplatePlaceTypeAlias
reference (опц.)ITemplateFillableReference[] | null
tabRefEntityShell
value_typeETemplateValueTypeAlias
table_data (опц.)IFillableAttributeTableData

ITemplateFillableAttributeEditor ​

СвойствоТипОписание
idITemplateFillableAttribute['id']
labelITemplateFillableAttribute['label']
descriptionITemplateFillableAttribute['description']
valueFillableAttributeValueT
placeTypeETemplatePlaceTypeAlias
valueTypeETemplateValueTypeAlias
tableData (опц.)ITemplateFillableAttribute['table_data']
languageRefEntityShell
tabRefEntityShell
references (опц.)ITheSelectList[]
isRequiredITemplateFillableAttribute['is_required']

ITemplateFillableReference ​

СвойствоТипОписание
idnumber
is_activeboolean
valuestring | number

ITemplateValue ​

СвойствоТипОписание
idnumber
sys_documents_idIDocument['id']
sys_template_attributes_idITemplateFillableAttribute['id']
sys_templates_idITemplate['id']
valueFillableAttributeValueT

ITerminateDocumentPayload ​

СвойствоТипОписание
dateRefSystemDate
commentstring
file_idIFile['id']

ITheSelectList ​

СвойствоТипОписание
idnumber | string
titlestring
valuestring | number

IUser ​

СвойствоТипОписание
idnumber
created_atRefDate
birth_dateRefDate
emailstring
email_verifiedboolean
verification_token (опц.)string
identifierstring
is_disableboolean
phonestring
set_passwordboolean
lastname (опц.)string
namestring
surname (опц.)string
unread_notifications_countnumber
permissionsEUserPermissions[]
profile_photo_urlRefEntityMedia
rolesIUserRole[]
subject_rolesISubjectRole[]
is_disabled_reason (опц.)string
has_password (опц.)boolean

IUserRole ​

СвойствоТипОписание
idnumber
namestring
aliasEUserRoleAlias
created_atRefDate

IWithdrawDocumentPayload ​

СвойствоТипОписание
commentstring

RefBaseUserProfile ​

СвойствоТипОписание
emailstring
idnumber
identifierstring
lastname (опц.)string
namestring
phonestring
surname (опц.)string

RefEntityMedia ​

СвойствоТипОписание
defaultboolean
urlstring

RefEntityShell ​

СвойствоТипОписание
idid
aliasalias
namestring

CreatedDocumentT ​

Тип: CreatedDocumentT