@d19n/youfibre-odin-sdk 2.0.384 → 2.0.385

package/dist/entities-v2/Order.d.ts

@@ -111,15 +111,93 @@ export declare enum DefaultOrderStageKeys {
     OrderStageBrskMigrationRemediation = "OrderStageBrskMigrationRemediation"
 }
 /**
- * Valid values for Order.CurrencyCode
+ * Valid values for Order.ActivationStatus
  *
- * Currency code (Sales - Order)
+ * status of the order (must be activated for billing) (Sales - Order)
  *
  * @remarks Available options:
- * - `GBP`
+ * - `ACTIVE` - Active
+ * - `BLOCKED` - Blocked
+ * - `CANCELLED` - Cancelled
+ * - `DRAFT` - Draft
+ * - `EXPIRED` - Expired
+ * - `PENDING_FULFILMENT` - Pending Fulfillment
+ * - `PROVISIONING` - Provisioning
+ * - `SUSPENDED` - Suspended
  */
-export declare enum OrderCurrencyCode {
-    GBP = "GBP"
+export declare enum OrderActivationStatus {
+    ACTIVE = "ACTIVE",
+    BLOCKED = "BLOCKED",
+    CANCELLED = "CANCELLED",
+    DRAFT = "DRAFT",
+    EXPIRED = "EXPIRED",
+    PENDING_FULFILLMENT = "PENDING_FULFILMENT",
+    PROVISIONING = "PROVISIONING",
+    SUSPENDED = "SUSPENDED"
+}
+/**
+ * Valid values for Order.AltContactMethod
+ *
+ * AltContactMethod
+ *
+ * @remarks Available options:
+ * - `NO` - No
+ * - `YES` - Yes
+ */
+export declare enum OrderAltContactMethod {
+    NO = "NO",
+    YES = "YES"
+}
+/**
+ * Valid values for Order.BatteryBackupAnswersSource
+ *
+ * Front end that last saved the battery backup answers. Set by the customer portal API, copied to the dispatch work order Source by the orders module, then cleared (PORTAPP-3276).
+ *
+ * @remarks Available options:
+ * - `CUSTOMER_APP` - Customer App
+ * - `CUSTOMER_PORTAL` - Customer Portal
+ */
+export declare enum OrderBatteryBackupAnswersSource {
+    CUSTOMER_APP = "CUSTOMER_APP",
+    CUSTOMER_PORTAL = "CUSTOMER_PORTAL"
+}
+/**
+ * Valid values for Order.BatteryPackRequired
+ *
+ * BatteryPackRequired
+ *
+ * @remarks Available options:
+ * - `NO` - No
+ * - `YES` - Yes
+ */
+export declare enum OrderBatteryPackRequired {
+    NO = "NO",
+    YES = "YES"
+}
+/**
+ * Valid values for Order.BillingTerms
+ *
+ * Billing terms i.e NET 15,30 (Sales - Order)
+ *
+ * @remarks Available options:
+ * - `NET_0` - NET 0
+ * - `NET_10` - NET 10
+ * - `NET_120` - NET 120
+ * - `NET_15` - NET 15
+ * - `NET_3` - NET 3
+ * - `NET_30` - NET 30
+ * - `NET_60` - NET 60
+ * - `NET_90` - NET 90
+ */
+export declare enum OrderBillingTerms {
+    NET_0 = "NET_0",
+    NET_10 = "NET_10",
+    NET_120 = "NET_120",
+    NET_15 = "NET_15",
+    NET_3 = "NET_3",
+    NET_30 = "NET_30",
+    NET_60 = "NET_60",
+    NET_90 = "NET_90"
 }
 /**
  * Valid values for Order.ContractType
@@ -148,47 +226,26 @@ export declare enum OrderContractType {
     NO_CONTRACT = "NONE"
 }
 /**
- * Valid values for Order.TrialUnit
- *
- * trial unit is the unit of measure for free periods (Sales - Order)
- *
- * @remarks Available options:
- * - `DAYS` - Days
- * - `MONTHS` - Months
- */
-export declare enum OrderTrialUnit {
-    DAYS = "DAYS",
-    MONTHS = "MONTHS"
-}
-/**
- * Valid values for Order.DiscountUnit
+ * Valid values for Order.CurrencyCode
  *
- * discount duration unit (Sales - Order)
+ * Currency code (Sales - Order)
  *
  * @remarks Available options:
- * - `DAYS` - Days
- * - `MONTHS` - Months
+ * - `GBP`
  */
-export declare enum OrderDiscountUnit {
-    DAYS = "DAYS",
-    MONTHS = "MONTHS"
+export declare enum OrderCurrencyCode {
+    GBP = "GBP"
 }
 /**
- * Valid values for Order.WithholdCommissionReason
+ * Valid values for Order.DeactivationReason
  *
- * WithholdCommissionReason
+ * Reason for deactivating the order (Sales - Order)
  *
  * @remarks Available options:
- * - `ETF_VALUE` - ETF over £300
- * - `NO_WELCOME_PACK` - No welcome pack
- * - `OTHER` - Other
- * - `PRICE_MATCH_EVIDENCE` - Price Match evidence insufficient or missing
+ * - `PAYMENT_OVERDUE` - Payment overdue
  */
-export declare enum OrderWithholdCommissionReason {
-    ETF_OVER_300 = "ETF_VALUE",
-    NO_WELCOME_PACK = "NO_WELCOME_PACK",
-    OTHER = "OTHER",
-    PRICE_MATCH_EVIDENCE_INSUFFICIENT_OR_MISSING = "PRICE_MATCH_EVIDENCE"
+export declare enum OrderDeactivationReason {
+    PAYMENT_OVERDUE = "PAYMENT_OVERDUE"
 }
 /**
  * Valid values for Order.DiscountType
@@ -204,74 +261,30 @@ export declare enum OrderDiscountType {
     PERCENT = "PERCENT"
 }
 /**
- * Valid values for Order.DeactivationReason
- *
- * Reason for deactivating the order (Sales - Order)
- *
- * @remarks Available options:
- * - `PAYMENT_OVERDUE` - Payment overdue
- */
-export declare enum OrderDeactivationReason {
-    PAYMENT_OVERDUE = "PAYMENT_OVERDUE"
-}
-/**
- * Valid values for Order.BillingTerms
- *
- * Billing terms i.e NET 15,30 (Sales - Order)
- *
- * @remarks Available options:
- * - `NET_0` - NET 0
- * - `NET_10` - NET 10
- * - `NET_120` - NET 120
- * - `NET_15` - NET 15
- * - `NET_3` - NET 3
- * - `NET_30` - NET 30
- * - `NET_60` - NET 60
- * - `NET_90` - NET 90
- */
-export declare enum OrderBillingTerms {
-    NET_0 = "NET_0",
-    NET_10 = "NET_10",
-    NET_120 = "NET_120",
-    NET_15 = "NET_15",
-    NET_3 = "NET_3",
-    NET_30 = "NET_30",
-    NET_60 = "NET_60",
-    NET_90 = "NET_90"
-}
-/**
- * Valid values for Order.Provider
+ * Valid values for Order.DiscountUnit
  *
- * network provider (Sales - Order)
+ * discount duration unit (Sales - Order)
  *
  * @remarks Available options:
- * - `BRSK` - Brsk
- * - `CITYFIBRE` - CityFibre
- * - `NETOMNIA` - Netomnia
- * - `NETOMNIA_LEGACY` - Netomnia legacy
- * - `OPENREACH` - Openreach
- * - `PYOMNI` - PyOmni
+ * - `DAYS` - Days
+ * - `MONTHS` - Months
  */
-export declare enum OrderProvider {
-    BRSK = "BRSK",
-    CITY_FIBRE = "CITYFIBRE",
-    NETOMNIA = "NETOMNIA",
-    NETOMNIA_LEGACY = "NETOMNIA_LEGACY",
-    OPENREACH = "OPENREACH",
-    PY_OMNI = "PYOMNI"
+export declare enum OrderDiscountUnit {
+    DAYS = "DAYS",
+    MONTHS = "MONTHS"
 }
 /**
- * Valid values for Order.AltContactMethod
+ * Valid values for Order.FulfillmentState
  *
- * AltContactMethod
+ * Derived from the commitment set: OPEN while any commitment is Pending or Breached, SETTLED when none is. Written only by the commitment lifecycle.
  *
  * @remarks Available options:
- * - `NO` - No
- * - `YES` - Yes
+ * - `OPEN` - Open
+ * - `SETTLED` - Settled
  */
-export declare enum OrderAltContactMethod {
-    NO = "NO",
-    YES = "YES"
+export declare enum OrderFulfillmentState {
+    OPEN = "OPEN",
+    SETTLED = "SETTLED"
 }
 /**
  * Valid values for Order.MobileCoverage
@@ -286,19 +299,6 @@ export declare enum OrderMobileCoverage {
     NO = "NO",
     YES = "YES"
 }
-/**
- * Valid values for Order.BatteryPackRequired
- *
- * BatteryPackRequired
- *
- * @remarks Available options:
- * - `NO` - No
- * - `YES` - Yes
- */
-export declare enum OrderBatteryPackRequired {
-    NO = "NO",
-    YES = "YES"
-}
 /**
  * Valid values for Order.OtsNotRequiredReason
  *
@@ -329,6 +329,27 @@ export declare enum OrderOtsNotRequiredReason {
     PRE_WIRED_ADDRESS = "PRE_WIRED_ADDRESS",
     TRANSFER_OF_OWNERSHIP = "TRANSFER_OF_OWNERSHIP"
 }
+/**
+ * Valid values for Order.Provider
+ *
+ * network provider (Sales - Order)
+ *
+ * @remarks Available options:
+ * - `BRSK` - Brsk
+ * - `CITYFIBRE` - CityFibre
+ * - `NETOMNIA` - Netomnia
+ * - `NETOMNIA_LEGACY` - Netomnia legacy
+ * - `OPENREACH` - Openreach
+ * - `PYOMNI` - PyOmni
+ */
+export declare enum OrderProvider {
+    BRSK = "BRSK",
+    CITY_FIBRE = "CITYFIBRE",
+    NETOMNIA = "NETOMNIA",
+    NETOMNIA_LEGACY = "NETOMNIA_LEGACY",
+    OPENREACH = "OPENREACH",
+    PY_OMNI = "PYOMNI"
+}
 /**
  * Valid values for Order.SupplierOrderType
  *
@@ -343,405 +364,346 @@ export declare enum OrderSupplierOrderType {
     START_EXISTING = "START"
 }
 /**
- * Valid values for Order.ActivationStatus
+ * Valid values for Order.TrialUnit
  *
- * status of the order (must be activated for billing) (Sales - Order)
+ * trial unit is the unit of measure for free periods (Sales - Order)
  *
  * @remarks Available options:
- * - `ACTIVE` - Active
- * - `BLOCKED` - Blocked
- * - `CANCELLED` - Cancelled
- * - `DRAFT` - Draft
- * - `EXPIRED` - Expired
- * - `PENDING_FULFILMENT` - Pending Fulfillment
- * - `PROVISIONING` - Provisioning
- * - `SUSPENDED` - Suspended
+ * - `DAYS` - Days
+ * - `MONTHS` - Months
  */
-export declare enum OrderActivationStatus {
-    ACTIVE = "ACTIVE",
-    BLOCKED = "BLOCKED",
-    CANCELLED = "CANCELLED",
-    DRAFT = "DRAFT",
-    EXPIRED = "EXPIRED",
-    PENDING_FULFILLMENT = "PENDING_FULFILMENT",
-    PROVISIONING = "PROVISIONING",
-    SUSPENDED = "SUSPENDED"
-}
-/**
- * Valid values for Order.BatteryBackupAnswersSource
- *
- * Front end that last saved the battery backup answers. Set by the customer portal API, copied to the dispatch work order Source by the orders module, then cleared (PORTAPP-3276).
- *
- * @remarks Available options:
- * - `CUSTOMER_APP` - Customer App
- * - `CUSTOMER_PORTAL` - Customer Portal
- */
-export declare enum OrderBatteryBackupAnswersSource {
-    CUSTOMER_APP = "CUSTOMER_APP",
-    CUSTOMER_PORTAL = "CUSTOMER_PORTAL"
+export declare enum OrderTrialUnit {
+    DAYS = "DAYS",
+    MONTHS = "MONTHS"
 }
 /**
- * Valid values for Order.FulfillmentState
+ * Valid values for Order.WithholdCommissionReason
  *
- * Derived from the commitment set: OPEN while any commitment is Pending or Breached, SETTLED when none is. Written only by the commitment lifecycle.
+ * WithholdCommissionReason
  *
  * @remarks Available options:
- * - `OPEN` - Open
- * - `SETTLED` - Settled
+ * - `ETF_VALUE` - ETF over £300
+ * - `NO_WELCOME_PACK` - No welcome pack
+ * - `OTHER` - Other
+ * - `PRICE_MATCH_EVIDENCE` - Price Match evidence insufficient or missing
  */
-export declare enum OrderFulfillmentState {
-    OPEN = "OPEN",
-    SETTLED = "SETTLED"
+export declare enum OrderWithholdCommissionReason {
+    ETF_OVER_300 = "ETF_VALUE",
+    NO_WELCOME_PACK = "NO_WELCOME_PACK",
+    OTHER = "OTHER",
+    PRICE_MATCH_EVIDENCE_INSUFFICIENT_OR_MISSING = "PRICE_MATCH_EVIDENCE"
 }
 /**
  * Property keys for Order
  * Use these constants instead of string literals for type safety
  */
 export declare enum OrderPropertyKeys {
-    /** Pending Amco Collection Work Order */
-    PendingAmcoCollection = "PendingAmcoCollection",
-    /** ExternalReference */
-    ExternalReference = "ExternalReference",
-    /** unit cost for the product derived from product components UnitCost (Sales - Order) */
-    TaxRate = "TaxRate",
-    /** Currency code (Sales - Order) */
-    CurrencyCode = "CurrencyCode",
-    /** the delivery date requested by the customer (Sales - Order) */
-    RequestedDeliveryDate = "RequestedDeliveryDate",
-    /** Display name/title for Order records. Primary identifier for Sales team. */
-    Name = "Name",
-    /** the type of the contract (Sales - Order) */
-    ContractType = "ContractType",
-    /** unique multiple point reference number (Sales - Order) */
-    Umprn = "UMPRN",
+    /** status of the order (must be activated for billing) (Sales - Order) */
+    ActivationStatus = "ActivationStatus",
+    /** active date (Sales - Order) */
+    ActiveDate = "ActiveDate",
+    /** true if the customer has an active mandate (Sales - Order) */
+    ActiveMandate = "ActiveMandate",
+    /** Reference identifier for Order relationships. Used for data integrity. */
+    AddressId = "AddressId",
     /** Affiliate code used when order was placed */
     AffiliateCode = "AffiliateCode",
-    /** Pending Amco Replacement WorkOrder */
-    PendingAmcoReplacement = "PendingAmcoReplacement",
-    /** BrskOrderStatus */
-    BrskOrderStatus = "BrskOrderStatus",
+    /** Aklamio cashback was rejected (Sales - Order) */
+    AklamioCashbackRejectionDate = "AklamioCashbackRejectionDate",
+    /** Aklamio cashback was applied (Sales - Order) */
+    AklamioCashbackVerificationDate = "AklamioCashbackVerificationDate",
     /** This order comes because of an Aklamio Reference (Sales - Order) */
     AklamioReferenced = "AklamioReferenced",
-    /** total taxes (Sales - Order) */
-    TotalTaxAmount = "TotalTaxAmount",
-    /** Data field for Order records. Used by Sales team. */
-    VatNumber = "VATNumber",
-    /** Billing start date (Sales - Order) */
-    BillingStartDate = "BillingStartDate",
-    /** trial unit is the unit of measure for free periods (Sales - Order) */
-    TrialUnit = "TrialUnit",
-    /** discount duration unit (Sales - Order) */
-    DiscountUnit = "DiscountUnit",
-    /** trial length is the number of X free periods (Sales - Order) */
-    TrialLength = "TrialLength",
+    /** The date the order was rejected in aklamio (Sales - Order) */
+    AklamioRejectionDate = "AklamioRejectionDate",
+    /** Aklamio Verification Date (Sales - Order) */
+    AklamioVerificationDate = "AklamioVerificationDate",
+    /** alerts that need to be visible on the order (Sales - Order) */
+    AlertMessage = "AlertMessage",
+    /** the date of the alert message (Sales - Order) */
+    AlertMessageDate = "AlertMessageDate",
+    /** AltContactMethod */
+    AltContactMethod = "AltContactMethod",
     /** the datetime when the amendment was performed (Sales - Order) */
     AmendmentDate = "AmendmentDate",
-    /** Monthly contract value (Sales - Order) */
-    ContractValueMonthly = "ContractValueMonthly",
-    /** WithholdCommissionNotes */
-    WithholdCommissionNotes = "WithholdCommissionNotes",
-    /** WithholdCommissionReason */
-    WithholdCommissionReason = "WithholdCommissionReason",
-    /** total discounts (Sales - Order) */
-    TotalDiscounts = "TotalDiscounts",
-    /** ExternalRefBrskISP */
-    ExternalRefBrskIsp = "ExternalRefBrskISP",
-    /** Pending Amco Dispatch Work Order */
-    PendingAmcoDispatch = "PendingAmcoDispatch",
-    /** ExternalRefBrskFF */
-    ExternalRefBrskFf = "ExternalRefBrskFF",
-    /** ExternalRefBrskFNO */
-    ExternalRefBrskFno = "ExternalRefBrskFNO",
-    /** the date the order is delivered (Sales - Order) */
-    DeliveryDate = "DeliveryDate",
-    /** subtotal of the prices no taxes (Sales - Order) */
-    Subtotal = "Subtotal",
-    /** phone number to transfer (Sales - Order) */
-    TransferPhone = "TransferPhone",
-    /** the date the order is issued (Sales - Order) */
-    IssuedDate = "IssuedDate",
-    /** active date (Sales - Order) */
-    ActiveDate = "ActiveDate",
-    /** the type of discount (Sales - Order) */
-    DiscountType = "DiscountType",
-    /** Reference identifier for Order relationships. Used for data integrity. */
-    AddressId = "AddressId",
-    /** Total contract value (Sales - Order) */
-    ContractValueTotal = "ContractValueTotal",
-    /** Reason for deactivating the order (Sales - Order) */
-    DeactivationReason = "DeactivationReason",
-    /** cancellation reason notes (Sales - Order) */
-    CancellationReasonNote = "CancellationReasonNote",
+    /** the average monthly contract value (Sales - Order) */
+    AverageMonthlyValue = "AverageMonthlyValue",
+    /** Front end that last saved the battery backup answers. Set by the customer portal API, copied to the dispatch work order Source by the orders module, then cleared (PORTAPP-3276). */
+    BatteryBackupAnswersSource = "BatteryBackupAnswersSource",
+    /** Whether a customer already has a battery pack from YouFibre or not */
+    BatteryPackProvided = "BatteryPackProvided",
+    /** BatteryPackRequired */
+    BatteryPackRequired = "BatteryPackRequired",
+    /** Billing day in the month (Sales - Order) */
+    BillingDay = "BillingDay",
+    /** Billing start date (Sales - Order) */
+    BillingStartDate = "BillingStartDate",
+    /** Billing terms i.e NET 15,30 (Sales - Order) */
+    BillingTerms = "BillingTerms",
+    /** BrskOrderStatus */
+    BrskOrderStatus = "BrskOrderStatus",
+    /** This will be the date the order is automatically cancelled. It will always be at the end of an invoice billing period end date. (Sales - Order) */
+    CancellationEffectiveDate = "CancellationEffectiveDate",
     /** Cancelation reason (Sales - Order) */
     CancellationReason = "CancellationReason",
-    /** To be handled manually by an operator. Default state = false (Sales - Order) */
-    IsVerified = "IsVerified",
-    /** true if the customer has an active mandate (Sales - Order) */
-    ActiveMandate = "ActiveMandate",
-    /** the highest status of the invoices in dunning (Sales - Order) */
-    DunningStatus = "DunningStatus",
-    /** alerts that need to be visible on the order (Sales - Order) */
-    AlertMessage = "AlertMessage",
-    /** Data field for Order records. Used by Sales team. */
-    Source = "Source",
-    /** Landing Page (Sales - Order) */
-    LandingPage = "LandingPage",
-    /** the date the mandate reminder was sent (Sales - Order) */
-    MandateReminderSmsSentAt = "MandateReminderSmsSentAt",
-    /** unique delivery point reference number (Sales - Order) */
-    Udprn = "UDPRN",
-    /** the value to discount (Sales - Order) */
-    DiscountValue = "DiscountValue",
+    /** cancellation reason notes (Sales - Order) */
+    CancellationReasonNote = "CancellationReasonNote",
+    /** the date the order was cancelled (Sales - Order) */
+    CancelledDate = "CancelledDate",
+    /** The date the order should be moved to cancelled (Sales - Order) */
+    CancelOnDate = "CancelOnDate",
+    /** When the Cashback was approved (Sales - Order) */
+    CashbackApprovalDate = "CashbackApprovalDate",
+    /** Supplier-committed fulfillment date carried on COMMITTED KCI (per yf-kci-effect-bridge.ts#provide-committed). Stamped onto YF Order via walker-driven receiveKci PROPERTY_WRITE. */
+    CommittedDate = "CommittedDate",
+    /** the contract buy out amount requested by the customer (Sales - Order) */
+    ContractBuyOutRequested = "ContractBuyOutRequested",
+    /** I have read and confirm receipt of the Contract Summary. I consent to the Privacy Policy and acknowledge receipt of the T&Cs. (Sales - Contact) */
+    ContractConsent = "ContractConsent",
+    /** the date the contract will end (Sales - Order) */
+    ContractEndDate = "ContractEndDate",
     /** the number of times the contract has renewed (Sales - Order) */
     ContractRenewalCount = "ContractRenewalCount",
-    /** total price including taxes and discounts (Sales - Order) */
-    TotalPrice = "TotalPrice",
-    /** length for the items discount duration (Sales - Order) */
-    DiscountLength = "DiscountLength",
     /** the additional number of times the contract has renewed (Sales - Order) */
     ContractRenewalCountOverride = "ContractRenewalCountOverride",
-    /** Description of order deactivation (Sales - Order) */
-    DeactivationDescription = "DeactivationDescription",
-    /** the number of invoices in dunning (Sales - Order) */
-    InvoicesDunning = "InvoicesDunning",
-    /** the date the dunning period started (Sales - Order) */
-    DunningStartDate = "DunningStartDate",
-    /** the average monthly contract value (Sales - Order) */
-    AverageMonthlyValue = "AverageMonthlyValue",
-    /** the date of the alert message (Sales - Order) */
-    AlertMessageDate = "AlertMessageDate",
     /** the date the contract start (Sales - Order) */
     ContractStartDate = "ContractStartDate",
-    /** the date the order was cancelled (Sales - Order) */
-    CancelledDate = "CancelledDate",
-    /** the date the mandate reminder email was sent (Sales - Order) */
-    MandateReminderEmailSentAt = "MandateReminderEmailSentAt",
-    /** the date the contract will end (Sales - Order) */
-    ContractEndDate = "ContractEndDate",
-    /** the previous order prior to an amendment or recontract (Sales - Order) */
-    PreviousOrderId = "PreviousOrderId",
-    /** This will be the date the order is automatically cancelled. It will always be at the end of an invoice billing period end date. (Sales - Order) */
-    CancellationEffectiveDate = "CancellationEffectiveDate",
-    /** the date the mandate status was updated (Sales - Order) */
-    MandateStatusUpdatedAt = "MandateStatusUpdatedAt",
-    /** the contract buy out amount requested by the customer (Sales - Order) */
-    ContractBuyOutRequested = "ContractBuyOutRequested",
-    /** The total value sent to collect (Sales - Order) */
-    DcaCollectionValue = "DCACollectionValue",
-    /** The collection value paid to date (Sales - Order) */
-    DcaPaidToDate = "DCAPaidToDate",
+    /** the type of the contract (Sales - Order) */
+    ContractType = "ContractType",
+    /** Monthly contract value (Sales - Order) */
+    ContractValueMonthly = "ContractValueMonthly",
+    /** Total contract value (Sales - Order) */
+    ContractValueTotal = "ContractValueTotal",
+    /** Currency code (Sales - Order) */
+    CurrencyCode = "CurrencyCode",
+    /** Reference identifier for Order relationships. Used for data integrity. */
+    DataSetId = "DataSetId",
     /** The reason for collection attempts stopping (Sales - Order) */
     DcaClosureReason = "DCAClosureReason",
+    /** The total value sent to collect (Sales - Order) */
+    DcaCollectionValue = "DCACollectionValue",
     /** The date the DCA loaded the order (Sales - Order) */
     DcaLoadedDate = "DCALoadedDate",
-    /** Data field for Order records. Used by Sales team. */
-    Longitude = "Longitude",
-    /** Reference identifier for Order relationships. Used for data integrity. */
-    DataSetId = "DataSetId",
-    /** Data field for Order records. Used by Sales team. */
-    Latitude = "Latitude",
-    /** Desired Billing Day (Sales - Order) */
-    DesiredBillingDay = "DesiredBillingDay",
+    /** The collection value paid to date (Sales - Order) */
+    DcaPaidToDate = "DCAPaidToDate",
+    /** The debt collection agency status (Sales - Order) */
+    DcaStatus = "DCAStatus",
     /** The date the order should be moved to deactivated (Sales - Order) */
     DeactivateOnDate = "DeactivateOnDate",
-    /** The date the order should be moved to cancelled (Sales - Order) */
-    CancelOnDate = "CancelOnDate",
-    /** Billing terms i.e NET 15,30 (Sales - Order) */
-    BillingTerms = "BillingTerms",
-    /** Data field for Order records. Used by Sales team. */
-    Uprn = "Uprn",
-    /** referral email (Sales - Order) */
-    ReferralEmail = "ReferralEmail",
-    /** network provider (Sales - Order) */
-    Provider = "Provider",
+    /** The day this order was deactivated. Cleared when the order goes back to Active, and kept when it goes on to Cancelled. Empty means the order is not deactivated. Not to be confused with DeactivateOnDate, which is a scheduled instruction and is cleared once it is acted on. */
+    DeactivationDate = "DeactivationDate",
+    /** Description of order deactivation (Sales - Order) */
+    DeactivationDescription = "DeactivationDescription",
+    /** Reason for deactivating the order (Sales - Order) */
+    DeactivationReason = "DeactivationReason",
+    /** the date the order is delivered (Sales - Order) */
+    DeliveryDate = "DeliveryDate",
+    /** Desired Billing Day (Sales - Order) */
+    DesiredBillingDay = "DesiredBillingDay",
+    /** length for the items discount duration (Sales - Order) */
+    DiscountLength = "DiscountLength",
+    /** the type of discount (Sales - Order) */
+    DiscountType = "DiscountType",
+    /** discount duration unit (Sales - Order) */
+    DiscountUnit = "DiscountUnit",
+    /** the value to discount (Sales - Order) */
+    DiscountValue = "DiscountValue",
+    /** the date the dunning period started (Sales - Order) */
+    DunningStartDate = "DunningStartDate",
+    /** the highest status of the invoices in dunning (Sales - Order) */
+    DunningStatus = "DunningStatus",
     /** when the dunning status was last updated (Sales - Order) */
     DunningStatusUpdatedAt = "DunningStatusUpdatedAt",
-    /** The debt collection agency status (Sales - Order) */
-    DcaStatus = "DCAStatus",
-    /** the price match requested by the customer (Sales - Order) */
-    PriceMatchRequested = "PriceMatchRequested",
-    /** Billing day in the month (Sales - Order) */
-    BillingDay = "BillingDay",
-    /** ReferralApprovalDate (Sales - Order) */
-    ReferralApprovalDate = "ReferralApprovalDate",
-    /** The date the order was rejected in aklamio (Sales - Order) */
-    AklamioRejectionDate = "AklamioRejectionDate",
-    /** the subscriber id is used as the identifier when provisioning on the network (Sales - Order) */
-    SubscriberId = "SubscriberId",
-    /** check this box if you want to flag a commission hold on this order (Sales - Order) */
-    WithholdCommission = "WithholdCommission",
-    /** Aklamio cashback was rejected (Sales - Order) */
-    AklamioCashbackRejectionDate = "AklamioCashbackRejectionDate",
-    /** Aklamio cashback was applied (Sales - Order) */
-    AklamioCashbackVerificationDate = "AklamioCashbackVerificationDate",
-    /** When the Cashback was approved (Sales - Order) */
-    CashbackApprovalDate = "CashbackApprovalDate",
-    /** Supplier-committed fulfillment date carried on COMMITTED KCI (per yf-kci-effect-bridge.ts#provide-committed). Stamped onto YF Order via walker-driven receiveKci PROPERTY_WRITE. */
-    CommittedDate = "CommittedDate",
-    /** Whether a customer already has a battery pack from YouFibre or not */
-    BatteryPackProvided = "BatteryPackProvided",
-    /** I have read and confirm receipt of the Contract Summary. I consent to the Privacy Policy and acknowledge receipt of the T&Cs. (Sales - Contact) */
-    ContractConsent = "ContractConsent",
+    /** The next commitment to fall due. What a "what is about to breach" query sorts on, without walking every commitment. Written only by the lifecycle. */
+    EarliestDueAt = "EarliestDueAt",
     /** The early termination fee quoted for this order (VAT-inclusive, totalGross from the ETF quote calculation). Written by EarlyTerminationService.getQuote on every quote call, for any caller and any atDate — a hypothetical quote overwrites the "as of now" value (deliberate, see CASES-1640). Direct input to the ETF <= £330 eligibility rule in the product-selection flow (WEB-1421 / PORTAPP-2651). */
     EarlyTerminationFee = "EarlyTerminationFee",
-    /** AltContactMethod */
-    AltContactMethod = "AltContactMethod",
-    /** MobileCoverage */
-    MobileCoverage = "MobileCoverage",
-    /** BatteryPackRequired */
-    BatteryPackRequired = "BatteryPackRequired",
+    /** ExternalRefBrskFF */
+    ExternalRefBrskFf = "ExternalRefBrskFF",
+    /** ExternalRefBrskFNO */
+    ExternalRefBrskFno = "ExternalRefBrskFNO",
+    /** ExternalRefBrskISP */
+    ExternalRefBrskIsp = "ExternalRefBrskISP",
+    /** ExternalReference */
+    ExternalReference = "ExternalReference",
+    /** One Touch Switch reference number */
+    ExternalReferenceOts = "ExternalReferenceOts",
+    /** The activation date asked for when the order was placed. Written once at checkout and never changed; RequestedActivationDate moves when the date does. */
+    FirstRequestedActivationDate = "FirstRequestedActivationDate",
+    /** Derived from the commitment set: OPEN while any commitment is Pending or Breached, SETTLED when none is. Written only by the commitment lifecycle. */
+    FulfillmentState = "FulfillmentState",
+    /** the number of invoices in dunning (Sales - Order) */
+    InvoicesDunning = "InvoicesDunning",
+    /** the date the order is issued (Sales - Order) */
+    IssuedDate = "IssuedDate",
+    /** To be handled manually by an operator. Default state = false (Sales - Order) */
+    IsVerified = "IsVerified",
+    /** Landing Page (Sales - Order) */
+    LandingPage = "LandingPage",
+    /** Data field for Order records. Used by Sales team. */
+    Latitude = "Latitude",
     /** LegacyBrskOtsData */
     LegacyBrskOtsData = "LegacyBrskOtsData",
+    /** Data field for Order records. Used by Sales team. */
+    Longitude = "Longitude",
+    /** the date the mandate reminder email was sent (Sales - Order) */
+    MandateReminderEmailSentAt = "MandateReminderEmailSentAt",
+    /** the date the mandate reminder was sent (Sales - Order) */
+    MandateReminderSmsSentAt = "MandateReminderSmsSentAt",
+    /** the date the mandate status was updated (Sales - Order) */
+    MandateStatusUpdatedAt = "MandateStatusUpdatedAt",
+    /** MobileCoverage */
+    MobileCoverage = "MobileCoverage",
+    /** Display name/title for Order records. Primary identifier for Sales team. */
+    Name = "Name",
+    /** How many commitments are Pending or Breached. Written only by the lifecycle. */
+    OpenCommitmentCount = "OpenCommitmentCount",
     /** OtsNotRequiredReason */
     OtsNotRequiredReason = "OtsNotRequiredReason",
-    /** Aklamio Verification Date (Sales - Order) */
-    AklamioVerificationDate = "AklamioVerificationDate",
-    /** The type of supplier order required to fulfil this YF order. */
-    SupplierOrderType = "SupplierOrderType",
-    /** One Touch Switch reference number */
-    ExternalReferenceOts = "ExternalReferenceOts",
+    /** Pending Amco Collection Work Order */
+    PendingAmcoCollection = "PendingAmcoCollection",
+    /** Pending Amco Dispatch Work Order */
+    PendingAmcoDispatch = "PendingAmcoDispatch",
+    /** Pending Amco Replacement WorkOrder */
+    PendingAmcoReplacement = "PendingAmcoReplacement",
+    /** the previous order prior to an amendment or recontract (Sales - Order) */
+    PreviousOrderId = "PreviousOrderId",
+    /** the price match requested by the customer (Sales - Order) */
+    PriceMatchRequested = "PriceMatchRequested",
+    /** network provider (Sales - Order) */
+    Provider = "Provider",
     /** Date the order was recontracted (in place). Discriminator + event date. */
     RecontractDate = "RecontractDate",
-    /** status of the order (must be activated for billing) (Sales - Order) */
-    ActivationStatus = "ActivationStatus",
-    /** Front end that last saved the battery backup answers. Set by the customer portal API, copied to the dispatch work order Source by the orders module, then cleared (PORTAPP-3276). */
-    BatteryBackupAnswersSource = "BatteryBackupAnswersSource",
-    /** The day this order was deactivated. Cleared when the order goes back to Active, and kept when it goes on to Cancelled. Empty means the order is not deactivated. Not to be confused with DeactivateOnDate, which is a scheduled instruction and is cleared once it is acted on. */
-    DeactivationDate = "DeactivationDate",
+    /** ReferralApprovalDate (Sales - Order) */
+    ReferralApprovalDate = "ReferralApprovalDate",
+    /** referral email (Sales - Order) */
+    ReferralEmail = "ReferralEmail",
     /** Used when restarting an existing service, allows the customer to specify what date is used for the RequestedCompletionDate on the supplier-side START order. Used for when a customer is technically able to start receiving service. */
     RequestedActivationDate = "RequestedActivationDate",
-    /** Derived from the commitment set: OPEN while any commitment is Pending or Breached, SETTLED when none is. Written only by the commitment lifecycle. */
-    FulfillmentState = "FulfillmentState",
-    /** How many commitments are Pending or Breached. Written only by the lifecycle. */
-    OpenCommitmentCount = "OpenCommitmentCount",
-    /** The next commitment to fall due. What a "what is about to breach" query sorts on, without walking every commitment. Written only by the lifecycle. */
-    EarliestDueAt = "EarliestDueAt",
+    /** the delivery date requested by the customer (Sales - Order) */
+    RequestedDeliveryDate = "RequestedDeliveryDate",
     /** True while the customer has declined the router/mesh dispatch this recontract would otherwise raise. Written by dispatchRouterForSpeedChange on every call — true when a decline is honoured, false otherwise — so reversal is simply calling the endpoint again with no decline flag (ORD-493). */
     RouterUpgradeDeclined = "RouterUpgradeDeclined",
-    /** The activation date asked for when the order was placed. Written once at checkout and never changed; RequestedActivationDate moves when the date does. */
-    FirstRequestedActivationDate = "FirstRequestedActivationDate"
-}
-/**
- * Properties for Order records
- *
- * @see OrderModule:Order
- */
-export interface OrderProperties {
-    /** Pending Amco Collection Work Order
-     *
-     * @type {BOOLEAN}
-     */
-    PendingAmcoCollection: boolean;
-    /** ExternalReference
-     *
-     * @type {TEXT}
-     */
-    ExternalReference: string;
-    /** unit cost for the product derived from product components UnitCost (Sales - Order)
-     *
-     * @type {PERCENT}
-     * @default 0
-     * @hidden This field is hidden in the UI
-     */
-    TaxRate: number;
-    /** Currency code (Sales - Order)
+    /** Data field for Order records. Used by Sales team. */
+    Source = "Source",
+    /** the subscriber id is used as the identifier when provisioning on the network (Sales - Order) */
+    SubscriberId = "SubscriberId",
+    /** subtotal of the prices no taxes (Sales - Order) */
+    Subtotal = "Subtotal",
+    /** The type of supplier order required to fulfil this YF order. */
+    SupplierOrderType = "SupplierOrderType",
+    /** unit cost for the product derived from product components UnitCost (Sales - Order) */
+    TaxRate = "TaxRate",
+    /** total discounts (Sales - Order) */
+    TotalDiscounts = "TotalDiscounts",
+    /** total price including taxes and discounts (Sales - Order) */
+    TotalPrice = "TotalPrice",
+    /** total taxes (Sales - Order) */
+    TotalTaxAmount = "TotalTaxAmount",
+    /** phone number to transfer (Sales - Order) */
+    TransferPhone = "TransferPhone",
+    /** trial length is the number of X free periods (Sales - Order) */
+    TrialLength = "TrialLength",
+    /** trial unit is the unit of measure for free periods (Sales - Order) */
+    TrialUnit = "TrialUnit",
+    /** unique delivery point reference number (Sales - Order) */
+    Udprn = "UDPRN",
+    /** unique multiple point reference number (Sales - Order) */
+    Umprn = "UMPRN",
+    /** Data field for Order records. Used by Sales team. */
+    Uprn = "Uprn",
+    /** Data field for Order records. Used by Sales team. */
+    VatNumber = "VATNumber",
+    /** check this box if you want to flag a commission hold on this order (Sales - Order) */
+    WithholdCommission = "WithholdCommission",
+    /** WithholdCommissionNotes */
+    WithholdCommissionNotes = "WithholdCommissionNotes",
+    /** WithholdCommissionReason */
+    WithholdCommissionReason = "WithholdCommissionReason"
+}
+/**
+ * Properties for Order records
+ *
+ * @see OrderModule:Order
+ */
+export interface OrderProperties {
+    /** status of the order (must be activated for billing) (Sales - Order)
      *
      * @type {ENUM}
-     * @default GBP
-     * @enum {OrderCurrencyCode}
+     * @default DRAFT
+     * @enum {OrderActivationStatus}
+     * @hidden This field is hidden in the UI
      */
-    CurrencyCode: OrderCurrencyCode;
-    /** the delivery date requested by the customer (Sales - Order)
+    ActivationStatus: OrderActivationStatus;
+    /** active date (Sales - Order)
      *
      * @type {DATE}
      * @format DD/MM/YYYY
      * @hidden This field is hidden in the UI
      */
-    RequestedDeliveryDate: string;
-    /** Display name/title for Order records. Primary identifier for Sales team.
-     *
-     * @type {TEXT}
-     * @placeholder name
-     * @hidden This field is hidden in the UI
-     */
-    Name: string;
-    /** the type of the contract (Sales - Order)
+    ActiveDate: string;
+    /** true if the customer has an active mandate (Sales - Order)
      *
-     * @type {ENUM}
-     * @enum {OrderContractType}
+     * @type {BOOLEAN}
      * @hidden This field is hidden in the UI
      */
-    ContractType: OrderContractType;
-    /** unique multiple point reference number (Sales - Order)
+    ActiveMandate: boolean;
+    /** Reference identifier for Order relationships. Used for data integrity.
      *
-     * @type {NUMBER}
-     * @default 0
+     * @type {LOOKUP}
      */
-    Umprn: number;
+    AddressId: string;
     /** Affiliate code used when order was placed
      *
      * @type {TEXT}
      */
     AffiliateCode: string;
-    /** Pending Amco Replacement WorkOrder
+    /** Aklamio cashback was rejected (Sales - Order)
      *
-     * @type {BOOLEAN}
+     * @type {DATE}
      */
-    PendingAmcoReplacement: boolean;
-    /** BrskOrderStatus
+    AklamioCashbackRejectionDate: string;
+    /** Aklamio cashback was applied (Sales - Order)
      *
-     * @type {TEXT}
+     * @type {DATE}
      */
-    BrskOrderStatus: string;
+    AklamioCashbackVerificationDate: string;
     /** This order comes because of an Aklamio Reference (Sales - Order)
      *
      * @type {BOOLEAN}
      * @default False
      */
     AklamioReferenced: boolean;
-    /** total taxes (Sales - Order)
-     *
-     * @type {CURRENCY}
-     * @default 0
-     * @hidden This field is hidden in the UI
-     */
-    TotalTaxAmount: string;
-    /** Data field for Order records. Used by Sales team.
+    /** The date the order was rejected in aklamio (Sales - Order)
      *
-     * @type {TEXT}
-     * @default 0
-     * @hidden This field is hidden in the UI
+     * @type {DATE}
      */
-    VatNumber: string;
-    /** Billing start date (Sales - Order)
+    AklamioRejectionDate: string;
+    /** Aklamio Verification Date (Sales - Order)
      *
      * @type {DATE}
-     * @format DD/MM/YYYY
      * @hidden This field is hidden in the UI
      */
-    BillingStartDate: string;
-    /** trial unit is the unit of measure for free periods (Sales - Order)
+    AklamioVerificationDate: string;
+    /** alerts that need to be visible on the order (Sales - Order)
      *
-     * @type {ENUM}
-     * @default
-     * @enum {OrderTrialUnit}
+     * @type {TEXT_LONG}
      * @hidden This field is hidden in the UI
      */
-    TrialUnit: OrderTrialUnit;
-    /** discount duration unit (Sales - Order)
+    AlertMessage: string;
+    /** the date of the alert message (Sales - Order)
      *
-     * @type {ENUM}
-     * @default
-     * @enum {OrderDiscountUnit}
+     * @type {DATE}
+     * @format DD/MM/YYYY
      * @hidden This field is hidden in the UI
      */
-    DiscountUnit: OrderDiscountUnit;
-    /** trial length is the number of X free periods (Sales - Order)
+    AlertMessageDate: string;
+    /** AltContactMethod
      *
-     * @type {NUMBER}
-     * @hidden This field is hidden in the UI
+     * @type {ENUM}
+     * @enum {OrderAltContactMethod}
      */
-    TrialLength: number;
+    AltContactMethod: OrderAltContactMethod;
     /** the datetime when the amendment was performed (Sales - Order)
      *
      * @type {DATE}
@@ -749,571 +711,609 @@ export interface OrderProperties {
      * @hidden This field is hidden in the UI
      */
     AmendmentDate: string;
-    /** Monthly contract value (Sales - Order)
+    /** the average monthly contract value (Sales - Order)
      *
-     * @type {TEXT}
+     * @type {CURRENCY}
+     * @default 0
      * @hidden This field is hidden in the UI
      */
-    ContractValueMonthly: string;
-    /** WithholdCommissionNotes
-     *
-     * @type {TEXT_LONG}
-     */
-    WithholdCommissionNotes: string;
-    /** WithholdCommissionReason
+    AverageMonthlyValue: string;
+    /** Front end that last saved the battery backup answers. Set by the customer portal API, copied to the dispatch work order Source by the orders module, then cleared (PORTAPP-3276).
      *
      * @type {ENUM}
-     * @enum {OrderWithholdCommissionReason}
+     * @default
+     * @enum {OrderBatteryBackupAnswersSource}
      */
-    WithholdCommissionReason: OrderWithholdCommissionReason;
-    /** total discounts (Sales - Order)
+    BatteryBackupAnswersSource: OrderBatteryBackupAnswersSource;
+    /** Whether a customer already has a battery pack from YouFibre or not
      *
-     * @type {CURRENCY}
-     * @default 0
+     * @type {BOOLEAN}
+     * @default
      * @hidden This field is hidden in the UI
      */
-    TotalDiscounts: string;
-    /** ExternalRefBrskISP
+    BatteryPackProvided: boolean;
+    /** BatteryPackRequired
      *
-     * @type {TEXT}
+     * @type {ENUM}
+     * @enum {OrderBatteryPackRequired}
      */
-    ExternalRefBrskIsp: string;
-    /** Pending Amco Dispatch Work Order
+    BatteryPackRequired: OrderBatteryPackRequired;
+    /** Billing day in the month (Sales - Order)
      *
-     * @type {BOOLEAN}
+     * @type {NUMBER}
      */
-    PendingAmcoDispatch: boolean;
-    /** ExternalRefBrskFF
+    BillingDay: number;
+    /** Billing start date (Sales - Order)
      *
-     * @type {TEXT}
+     * @type {DATE}
+     * @format DD/MM/YYYY
+     * @hidden This field is hidden in the UI
      */
-    ExternalRefBrskFf: string;
-    /** ExternalRefBrskFNO
+    BillingStartDate: string;
+    /** Billing terms i.e NET 15,30 (Sales - Order)
+     *
+     * @type {ENUM}
+     * @default NET_0
+     * @enum {OrderBillingTerms}
+     */
+    BillingTerms: OrderBillingTerms;
+    /** BrskOrderStatus
      *
      * @type {TEXT}
      */
-    ExternalRefBrskFno: string;
-    /** the date the order is delivered (Sales - Order)
+    BrskOrderStatus: string;
+    /** This will be the date the order is automatically cancelled. It will always be at the end of an invoice billing period end date. (Sales - Order)
      *
      * @type {DATE}
      * @format DD/MM/YYYY
      * @hidden This field is hidden in the UI
      */
-    DeliveryDate: string;
-    /** subtotal of the prices no taxes (Sales - Order)
+    CancellationEffectiveDate: string;
+    /** Cancelation reason (Sales - Order)
      *
-     * @type {CURRENCY}
-     * @default 0
+     * @type {TEXT}
      * @hidden This field is hidden in the UI
      */
-    Subtotal: string;
-    /** phone number to transfer (Sales - Order)
+    CancellationReason: string;
+    /** cancellation reason notes (Sales - Order)
      *
-     * @type {PHONE_NUMBER}
-     * @default
-     * @pii This field contains personally identifiable information
+     * @type {TEXT}
      * @hidden This field is hidden in the UI
      */
-    TransferPhone: string;
-    /** the date the order is issued (Sales - Order)
+    CancellationReasonNote: string;
+    /** the date the order was cancelled (Sales - Order)
      *
      * @type {DATE}
      * @format DD/MM/YYYY
      * @hidden This field is hidden in the UI
      */
-    IssuedDate: string;
-    /** active date (Sales - Order)
+    CancelledDate: string;
+    /** The date the order should be moved to cancelled (Sales - Order)
      *
      * @type {DATE}
-     * @format DD/MM/YYYY
-     * @hidden This field is hidden in the UI
-     */
-    ActiveDate: string;
-    /** the type of discount (Sales - Order)
-     *
-     * @type {ENUM}
-     * @default
-     * @enum {OrderDiscountType}
-     * @hidden This field is hidden in the UI
+     * @tracked Changes to this field are tracked in audit history
      */
-    DiscountType: OrderDiscountType;
-    /** Reference identifier for Order relationships. Used for data integrity.
+    CancelOnDate: string;
+    /** When the Cashback was approved (Sales - Order)
      *
-     * @type {LOOKUP}
+     * @type {DATE}
      */
-    AddressId: string;
-    /** Total contract value (Sales - Order)
+    CashbackApprovalDate: string;
+    /** Supplier-committed fulfillment date carried on COMMITTED KCI (per yf-kci-effect-bridge.ts#provide-committed). Stamped onto YF Order via walker-driven receiveKci PROPERTY_WRITE.
      *
-     * @type {TEXT}
-     * @hidden This field is hidden in the UI
+     * @type {DATE}
      */
-    ContractValueTotal: string;
-    /** Reason for deactivating the order (Sales - Order)
+    CommittedDate: string;
+    /** the contract buy out amount requested by the customer (Sales - Order)
      *
-     * @type {ENUM}
-     * @enum {OrderDeactivationReason}
+     * @type {BOOLEAN}
      * @hidden This field is hidden in the UI
      */
-    DeactivationReason: OrderDeactivationReason;
-    /** cancellation reason notes (Sales - Order)
+    ContractBuyOutRequested: boolean;
+    /** I have read and confirm receipt of the Contract Summary. I consent to the Privacy Policy and acknowledge receipt of the T&Cs. (Sales - Contact)
      *
-     * @type {TEXT}
-     * @hidden This field is hidden in the UI
+     * @type {BOOLEAN}
      */
-    CancellationReasonNote: string;
-    /** Cancelation reason (Sales - Order)
+    ContractConsent: boolean;
+    /** the date the contract will end (Sales - Order)
      *
-     * @type {TEXT}
+     * @type {DATE}
+     * @format DD/MM/YYYY
      * @hidden This field is hidden in the UI
      */
-    CancellationReason: string;
-    /** To be handled manually by an operator. Default state = false (Sales - Order)
+    ContractEndDate: string;
+    /** the number of times the contract has renewed (Sales - Order)
      *
-     * @type {BOOLEAN}
-     * @default false
+     * @type {NUMBER}
      * @hidden This field is hidden in the UI
      */
-    IsVerified: boolean;
-    /** true if the customer has an active mandate (Sales - Order)
+    ContractRenewalCount: number;
+    /** the additional number of times the contract has renewed (Sales - Order)
      *
-     * @type {BOOLEAN}
+     * @type {NUMBER}
      * @hidden This field is hidden in the UI
      */
-    ActiveMandate: boolean;
-    /** the highest status of the invoices in dunning (Sales - Order)
+    ContractRenewalCountOverride: number;
+    /** the date the contract start (Sales - Order)
      *
-     * @type {TEXT}
+     * @type {DATE}
+     * @format DD/MM/YYYY
      * @hidden This field is hidden in the UI
      */
-    DunningStatus: string;
-    /** alerts that need to be visible on the order (Sales - Order)
+    ContractStartDate: string;
+    /** the type of the contract (Sales - Order)
      *
-     * @type {TEXT_LONG}
+     * @type {ENUM}
+     * @enum {OrderContractType}
      * @hidden This field is hidden in the UI
      */
-    AlertMessage: string;
-    /** Data field for Order records. Used by Sales team.
+    ContractType: OrderContractType;
+    /** Monthly contract value (Sales - Order)
      *
      * @type {TEXT}
      * @hidden This field is hidden in the UI
      */
-    Source: string;
-    /** Landing Page (Sales - Order)
+    ContractValueMonthly: string;
+    /** Total contract value (Sales - Order)
      *
      * @type {TEXT}
      * @hidden This field is hidden in the UI
      */
-    LandingPage: string;
-    /** the date the mandate reminder was sent (Sales - Order)
+    ContractValueTotal: string;
+    /** Currency code (Sales - Order)
      *
-     * @type {DATE}
-     * @format DD/MM/YYYY
+     * @type {ENUM}
+     * @default GBP
+     * @enum {OrderCurrencyCode}
+     */
+    CurrencyCode: OrderCurrencyCode;
+    /** Reference identifier for Order relationships. Used for data integrity.
+     *
+     * @type {UUID}
      * @hidden This field is hidden in the UI
      */
-    MandateReminderSmsSentAt: string;
-    /** unique delivery point reference number (Sales - Order)
+    DataSetId: string;
+    /** The reason for collection attempts stopping (Sales - Order)
      *
-     * @type {NUMBER}
-     * @default 0
+     * @type {TEXT}
+     * @hidden This field is hidden in the UI
      */
-    Udprn: number;
-    /** the value to discount (Sales - Order)
+    DcaClosureReason: string;
+    /** The total value sent to collect (Sales - Order)
      *
      * @type {CURRENCY}
-     * @default 0
      * @hidden This field is hidden in the UI
      */
-    DiscountValue: string;
-    /** the number of times the contract has renewed (Sales - Order)
+    DcaCollectionValue: string;
+    /** The date the DCA loaded the order (Sales - Order)
      *
-     * @type {NUMBER}
+     * @type {DATE}
+     * @format DD/MM/YYYY
      * @hidden This field is hidden in the UI
      */
-    ContractRenewalCount: number;
-    /** total price including taxes and discounts (Sales - Order)
+    DcaLoadedDate: string;
+    /** The collection value paid to date (Sales - Order)
      *
      * @type {CURRENCY}
-     * @default 0
      * @hidden This field is hidden in the UI
      */
-    TotalPrice: string;
-    /** length for the items discount duration (Sales - Order)
+    DcaPaidToDate: string;
+    /** The debt collection agency status (Sales - Order)
      *
-     * @type {NUMBER}
+     * @type {TEXT}
      * @hidden This field is hidden in the UI
      */
-    DiscountLength: number;
-    /** the additional number of times the contract has renewed (Sales - Order)
+    DcaStatus: string;
+    /** The date the order should be moved to deactivated (Sales - Order)
      *
-     * @type {NUMBER}
-     * @hidden This field is hidden in the UI
+     * @type {DATE}
+     * @tracked Changes to this field are tracked in audit history
      */
-    ContractRenewalCountOverride: number;
+    DeactivateOnDate: string;
+    /** The day this order was deactivated. Cleared when the order goes back to Active, and kept when it goes on to Cancelled. Empty means the order is not deactivated. Not to be confused with DeactivateOnDate, which is a scheduled instruction and is cleared once it is acted on.
+     *
+     * @type {DATE}
+     * @default
+     */
+    DeactivationDate: string;
     /** Description of order deactivation (Sales - Order)
      *
      * @type {TEXT}
      * @hidden This field is hidden in the UI
      */
     DeactivationDescription: string;
-    /** the number of invoices in dunning (Sales - Order)
+    /** Reason for deactivating the order (Sales - Order)
      *
-     * @type {NUMBER}
+     * @type {ENUM}
+     * @enum {OrderDeactivationReason}
      * @hidden This field is hidden in the UI
      */
-    InvoicesDunning: number;
-    /** the date the dunning period started (Sales - Order)
+    DeactivationReason: OrderDeactivationReason;
+    /** the date the order is delivered (Sales - Order)
      *
      * @type {DATE}
      * @format DD/MM/YYYY
      * @hidden This field is hidden in the UI
      */
-    DunningStartDate: string;
-    /** the average monthly contract value (Sales - Order)
+    DeliveryDate: string;
+    /** Desired Billing Day (Sales - Order)
      *
-     * @type {CURRENCY}
-     * @default 0
-     * @hidden This field is hidden in the UI
+     * @type {NUMBER}
      */
-    AverageMonthlyValue: string;
-    /** the date of the alert message (Sales - Order)
+    DesiredBillingDay: number;
+    /** length for the items discount duration (Sales - Order)
      *
-     * @type {DATE}
-     * @format DD/MM/YYYY
+     * @type {NUMBER}
      * @hidden This field is hidden in the UI
      */
-    AlertMessageDate: string;
-    /** the date the contract start (Sales - Order)
+    DiscountLength: number;
+    /** the type of discount (Sales - Order)
      *
-     * @type {DATE}
-     * @format DD/MM/YYYY
+     * @type {ENUM}
+     * @default
+     * @enum {OrderDiscountType}
      * @hidden This field is hidden in the UI
      */
-    ContractStartDate: string;
-    /** the date the order was cancelled (Sales - Order)
+    DiscountType: OrderDiscountType;
+    /** discount duration unit (Sales - Order)
      *
-     * @type {DATE}
-     * @format DD/MM/YYYY
+     * @type {ENUM}
+     * @default
+     * @enum {OrderDiscountUnit}
      * @hidden This field is hidden in the UI
      */
-    CancelledDate: string;
-    /** the date the mandate reminder email was sent (Sales - Order)
+    DiscountUnit: OrderDiscountUnit;
+    /** the value to discount (Sales - Order)
      *
-     * @type {DATE}
-     * @format DD/MM/YYYY
+     * @type {CURRENCY}
+     * @default 0
      * @hidden This field is hidden in the UI
      */
-    MandateReminderEmailSentAt: string;
-    /** the date the contract will end (Sales - Order)
+    DiscountValue: string;
+    /** the date the dunning period started (Sales - Order)
      *
      * @type {DATE}
      * @format DD/MM/YYYY
      * @hidden This field is hidden in the UI
      */
-    ContractEndDate: string;
-    /** the previous order prior to an amendment or recontract (Sales - Order)
+    DunningStartDate: string;
+    /** the highest status of the invoices in dunning (Sales - Order)
      *
-     * @type {LOOKUP}
+     * @type {TEXT}
      * @hidden This field is hidden in the UI
      */
-    PreviousOrderId: string;
-    /** This will be the date the order is automatically cancelled. It will always be at the end of an invoice billing period end date. (Sales - Order)
+    DunningStatus: string;
+    /** when the dunning status was last updated (Sales - Order)
      *
      * @type {DATE}
      * @format DD/MM/YYYY
      * @hidden This field is hidden in the UI
      */
-    CancellationEffectiveDate: string;
-    /** the date the mandate status was updated (Sales - Order)
+    DunningStatusUpdatedAt: string;
+    /** The next commitment to fall due. What a "what is about to breach" query sorts on, without walking every commitment. Written only by the lifecycle.
      *
-     * @type {DATE}
-     * @format DD/MM/YYYY
-     * @hidden This field is hidden in the UI
+     * @type {DATE_TIME}
+     * @default
      */
-    MandateStatusUpdatedAt: string;
-    /** the contract buy out amount requested by the customer (Sales - Order)
+    EarliestDueAt: string;
+    /** The early termination fee quoted for this order (VAT-inclusive, totalGross from the ETF quote calculation). Written by EarlyTerminationService.getQuote on every quote call, for any caller and any atDate — a hypothetical quote overwrites the "as of now" value (deliberate, see CASES-1640). Direct input to the ETF <= £330 eligibility rule in the product-selection flow (WEB-1421 / PORTAPP-2651).
      *
-     * @type {BOOLEAN}
-     * @hidden This field is hidden in the UI
+     * @type {NUMBER}
+     * @default
      */
-    ContractBuyOutRequested: boolean;
-    /** The total value sent to collect (Sales - Order)
+    EarlyTerminationFee: number;
+    /** ExternalRefBrskFF
      *
-     * @type {CURRENCY}
-     * @hidden This field is hidden in the UI
+     * @type {TEXT}
      */
-    DcaCollectionValue: string;
-    /** The collection value paid to date (Sales - Order)
+    ExternalRefBrskFf: string;
+    /** ExternalRefBrskFNO
      *
-     * @type {CURRENCY}
-     * @hidden This field is hidden in the UI
+     * @type {TEXT}
      */
-    DcaPaidToDate: string;
-    /** The reason for collection attempts stopping (Sales - Order)
+    ExternalRefBrskFno: string;
+    /** ExternalRefBrskISP
      *
      * @type {TEXT}
-     * @hidden This field is hidden in the UI
      */
-    DcaClosureReason: string;
-    /** The date the DCA loaded the order (Sales - Order)
+    ExternalRefBrskIsp: string;
+    /** ExternalReference
      *
-     * @type {DATE}
-     * @format DD/MM/YYYY
-     * @hidden This field is hidden in the UI
+     * @type {TEXT}
      */
-    DcaLoadedDate: string;
-    /** Data field for Order records. Used by Sales team.
+    ExternalReference: string;
+    /** One Touch Switch reference number
      *
      * @type {TEXT}
-     * @hidden This field is hidden in the UI
      */
-    Longitude: string;
-    /** Reference identifier for Order relationships. Used for data integrity.
+    ExternalReferenceOts: string;
+    /** The activation date asked for when the order was placed. Written once at checkout and never changed; RequestedActivationDate moves when the date does.
      *
-     * @type {UUID}
-     * @hidden This field is hidden in the UI
+     * @type {DATE}
+     * @default
      */
-    DataSetId: string;
-    /** Data field for Order records. Used by Sales team.
+    FirstRequestedActivationDate: string;
+    /** Derived from the commitment set: OPEN while any commitment is Pending or Breached, SETTLED when none is. Written only by the commitment lifecycle.
      *
-     * @type {TEXT}
-     * @hidden This field is hidden in the UI
+     * @type {ENUM}
+     * @default
+     * @enum {OrderFulfillmentState}
      */
-    Latitude: string;
-    /** Desired Billing Day (Sales - Order)
+    FulfillmentState: OrderFulfillmentState;
+    /** the number of invoices in dunning (Sales - Order)
      *
      * @type {NUMBER}
+     * @hidden This field is hidden in the UI
      */
-    DesiredBillingDay: number;
-    /** The date the order should be moved to deactivated (Sales - Order)
+    InvoicesDunning: number;
+    /** the date the order is issued (Sales - Order)
      *
      * @type {DATE}
-     * @tracked Changes to this field are tracked in audit history
+     * @format DD/MM/YYYY
+     * @hidden This field is hidden in the UI
      */
-    DeactivateOnDate: string;
-    /** The date the order should be moved to cancelled (Sales - Order)
+    IssuedDate: string;
+    /** To be handled manually by an operator. Default state = false (Sales - Order)
      *
-     * @type {DATE}
-     * @tracked Changes to this field are tracked in audit history
+     * @type {BOOLEAN}
+     * @default false
+     * @hidden This field is hidden in the UI
      */
-    CancelOnDate: string;
-    /** Billing terms i.e NET 15,30 (Sales - Order)
+    IsVerified: boolean;
+    /** Landing Page (Sales - Order)
      *
-     * @type {ENUM}
-     * @default NET_0
-     * @enum {OrderBillingTerms}
+     * @type {TEXT}
+     * @hidden This field is hidden in the UI
      */
-    BillingTerms: OrderBillingTerms;
+    LandingPage: string;
     /** Data field for Order records. Used by Sales team.
      *
-     * @type {NUMBER}
+     * @type {TEXT}
+     * @hidden This field is hidden in the UI
      */
-    Uprn: number;
-    /** referral email (Sales - Order)
+    Latitude: string;
+    /** LegacyBrskOtsData
+     *
+     * @type {JSON}
+     */
+    LegacyBrskOtsData: string;
+    /** Data field for Order records. Used by Sales team.
      *
      * @type {TEXT}
-     * @pii This field contains personally identifiable information
+     * @hidden This field is hidden in the UI
+     */
+    Longitude: string;
+    /** the date the mandate reminder email was sent (Sales - Order)
+     *
+     * @type {DATE}
+     * @format DD/MM/YYYY
+     * @hidden This field is hidden in the UI
      */
-    ReferralEmail: string;
-    /** network provider (Sales - Order)
+    MandateReminderEmailSentAt: string;
+    /** the date the mandate reminder was sent (Sales - Order)
      *
-     * @type {ENUM}
-     * @default PYOMNI
-     * @enum {OrderProvider}
+     * @type {DATE}
+     * @format DD/MM/YYYY
+     * @hidden This field is hidden in the UI
      */
-    Provider: OrderProvider;
-    /** when the dunning status was last updated (Sales - Order)
+    MandateReminderSmsSentAt: string;
+    /** the date the mandate status was updated (Sales - Order)
      *
      * @type {DATE}
      * @format DD/MM/YYYY
      * @hidden This field is hidden in the UI
      */
-    DunningStatusUpdatedAt: string;
-    /** The debt collection agency status (Sales - Order)
+    MandateStatusUpdatedAt: string;
+    /** MobileCoverage
      *
-     * @type {TEXT}
-     * @hidden This field is hidden in the UI
+     * @type {ENUM}
+     * @enum {OrderMobileCoverage}
      */
-    DcaStatus: string;
-    /** the price match requested by the customer (Sales - Order)
+    MobileCoverage: OrderMobileCoverage;
+    /** Display name/title for Order records. Primary identifier for Sales team.
      *
-     * @type {BOOLEAN}
+     * @type {TEXT}
+     * @placeholder name
      * @hidden This field is hidden in the UI
      */
-    PriceMatchRequested: boolean;
-    /** Billing day in the month (Sales - Order)
+    Name: string;
+    /** How many commitments are Pending or Breached. Written only by the lifecycle.
      *
      * @type {NUMBER}
+     * @default
      */
-    BillingDay: number;
-    /** ReferralApprovalDate (Sales - Order)
+    OpenCommitmentCount: number;
+    /** OtsNotRequiredReason
      *
-     * @type {DATE}
-     * @hidden This field is hidden in the UI
+     * @type {ENUM}
+     * @enum {OrderOtsNotRequiredReason}
      */
-    ReferralApprovalDate: string;
-    /** The date the order was rejected in aklamio (Sales - Order)
+    OtsNotRequiredReason: OrderOtsNotRequiredReason;
+    /** Pending Amco Collection Work Order
      *
-     * @type {DATE}
+     * @type {BOOLEAN}
      */
-    AklamioRejectionDate: string;
-    /** the subscriber id is used as the identifier when provisioning on the network (Sales - Order)
+    PendingAmcoCollection: boolean;
+    /** Pending Amco Dispatch Work Order
      *
-     * @type {TEXT}
+     * @type {BOOLEAN}
      */
-    SubscriberId: string;
-    /** check this box if you want to flag a commission hold on this order (Sales - Order)
+    PendingAmcoDispatch: boolean;
+    /** Pending Amco Replacement WorkOrder
      *
      * @type {BOOLEAN}
-     * @default false
-     * @hidden This field is hidden in the UI
      */
-    WithholdCommission: boolean;
-    /** Aklamio cashback was rejected (Sales - Order)
+    PendingAmcoReplacement: boolean;
+    /** the previous order prior to an amendment or recontract (Sales - Order)
      *
-     * @type {DATE}
+     * @type {LOOKUP}
+     * @hidden This field is hidden in the UI
      */
-    AklamioCashbackRejectionDate: string;
-    /** Aklamio cashback was applied (Sales - Order)
+    PreviousOrderId: string;
+    /** the price match requested by the customer (Sales - Order)
      *
-     * @type {DATE}
+     * @type {BOOLEAN}
+     * @hidden This field is hidden in the UI
      */
-    AklamioCashbackVerificationDate: string;
-    /** When the Cashback was approved (Sales - Order)
+    PriceMatchRequested: boolean;
+    /** network provider (Sales - Order)
      *
-     * @type {DATE}
+     * @type {ENUM}
+     * @default PYOMNI
+     * @enum {OrderProvider}
      */
-    CashbackApprovalDate: string;
-    /** Supplier-committed fulfillment date carried on COMMITTED KCI (per yf-kci-effect-bridge.ts#provide-committed). Stamped onto YF Order via walker-driven receiveKci PROPERTY_WRITE.
+    Provider: OrderProvider;
+    /** Date the order was recontracted (in place). Discriminator + event date.
      *
      * @type {DATE}
      */
-    CommittedDate: string;
-    /** Whether a customer already has a battery pack from YouFibre or not
+    RecontractDate: string;
+    /** ReferralApprovalDate (Sales - Order)
      *
-     * @type {BOOLEAN}
-     * @default
+     * @type {DATE}
      * @hidden This field is hidden in the UI
      */
-    BatteryPackProvided: boolean;
-    /** I have read and confirm receipt of the Contract Summary. I consent to the Privacy Policy and acknowledge receipt of the T&Cs. (Sales - Contact)
-     *
-     * @type {BOOLEAN}
-     */
-    ContractConsent: boolean;
-    /** The early termination fee quoted for this order (VAT-inclusive, totalGross from the ETF quote calculation). Written by EarlyTerminationService.getQuote on every quote call, for any caller and any atDate — a hypothetical quote overwrites the "as of now" value (deliberate, see CASES-1640). Direct input to the ETF <= £330 eligibility rule in the product-selection flow (WEB-1421 / PORTAPP-2651).
+    ReferralApprovalDate: string;
+    /** referral email (Sales - Order)
      *
-     * @type {NUMBER}
-     * @default
+     * @type {TEXT}
+     * @pii This field contains personally identifiable information
      */
-    EarlyTerminationFee: number;
-    /** AltContactMethod
+    ReferralEmail: string;
+    /** Used when restarting an existing service, allows the customer to specify what date is used for the RequestedCompletionDate on the supplier-side START order. Used for when a customer is technically able to start receiving service.
      *
-     * @type {ENUM}
-     * @enum {OrderAltContactMethod}
+     * @type {DATE}
      */
-    AltContactMethod: OrderAltContactMethod;
-    /** MobileCoverage
+    RequestedActivationDate: string;
+    /** the delivery date requested by the customer (Sales - Order)
      *
-     * @type {ENUM}
-     * @enum {OrderMobileCoverage}
+     * @type {DATE}
+     * @format DD/MM/YYYY
+     * @hidden This field is hidden in the UI
      */
-    MobileCoverage: OrderMobileCoverage;
-    /** BatteryPackRequired
+    RequestedDeliveryDate: string;
+    /** True while the customer has declined the router/mesh dispatch this recontract would otherwise raise. Written by dispatchRouterForSpeedChange on every call — true when a decline is honoured, false otherwise — so reversal is simply calling the endpoint again with no decline flag (ORD-493).
      *
-     * @type {ENUM}
-     * @enum {OrderBatteryPackRequired}
+     * @type {BOOLEAN}
+     * @default
      */
-    BatteryPackRequired: OrderBatteryPackRequired;
-    /** LegacyBrskOtsData
+    RouterUpgradeDeclined: boolean;
+    /** Data field for Order records. Used by Sales team.
      *
-     * @type {JSON}
+     * @type {TEXT}
+     * @hidden This field is hidden in the UI
      */
-    LegacyBrskOtsData: string;
-    /** OtsNotRequiredReason
+    Source: string;
+    /** the subscriber id is used as the identifier when provisioning on the network (Sales - Order)
      *
-     * @type {ENUM}
-     * @enum {OrderOtsNotRequiredReason}
+     * @type {TEXT}
      */
-    OtsNotRequiredReason: OrderOtsNotRequiredReason;
-    /** Aklamio Verification Date (Sales - Order)
+    SubscriberId: string;
+    /** subtotal of the prices no taxes (Sales - Order)
      *
-     * @type {DATE}
+     * @type {CURRENCY}
+     * @default 0
      * @hidden This field is hidden in the UI
      */
-    AklamioVerificationDate: string;
+    Subtotal: string;
     /** The type of supplier order required to fulfil this YF order.
      *
      * @type {ENUM}
      * @enum {OrderSupplierOrderType}
      */
     SupplierOrderType: OrderSupplierOrderType;
-    /** One Touch Switch reference number
+    /** unit cost for the product derived from product components UnitCost (Sales - Order)
      *
-     * @type {TEXT}
+     * @type {PERCENT}
+     * @default 0
+     * @hidden This field is hidden in the UI
      */
-    ExternalReferenceOts: string;
-    /** Date the order was recontracted (in place). Discriminator + event date.
+    TaxRate: number;
+    /** total discounts (Sales - Order)
      *
-     * @type {DATE}
+     * @type {CURRENCY}
+     * @default 0
+     * @hidden This field is hidden in the UI
      */
-    RecontractDate: string;
-    /** status of the order (must be activated for billing) (Sales - Order)
+    TotalDiscounts: string;
+    /** total price including taxes and discounts (Sales - Order)
      *
-     * @type {ENUM}
-     * @default DRAFT
-     * @enum {OrderActivationStatus}
+     * @type {CURRENCY}
+     * @default 0
      * @hidden This field is hidden in the UI
      */
-    ActivationStatus: OrderActivationStatus;
-    /** Front end that last saved the battery backup answers. Set by the customer portal API, copied to the dispatch work order Source by the orders module, then cleared (PORTAPP-3276).
+    TotalPrice: string;
+    /** total taxes (Sales - Order)
      *
-     * @type {ENUM}
-     * @default
-     * @enum {OrderBatteryBackupAnswersSource}
+     * @type {CURRENCY}
+     * @default 0
+     * @hidden This field is hidden in the UI
      */
-    BatteryBackupAnswersSource: OrderBatteryBackupAnswersSource;
-    /** The day this order was deactivated. Cleared when the order goes back to Active, and kept when it goes on to Cancelled. Empty means the order is not deactivated. Not to be confused with DeactivateOnDate, which is a scheduled instruction and is cleared once it is acted on.
+    TotalTaxAmount: string;
+    /** phone number to transfer (Sales - Order)
      *
-     * @type {DATE}
+     * @type {PHONE_NUMBER}
      * @default
+     * @pii This field contains personally identifiable information
+     * @hidden This field is hidden in the UI
      */
-    DeactivationDate: string;
-    /** Used when restarting an existing service, allows the customer to specify what date is used for the RequestedCompletionDate on the supplier-side START order. Used for when a customer is technically able to start receiving service.
+    TransferPhone: string;
+    /** trial length is the number of X free periods (Sales - Order)
      *
-     * @type {DATE}
+     * @type {NUMBER}
+     * @hidden This field is hidden in the UI
      */
-    RequestedActivationDate: string;
-    /** Derived from the commitment set: OPEN while any commitment is Pending or Breached, SETTLED when none is. Written only by the commitment lifecycle.
+    TrialLength: number;
+    /** trial unit is the unit of measure for free periods (Sales - Order)
      *
      * @type {ENUM}
      * @default
-     * @enum {OrderFulfillmentState}
+     * @enum {OrderTrialUnit}
+     * @hidden This field is hidden in the UI
      */
-    FulfillmentState: OrderFulfillmentState;
-    /** How many commitments are Pending or Breached. Written only by the lifecycle.
+    TrialUnit: OrderTrialUnit;
+    /** unique delivery point reference number (Sales - Order)
      *
      * @type {NUMBER}
-     * @default
+     * @default 0
      */
-    OpenCommitmentCount: number;
-    /** The next commitment to fall due. What a "what is about to breach" query sorts on, without walking every commitment. Written only by the lifecycle.
+    Udprn: number;
+    /** unique multiple point reference number (Sales - Order)
      *
-     * @type {DATE_TIME}
-     * @default
+     * @type {NUMBER}
+     * @default 0
      */
-    EarliestDueAt: string;
-    /** True while the customer has declined the router/mesh dispatch this recontract would otherwise raise. Written by dispatchRouterForSpeedChange on every call — true when a decline is honoured, false otherwise — so reversal is simply calling the endpoint again with no decline flag (ORD-493).
+    Umprn: number;
+    /** Data field for Order records. Used by Sales team.
+     *
+     * @type {NUMBER}
+     */
+    Uprn: number;
+    /** Data field for Order records. Used by Sales team.
+     *
+     * @type {TEXT}
+     * @default 0
+     * @hidden This field is hidden in the UI
+     */
+    VatNumber: string;
+    /** check this box if you want to flag a commission hold on this order (Sales - Order)
      *
      * @type {BOOLEAN}
-     * @default
+     * @default false
+     * @hidden This field is hidden in the UI
      */
-    RouterUpgradeDeclined: boolean;
-    /** The activation date asked for when the order was placed. Written once at checkout and never changed; RequestedActivationDate moves when the date does.
+    WithholdCommission: boolean;
+    /** WithholdCommissionNotes
      *
-     * @type {DATE}
-     * @default
+     * @type {TEXT_LONG}
      */
-    FirstRequestedActivationDate: string;
+    WithholdCommissionNotes: string;
+    /** WithholdCommissionReason
+     *
+     * @type {ENUM}
+     * @enum {OrderWithholdCommissionReason}
+     */
+    WithholdCommissionReason: OrderWithholdCommissionReason;
 }
 /**
  * Order entity from OrderModule