ReferencesRepository

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

Методы

`getContactTypes`

Описание

Получение словаря типов контакта

HTTP метод: GET

URL: /api/v1/references/contact-type

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

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

`getCountries`

Описание

Получение словаря стран

HTTP метод: GET

URL: /api/v1/references/country

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

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

`getKATOs`

Описание

Поиск по стороннему словарю KATO

HTTP метод: GET

URL: /api/v1/references/kato

Параметры:

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

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

`getBanks`

Описание

Получение словаря банков

HTTP метод: GET

URL: /api/v1/references/bank

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

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

`getCurrencies`

Описание

Получение словаря валют

HTTP метод: GET

URL: /api/v1/references/currency

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

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

`getBillTypes`

Описание

Получение словаря тип счетов

HTTP метод: GET

URL: /api/v1/references/bill-type

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

Возвращает: Promise<Omit<RefEntityShell<undefined, EBillTypeId>, 'alias'>[]>

`getRoles`

Описание

Получение словаря ролей для пользователя

HTTP метод: GET

URL: /api/v1/references/role

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

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

`getDocumentTypes`

Описание

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

HTTP метод: GET

URL: /api/v1/references/document-type

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

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

`getDocumentStatuses`

Описание

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

HTTP метод: GET

URL: /api/v1/references/document-status

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

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

`getDocumentTemplates`

Описание

Получение словаря шаблонов документа

HTTP метод: GET

URL: /api/v1/templates

Параметры:

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

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

`getTemplateContextAttributes`

Описание

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

HTTP метод: GET

URL: /api/v1/references/template-context-attributes

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

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

`getSuperAdminReferences`

Описание

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

HTTP метод: GET

URL: /api-admin/v1/subject-references

Параметры:

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

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

`getSuperAdminReferenceById`

Описание

Получение записи словаря по ID

HTTP метод: GET

URL: /api-admin/v1/subject-references/{param}

Параметры:

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

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

`createSuperAdminReference`

Описание

Создание справочника

HTTP метод: POST

URL: /api-admin/v1/subject-references

Параметры:

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

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

`updateSuperAdminReference`

Описание

Обновление данных справочника

HTTP метод: PUT

URL: /api-admin/v1/subject-references/{param}

Параметры:

Имя	Тип	Описание
`referenceId`	`ISuperAdminReference['id']`
`payload`	`ISuperAdminReferenceEditor`

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

`deactivateSuperAdminReferenceValue`

Описание

Отключение активности значения справочника

HTTP метод: GET

URL: /api-admin/v1/subject-references/values/{param}/deactivate

Параметры:

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

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

`activateSuperAdminReferenceValue`

Описание

Включение активности значения справочника

HTTP метод: GET

URL: /api-admin/v1/subject-references/values/{param}/activate

Параметры:

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

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

`getSuperAdminTemplateTabs`

Описание

Получение табов шаблонов для суперадминистрирования

HTTP метод: GET

URL: /api-admin/v1/references/template-tabs

Параметры:

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

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

`createSuperAdminTemplateTab`

Описание

Создание таба шаблона для суперадминистрирования

HTTP метод: POST

URL: /api-admin/v1/references/template-tabs

Параметры:

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

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

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

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

