Schemas

Tag name (must be unique within company)

Hex color code for the tag (e.g., #FF5733)

Optional description of the tag's purpose

Tag to assign when rule matches

Rule name (must be unique within company)

Optional description of the rule's purpose

JSON representation of the rule logic

Whether the rule is active and should be evaluated

HTTP status code e.g. 404, 403, 500

Human-readable error message explaining the failure

Detailed error information

ISO 8601 timestamp when the error occurred (UTC)

Correlation / trace identifier for diagnostics

Resolved label for Type

Resolved label for Material

Resolved name for Supplier (from Organisations)

Resolved label for Stock Location (from CompanyStockLocations)

Number of pieces available

Total weight in kilograms

Heat code for traceability

Diameter in millimetres

Length dimension (mm)

Width dimension (mm)

Depth dimension (mm)

Type reference (FK to InventoryTypes)

Material reference (FK to InventoryMaterials)

Supplier reference (FK to Organisations)

Stock location reference (FK to CompanyStockLocations)

Unique identifier for the inventory record

Identifier of the owning company

Human readable product name

Unit price in company currency

Display name of the user who logged this entry

Unique identifier for the scrap log entry

Identifier of the owning company

Date when the scrap was logged

Bin or skip reference identifier

Starting weight in kilograms

Closing weight in kilograms

Net weight (calculated as ClosingWeight - StartingWeight) in kilograms

User ID of the person who logged this entry

Timestamp when the record was created (UTC)

Timestamp when the record was last updated (UTC)

Soft delete flag (true = active, false = deleted)

Number of pieces available

Total weight in kilograms

Heat code for traceability

Diameter in millimetres

Length dimension (mm)

Width dimension (mm)

Depth dimension (mm)

Type reference (FK to InventoryTypes)

Material reference (FK to InventoryMaterials)

Supplier reference (FK to Organisations)

Stock location reference (FK to CompanyStockLocations)

Unique identifier for the inventory record

Identifier of the owning company

Human readable product name

Unit price in company currency

Unique identifier for the assignment

Inventory item identifier

Tag identifier

Rule that assigned this tag (null if manual)

Timestamp when the tag was assigned (UTC)

The inventory item identifier

Unique identifier for the tag

Identifier of the owning company

Tag name

Hex color code for the tag

Optional description of the tag

Unique identifier for the tag

Identifier of the owning company

Tag name (must be unique within company)

Hex color code for the tag (e.g., #FF5733)

Optional description of the tag's purpose

Unique identifier for the rule

Identifier of the owning company

Tag to assign when rule matches

Rule name (must be unique within company)

Optional description of the rule's purpose

JSON representation of the rule logic

Whether the rule is active and should be evaluated

Timestamp when the record was created (UTC)

Timestamp when the record was last updated (UTC)

Mill certification ID if inventory is linked to a mill cert via heat code

JSON array string of linked orders in format '[{"orderId":"...","orderReference":"..."},...]'. '[]' when no orders are linked.

Resolved label for Type

Resolved label for Material

Resolved name for Supplier (from Organisations)

Resolved label for Stock Location (from CompanyStockLocations)

Number of pieces available

Total weight in kilograms

Heat code for traceability

Diameter in millimetres

Length dimension (mm)

Width dimension (mm)

Depth dimension (mm)

Type reference (FK to InventoryTypes)

Material reference (FK to InventoryMaterials)

Supplier reference (FK to Organisations)

Stock location reference (FK to CompanyStockLocations)

Unique identifier for the inventory record

Identifier of the owning company

Human readable product name

Unit price in company currency

Timestamp when the tag was created (UTC)

Timestamp when the tag was last updated (UTC)

Number of inventory items currently assigned this tag

Unique identifier for the tag

Identifier of the owning company

Tag name (must be unique within company)

Hex color code for the tag (e.g., #FF5733)

Optional description of the tag's purpose

Timestamp when the rule was created (UTC)

Timestamp when the rule was last updated (UTC)

Name of the linked tag

Color of the linked tag

Unique identifier for the rule

Identifier of the owning company

Tag to assign when rule matches

Rule name (must be unique within company)

Optional description of the rule's purpose

JSON representation of the rule logic

Whether the rule is active and should be evaluated

Timestamp when the record was created (UTC)

Timestamp when the record was last updated (UTC)

Organisation address

Contact information (email, phone, etc.)

Tax identification number

List of role IDs assigned to this organisation

List of role names assigned to this organisation

Unique identifier for the organisation

Identifier of the owning company

Organisation name

Organisation name

Organisation address

Contact information (email, phone, etc.)

Tax identification number

List of role IDs to assign to this organisation

Number of organisations deleted

List of organisation IDs that were deleted

Organisation address

Contact information (email, phone, etc.)

Tax identification number

List of role IDs assigned to this organisation

List of role names assigned to this organisation

Unique identifier for the organisation

Identifier of the owning company

Organisation name

Unique identifier for the role

Role name

List of deleted scrap log entry IDs

Unique identifier for the scrap log entry

Identifier of the owning company

Date when the scrap was logged

Bin or skip reference identifier

Starting weight in kilograms

Closing weight in kilograms

Net weight (calculated as ClosingWeight - StartingWeight) in kilograms

User ID of the person who logged this entry

Timestamp when the record was created (UTC)

Timestamp when the record was last updated (UTC)

Soft delete flag (true = active, false = deleted)

Unique identifier for the edit history entry

The scrap log entry that was edited

User ID of the editor

Display name of the editor

Name of the field that was changed

Previous value before the edit

New value after the edit

Timestamp when the edit occurred (UTC)

Top-up pack ID (1=500cr 2=1500cr 3=5000cr 4=15000cr)

Total available credits after the top-up is applied

Number of credits added by the top-up pack

Plan ID to assign

Optional admin note recorded with the assignment

Stripe Billing Portal Session URL to redirect the customer to

Desired ongoing commitment type: 'monthly' or 'annual'

Target plan ID

Set to true to cancel a pending downgrade and proceed with this assignment

Stripe Checkout Session URL to redirect the customer to

Saw-blade width lost per cut, in mm (0 to 20, at most 2 decimal places).

Plan ID

Plan display name

Plan key

Monthly credits in plan

Monthly credits remaining this period

Top-up credits remaining (never expire)

Total available credits

Block uploads when credits reach zero

Warn when credits fall below this threshold; null = no alert

Next monthly credit reset UTC

When the subscription was cancelled UTC; null if active

True when a cancellation is scheduled (Stripe cancel_at_period_end) but hasn't taken effect yet — still fully active/entitled until CancelEffectiveAt

When a scheduled cancellation takes effect UTC; null if none scheduled

monthly or annual

Start of current annual commitment period; null if monthly

End of current annual commitment period (CommitmentPeriodStart + 12 months); null if monthly

Commitment type pending at the current commitment period's end (only ever 'monthly'); null if none pending

Plan to apply at next rollover; null if none pending

Display name of pending plan

When the pending plan takes effect UTC

Result of the last tier or commitment change: upgrade | downgrade_scheduled | lateral | commitment_upgrade | commitment_downgrade_scheduled | pending_cancelled | no_change

Stripe customer ID, set once the company has completed at least one subscription checkout; null if never subscribed via Stripe

True when this subscription is the 7-day no-card signup trial

When the trial ends UTC (AssignedAt + 7 days); null unless IsTrial

Mirror of the Stripe subscription status: active | trialing | past_due | unpaid | paused | incomplete | incomplete_expired | canceled. past_due, unpaid and incomplete are the dunning states (payment failed, entitlement continues until DunningGraceEndsAt); incomplete_expired and canceled are terminal.

When the subscription first entered a dunning status UTC; null when in good standing

When the dunning grace window ends and entitlement lapses UTC (PastDueSince + BillingSettings.DunningGraceDays); null unless in a dunning status with a PastDueSince anchor

Unique identifier for the country

ISO-3166 alpha-2 country code (e.g. GB, US)

ISO-3166 alpha-3 country code (e.g. GBR, USA)

Country name

The frontend's own window.location.origin, used to build the post-portal-session return URL. Validated against a known-origins allow-list; falls back to the production URL if missing or untrusted.

Plan ID to subscribe to

monthly or annual

The frontend's own window.location.origin, used to build the post-checkout redirect URL. Validated against a known-origins allow-list; falls back to the production URL if missing or untrusted.

Tag name (must be unique within company)

Hex color code for the tag

Optional description

Severity: null, 'Block', 'Flag', or 'Audit'. Not exclusive to system tags.

Tag to assign when rule matches

Rule name (must be unique within company)

Optional description

JSON representation of the rule logic

Whether the rule is active and should be evaluated

Tag name (must be unique within company)

Hex color code for the tag

Optional description

Tag to assign when rule matches

Rule name (must be unique within company)

Optional description

JSON representation of the rule logic

Whether the rule is active and should be evaluated

Tag name (must be unique within company)

Hex color code for the tag

Optional description

Severity: null, 'Block', 'Flag', or 'Audit'. Not exclusive to system tags.

Tag to assign when rule matches

Rule name (must be unique within company)

Optional description

JSON representation of the rule logic

Whether the rule is active and should be evaluated

Top-up pack ID

The frontend's own window.location.origin, used to build the post-checkout redirect URL. Validated against a known-origins allow-list; falls back to the production URL if missing or untrusted.

Ledger row ID

monthly_grant | topup | consumed | monthly_expired | tier_upgrade_adjustment

Credits changed (positive = added, negative = consumed/expired)

Total balance after this transaction

Mill certification ID for consumed rows

When the transaction occurred UTC

Top-up pack ID (1=500cr 2=1500cr 3=5000cr 4=15000cr)

Credits granted by this pack

Price in GBP