ExternalRepository

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

Методы

`getPlanPoints`

Описание

Получение пункт планов из Портала закупок Для Национального Банка РК

HTTP метод: GET

URL: /api/v1/external/pln-points

Параметры:

Имя	Тип	Описание
`payload`	`IGetPointPlansPayload`

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

`sendPlanPointToNationalBank`

Описание

Отправка документа в Национальный банк

HTTP метод: POST

URL: /api/v1/document/{param}/external-services/nb/send-plan-point

Параметры:

Имя	Тип	Описание
`documentId`	`IDocument['id']`

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

`revokeDocument`

Описание

Редактирование/Отзыв Документа "Согласования закупки"

HTTP метод: POST

URL: /api/v1/document/{param}/external-services/nb/revoke

Параметры:

Имя	Тип	Описание
`documentId`	`IDocument['id']`

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

`getRedirectUrlToNationalBank`

Описание

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

HTTP метод: GET

URL: /api/v1/external/sso/create-redirect-url

Параметры: Нет

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

`updateContractStatus`

Описание

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

HTTP метод: POST

URL: /api/v1/document/{param}/external-services/nb/update-contract-status

Параметры:

Имя	Тип	Описание
`documentId`	`IDocument['id']`
`documentStatus`	`IDocument['status']['id']`

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

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

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

IArgRegistry

Свойство	Тип	Описание
`amount_fact`	`string`
`amount_fact_nds`	`string`
`amount_guarantee_contract`	`string`
`amount_guarantee_prepayment`	`string`
`amount_guarantee_total`	`string`
`amount_plan_total`	`string`
`amount_result_nds`	`string`
`amount_result_total`	`string`
`aux_orders_id`	`null`
`code`	`string`
`contract_date`	`null \| string`
`create_date`	`string`
`customer_address`	`string`
`customer_address_kz`	`string`
`customer_bank`	`string`
`customer_bik`	`string`
`customer_bill_pid`	`number`
`customer_email`	`null \| string`
`customer_id`	`number`
`customer_iik`	`string`
`customer_leader_basis_kz`	`number`
`customer_leader_basis_ru`	`number`
`customer_leader_name`	`string`
`customer_leader_pid`	`number`
`customer_leader_title`	`string`
`customer_leader_title_kz`	`string`
`customer_phone`	`number`
`execute_date`	`null`
`fact_trade_method`	`number`
`finish_date`	`string`
`id`	`number`
`is_additional`	`number`
`is_contract_procuring_confirmed`	`number`
`is_deleted`	`number`
`is_longterm`	`number`
`is_manual`	`number`
`is_offer_procuring_confirmed`	`number`
`is_quasi`	`number`
`is_sent_edoc`	`number`
`is_typical`	`number`
`is_uninterrupted`	`number`
`name_kz`	`string`
`name_ru`	`string`
`nds`	`number`
`notify_days`	`number`
`number`	`number`
`parent_id`	`null`
`plan_trade_method`	`number`
`ref_agreement_types_id`	`number`
`ref_agreements_statuses_id`	`number`
`ref_buys_types_id`	`number`
`ref_currency_code`	`string`
`ref_guarantee_reasons_id`	`null`
`ref_procuring_types_id`	`null`
`ref_subject_types_code`	`string`
`result_date`	`null`
`root_id`	`null`
`supplier_address`	`string`
`supplier_address_kz`	`string`
`supplier_bank`	`string`
`supplier_bik`	`string`
`supplier_bill_pid`	`number`
`supplier_email`	`string`
`supplier_id`	`number`
`supplier_iik`	`string`
`supplier_leader_basis_kz`	`number`
`supplier_leader_basis_ru`	`number`
`supplier_leader_name`	`string`
`supplier_leader_pid`	`number`
`supplier_leader_title`	`string`
`supplier_leader_title_kz`	`string`
`supplier_nds`	`number`
`supplier_phone`	`string`
`sys_users_id`	`number`
`trd_buy_id`	`null`
`update_date`	`string`
`update_statuses (опц.)`	`{

    id: number
    attempts: 'attempts'
    status: EDocumentStatusIds
    sent: boolean
}` |  |

IAttribute

Свойство	Тип	Описание
`id`	`number`
`files`	`IFile[]`
`is_active`	`RefNumericBoolean`
`is_hidden`	`RefNumericBoolean`
`is_readonly`	`RefNumericBoolean`
`number`	`number`
`name`	`string`
`value`	`AttributeValueT`
`attribute`	`IAttributeMeta`
`template (опц.)`	`ITemplate`
`template_values (опц.)`	`ITemplateValue[]`