IBank

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

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
}` |  |

IDocumentTemplateInfo

Свойство	Тип	Описание
`id`	`number`
`name`	`string`
`document_type`	`RefEntityShell`
`subject`	`IDocumentTemplateSubject`

IDocumentTemplateSubject

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

IGetDocumentTemplatesPayload

Свойство	Тип	Описание
`context_subject_type_code (опц.)`	`EProcurementTypeValues`
`context_trade_method_id (опц.)`	`EProcurementMethodValues`
`document_type_id (опц.)`	`EDocumentTypeIds`

IGetSuperAdminReferencesPayload

Наследует: IPaginationPayload

Свойство	Тип	Описание
`name (опц.)`	`string`
`sys_subjects_id (опц.)`	`ISubject['id'] \| null`
`is_global (опц.)`	`RefNumericBoolean \| null`

IGetSuperAdminTemplateTabsPayload

Наследует: IPaginationPayload

Свойство	Тип	Описание
`name (опц.)`	`string`
`document_type_id (опц.)`	`EDocumentTypeIds \| null`

IGetTemplateContextAttributesResponse

Свойство	Тип	Описание
`subject_type_code`	`IProcurementType[]`
`trade_method_id`	`IProcurementMethod[]`

IKATO

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

IKATOPayload

Свойство	Тип	Описание
`name (опц.)`	`string`
`ids (опц.)`	`Array<number \| 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`

IProcurementMethod

Свойство	Тип	Описание
`name`	`string`
`value`	`EProcurementMethodValues`
`description`	`string`

IProcurementType

Свойство	Тип	Описание
`name`	`string`
`value`	`EProcurementTypeValues`
`description`	`string`

IReferencesRepository

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

ISuperAdminReference

Свойство	Тип	Описание
`code`	`string`
`created_at`	`RefDateTimezone`
`id`	`number`
`is_global`	`boolean`
`name`	`string`
`subject`	`Pick<ISubject, 'id' \| 'name' \| 'parent_id'> \| null`
`sys_subjects_id`	`ISubject['id']`
`updated_at`	`RefDateTimezone`
`values`	`ISuperAdminReferenceValue[]`

ISuperAdminReferenceEditor

Свойство	Тип	Описание
`code`	`ISuperAdminReference['code']`
`name`	`ISuperAdminReference['name']`
`subject_id`	`ISubject['id'] \| null`
`values`	`valueT`

ISuperAdminReferenceValue

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

ISuperAdminTemplateTab

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

ISuperAdminTemplateTabEditor

Свойство	Тип	Описание
`document_type_id`	`EDocumentTypeIds \| null`
`values`	`string[]`

IUserRole

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

RefEntityShell

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

ReferencesRepository ​

Методы ​

getContactTypes ​

getCountries ​

getKATOs ​

getBanks ​

getCurrencies ​

getBillTypes ​

getRoles ​

getDocumentTypes ​

getDocumentStatuses ​

getDocumentTemplates ​

getTemplateContextAttributes ​

getSuperAdminReferences ​

getSuperAdminReferenceById ​

createSuperAdminReference ​

updateSuperAdminReference ​

deactivateSuperAdminReferenceValue ​

activateSuperAdminReferenceValue ​

getSuperAdminTemplateTabs ​

createSuperAdminTemplateTab ​

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

IBank ​

ICountry ​

ICurrency ​

IDocumentTemplateInfo ​

IDocumentTemplateSubject ​

IGetDocumentTemplatesPayload ​

IGetSuperAdminReferencesPayload ​

IGetSuperAdminTemplateTabsPayload ​

IGetTemplateContextAttributesResponse ​

IKATO ​

IKATOPayload ​

IPaginationLinks ​

IPaginationMeta ​

IPaginationMetaLink ​

IPaginationPayload ​

IPaginationShell ​

IProcurementMethod ​

IProcurementType ​

IReferencesRepository ​

ISuperAdminReference ​

ISuperAdminReferenceEditor ​

ISuperAdminReferenceValue ​

ISuperAdminTemplateTab ​

ISuperAdminTemplateTabEditor ​

IUserRole ​

RefEntityShell ​

ReferencesRepository

Методы

`getContactTypes`

`getCountries`

`getKATOs`

`getBanks`

`getCurrencies`

`getBillTypes`

`getRoles`

`getDocumentTypes`

`getDocumentStatuses`

`getDocumentTemplates`

`getTemplateContextAttributes`

`getSuperAdminReferences`

`getSuperAdminReferenceById`

`createSuperAdminReference`

`updateSuperAdminReference`

`deactivateSuperAdminReferenceValue`

`activateSuperAdminReferenceValue`

`getSuperAdminTemplateTabs`

`createSuperAdminTemplateTab`

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

IBank

ICountry

ICurrency

IDocumentTemplateInfo

IDocumentTemplateSubject

IGetDocumentTemplatesPayload

IGetSuperAdminReferencesPayload

IGetSuperAdminTemplateTabsPayload

IGetTemplateContextAttributesResponse

IKATO

IKATOPayload

IPaginationLinks

IPaginationMeta

IPaginationMetaLink

IPaginationPayload

IPaginationShell

IProcurementMethod

IProcurementType

IReferencesRepository

ISuperAdminReference

ISuperAdminReferenceEditor

ISuperAdminReferenceValue

ISuperAdminTemplateTab

ISuperAdminTemplateTabEditor

IUserRole

RefEntityShell