Schemas
companyDto
createdAtupdatedAtcompanyIdcompanyNameaddresscompanyInventoryMaterialDto
companyInventoryMaterialIdcompanyIdinventoryMaterialIdcategoryvalueactivecompanyInventoryTypeDto
companyInventoryTypeIdcompanyIdinventoryTypeIdcategoryvalueactivecompanyStockLocationDto
companyStockLocationIdcompanyIdstockLocationIdcategoryvalueactivecreateInventoryTagDto
nameTag name (must be unique within company)
colorHex color code for the tag (e.g., #FF5733)
descriptionOptional description of the tag's purpose
createInventoryTagRuleDto
tagIdTag to assign when rule matches
nameRule name (must be unique within company)
descriptionOptional description of the rule's purpose
ruleJsonJSON representation of the rule logic
isActiveWhether the rule is active and should be evaluated
defenderResultDto
defenderResultIdsubjectcorrelationIdblobUrieTagscanFinishedTimeUtcscanResultTypemalwareNamesFoundmalwareSha256eventTypedataVersionmetadataVersioneventTimetopiccreatedAtupdatedAtdetailedMillCertificationDto
newFileNamedefenderResultIddateInserteddateModifiedheatCodesmillCertificationIdcompanyIdoriginalFileNamestorageFileNamestatusmillCertificationStatusLabelmillCertificationStatusNotesmillCertificationStatusTypedetailedMillCertificationHeatDto
heatNumberdiameterlengthcarbonEquivalentcreatedAtupdatedAtmillCertificationHeatIdcompanyIdmillCertificationPageIddetailedMillCertificationPageDto
newFileNameclassificationModelResultextractionModelextractionModelResultcreatedAtupdatedAtmillCertificationStatusLabelmillCertificationStatusNotesmillCertificationStatusTypemillCertificationPageIdcompanyIdmillCertificationIdblobUrioriginalFileNamestatusentitlementDto
featureIdfeatureKeyfeatureNamedescriptioncategoryrequiresUnlockdisplayOrderisEnabledunlockedAtexpiresAtnoteshasAccesserrorResponse
statusCodeHTTP status code e.g. 404, 403, 500
messageHuman-readable error message explaining the failure
detailsDetailed error information
timestampISO 8601 timestamp when the error occurred (UTC)
traceIdCorrelation / trace identifier for diagnostics
extendedInventoryDto
typeLabelResolved label for Type
materialLabelResolved label for Material
supplierNameResolved name for Supplier (from Organisations)
stockLocationLabelResolved label for Stock Location (from CompanyStockLocations)
quantityNumber of pieces available
weightTotal weight in kilograms
heatCodeHeat code for traceability
diameterDiameter in millimetres
lengthLength dimension (mm)
widthWidth dimension (mm)
depthDepth dimension (mm)
typeType reference (FK to InventoryTypes)
materialMaterial reference (FK to InventoryMaterials)
supplierIdSupplier reference (FK to Organisations)
stockLocationIdStock location reference (FK to CompanyStockLocations)
inventoryIdUnique identifier for the inventory record
companyIdIdentifier of the owning company
productNameHuman readable product name
unitPriceUnit price in company currency
extendedScrapLogDto
loggedByNameDisplay name of the user who logged this entry
scrapLogIdUnique identifier for the scrap log entry
companyIdIdentifier of the owning company
logDateDate when the scrap was logged
binSkipReferenceBin or skip reference identifier
startingWeightStarting weight in kilograms
closingWeightClosing weight in kilograms
netWeightNet weight (calculated as ClosingWeight - StartingWeight) in kilograms
loggedByUser ID of the person who logged this entry
createdAtTimestamp when the record was created (UTC)
updatedAtTimestamp when the record was last updated (UTC)
activeSoft delete flag (true = active, false = deleted)
featureDto
featureIdfeatureNamefeatureKeydescriptioncategoryrequiresUnlockdisplayOrderinventoryDto
quantityNumber of pieces available
weightTotal weight in kilograms
heatCodeHeat code for traceability
diameterDiameter in millimetres
lengthLength dimension (mm)
widthWidth dimension (mm)
depthDepth dimension (mm)
typeType reference (FK to InventoryTypes)
materialMaterial reference (FK to InventoryMaterials)
supplierIdSupplier reference (FK to Organisations)
stockLocationIdStock location reference (FK to CompanyStockLocations)
inventoryIdUnique identifier for the inventory record
companyIdIdentifier of the owning company
productNameHuman readable product name
unitPriceUnit price in company currency
inventoryTagAssignmentDto
assignmentIdUnique identifier for the assignment
inventoryIdInventory item identifier
tagIdTag identifier
assignedByRuleIdRule that assigned this tag (null if manual)
assignedAtTimestamp when the tag was assigned (UTC)
inventoryTagAssignmentTagDto
inventoryIdThe inventory item identifier
tagIdUnique identifier for the tag
companyIdIdentifier of the owning company
nameTag name
colorHex color code for the tag
descriptionOptional description of the tag
inventoryTagDto
tagIdUnique identifier for the tag
companyIdIdentifier of the owning company
nameTag name (must be unique within company)
colorHex color code for the tag (e.g., #FF5733)
descriptionOptional description of the tag's purpose
inventoryTagEvaluationResultDto
inventoryIdcompanyIdassignedTagCountinventoryTagRuleDto
ruleIdUnique identifier for the rule
companyIdIdentifier of the owning company
tagIdTag to assign when rule matches
nameRule name (must be unique within company)
descriptionOptional description of the rule's purpose
ruleJsonJSON representation of the rule logic
isActiveWhether the rule is active and should be evaluated
linkedInventoryItemDto
inventoryIdcompanyIdproductNamequantityweightunitPriceheatCodediameterlengthwidthdepthtypematerialtypeLabelmaterialLabelsupplierIdsupplierNamestockLocationIdstockLocationLabelcreatedAtupdatedAtorderLineItemIdmetaInventoryDto
createdAtTimestamp when the record was created (UTC)
updatedAtTimestamp when the record was last updated (UTC)
millCertificationIdMill certification ID if inventory is linked to a mill cert via heat code
linkedOrdersJSON array string of linked orders in format '[{"orderId":"...","orderReference":"..."},...]'. '[]' when no orders are linked.
typeLabelResolved label for Type
materialLabelResolved label for Material
supplierNameResolved name for Supplier (from Organisations)
stockLocationLabelResolved label for Stock Location (from CompanyStockLocations)
quantityNumber of pieces available
weightTotal weight in kilograms
heatCodeHeat code for traceability
diameterDiameter in millimetres
lengthLength dimension (mm)
widthWidth dimension (mm)
depthDepth dimension (mm)
typeType reference (FK to InventoryTypes)
materialMaterial reference (FK to InventoryMaterials)
supplierIdSupplier reference (FK to Organisations)
stockLocationIdStock location reference (FK to CompanyStockLocations)
inventoryIdUnique identifier for the inventory record
companyIdIdentifier of the owning company
productNameHuman readable product name
unitPriceUnit price in company currency
metaInventoryTagDto
createdAtTimestamp when the tag was created (UTC)
updatedAtTimestamp when the tag was last updated (UTC)
usageCountNumber of inventory items currently assigned this tag
tagIdUnique identifier for the tag
companyIdIdentifier of the owning company
nameTag name (must be unique within company)
colorHex color code for the tag (e.g., #FF5733)
descriptionOptional description of the tag's purpose
metaInventoryTagRuleDto
createdAtTimestamp when the rule was created (UTC)
updatedAtTimestamp when the rule was last updated (UTC)
tagNameName of the linked tag
tagColorColor of the linked tag
ruleIdUnique identifier for the rule
companyIdIdentifier of the owning company
tagIdTag to assign when rule matches
nameRule name (must be unique within company)
descriptionOptional description of the rule's purpose
ruleJsonJSON representation of the rule logic
isActiveWhether the rule is active and should be evaluated
metaOrderDto
createdAtupdatedAtorderReferencequantityorderDatedeliveryDatesitestatusactiverelatedOrganisationIdcustomerNameorderIdcompanyIdmetaOrganisationDto
createdAtTimestamp when the record was created (UTC)
updatedAtTimestamp when the record was last updated (UTC)
addressOrganisation address
contactInfoContact information (email, phone, etc.)
taxIdTax identification number
roleIdsList of role IDs assigned to this organisation
rolesList of role names assigned to this organisation
organisationIdUnique identifier for the organisation
companyIdIdentifier of the owning company
nameOrganisation name
metaResultDto
dateCreateddateUpdatedresultresultComparisondescriptionresultIdcompanyIdmillCertification
millCertificationIdcompanyIddefenderResultIdoriginalFileNamenewFileNamestorageFileNamestatusisTestRunmillCertificationDto
newFileNamedefenderResultIddateInserteddateModifiedheatCodesmillCertificationIdcompanyIdoriginalFileNamestorageFileNamestatusmillCertificationStatusLabelmillCertificationStatusNotesmillCertificationStatusTypemillCertificationMechanicalPropertyDto
testNumbermassPerMetercreatedAtupdatedAtmillCertificationMechanicalPropertyIdcompanyIdmillCertificationHeatIdmillCertificationStatusDto
millCertificationStatusIdtypelabelnotesoptimisationRequestTriggerWithResultDto
optimisationRequestTriggerIdcompanyIdstatustriggerCreatedAttriggerUpdatedAtresultIddescriptionresultCreatedAtresultUpdatedAtresultCountorderDetailsResponse
orderIdcompanyIdorderReferencequantityorderDatedeliveryDatesitestatusactiverelatedOrganisationIdcustomerNamecreatedAtupdatedAtorderDto
orderReferencequantityorderDatedeliveryDatesitestatusactiverelatedOrganisationIdcustomerNameorderIdcompanyIdorderLineItemDto
orderLineItemIdorderIdcompanyIdorderLineItemReferenceshapeCodeheatCodelengthdiameterheightwidthquantitypricestatusattachmentUrlattachmentNameactivecreatedAtupdatedAtordersEditHistoryDto
ordersEditHistoryIdorderIdorderLineItemIdeditoreditorNamefieldChangedoldValuenewValueeditedAtorganisationCreateUpdateDto
nameOrganisation name
addressOrganisation address
contactInfoContact information (email, phone, etc.)
taxIdTax identification number
roleIdsList of role IDs to assign to this organisation
organisationDeleteResponse
deletedCountNumber of organisations deleted
deletedIdsList of organisation IDs that were deleted
organisationDto
addressOrganisation address
contactInfoContact information (email, phone, etc.)
taxIdTax identification number
roleIdsList of role IDs assigned to this organisation
rolesList of role names assigned to this organisation
organisationIdUnique identifier for the organisation
companyIdIdentifier of the owning company
nameOrganisation name
organisationRoleDto
organisationRoleIdUnique identifier for the role
valueRole name
reserveInventoryResultDto
linkedInventoryIdoriginalInventoryIdwasSplitorderLineItemIdscrapLogCreateRequest
logDatebinSkipReferencestartingWeightclosingWeightloggedByscrapLogDto
scrapLogIdUnique identifier for the scrap log entry
companyIdIdentifier of the owning company
logDateDate when the scrap was logged
binSkipReferenceBin or skip reference identifier
startingWeightStarting weight in kilograms
closingWeightClosing weight in kilograms
netWeightNet weight (calculated as ClosingWeight - StartingWeight) in kilograms
loggedByUser ID of the person who logged this entry
createdAtTimestamp when the record was created (UTC)
updatedAtTimestamp when the record was last updated (UTC)
activeSoft delete flag (true = active, false = deleted)
scrapLogEditHistoryDto
scrapLogEditHistoryIdUnique identifier for the edit history entry
scrapLogIdThe scrap log entry that was edited
editorUser ID of the editor
editorNameDisplay name of the editor
fieldChangedName of the field that was changed
oldValuePrevious value before the edit
newValueNew value after the edit
editedAtTimestamp when the edit occurred (UTC)
scrapLogUpdateRequest
scrapLogIdlogDatebinSkipReferencestartingWeightclosingWeightunreserveInventoryResultDto
linkIdcompanyIdorderLineItemIdinventoryIduserSyncResponse
userIdfirstNamelastNametutorialModeisSyncedaddTopUpResponse
balanceAfterTotal available credits after the top-up is applied
creditsAddedNumber of credits added by the top-up pack
assignPlanRequest
planIdPlan ID to assign
notesOptional admin note recorded with the assignment
auditEventDto
changedAtchangedByIdchangedByNamechangeTypeentityTypeentityLabelchangeTierPlanRequest
planIdTarget plan ID
forceCancelPendingSet to true to cancel a pending downgrade and proceed with this assignment
companyCertificateSettingsDto
companyIdlogoStorageFileNamestampStorageFileNamestampTextcertificateContactNamecertificateContactEmailcertificateContactPhonecertificateFooterTextcompanyRegistrationNumbercreatedAtupdatedAtcompanyEmailDomainDto
companyEmailDomainIdcompanyIdemailDomainactivelastModifiedByupdatedAtcompanyOrderStatusDto
companyOrderStatusIdcompanyIdorderStatusIdcategoryvalueactivelastModifiedByupdatedAtcompanySubscriptionDto
planIdPlan ID
planNamePlan display name
planKeyPlan key
planMonthlyCreditsMonthly credits in plan
monthlyCreditsRemainingMonthly credits remaining this period
topUpCreditsRemainingTop-up credits remaining (never expire)
totalCreditsTotal available credits
hardStopEnabledBlock uploads when credits reach zero
softAlertThresholdWarn when credits fall below this threshold; null = no alert
nextMonthlyResetAtNext monthly credit reset UTC
commitmentTypemonthly or annual
commitmentPeriodStartStart of current annual commitment period; null if monthly
commitmentPeriodEndEnd of current annual commitment period (CommitmentPeriodStart + 12 months); null if monthly
pendingPlanIdPlan to apply at next rollover; null if none pending
pendingPlanNameDisplay name of pending plan
pendingPlanEffectiveAtWhen the pending plan takes effect UTC
changeTypeResult of the last tier change: upgrade | downgrade_scheduled | lateral
countryDto
countryIdUnique identifier for the country
iso2CodeISO-3166 alpha-2 country code (e.g. GB, US)
iso3CodeISO-3166 alpha-3 country code (e.g. GBR, USA)
nameCountry name
createMillCertTagDto
nameTag name (must be unique within company)
colorHex color code for the tag
descriptionOptional description
createMillCertTagRuleDto
tagIdTag to assign when rule matches
nameRule name (must be unique within company)
descriptionOptional description
ruleJsonJSON representation of the rule logic
isActiveWhether the rule is active and should be evaluated
createOrderTagDto
nameTag name (must be unique within company)
colorHex color code for the tag
descriptionOptional description
createOrderTagRuleDto
tagIdTag to assign when rule matches
nameRule name (must be unique within company)
descriptionOptional description
ruleJsonJSON representation of the rule logic
isActiveWhether the rule is active and should be evaluated
creditLedgerEntryDto
ledgerIdLedger row ID
transactionTypemonthly_grant | topup | consumed | monthly_expired | tier_upgrade_adjustment
creditsCredits changed (positive = added, negative = consumed/expired)
balanceAfterTotal balance after this transaction
referenceIdMill certification ID for consumed rows
createdAtWhen the transaction occurred UTC
deleteResponse
deletedCountNumber of items deleted
deletedIdsList of IDs that were deleted
geocodeCandidateDto
formattedAddressFull formatted address as returned by Azure Maps
addressLine1Address line 1 (street number + street name)
cityCity / municipality
regionRegion/state/county
postalCodePostal/ZIP code
countryIso2ISO-3166 alpha-2 country code
latitudeLatitude of the matched location
longitudeLongitude of the matched location
confidenceAzure Maps match confidence score (0-1, higher is better)
industrySectorDto
industrySectorIdUnique identifier for the industry sector
nameIndustry sector name
inventoryMillCertAggregates
carbonEquivalentMincarbonEquivalentMaxcarbonEquivalentAvgcarbonMincarbonMaxcarbonAvgmanganeseMinmanganeseMaxmanganeseAvgsiliconMinsiliconMaxsiliconAvgphosphorusMinphosphorusMaxphosphorusAvgsulphurMinsulphurMaxsulphurAvgchromiumMinchromiumMaxchromiumAvgnickelMinnickelMaxnickelAvgcopperMincopperMaxcopperAvgmolybdenumMinmolybdenumMaxmolybdenumAvgvanadiumMinvanadiumMaxvanadiumAvgnitrogenMinnitrogenMaxnitrogenAvgboronMinboronMaxboronAvgrelativeRibAreaMinrelativeRibAreaMaxrelativeRibAreaAvgmassPerMeterMinmassPerMeterMaxmassPerMeterAvgyieldStrengthMinyieldStrengthMaxyieldStrengthAvgtensileStrengthMintensileStrengthMaxtensileStrengthAvgrmReRatioMinrmReRatioMaxrmReRatioAvgelongationA5MinelongationA5MaxelongationA5AvgelongationAgtMinelongationAgtMaxelongationAgtAvghardnessValueMinhardnessValueMaxhardnessValueAvgmanualCreateMillCertificationRow
millCertificationIdcompanyIdoriginalFileNamestorageFileNamestatusisTestRunsuppliermillstandardqualityproductionProcesscaresQRcertificateDatecustomerNamecustomerAddressdescriptionOfGoodsrollingMarkcaresDispensationReferenceradioactivityStatementconformityStatementcaresApprovalinvoiceNumberproductFormcomplianceStatementdateOfIssueAndValidationinspectionOriginatorsignatoryNamesignatoryRolesignaturePresentsignatureDateceMarkPresentceMarkingCertificateNoukcaMarkPresentukcaMarkingCertificateNocontentTypefileSizeBytesentrySourceuploadedBymaterialProposalRow
referenceMaterialIdcategoryvalueisCustomconfidencesourceExcerptissuemetalGradeDto
metalGradeIdUnique identifier for the metal grade
metalStandardIdThe standard this grade is defined under
metalStandardCodeStandard code this grade belongs to (e.g. ASTM_A615)
codeGrade code (e.g. B500B, Grade 60, 316L, 6061-T6)
nameGrade display name
compositionNotesComposition/property notes
metalStandardDto
metalStandardIdUnique identifier for the metal standard
standardsBodyIdPublishing standards body identifier (see StandardsBodies)
standardsBodyCodePublishing standards body code (e.g. ASTM, BSI, CEN)
materialFamilyIdMaterial family identifier this standard belongs to
materialFamilyNameMaterial family name (e.g. Rebar, Titanium, Non-Ferrous Metals)
codeStandard code (e.g. ASTM_A615, BS4449)
nameStandard display name (e.g. ASTM A615, BS 4449:2005+A3:2016)
scopeBrief plain-English scope summary
versionStandard version/revision
metaMillCertTagDto
usageCountNumber of mill certs currently assigned this tag
createdAtupdatedAttagIdUnique identifier for the tag
companyIdIdentifier of the owning company
nameTag name (must be unique within company)
colorHex color code for the tag
descriptionOptional description
activeWhether the tag is active (false = soft-deleted)
lastModifiedByID of the user who last modified this tag
isSystemTagTrue for tags provisioned by a subscribed Rule Pack — read-only, managed via subscribe/unsubscribe
severityRule Pack severity (Block/Flag/Audit) this tag represents; null for company-authored tags
metaMillCertTagRuleDto
createdAtTimestamp when the rule was created (UTC)
updatedAtTimestamp when the rule was last updated (UTC)
tagNameName of the linked tag
tagColorColor of the linked tag
ruleIdUnique identifier for the rule
companyIdIdentifier of the owning company
tagIdTag to assign when rule matches
nameRule name (must be unique within company)
descriptionOptional description
ruleJsonJSON representation of the rule logic
isActiveWhether the rule is active and should be evaluated
activeWhether the rule exists (false = soft-deleted)
lastModifiedByID of the user who last modified this rule
isSystemRuleTrue for rules provisioned by a subscribed Rule Pack — read-only (cannot be edited), but can be deleted
metaOrderTagDto
usageCountNumber of orders currently assigned this tag
createdAtupdatedAttagIdUnique identifier for the tag
companyIdIdentifier of the owning company
nameTag name (must be unique within company)
colorHex color code for the tag
descriptionOptional description
activeWhether the tag is active (false = soft-deleted)
lastModifiedByID of the user who last modified this tag
isSystemTagTrue for tags provisioned by a subscribed Rule Pack — read-only, managed via subscribe/unsubscribe
severityRule Pack severity (Block/Flag/Audit) this tag represents; null for company-authored tags
metaOrderTagRuleDto
createdAtTimestamp when the rule was created (UTC)
updatedAtTimestamp when the rule was last updated (UTC)
tagNameName of the linked tag
tagColorColor of the linked tag
ruleIdUnique identifier for the rule
companyIdIdentifier of the owning company
tagIdTag to assign when rule matches
nameRule name (must be unique within company)
descriptionOptional description
ruleJsonJSON representation of the rule logic
isActiveWhether the rule is active and should be evaluated
activeWhether the rule exists (false = soft-deleted)
lastModifiedByID of the user who last modified this rule
isSystemRuleTrue for rules provisioned by a subscribed Rule Pack — read-only (cannot be edited), but can be deleted
millCertificationDocumentFieldUpdateDto
millCertificationIdsuppliermillstandardqualityproductionProcesscaresQRcertificateDatecustomerNamecustomerAddressdescriptionOfGoodsrollingMarkcaresDispensationReferenceradioactivityStatementconformityStatementcaresApprovalinvoiceNumberproductFormcomplianceStatementdateOfIssueAndValidationinspectionOriginatorsignatoryNamesignatoryRolesignaturePresentsignatureDateceMarkPresentceMarkingCertificateNoukcaMarkPresentukcaMarkingCertificateNolastModifiedBydateModifiedmillCertificationHeatUpdateDto
millCertificationHeatIdcompanyIdmillCertificationPageIdheatNumberproductReferenceproductFormqualitydiameterlengthcarbonEquivalentcarbonmanganesesiliconphosphorussulphurchromiumnickelcoppermolybdenumvanadiumnitrogenboronaluminiumniobiumwidthrelativeRibAreamodifiedByactivemillCertificationMechanicalPropertyUpdateDto
millCertificationMechanicalPropertyIdcompanyIdmillCertificationHeatIdtestNumbermassPerMeteryieldStrengthtensileStrengthrmReRatioelongationA5elongationAgtbendTestrebendTestimpactEnergyJimpactTemperatureDegChardnessValuehardnessScaleproductionNumberquantitymodifiedByactivemillCertificationPageUpdateDto
millCertificationPageIdcompanyIdpageNumbermillCertPageUrlDto
millCertificationPageIdpageFileNamepageNumbersignedUrlcontentTypemillCertTagAssignmentDto
assignmentIdUnique identifier for the assignment
millCertificationIdMill certification identifier
tagIdTag identifier
assignedByRuleIdRule that assigned this tag (null if manual)
assignedAtTimestamp when the tag was assigned (UTC)
millCertTagAssignmentTagDto
millCertificationIdThe mill certification identifier
tagIdUnique identifier for the tag
companyIdIdentifier of the owning company
nameTag name
colorHex color code for the tag
descriptionOptional description of the tag
assignedByRuleIdRule that assigned this tag (null if manually assigned)
isSystemTagTrue for tags provisioned by a subscribed Rule Pack
severityRule Pack severity (Block/Flag/Audit) this tag represents; null for company-authored tags
millCertTagDto
tagIdUnique identifier for the tag
companyIdIdentifier of the owning company
nameTag name (must be unique within company)
colorHex color code for the tag
descriptionOptional description
activeWhether the tag is active (false = soft-deleted)
lastModifiedByID of the user who last modified this tag
isSystemTagTrue for tags provisioned by a subscribed Rule Pack — read-only, managed via subscribe/unsubscribe
severityRule Pack severity (Block/Flag/Audit) this tag represents; null for company-authored tags
millCertTagRuleDto
ruleIdUnique identifier for the rule
companyIdIdentifier of the owning company
tagIdTag to assign when rule matches
nameRule name (must be unique within company)
descriptionOptional description
ruleJsonJSON representation of the rule logic
isActiveWhether the rule is active and should be evaluated
activeWhether the rule exists (false = soft-deleted)
lastModifiedByID of the user who last modified this rule
isSystemRuleTrue for rules provisioned by a subscribed Rule Pack — read-only (cannot be edited), but can be deleted
onboardingProposalDto
onboardingProposalIdonboardingSessionIdcompanyIdsurfacesourceTypepayloadJsonmodelDeploymentpromptVersionstatuscreatedBycreatedAtupdatedAtonboardingSessionDto
onboardingSessionIdcompanyIdstatusstepsCompletedcreatedBycreatedAtupdatedAtorderLineItemSpecificationDto
orderLineItemIdcompanyIdmetalStandardIdmetalStandardCodemetalStandardNamemetalGradeIdmetalGradeCodemetalGradeNamenotescoatingCodebendTypeCodebarSizeCodesurfaceTypecarbonEquivalentbendRadiushookAnglelegLength1legLength2toleranceClasssurfaceFinishcertificationTypeheatTreatmentedgeConditionconductivityIACSnonFerrousSurfaceFinishcountryOfOrigincreatedAtupdatedAtorderTagAssignmentDto
assignmentIdUnique identifier for the assignment
orderIdOrder identifier
tagIdTag identifier
assignedByRuleIdRule that assigned this tag (null if manual)
assignedAtTimestamp when the tag was assigned (UTC)
orderTagAssignmentTagDto
orderIdThe order identifier
tagIdUnique identifier for the tag
companyIdIdentifier of the owning company
nameTag name
colorHex color code for the tag
descriptionOptional description of the tag
assignedByRuleIdRule that assigned this tag (null if manually assigned)
isSystemTagTrue for tags provisioned by a subscribed Rule Pack
severityRule Pack severity (Block/Flag/Audit) this tag represents; null for company-authored tags
orderTagDto
tagIdUnique identifier for the tag
companyIdIdentifier of the owning company
nameTag name (must be unique within company)
colorHex color code for the tag
descriptionOptional description
activeWhether the tag is active (false = soft-deleted)
lastModifiedByID of the user who last modified this tag
isSystemTagTrue for tags provisioned by a subscribed Rule Pack — read-only, managed via subscribe/unsubscribe
severityRule Pack severity (Block/Flag/Audit) this tag represents; null for company-authored tags
orderTagRuleDto
ruleIdUnique identifier for the rule
companyIdIdentifier of the owning company
tagIdTag to assign when rule matches
nameRule name (must be unique within company)
descriptionOptional description
ruleJsonJSON representation of the rule logic
isActiveWhether the rule is active and should be evaluated
activeWhether the rule exists (false = soft-deleted)
lastModifiedByID of the user who last modified this rule
isSystemRuleTrue for rules provisioned by a subscribed Rule Pack — read-only (cannot be edited), but can be deleted
pendingConflictResponse
messageHuman-readable conflict message
pendingPlanNameName of the pending plan
pendingPlanEffectiveAtWhen the pending plan takes effect UTC
proposeOnboardingRequest
surfacesourceTypeinputonboardingSessionIdreviewMillCertificationRequest
reviewStatuscommentreviewMillCertificationResponse
millCertificationIdreviewStatusreviewStatusLabelreviewCommentreviewedByNamereviewedAtmessagerulePackDetailDto
Rules belonging to this pack
rulePackIdUnique identifier for the rule pack
categoryNameCategory name (Rebar, Stainless Steel, Non-Ferrous Metals, Structural & Alloy Steel, Nickel Alloys)
nameRule pack name
descriptionRule pack description
isSubscribedWhether the requesting company is currently subscribed to this pack
objectTypesSemicolon-joined distinct object types this pack has rules for (Inventory;MillCert;Order)
standardsSemicolon-joined standard codes this pack covers
gradesSemicolon-joined grade codes this pack covers
rulePackDto
rulePackIdUnique identifier for the rule pack
categoryNameCategory name (Rebar, Stainless Steel, Non-Ferrous Metals, Structural & Alloy Steel, Nickel Alloys)
nameRule pack name
descriptionRule pack description
isSubscribedWhether the requesting company is currently subscribed to this pack
objectTypesSemicolon-joined distinct object types this pack has rules for (Inventory;MillCert;Order)
standardsSemicolon-joined standard codes this pack covers
gradesSemicolon-joined grade codes this pack covers
rulePackRuleDto
rulePackRuleIdUnique identifier for the rule
objectTypeObject type this rule evaluates (Inventory, MillCert, or Order)
nameTechnical rule name
descriptionHuman-readable description of what the rule checks
ruleJsonJSON representation of the rule logic (Microsoft.RulesEngine format)
severitySeverity: Block, Flag, or Audit
submitQualityReviewResponse
orderLineItemIdinventoryIdreviewStatusreviewStatusLabelreviewCommentreviewedByNamereviewedAtmessagesubscriptionPlanDto
planIdPlan ID (1=Starter 2=Workshop 3=Production 4=Scale)
planNameDisplay name
planKeyProgrammatic key
monthlyCreditsMonthly AI credits included
annualCostGbpAnnual cost in GBP; null = not yet set
sortOrderDisplay order
updateCompanyCertificateSettingsRequest
stampTextcertificateContactNamecertificateContactEmailcertificateContactPhonecertificateFooterTextcompanyRegistrationNumber