IAttributeMeta

Свойство	Тип	Описание
`is_active`	`RefNumericBoolean`
`name`	`string`
`number`	`number`
`alias`	`EAttributeAlias`
`attribute_type`	`IAttributeType`

IAttributeType

Свойство	Тип	Описание
`name`	`string`
`alias`	`EAttributeTypeAlias`

IBank

Свойство	Тип	Описание
`id`	`number`
`name`	`string`
`address`	`string`
`bik`	`string`
`code`	`number`
`country`	`ICountry`
`is_active`	`boolean`
`is_head`	`boolean`

IBill

Свойство	Тип	Описание
`id`	`number`
`iik`	`string`
`is_default`	`boolean`
`kbe`	`RefNumberInString`
`sys_subjects_id`	`number`
`country`	`ICountry`
`currency`	`ICurrency`
`bank`	`IBank`
`bill_type`	`Omit<RefEntityShell<undefined, EBillTypeId>, 'alias'>`

IComment

Свойство	Тип	Описание
`id`	`number`
`created_at`	`RefDateTime`
`updated_at (опц.)`	`RefDateTime`
`user`	`RefBaseUserProfile`
`content`	`string`
`type`	`RefEntityShell`
`files (опц.)`	`IFile[]`

IContact

Свойство	Тип	Описание
`id`	`number`
`fulladdress`	`string`
`is_default`	`boolean`
`phone`	`string`
`postal`	`string`
`sys_subjects_id`	`number`
`contact_type`	`RefEntityShell`
`country`	`ICountry`
`kato (опц.)`	`IKATO`

ICountry

Свойство	Тип	Описание
`alpha2`	`CountryIsoCode`
`code`	`RefNumberInString`
`id`	`number`
`is_active`	`boolean`
`name`	`string`

ICurrency

Свойство	Тип	Описание
`id`	`RefNumberInString`
`name`	`string`
`code`	`number`
`is_active`	`boolean`
`current`	`{

    id: number
    code: string
    publish_date: string
    amount: string
    description: string
}` |  |

IDocument

