Skip to main content

UpdateTenantSettingsDto

defaultCurrencystring
unitsOfMeasurementstring
timezonestring
logoUrlstring
organizationNamestring
registrationNumberstring
countrystring
physicalAddressstring
simplifiedWorkflowModeboolean
complianceOverdueThresholdDaysnumber

Days past dueDate before a requirement is flagged OVERDUE and Directors notified

licenseExpiryWarningDaysnumber[]

FR-CLM-020 — days-before-expiry when the license expiry cron fires (e.g. [90, 60, 30, 7])

commitmentExpiryWarningDaysnumber[]

Days-before-due when the commitment expiry cron fires

jurisdictionstring
weekStartDaynumber

FR-WEEKLY-001 — weekly report start day (1=Mon … 7=Sun).

Possible values: >= 1 and <= 7

shiftDefinitionsobject

FR-ONB-003 — Working shift definitions, keyed by shift name. Values are HH:mm-HH:mm time windows.

Example: {"day":"06:00-18:00","night":"18:00-06:00"}
reportBrandingobject

FR-ONB-003 — Report branding overrides, e.g. primaryColor, accentColor, fontFamily.

Example: {"primaryColor":"#0F766E","accentColor":"#F59E0B"}
complianceCategories object[]
  • Array [
  • namestring
    regulatoryBodystring
    descriptionstring
  • ]
  • paymentBatchApprovalThresholds object[]

    FR-ONB-003 — Approval thresholds for payment batches (tiered)

  • Array [
  • maxAmountobjectnullable

    Inclusive upper bound for this tier in the tenant default currency. Null = unbounded top tier.

    requiredApproverRolesstring[]
  • ]
  • paymentOtpThresholdRwfobjectnullable

    FR-PAYSEC-005 — payment batches above this RWF amount require a 2FA/OTP code on approval. Null uses the system default.

    auditLogRetentionYearsnumber

    FR-AUD-005 — Audit log retention in years. Minimum 5, recommended 7.

    misfireThresholdnumber

    FR-BLAST-002 — Misfire count per tunnel per week above this threshold flags the row in the weekly summary.

    equipmentBreakdownThresholdMinutesnumber

    FR-EQUIP-003 — Equipment breakdown duration threshold in minutes. Auto-notifies the Mine Manager.

    packagingUnitKgnumber

    FR-TRACE-001 — kilograms of mineral per packaging unit.

    meuCodePrefixstring

    FR-TRACE-001 — override the MEU code prefix. Defaults to tenant.code.

    productionCategoriesstring[]

    FR-OPS-010 — production sub-category keys (e.g. ["NUGGET","SLUICED","CRUSHED"])

    materialClassificationListstring[]

    FR-TRACE-003 — allowed MEU material classification values.

    devMaterialClassificationsstring[]

    FR-OPS-010 — allowed development-shift material classification keys. Tenant-configurable; SRS defaults are WASTE / ORE / MIXED.

    activityTypesstring[]

    FR-OPS-010 — production-log activity types (dropdown options; users may still enter "Other").

    oreTypesstring[]

    FR-OPS-010 — production-log ore types (dropdown options; users may still enter "Other").

    custodyAttendanceCrossRefstring

    FR-TRACE-012 — strictness when a custody-transfer user has no matching attendance.

    Possible values: [WARN, BLOCK]

    requireDigitalSignaturesboolean

    FR-OPS-§6.9.3 — when true, submitting users must sign critical records (custody, dispatch, production-shift-closure) with their registered device key.

    halfDayThresholdHoursnumber

    FR-LBR-031 — half-day midpoint threshold in hours. Hours >= this count as a full day, otherwise half. Null falls back to the global default (4).

    defaultPaymentFrequencystring

    FR-LBR-050 — default payment cadence for workers with no team/subcontractor frequency.

    Possible values: [DAILY, WEEKLY, BI_WEEKLY, MONTHLY]

    UpdateTenantSettingsDto
    {
    "defaultCurrency": "string",
    "unitsOfMeasurement": "string",
    "timezone": "string",
    "logoUrl": "string",
    "organizationName": "string",
    "registrationNumber": "string",
    "country": "string",
    "physicalAddress": "string",
    "simplifiedWorkflowMode": true,
    "complianceOverdueThresholdDays": 0,
    "licenseExpiryWarningDays": [
    0
    ],
    "commitmentExpiryWarningDays": [
    0
    ],
    "jurisdiction": "string",
    "weekStartDay": 0,
    "shiftDefinitions": {
    "day": "06:00-18:00",
    "night": "18:00-06:00"
    },
    "reportBranding": {
    "primaryColor": "#0F766E",
    "accentColor": "#F59E0B"
    },
    "complianceCategories": [
    {
    "name": "string",
    "regulatoryBody": "string",
    "description": "string"
    }
    ],
    "paymentBatchApprovalThresholds": [
    {
    "maxAmount": {},
    "requiredApproverRoles": [
    "string"
    ]
    }
    ],
    "paymentOtpThresholdRwf": {},
    "auditLogRetentionYears": 0,
    "misfireThreshold": 0,
    "equipmentBreakdownThresholdMinutes": 0,
    "packagingUnitKg": 0,
    "meuCodePrefix": "string",
    "productionCategories": [
    "string"
    ],
    "materialClassificationList": [
    "string"
    ],
    "devMaterialClassifications": [
    "string"
    ],
    "activityTypes": [
    "string"
    ],
    "oreTypes": [
    "string"
    ],
    "custodyAttendanceCrossRef": "WARN",
    "requireDigitalSignatures": true,
    "halfDayThresholdHours": 0,
    "defaultPaymentFrequency": "DAILY"
    }