WH — схемы

Что здесь: определения типов запросов/ответов сервиса WH. Ручки, ссылающиеся на них — endpoints/WH.md.

type AspNetCoreResultsUserResult { avatarUrl?: str, deleted?: datetime, firstName?: str, id?: int, lastName?: str, middleName?: str }
type DataAttachmentsFromBodyUploadData { checkSum?: str, contentLength?: int, contentStream?: file, contentType: str, coordinate?: str, description?: str, file: str, fileName: str, isIgnorePossibleDuplication?: bool, isPublic?: bool, md5Hash?: str, roles?: int[], uid?: uuid }
type DataAttachmentsFromFormUploadData { contentLength?: int, contentStream?: file, contentType?: str, coordinate?: str, description?: str, file: file, fileName?: str, isIgnorePossibleDuplication?: bool, isPublic?: bool, md5Hash?: str, roles?: int[], uid?: uuid }
type ExceptionHandlingModelsErrorModel { arguments?: map<str>, code?: str, message?: str, traceIdentifier?: str }
type IdCodeNameResultOfByte { code?: str, id?: int, name?: str }
type IdNameDeletedResultOfInt { deleted?: datetime, id?: int, name?: str }
type IdNameResultOfByte { id?: int, name?: str }
type IdNameResultOfInt { id?: int, name?: str }
type IdNameResultOfShort { id?: int, name?: str }
type MaterialActionDataOfShort { data: int[], materialID?: int }
type ResultsBarcodeTypesListResult { name?: str /* Имя типа штрихкода */ }
type ResultsCommonAssetResult { deleted?: datetime, host?: IdNameDeletedResultOfInt, id?: int, name?: str }
type ResultsCommonCurrencyResult { asciiCode?: str /* Ascii код валюты */, id?: int /* Идентификатор валюты */, shortName?: str /* Краткое наименование валюты */ }
type ResultsCommonLocationResult { address?: str /* Адрес объекта */, coordinate?: str /* Координаты объекта в формате LAT:LNG */, country?: ResultsLocationsCountryResult, deleted?: datetime /* Дата удаления */, description?: str /* Описание локации */, id?: int }
type ResultsCommonLocationShortResult { address?: str /* Адрес объекта */, coordinate?: str /* Координаты объекта в формате LAT:LNG */, description?: str /* Описание локации */, id?: int }
type ResultsCommonMeasurementUnitResult { abbreviation?: str /* Аббревиатура */, designation?: str /* Обозначение */, id?: int /* Идентификатор */, name?: str /* Наименование */ }
type ResultsCommonTaskResult { asset?: ResultsCommonAssetResult, id?: int /* Идентификатор */, number?: str /* Наименование заявки */ }
type ResultsCommonWarehouseResult { erpID?: str /* Код склада */, id?: int /* Идентификатор склада */, location?: ResultsCommonLocationShortResult, name?: str /* Наименование склада */ }
type ResultsDocumentsDocumentResult { created?: datetime /* Дата создания документа */, deleted?: datetime /* Дата удаления документа */, description?: str /* Комментарий документа */, documentDate?: datetime /* Дата документа */, documentStatus?: IdCodeNameResultOfByte, documentType?: IdNameResultOfByte, documentTypeID?: int /* Идентификатор типа документа */, fromWarehouse?: IdNameResultOfShort, fromWarehouseID?: int /* Идентификатор склада-источника */, id?: int, modified?: datetime /* Дата изменения документа */, name?: str, operationType?: IdNameResultOfShort, posted?: datetime /* Дата проведения документа */, relatedTaskID?: int /* Идентификатор связанной заявки */, responsiblePerson?: IdNameResultOfInt, taskNumber?: str /* Номер связанной заявки */, toWarehouse?: IdNameResultOfShort, toWarehouseID?: int /* Идентификатор склада-приемника */ }
type ResultsDocumentStatusesListResult { code?: str /* Код складского документа */, name?: str /* Имя статуса складского документа */ }
type ResultsDocumentTypesListResult { code?: str /* Код типа складского документа */, name?: str /* Имя типа складского документа */ }
type ResultsInventoriesListResult { dateFrom?: datetime /* Дата начала инвентаризации */, dateTill?: datetime /* Дата окончания инвентаризации */, id?: int /* Идентификатор инвентаризации */ }
type ResultsInventoriesPostResult { dateFrom?: datetime /* Дата начала инвентаризации */, dateTill?: datetime /* Дата окончания инвентаризации */, id?: int /* Идентификатор инвентаризации */ }
type ResultsIssueItemsListResult { issueID?: int /* Идентификатор списания материалов */, material?: ResultsMaterialsMaterialResult, measurementUnit?: IdNameResultOfShort, quantity?: float /* Количество материала */, sortOrder?: int /* Номер строки */ }
type ResultsIssuesIssueResult { created?: datetime /* Дата создания списания материала */, deleted?: datetime /* Дата удаления списания материала */, description?: str /* Описание документа */, documentDate?: datetime /* Дата документа */, documentStatus?: IdCodeNameResultOfByte, erpID?: str /* Идентификатор документа во внешней системе */, id?: int, modified?: datetime /* Дата изменения списания материала */, name?: str, number?: str /* Номер документа */, operationType?: IdNameResultOfShort, posted?: datetime /* Дата проведения списания материала */, relatedTaskID?: int /* Идентификатор связанной заявки */, responsiblePerson?: IdNameResultOfInt, taskNumber?: str /* Номер связанной заявки */, warehouseID?: int /* Идентификатор склада */, warehouseName?: str /* Название склада */ }
type ResultsLocationsCountryResult { id?: int, name?: str, twoSymbolCode?: str /* Двухбуквенный код страны */ }
type ResultsMaterialAttachmentsMaterialAttachmentListResult { created?: datetime /* Дата загрузки UTC */, description?: str /* Описание */, fileName?: str /* Название файла (с расширением) */, isProtected?: bool /* Признак того, что вложенный файл доступен ограниченному набору ролей */, isUploaded?: bool, publicUrl?: str /* Публичная ссылка на файл (только для опубликованных файлов) */, size?: int /* Размер файла в байтах */, thumbnailUrl?: str /* Ссылка на эскиз изображения */ }
type ResultsMaterialAttachmentsMaterialAttachmentPostResult { attachmentID?: int /* Идентификатор вложения */, materialID?: int /* Идентификатор материала */, tenantID?: int /* Идентификатор тенанта */ }
type ResultsMaterialAttachmentsMaterialAttachmentResult { attachmentID?: int /* Идентификатор прикрепленного к материалу файла */, created?: datetime /* Дата загрузки UTC */, description?: str /* Описание */, fileName?: str /* Название файла (с расширением) */, isProtected?: bool /* Признак того, что вложенный файл доступен ограниченному набору ролей */, isUploaded?: bool, publicUrl?: str /* Публичная ссылка на файл (только для опубликованных файлов) */, size?: int /* Размер файла в байтах */, thumbnailUrl?: str /* Ссылка на эскиз изображения */ }
type ResultsMaterialAttachmentsUploadResult { attachmentID?: int /* Идентификатор вложенного файла */, fileName?: str /* Имя загруженного файла */, isProtected?: bool /* Признак того, что вложенный файл доступен ограниченному набору ролей */, materialID?: int /* Идентификатор материала */, md5Hash?: str /* Проверочная сумма MD5 */ }
type ResultsMaterialBarcodesListResult { barcodeType?: IdNameResultOfByte, id?: int, value?: str /* Значение штрихкода */ }
type ResultsMaterialBarcodesPostResult { id?: int, materialID?: int /* Идентификатор материала */ }
type ResultsMaterialConsumptionsMaterialConsumptionsResult { consumed?: datetime /* Дата последнего взятия материала */, consumedBy?: AspNetCoreResultsUserResult, consumption?: float /* Израсходованное количество */, cost?: float /* Стоимость материала */, currency?: ResultsCommonCurrencyResult, description?: str /* Описание материала */, erpID?: str /* Код материала */, id?: int /* Идентификатор материала */, measurementUnit?: IdNameResultOfShort, name?: str /* Наименование материала */, sortOrder?: int /* Индекс сортировки */, task?: ResultsCommonTaskResult, totalCost?: float /* Общая стоимость материалов */, warehouse?: ResultsCommonWarehouseResult }
type ResultsMaterialConsumptionsMaterialInventoryResult { date?: datetime /* дата импорта/инвентаризации */, id?: int /* Идентификатор импорта/инвентаризации */, materials?: ResultsMaterialConsumptionsMaterialConsumptionsResult[] /* Расход материалов */, sort?: int /* Ключ сортировки */ }
type ResultsMaterialsListRequiredResult { actualQuantity?: float /* Акутальное количество */, cost?: float /* Стоимость материала */, currency?: ResultsCommonCurrencyResult, description?: str /* Описание материала */, erpID?: str /* Код материала */, id?: int /* Идентификатор материала */, importQuantity?: float /* Импортированное количество */, materialIsMarkable?: bool /* Признак обязательности маркировки */, measurementUnit?: IdNameResultOfShort, name?: str /* Наименование материала */, sortOrder?: int /* Индекс сортировки */, vendorCode?: str /* Код поставщика */, warehouse?: ResultsCommonWarehouseResult }
type ResultsMaterialsListResult { actualQuantity?: float /* Акутальное количество */, cost?: float /* Стоимость материала */, currency?: ResultsCommonCurrencyResult, description?: str /* Описание материала */, erpID?: str /* Код материала */, id?: int /* Идентификатор материала */, importQuantity?: float /* Импортированное количество */, materialIsMarkable?: bool /* Признак обязательности маркировки */, measurementUnit?: IdNameResultOfShort, name?: str /* Наименование материала */, sortOrder?: int /* Индекс сортировки */, taken?: datetime /* Дата последнего взятия материала */, takenBy?: AspNetCoreResultsUserResult, task?: ResultsCommonTaskResult, vendorCode?: str /* Код поставщика */, warehouse?: ResultsCommonWarehouseResult }
type ResultsMaterialsMaterialListResult { cost?: float /* Закупочная стоимость материала */, costCurrency?: ResultsCommonCurrencyResult, costCurrencyID?: int /* Валюта закупочной стоимости материала */, deleted?: datetime /* Дата удаления материала */, description?: str /* Описание материала */, erpID?: str /* Идентификатор материала во внешней системе */, id?: int, isMarkable?: bool /* Признак маркируемости материала */, measurementUnit?: ResultsCommonMeasurementUnitResult, measurementUnitID?: int /* Единица измерения материала */, name?: str, purchaseCost?: float /* Стоимость материала для клиента */, purchaseCostCurrency?: ResultsCommonCurrencyResult, purchaseCostCurrencyID?: int /* Валюта стоимости материала для клиента */, sortOrder?: int /* Порядок сортировки */, vendorCode?: str /* Артикул материала */ }
type ResultsMaterialsMaterialResult { cost?: float /* Закупочная стоимость материала */, costCurrency?: ResultsCommonCurrencyResult, costCurrencyID?: int /* Валюта закупочной стоимости материала */, deleted?: datetime /* Дата удаления материала */, description?: str /* Описание материала */, erpID?: str /* Идентификатор материала во внешней системе */, id?: int, isMarkable?: bool /* Признак маркируемости материала */, measurementUnit?: ResultsCommonMeasurementUnitResult, measurementUnitID?: int /* Единица измерения материала */, name?: str, purchaseCost?: float /* Стоимость материала для клиента */, purchaseCostCurrency?: ResultsCommonCurrencyResult, purchaseCostCurrencyID?: int /* Валюта стоимости материала для клиента */, vendorCode?: str /* Артикул материала */ }
type ResultsNumberSequencesNumberSequenceResult { documentType?: IdCodeNameResultOfByte, lastNumber?: int /* Последний занятый номер маски номера документа */, prefix?: str /* Префикс маски номера документа */ }
type ResultsOperationTypesOperationTypeAddResult { id?: int /* Идентификатор типа операции */ }
type ResultsOperationTypesOperationTypeResult { deleted?: datetime /* Метка удаления типа операции */, documentType?: IdCodeNameResultOfByte, erpID?: str /* Код типа операции во внешней системе */, id?: int /* Идентификатор типа операции */, name?: str /* Наименование типа операции */ }
type ResultsReceiptItemsListResult { material?: ResultsMaterialsMaterialResult, measurementUnit?: IdNameResultOfShort, quantity?: float /* Количество материала */, receiptID?: int /* Идентификатор оприходывания материалов */, sortOrder?: int /* Номер строки */ }
type ResultsReceiptsReceiptResult { created?: datetime /* Дата создания оприходывания материала */, deleted?: datetime /* Дата удаления оприходывания материала */, description?: str /* Описание документа */, documentDate?: datetime /* Дата документа */, documentStatus?: IdCodeNameResultOfByte, erpID?: str /* Идентификатор документа во внешней системе */, id?: int, modified?: datetime /* Дата изменения оприходывания материала */, name?: str, number?: str /* Номер документа */, operationType?: IdNameResultOfShort, posted?: datetime /* Дата проведения оприходывания материала */, relatedTaskID?: int /* Идентификатор связанной заявки */, responsiblePerson?: IdNameResultOfInt, taskNumber?: str /* Номер связанной заявки */, warehouseID?: int /* Идентификатор склада */, warehouseName?: str /* Название склада */ }
type ResultsTransferItemsListResult { material?: ResultsMaterialsMaterialResult, measurementUnit?: IdNameResultOfShort, quantity?: float /* Количество материала */, sortOrder?: int /* Номер строки */, transferID?: int /* Идентификатор перемещения материалов */ }
type ResultsTransfersTransferResult { created?: datetime /* Дата создания перемещения материала */, deleted?: datetime /* Дата удаления перемещения материала */, description?: str /* Описание документа */, documentDate?: datetime /* Дата документа */, documentStatus?: IdCodeNameResultOfByte, erpID?: str /* Идентификатор документа во внешней системе */, fromWarehouseID?: int /* Идентификатор склада-источника */, fromWarehouseName?: str /* Название склада-источника */, id?: int, modified?: datetime /* Дата изменения перемещения материала */, name?: str, number?: str /* Номер документа */, operationType?: IdNameResultOfShort, posted?: datetime /* Дата проведения перемещения материала */, relatedTaskID?: int /* Идентификатор связанной заявки */, responsiblePerson?: IdNameResultOfInt, taskNumber?: str /* Номер связанной заявки */, toWarehouseID?: int /* Идентификатор склада-приемника */, toWarehouseName?: str /* Название склада-приемника */ }
type ResultsWarehousesGetResult { deleted?: datetime /* Дата удаления склада */, deletedBy?: int /* Член тенанта, который удалил склад */, description?: str /* Описание склада */, erpID?: str /* Идентификатор склада в сторонней системе */, id?: int, isDefault?: bool /* Признак склада по умолчанию */, location?: ResultsCommonLocationResult, name?: str }
type ResultsWarehousesListResult { deleted?: datetime /* Дата удаления склада */, description?: str /* Описание склада */, erpID?: str /* Идентификатор склада в сторонней системе */, id?: int, isDefault?: bool /* Признак склада по умолчанию */, location?: ResultsCommonLocationShortResult, name?: str, userCount?: int /* Количество пользователей назначенных на склад */ }
type ResultsWarehousesListShortResult { deleted?: datetime /* Дата удаления склада */, erpID?: str /* Идентификатор склада в сторонней системе */, id?: int, isDefault?: bool /* Признак склада по умолчанию */, name?: str }
type ResultsWarehouseUsersUserWarehouseListResult { erpID?: str /* Код склада */, name?: str /* Наименование склада */, warehouseID?: int /* Идентификатор склада */ }
type ResultsWarehouseUsersWarehouseUserListResult { userFullName?: str /* Полное имя пользователя */, userID?: int /* Идентификатор пользователя */ }
type WHInventoryAddData { inventoryDateFrom: datetime, materials?: WHInventoryInventoryMaterialData[] }
type WHInventoryInventoryMaterialData { materialCost?: float, materialCurrencyID?: int, materialErpID?: str, materialName?: str, measurementUnitID?: int, quantity?: float, warehouseErpID?: str, warehouseName?: str }
type WHInventoryUpdateData { inventoryDateFrom?: datetime, inventoryID: int, materials?: WHInventoryInventoryMaterialData[] }
type WHIssueAddData { description?: str, documentDate?: datetime, erpID?: str, number?: str, operationTypeID: int, relatedTaskID?: int, responsiblePersonID?: int, warehouseID: int }
type WHIssueIssueItemData { materialID: int, measurementUnitID: int, quantity: float, sortOrder: int }
type WHIssueIssueItemDeleteData { issueID?: int, items?: int[] }
type WHIssueIssueItemMergeData { issueID?: int, items?: WHIssueIssueItemData[] }
type WHIssueUpdateData { description?: str, documentDate?: datetime, erpID?: str, id?: int, number?: str, operationTypeID: int, relatedTaskID?: int, responsiblePersonID?: int, warehouseID: int }
type WHMaterialAddData { cost?: float, costCurrencyID?: int, description?: str, erpID?: str, isMarkable?: bool, measurementUnitID?: int, name: str, purchaseCost?: float, purchaseCostCurrencyID?: int, vendorCode?: str }
type WHMaterialBarcodeAddData { barcodes?: WHMaterialBarcodeBarcodeAddData[], materialID?: int }
type WHMaterialBarcodeBarcodeAddData { barcodeTypeID?: int, value: str }
type WHMaterialBarcodeBarcodeUpdateData { barcodeTypeID?: int, id?: int, value: str }
type WHMaterialBarcodeUpdateData { barcodes?: WHMaterialBarcodeBarcodeUpdateData[], materialID?: int }
type WHMaterialUpdateData { cost?: float, costCurrencyID?: int, description?: str, erpID?: str, id?: int, isMarkable?: bool, measurementUnitID?: int, name: str, purchaseCost?: float, purchaseCostCurrencyID?: int, vendorCode?: str }
type WHNumberSequenceModifyData { documentTypeID: int, lastNumber?: int, prefix?: str }
type WHOperationTypeAddData { documentTypeID?: int, erpID?: str, name: str }
type WHOperationTypeUpdateData { documentTypeID?: int, erpID?: str, id?: int, name: str }
type WHReceiptAddData { description?: str, documentDate?: datetime, erpID?: str, number?: str, operationTypeID: int, relatedTaskID?: int, responsiblePersonID?: int, warehouseID: int }
type WHReceiptReceiptItemData { materialID: int, measurementUnitID: int, quantity: float, sortOrder: int }
type WHReceiptReceiptItemDeleteData { items?: int[], receiptID?: int }
type WHReceiptReceiptItemMergeData { items?: WHReceiptReceiptItemData[], receiptID?: int }
type WHReceiptUpdateData { description?: str, documentDate?: datetime, erpID?: str, id?: int, number?: str, operationTypeID: int, relatedTaskID?: int, responsiblePersonID?: int, warehouseID: int }
type WHTransferAddData { description?: str, documentDate?: datetime, erpID?: str, fromWarehouseID: int, number?: str, operationTypeID: int, relatedTaskID?: int, responsiblePersonID?: int, toWarehouseID: int }
type WHTransferTransferItemData { materialID: int, measurementUnitID: int, quantity: float, sortOrder: int }
type WHTransferTransferItemDeleteData { items?: int[], transferID?: int }
type WHTransferTransferItemMergeData { items?: WHTransferTransferItemData[], transferID?: int }
type WHTransferUpdateData { description?: str, documentDate?: datetime, erpID?: str, fromWarehouseID: int, id?: int, number?: str, operationTypeID: int, relatedTaskID?: int, responsiblePersonID?: int, toWarehouseID: int }
type WHWarehouseAddData { description?: str, erpID?: str, isDefault?: bool, locationID?: int, name: str }
type WHWarehouseUpdateData { description?: str, erpID?: str, id?: int, isDefault?: bool, locationID?: int, name: str }
type WHWarehouseUserUserWarehousesData { userID: int, warehouseIDs: int[] }
type WHWarehouseUserWarehouseUsersData { isRelatedToAnyUser?: bool, userIDs?: int[], warehouseID: int }
type WHWarehouseUserWarehouseUsersDeleteData { isRelatedToAnyUser?: bool, userIDs?: int[], warehouseID: int }