Свойство	Тип	Описание
`id`	`number`
`name`	`string`
`number`	`string`
`active_task (опц.)`	`Omit<ITask, 'author' \| 'task_status' \| 'executors'>`
`active_task_comment (опц.)`	`IDocumentActiveTaskComment`
`attributes`	`IAttribute[]`
`author`	`IUser`
`currentSubjectId`	`number`
`date`	`RefDate`
`description`	`string`
`executor`	`IUser`
`progressBar`	`IDocumentProgressBarItem[]`
`properties`	`IDocumentProperty[]`
`selfStages`	`IDocumentSelfStage[]`
`root (опц.)`	`IDocument`
`status`	`RefEntityShell`
`type`	`RefEntityShell`
`subject`	`ISubject`
`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

Свойство	Тип	Описание
`id`	`number`
`content`	`string`

IDocumentParticipantShell

Свойство	Тип	Описание
`id`	`number`
`comments (опц.)`	`IComment[]`
`document (опц.)`	`null`
`due_date`	`RefSystemDateTime`
`executed_at (опц.)`	`RefSystemDateTime`
`executor`	`userT`
`task_executing`	`{

    assigned_at: RefDateTime
    due_date: RefDateTime
    executed_at: RefDateTime
    result: boolean \| null
    task_id: ITask['id']
}` |  |

IDocumentProgressBarItem

Свойство	Тип	Описание
`name`	`string`
`success`	`RefEntitySuccess`

IDocumentProperty

Свойство	Тип	Описание
`id`	`number`
`ref_document_properties_code`	`EDocumentPropertyAlias`
`value`	`string`
`property`	`RefEntityShell`

IDocumentSelfStage

Свойство	Тип	Описание
`id`	`number`
`name`	`null`
`number`	`number`
`stage_type`	`RefEntityShell`
`stage_status`	`RefEntityShell`
`tasks`	`ITask[]`

IExternalRepository

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

IFile

Свойство	Тип	Описание
`id`	`number`
`name`	`string`
`is_active`	`RefNumericBoolean`
`created_at (опц.)`	`RefSystemDateTime`
`sys_file`	`{

    id: number
    name: string
    full_path: string
    mime: RefMimeTypeFromDb
    path: string
    size: number
}` |  |

IFillableAttributeTableData

Свойство	Тип	Описание
`column`	`RefNumberInString`
`table`	`RefNumberInString`

IGetPointPlansPayload

Наследует: IPaginationPayload

Свойство	Тип	Описание
`'filters[trade_method_id]' (опц.)`	`EProcurementMethodValues \| null`
`'filters[subject_type_code]' (опц.)`	`EProcurementTypeValues \| null`
`q (опц.)`	`IPointPlan['name_ru']`
`'filters[type_id]' (опц.)`	`EPointPlanTypeIds \| null`
`'filters[year]' (опц.)`	`IPointPlan['year']`
`'filters[status_id]' (опц.)`	`EPointPlanStatusTypeIds \| null`
`sort (опц.)`	`EPointPlanSortAlias`
`order (опц.)`	`EPointPlanOrderAlias`

IHistoryFile

Свойство	Тип	Описание
`id`	`number`
`author`	`RefBaseUserProfile \| null`
`created_at`	`RefSystemDateTime`
`is_active`	`RefNumericBoolean`
`is_actual`	`boolean`
`name`	`string`
`sys_file`	`IFile`
`updated_at`	`RefSystemDateTime`
`version`	`number`

IKATO

Свойство	Тип	Описание
`id`	`number`
`full_name`	`string`
`name`	`string`
`te`	`string`

IPaginationLinks

Свойство	Тип	Описание
`first`	`string \| null`
`last`	`string \| null`
`next`	`string \| null`
`prev`	`string \| null`

IPaginationMeta

Свойство	Тип	Описание
`path`	`string`
`current_page`	`number`
`per_page`	`number`
`to`	`number`
`from`	`number`
`total`	`number`
`links`	`IPaginationMetaLink[]`
`last_page`	`number`

IPaginationMetaLink

Свойство	Тип	Описание
`active`	`boolean`
`label`	`string`
`url`	`string \| null`

IPaginationPayload

Свойство	Тип	Описание
`page`	`number`
`per_page`	`number`

IPaginationShell

Свойство	Тип	Описание
`links`	`IPaginationLinks[]`
`meta`	`IPaginationMeta`
`data`	`list`

ISubject

Свойство	Тип	Описание
`id`	`number`	Id компании
`name`	`string`
`name_ru`	`string`
`name_kz`	`string`
`name_en`	`string`
`created_at`	`RefDate`
`identifier`	`string`
`parent_id (опц.)`	`RefParentId`
`bills`	`IBill[]`
`contacts`	`IContact[]`
`country`	`ICountry`
`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

Свойство	Тип	Описание
`id`	`number`
`name`	`string`
`current`	`boolean`
`identifier`	`string`
`kopf`	`ISubject['kopf']`
`permissions`	`string[]`
`roles`	`IUserRole[]`

ITask

Свойство	Тип	Описание
`id`	`number`
`assigned_at (опц.)`	`RefDateTime`
`due_date`	`RefDateTime`
`executed_at (опц.)`	`RefDateTime`
`author`	`RefBaseUserProfile`
`task_status`	`RefEntityShell`
`task_type`	`RefEntityShell`
`executors`	`ITaskExecutor[]`

ITaskExecutor

Свойство	Тип	Описание
`id`	`number`
`assigned_at`	`RefDateTime`
`due_date`	`RefDateTime`
`executed_at`	`RefDateTime`
`result`	`RefEntitySuccess`
`signByLink (опц.)`	`ITaskSignByLink`
`user`	`RefBaseUserProfile`
`subject`	`ISubject`

ITaskSignByLink

Свойство	Тип	Описание
`comment (опц.)`	`string`
`due_date`	`RefDateTime`
`email`	`string`
`full_name`	`string`
`id`	`number`
`identifier`	`string`
`iin`	`string`
`subject_identifier`	`string`
`subject_name`	`string`
`sys_documents_id`	`number`
`sys_stages_id`	`number`
`sys_task_executors_id`	`number`
`sys_tasks_id`	`number`
`ttl`	`number`
`uuid`	`string`

ITemplate

Свойство	Тип	Описание
`id`	`number`
`name`	`string`
`fillableAttributes`	`ITemplateFillableAttribute[]`

ITemplateFillableAttribute

Свойство	Тип	Описание
`default_value`	`FillableAttributeValueT`
`description`	`string \| null`
`group`	`number`
`id`	`number`
`is_required`	`boolean`
`label`	`string`
`language`	`RefEntityShell`
`place_type`	`ETemplatePlaceTypeAlias`
`reference (опц.)`	`ITemplateFillableReference[] \| null`
`tab`	`RefEntityShell`
`value_type`	`ETemplateValueTypeAlias`
`table_data (опц.)`	`IFillableAttributeTableData`

ITemplateFillableReference

Свойство	Тип	Описание
`id`	`number`
`is_active`	`boolean`
`value`	`string \| number`

ITemplateValue

Свойство	Тип	Описание
`id`	`number`
`sys_documents_id`	`IDocument['id']`
`sys_template_attributes_id`	`ITemplateFillableAttribute['id']`
`sys_templates_id`	`ITemplate['id']`
`value`	`FillableAttributeValueT`

IUser

Свойство	Тип	Описание
`id`	`number`
`created_at`	`RefDate`
`birth_date`	`RefDate`
`email`	`string`
`email_verified`	`boolean`
`verification_token (опц.)`	`string`
`identifier`	`string`
`is_disable`	`boolean`
`phone`	`string`
`set_password`	`boolean`
`lastname (опц.)`	`string`
`name`	`string`
`surname (опц.)`	`string`
`unread_notifications_count`	`number`
`permissions`	`EUserPermissions[]`
`profile_photo_url`	`RefEntityMedia`
`roles`	`IUserRole[]`
`subject_roles`	`ISubjectRole[]`
`is_disabled_reason (опц.)`	`string`
`has_password (опц.)`	`boolean`

IUserRole

Свойство	Тип	Описание
`id`	`number`
`name`	`string`
`alias`	`EUserRoleAlias`
`created_at`	`RefDate`

RefBaseUserProfile

Свойство	Тип	Описание
`email`	`string`
`id`	`number`
`identifier`	`string`
`lastname (опц.)`	`string`
`name`	`string`
`phone`	`string`
`surname (опц.)`	`string`

RefEntityMedia

Свойство	Тип	Описание
`default`	`boolean`
`url`	`string`

RefEntityShell

Свойство	Тип	Описание
`id`	`id`
`alias`	`alias`
`name`	`string`

ExternalRepository ​

Методы ​

getPlanPoints ​

sendPlanPointToNationalBank ​

revokeDocument ​

getRedirectUrlToNationalBank ​

updateContractStatus ​

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

IArgRegistry ​

IAttribute ​

IAttributeMeta ​

IAttributeType ​

IBank ​

IBill ​

IComment ​

IContact ​

ICountry ​

ICurrency ​

IDocument ​

IDocumentActiveTaskComment ​

IDocumentParticipantShell ​

IDocumentProgressBarItem ​

IDocumentProperty ​

IDocumentSelfStage ​

IExternalRepository ​

IFile ​

IFillableAttributeTableData ​

IGetPointPlansPayload ​

IHistoryFile ​

IKATO ​

IPaginationLinks ​

IPaginationMeta ​

IPaginationMetaLink ​

IPaginationPayload ​

IPaginationShell ​

ISubject ​

ISubjectRole ​

ITask ​

ITaskExecutor ​

ITaskSignByLink ​

ITemplate ​

ITemplateFillableAttribute ​

ITemplateFillableReference ​

ITemplateValue ​

IUser ​

IUserRole ​

RefBaseUserProfile ​

RefEntityMedia ​

RefEntityShell ​

ExternalRepository

Методы

`getPlanPoints`

`sendPlanPointToNationalBank`

`revokeDocument`

`getRedirectUrlToNationalBank`

`updateContractStatus`

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

IArgRegistry

IAttribute

IAttributeMeta

IAttributeType

IBank

IBill

IComment

IContact

ICountry

ICurrency

IDocument

IDocumentActiveTaskComment

IDocumentParticipantShell

IDocumentProgressBarItem

IDocumentProperty

IDocumentSelfStage

IExternalRepository

IFile

IFillableAttributeTableData

IGetPointPlansPayload

IHistoryFile

IKATO

IPaginationLinks

IPaginationMeta

IPaginationMetaLink

IPaginationPayload

IPaginationShell

ISubject

ISubjectRole

ITask

ITaskExecutor

ITaskSignByLink

ITemplate

ITemplateFillableAttribute

ITemplateFillableReference

ITemplateValue

IUser

IUserRole

RefBaseUserProfile

RefEntityMedia

RefEntityShell