@d19n/youfibre-odin-sdk 2.0.385 → 2.0.387

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -111,93 +111,15 @@ export declare enum DefaultOrderStageKeys {
111
111
  OrderStageBrskMigrationRemediation = "OrderStageBrskMigrationRemediation"
112
112
  }
113
113
  /**
114
- * Valid values for Order.ActivationStatus
115
- *
116
- * status of the order (must be activated for billing) (Sales - Order)
117
- *
118
- * @remarks Available options:
119
- * - `ACTIVE` - Active
120
- * - `BLOCKED` - Blocked
121
- * - `CANCELLED` - Cancelled
122
- * - `DRAFT` - Draft
123
- * - `EXPIRED` - Expired
124
- * - `PENDING_FULFILMENT` - Pending Fulfillment
125
- * - `PROVISIONING` - Provisioning
126
- * - `SUSPENDED` - Suspended
127
- */
128
- export declare enum OrderActivationStatus {
129
- ACTIVE = "ACTIVE",
130
- BLOCKED = "BLOCKED",
131
- CANCELLED = "CANCELLED",
132
- DRAFT = "DRAFT",
133
- EXPIRED = "EXPIRED",
134
- PENDING_FULFILLMENT = "PENDING_FULFILMENT",
135
- PROVISIONING = "PROVISIONING",
136
- SUSPENDED = "SUSPENDED"
137
- }
138
- /**
139
- * Valid values for Order.AltContactMethod
140
- *
141
- * AltContactMethod
142
- *
143
- * @remarks Available options:
144
- * - `NO` - No
145
- * - `YES` - Yes
146
- */
147
- export declare enum OrderAltContactMethod {
148
- NO = "NO",
149
- YES = "YES"
150
- }
151
- /**
152
- * Valid values for Order.BatteryBackupAnswersSource
153
- *
154
- * 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).
155
- *
156
- * @remarks Available options:
157
- * - `CUSTOMER_APP` - Customer App
158
- * - `CUSTOMER_PORTAL` - Customer Portal
159
- */
160
- export declare enum OrderBatteryBackupAnswersSource {
161
- CUSTOMER_APP = "CUSTOMER_APP",
162
- CUSTOMER_PORTAL = "CUSTOMER_PORTAL"
163
- }
164
- /**
165
- * Valid values for Order.BatteryPackRequired
166
- *
167
- * BatteryPackRequired
168
- *
169
- * @remarks Available options:
170
- * - `NO` - No
171
- * - `YES` - Yes
172
- */
173
- export declare enum OrderBatteryPackRequired {
174
- NO = "NO",
175
- YES = "YES"
176
- }
177
- /**
178
- * Valid values for Order.BillingTerms
114
+ * Valid values for Order.CurrencyCode
179
115
  *
180
- * Billing terms i.e NET 15,30 (Sales - Order)
116
+ * Currency code (Sales - Order)
181
117
  *
182
118
  * @remarks Available options:
183
- * - `NET_0` - NET 0
184
- * - `NET_10` - NET 10
185
- * - `NET_120` - NET 120
186
- * - `NET_15` - NET 15
187
- * - `NET_3` - NET 3
188
- * - `NET_30` - NET 30
189
- * - `NET_60` - NET 60
190
- * - `NET_90` - NET 90
119
+ * - `GBP`
191
120
  */
192
- export declare enum OrderBillingTerms {
193
- NET_0 = "NET_0",
194
- NET_10 = "NET_10",
195
- NET_120 = "NET_120",
196
- NET_15 = "NET_15",
197
- NET_3 = "NET_3",
198
- NET_30 = "NET_30",
199
- NET_60 = "NET_60",
200
- NET_90 = "NET_90"
121
+ export declare enum OrderCurrencyCode {
122
+ GBP = "GBP"
201
123
  }
202
124
  /**
203
125
  * Valid values for Order.ContractType
@@ -226,26 +148,47 @@ export declare enum OrderContractType {
226
148
  NO_CONTRACT = "NONE"
227
149
  }
228
150
  /**
229
- * Valid values for Order.CurrencyCode
151
+ * Valid values for Order.TrialUnit
230
152
  *
231
- * Currency code (Sales - Order)
153
+ * trial unit is the unit of measure for free periods (Sales - Order)
232
154
  *
233
155
  * @remarks Available options:
234
- * - `GBP`
156
+ * - `DAYS` - Days
157
+ * - `MONTHS` - Months
235
158
  */
236
- export declare enum OrderCurrencyCode {
237
- GBP = "GBP"
159
+ export declare enum OrderTrialUnit {
160
+ DAYS = "DAYS",
161
+ MONTHS = "MONTHS"
238
162
  }
239
163
  /**
240
- * Valid values for Order.DeactivationReason
164
+ * Valid values for Order.DiscountUnit
241
165
  *
242
- * Reason for deactivating the order (Sales - Order)
166
+ * discount duration unit (Sales - Order)
243
167
  *
244
168
  * @remarks Available options:
245
- * - `PAYMENT_OVERDUE` - Payment overdue
169
+ * - `DAYS` - Days
170
+ * - `MONTHS` - Months
246
171
  */
247
- export declare enum OrderDeactivationReason {
248
- PAYMENT_OVERDUE = "PAYMENT_OVERDUE"
172
+ export declare enum OrderDiscountUnit {
173
+ DAYS = "DAYS",
174
+ MONTHS = "MONTHS"
175
+ }
176
+ /**
177
+ * Valid values for Order.WithholdCommissionReason
178
+ *
179
+ * WithholdCommissionReason
180
+ *
181
+ * @remarks Available options:
182
+ * - `ETF_VALUE` - ETF over £300
183
+ * - `NO_WELCOME_PACK` - No welcome pack
184
+ * - `OTHER` - Other
185
+ * - `PRICE_MATCH_EVIDENCE` - Price Match evidence insufficient or missing
186
+ */
187
+ export declare enum OrderWithholdCommissionReason {
188
+ ETF_OVER_300 = "ETF_VALUE",
189
+ NO_WELCOME_PACK = "NO_WELCOME_PACK",
190
+ OTHER = "OTHER",
191
+ PRICE_MATCH_EVIDENCE_INSUFFICIENT_OR_MISSING = "PRICE_MATCH_EVIDENCE"
249
192
  }
250
193
  /**
251
194
  * Valid values for Order.DiscountType
@@ -261,30 +204,74 @@ export declare enum OrderDiscountType {
261
204
  PERCENT = "PERCENT"
262
205
  }
263
206
  /**
264
- * Valid values for Order.DiscountUnit
207
+ * Valid values for Order.DeactivationReason
265
208
  *
266
- * discount duration unit (Sales - Order)
209
+ * Reason for deactivating the order (Sales - Order)
267
210
  *
268
211
  * @remarks Available options:
269
- * - `DAYS` - Days
270
- * - `MONTHS` - Months
212
+ * - `PAYMENT_OVERDUE` - Payment overdue
271
213
  */
272
- export declare enum OrderDiscountUnit {
273
- DAYS = "DAYS",
274
- MONTHS = "MONTHS"
214
+ export declare enum OrderDeactivationReason {
215
+ PAYMENT_OVERDUE = "PAYMENT_OVERDUE"
275
216
  }
276
217
  /**
277
- * Valid values for Order.FulfillmentState
218
+ * Valid values for Order.BillingTerms
278
219
  *
279
- * Derived from the commitment set: OPEN while any commitment is Pending or Breached, SETTLED when none is. Written only by the commitment lifecycle.
220
+ * Billing terms i.e NET 15,30 (Sales - Order)
280
221
  *
281
222
  * @remarks Available options:
282
- * - `OPEN` - Open
283
- * - `SETTLED` - Settled
223
+ * - `NET_0` - NET 0
224
+ * - `NET_10` - NET 10
225
+ * - `NET_120` - NET 120
226
+ * - `NET_15` - NET 15
227
+ * - `NET_3` - NET 3
228
+ * - `NET_30` - NET 30
229
+ * - `NET_60` - NET 60
230
+ * - `NET_90` - NET 90
284
231
  */
285
- export declare enum OrderFulfillmentState {
286
- OPEN = "OPEN",
287
- SETTLED = "SETTLED"
232
+ export declare enum OrderBillingTerms {
233
+ NET_0 = "NET_0",
234
+ NET_10 = "NET_10",
235
+ NET_120 = "NET_120",
236
+ NET_15 = "NET_15",
237
+ NET_3 = "NET_3",
238
+ NET_30 = "NET_30",
239
+ NET_60 = "NET_60",
240
+ NET_90 = "NET_90"
241
+ }
242
+ /**
243
+ * Valid values for Order.Provider
244
+ *
245
+ * network provider (Sales - Order)
246
+ *
247
+ * @remarks Available options:
248
+ * - `BRSK` - Brsk
249
+ * - `CITYFIBRE` - CityFibre
250
+ * - `NETOMNIA` - Netomnia
251
+ * - `NETOMNIA_LEGACY` - Netomnia legacy
252
+ * - `OPENREACH` - Openreach
253
+ * - `PYOMNI` - PyOmni
254
+ */
255
+ export declare enum OrderProvider {
256
+ BRSK = "BRSK",
257
+ CITY_FIBRE = "CITYFIBRE",
258
+ NETOMNIA = "NETOMNIA",
259
+ NETOMNIA_LEGACY = "NETOMNIA_LEGACY",
260
+ OPENREACH = "OPENREACH",
261
+ PY_OMNI = "PYOMNI"
262
+ }
263
+ /**
264
+ * Valid values for Order.AltContactMethod
265
+ *
266
+ * AltContactMethod
267
+ *
268
+ * @remarks Available options:
269
+ * - `NO` - No
270
+ * - `YES` - Yes
271
+ */
272
+ export declare enum OrderAltContactMethod {
273
+ NO = "NO",
274
+ YES = "YES"
288
275
  }
289
276
  /**
290
277
  * Valid values for Order.MobileCoverage
@@ -299,6 +286,19 @@ export declare enum OrderMobileCoverage {
299
286
  NO = "NO",
300
287
  YES = "YES"
301
288
  }
289
+ /**
290
+ * Valid values for Order.BatteryPackRequired
291
+ *
292
+ * BatteryPackRequired
293
+ *
294
+ * @remarks Available options:
295
+ * - `NO` - No
296
+ * - `YES` - Yes
297
+ */
298
+ export declare enum OrderBatteryPackRequired {
299
+ NO = "NO",
300
+ YES = "YES"
301
+ }
302
302
  /**
303
303
  * Valid values for Order.OtsNotRequiredReason
304
304
  *
@@ -329,27 +329,6 @@ export declare enum OrderOtsNotRequiredReason {
329
329
  PRE_WIRED_ADDRESS = "PRE_WIRED_ADDRESS",
330
330
  TRANSFER_OF_OWNERSHIP = "TRANSFER_OF_OWNERSHIP"
331
331
  }
332
- /**
333
- * Valid values for Order.Provider
334
- *
335
- * network provider (Sales - Order)
336
- *
337
- * @remarks Available options:
338
- * - `BRSK` - Brsk
339
- * - `CITYFIBRE` - CityFibre
340
- * - `NETOMNIA` - Netomnia
341
- * - `NETOMNIA_LEGACY` - Netomnia legacy
342
- * - `OPENREACH` - Openreach
343
- * - `PYOMNI` - PyOmni
344
- */
345
- export declare enum OrderProvider {
346
- BRSK = "BRSK",
347
- CITY_FIBRE = "CITYFIBRE",
348
- NETOMNIA = "NETOMNIA",
349
- NETOMNIA_LEGACY = "NETOMNIA_LEGACY",
350
- OPENREACH = "OPENREACH",
351
- PY_OMNI = "PYOMNI"
352
- }
353
332
  /**
354
333
  * Valid values for Order.SupplierOrderType
355
334
  *
@@ -364,262 +343,283 @@ export declare enum OrderSupplierOrderType {
364
343
  START_EXISTING = "START"
365
344
  }
366
345
  /**
367
- * Valid values for Order.TrialUnit
346
+ * Valid values for Order.ActivationStatus
368
347
  *
369
- * trial unit is the unit of measure for free periods (Sales - Order)
348
+ * status of the order (must be activated for billing) (Sales - Order)
370
349
  *
371
350
  * @remarks Available options:
372
- * - `DAYS` - Days
373
- * - `MONTHS` - Months
351
+ * - `ACTIVE` - Active
352
+ * - `BLOCKED` - Blocked
353
+ * - `CANCELLED` - Cancelled
354
+ * - `DRAFT` - Draft
355
+ * - `EXPIRED` - Expired
356
+ * - `PENDING_FULFILMENT` - Pending Fulfillment
357
+ * - `PROVISIONING` - Provisioning
358
+ * - `SUSPENDED` - Suspended
374
359
  */
375
- export declare enum OrderTrialUnit {
376
- DAYS = "DAYS",
377
- MONTHS = "MONTHS"
378
- }
379
- /**
380
- * Valid values for Order.WithholdCommissionReason
381
- *
382
- * WithholdCommissionReason
360
+ export declare enum OrderActivationStatus {
361
+ ACTIVE = "ACTIVE",
362
+ BLOCKED = "BLOCKED",
363
+ CANCELLED = "CANCELLED",
364
+ DRAFT = "DRAFT",
365
+ EXPIRED = "EXPIRED",
366
+ PENDING_FULFILLMENT = "PENDING_FULFILMENT",
367
+ PROVISIONING = "PROVISIONING",
368
+ SUSPENDED = "SUSPENDED"
369
+ }
370
+ /**
371
+ * Valid values for Order.BatteryBackupAnswersSource
372
+ *
373
+ * 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).
383
374
  *
384
375
  * @remarks Available options:
385
- * - `ETF_VALUE` - ETF over £300
386
- * - `NO_WELCOME_PACK` - No welcome pack
387
- * - `OTHER` - Other
388
- * - `PRICE_MATCH_EVIDENCE` - Price Match evidence insufficient or missing
376
+ * - `CUSTOMER_APP` - Customer App
377
+ * - `CUSTOMER_PORTAL` - Customer Portal
389
378
  */
390
- export declare enum OrderWithholdCommissionReason {
391
- ETF_OVER_300 = "ETF_VALUE",
392
- NO_WELCOME_PACK = "NO_WELCOME_PACK",
393
- OTHER = "OTHER",
394
- PRICE_MATCH_EVIDENCE_INSUFFICIENT_OR_MISSING = "PRICE_MATCH_EVIDENCE"
379
+ export declare enum OrderBatteryBackupAnswersSource {
380
+ CUSTOMER_APP = "CUSTOMER_APP",
381
+ CUSTOMER_PORTAL = "CUSTOMER_PORTAL"
382
+ }
383
+ /**
384
+ * Valid values for Order.FulfillmentState
385
+ *
386
+ * Derived from the commitment set: OPEN while any commitment is Pending or Breached, SETTLED when none is. Written only by the commitment lifecycle.
387
+ *
388
+ * @remarks Available options:
389
+ * - `OPEN` - Open
390
+ * - `SETTLED` - Settled
391
+ */
392
+ export declare enum OrderFulfillmentState {
393
+ OPEN = "OPEN",
394
+ SETTLED = "SETTLED"
395
395
  }
396
396
  /**
397
397
  * Property keys for Order
398
398
  * Use these constants instead of string literals for type safety
399
399
  */
400
400
  export declare enum OrderPropertyKeys {
401
- /** status of the order (must be activated for billing) (Sales - Order) */
402
- ActivationStatus = "ActivationStatus",
403
- /** active date (Sales - Order) */
404
- ActiveDate = "ActiveDate",
405
- /** true if the customer has an active mandate (Sales - Order) */
406
- ActiveMandate = "ActiveMandate",
407
- /** Reference identifier for Order relationships. Used for data integrity. */
408
- AddressId = "AddressId",
401
+ /** Pending Amco Collection Work Order */
402
+ PendingAmcoCollection = "PendingAmcoCollection",
403
+ /** ExternalReference */
404
+ ExternalReference = "ExternalReference",
405
+ /** unit cost for the product derived from product components UnitCost (Sales - Order) */
406
+ TaxRate = "TaxRate",
407
+ /** Currency code (Sales - Order) */
408
+ CurrencyCode = "CurrencyCode",
409
+ /** the delivery date requested by the customer (Sales - Order) */
410
+ RequestedDeliveryDate = "RequestedDeliveryDate",
411
+ /** Display name/title for Order records. Primary identifier for Sales team. */
412
+ Name = "Name",
413
+ /** the type of the contract (Sales - Order) */
414
+ ContractType = "ContractType",
415
+ /** unique multiple point reference number (Sales - Order) */
416
+ Umprn = "UMPRN",
409
417
  /** Affiliate code used when order was placed */
410
418
  AffiliateCode = "AffiliateCode",
411
- /** Aklamio cashback was rejected (Sales - Order) */
412
- AklamioCashbackRejectionDate = "AklamioCashbackRejectionDate",
413
- /** Aklamio cashback was applied (Sales - Order) */
414
- AklamioCashbackVerificationDate = "AklamioCashbackVerificationDate",
419
+ /** Pending Amco Replacement WorkOrder */
420
+ PendingAmcoReplacement = "PendingAmcoReplacement",
421
+ /** BrskOrderStatus */
422
+ BrskOrderStatus = "BrskOrderStatus",
415
423
  /** This order comes because of an Aklamio Reference (Sales - Order) */
416
424
  AklamioReferenced = "AklamioReferenced",
417
- /** The date the order was rejected in aklamio (Sales - Order) */
418
- AklamioRejectionDate = "AklamioRejectionDate",
419
- /** Aklamio Verification Date (Sales - Order) */
420
- AklamioVerificationDate = "AklamioVerificationDate",
421
- /** alerts that need to be visible on the order (Sales - Order) */
422
- AlertMessage = "AlertMessage",
423
- /** the date of the alert message (Sales - Order) */
424
- AlertMessageDate = "AlertMessageDate",
425
- /** AltContactMethod */
426
- AltContactMethod = "AltContactMethod",
427
- /** the datetime when the amendment was performed (Sales - Order) */
428
- AmendmentDate = "AmendmentDate",
429
- /** the average monthly contract value (Sales - Order) */
430
- AverageMonthlyValue = "AverageMonthlyValue",
431
- /** 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). */
432
- BatteryBackupAnswersSource = "BatteryBackupAnswersSource",
433
- /** Whether a customer already has a battery pack from YouFibre or not */
434
- BatteryPackProvided = "BatteryPackProvided",
435
- /** BatteryPackRequired */
436
- BatteryPackRequired = "BatteryPackRequired",
437
- /** Billing day in the month (Sales - Order) */
438
- BillingDay = "BillingDay",
425
+ /** total taxes (Sales - Order) */
426
+ TotalTaxAmount = "TotalTaxAmount",
427
+ /** Data field for Order records. Used by Sales team. */
428
+ VatNumber = "VATNumber",
439
429
  /** Billing start date (Sales - Order) */
440
430
  BillingStartDate = "BillingStartDate",
441
- /** Billing terms i.e NET 15,30 (Sales - Order) */
442
- BillingTerms = "BillingTerms",
443
- /** BrskOrderStatus */
444
- BrskOrderStatus = "BrskOrderStatus",
445
- /** 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) */
446
- CancellationEffectiveDate = "CancellationEffectiveDate",
447
- /** Cancelation reason (Sales - Order) */
448
- CancellationReason = "CancellationReason",
431
+ /** trial unit is the unit of measure for free periods (Sales - Order) */
432
+ TrialUnit = "TrialUnit",
433
+ /** discount duration unit (Sales - Order) */
434
+ DiscountUnit = "DiscountUnit",
435
+ /** trial length is the number of X free periods (Sales - Order) */
436
+ TrialLength = "TrialLength",
437
+ /** the datetime when the amendment was performed (Sales - Order) */
438
+ AmendmentDate = "AmendmentDate",
439
+ /** Monthly contract value (Sales - Order) */
440
+ ContractValueMonthly = "ContractValueMonthly",
441
+ /** WithholdCommissionNotes */
442
+ WithholdCommissionNotes = "WithholdCommissionNotes",
443
+ /** WithholdCommissionReason */
444
+ WithholdCommissionReason = "WithholdCommissionReason",
445
+ /** total discounts (Sales - Order) */
446
+ TotalDiscounts = "TotalDiscounts",
447
+ /** ExternalRefBrskISP */
448
+ ExternalRefBrskIsp = "ExternalRefBrskISP",
449
+ /** Pending Amco Dispatch Work Order */
450
+ PendingAmcoDispatch = "PendingAmcoDispatch",
451
+ /** ExternalRefBrskFF */
452
+ ExternalRefBrskFf = "ExternalRefBrskFF",
453
+ /** ExternalRefBrskFNO */
454
+ ExternalRefBrskFno = "ExternalRefBrskFNO",
455
+ /** the date the order is delivered (Sales - Order) */
456
+ DeliveryDate = "DeliveryDate",
457
+ /** subtotal of the prices no taxes (Sales - Order) */
458
+ Subtotal = "Subtotal",
459
+ /** phone number to transfer (Sales - Order) */
460
+ TransferPhone = "TransferPhone",
461
+ /** the date the order is issued (Sales - Order) */
462
+ IssuedDate = "IssuedDate",
463
+ /** active date (Sales - Order) */
464
+ ActiveDate = "ActiveDate",
465
+ /** the type of discount (Sales - Order) */
466
+ DiscountType = "DiscountType",
467
+ /** Reference identifier for Order relationships. Used for data integrity. */
468
+ AddressId = "AddressId",
469
+ /** Total contract value (Sales - Order) */
470
+ ContractValueTotal = "ContractValueTotal",
471
+ /** Reason for deactivating the order (Sales - Order) */
472
+ DeactivationReason = "DeactivationReason",
449
473
  /** cancellation reason notes (Sales - Order) */
450
474
  CancellationReasonNote = "CancellationReasonNote",
451
- /** the date the order was cancelled (Sales - Order) */
452
- CancelledDate = "CancelledDate",
453
- /** The date the order should be moved to cancelled (Sales - Order) */
454
- CancelOnDate = "CancelOnDate",
455
- /** When the Cashback was approved (Sales - Order) */
456
- CashbackApprovalDate = "CashbackApprovalDate",
457
- /** 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. */
458
- CommittedDate = "CommittedDate",
459
- /** the contract buy out amount requested by the customer (Sales - Order) */
460
- ContractBuyOutRequested = "ContractBuyOutRequested",
461
- /** 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) */
462
- ContractConsent = "ContractConsent",
463
- /** the date the contract will end (Sales - Order) */
464
- ContractEndDate = "ContractEndDate",
475
+ /** Cancelation reason (Sales - Order) */
476
+ CancellationReason = "CancellationReason",
477
+ /** To be handled manually by an operator. Default state = false (Sales - Order) */
478
+ IsVerified = "IsVerified",
479
+ /** true if the customer has an active mandate (Sales - Order) */
480
+ ActiveMandate = "ActiveMandate",
481
+ /** the highest status of the invoices in dunning (Sales - Order) */
482
+ DunningStatus = "DunningStatus",
483
+ /** alerts that need to be visible on the order (Sales - Order) */
484
+ AlertMessage = "AlertMessage",
485
+ /** Data field for Order records. Used by Sales team. */
486
+ Source = "Source",
487
+ /** Landing Page (Sales - Order) */
488
+ LandingPage = "LandingPage",
489
+ /** the date the mandate reminder was sent (Sales - Order) */
490
+ MandateReminderSmsSentAt = "MandateReminderSmsSentAt",
491
+ /** unique delivery point reference number (Sales - Order) */
492
+ Udprn = "UDPRN",
493
+ /** the value to discount (Sales - Order) */
494
+ DiscountValue = "DiscountValue",
465
495
  /** the number of times the contract has renewed (Sales - Order) */
466
496
  ContractRenewalCount = "ContractRenewalCount",
497
+ /** total price including taxes and discounts (Sales - Order) */
498
+ TotalPrice = "TotalPrice",
499
+ /** length for the items discount duration (Sales - Order) */
500
+ DiscountLength = "DiscountLength",
467
501
  /** the additional number of times the contract has renewed (Sales - Order) */
468
502
  ContractRenewalCountOverride = "ContractRenewalCountOverride",
503
+ /** Description of order deactivation (Sales - Order) */
504
+ DeactivationDescription = "DeactivationDescription",
505
+ /** the number of invoices in dunning (Sales - Order) */
506
+ InvoicesDunning = "InvoicesDunning",
507
+ /** the date the dunning period started (Sales - Order) */
508
+ DunningStartDate = "DunningStartDate",
509
+ /** the average monthly contract value (Sales - Order) */
510
+ AverageMonthlyValue = "AverageMonthlyValue",
511
+ /** the date of the alert message (Sales - Order) */
512
+ AlertMessageDate = "AlertMessageDate",
469
513
  /** the date the contract start (Sales - Order) */
470
514
  ContractStartDate = "ContractStartDate",
471
- /** the type of the contract (Sales - Order) */
472
- ContractType = "ContractType",
473
- /** Monthly contract value (Sales - Order) */
474
- ContractValueMonthly = "ContractValueMonthly",
475
- /** Total contract value (Sales - Order) */
476
- ContractValueTotal = "ContractValueTotal",
477
- /** Currency code (Sales - Order) */
478
- CurrencyCode = "CurrencyCode",
479
- /** Reference identifier for Order relationships. Used for data integrity. */
480
- DataSetId = "DataSetId",
481
- /** The reason for collection attempts stopping (Sales - Order) */
482
- DcaClosureReason = "DCAClosureReason",
515
+ /** the date the order was cancelled (Sales - Order) */
516
+ CancelledDate = "CancelledDate",
517
+ /** the date the mandate reminder email was sent (Sales - Order) */
518
+ MandateReminderEmailSentAt = "MandateReminderEmailSentAt",
519
+ /** the date the contract will end (Sales - Order) */
520
+ ContractEndDate = "ContractEndDate",
521
+ /** the previous order prior to an amendment or recontract (Sales - Order) */
522
+ PreviousOrderId = "PreviousOrderId",
523
+ /** 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) */
524
+ CancellationEffectiveDate = "CancellationEffectiveDate",
525
+ /** the date the mandate status was updated (Sales - Order) */
526
+ MandateStatusUpdatedAt = "MandateStatusUpdatedAt",
527
+ /** the contract buy out amount requested by the customer (Sales - Order) */
528
+ ContractBuyOutRequested = "ContractBuyOutRequested",
483
529
  /** The total value sent to collect (Sales - Order) */
484
530
  DcaCollectionValue = "DCACollectionValue",
485
- /** The date the DCA loaded the order (Sales - Order) */
486
- DcaLoadedDate = "DCALoadedDate",
487
531
  /** The collection value paid to date (Sales - Order) */
488
532
  DcaPaidToDate = "DCAPaidToDate",
489
- /** The debt collection agency status (Sales - Order) */
490
- DcaStatus = "DCAStatus",
491
- /** The date the order should be moved to deactivated (Sales - Order) */
492
- DeactivateOnDate = "DeactivateOnDate",
493
- /** 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. */
494
- DeactivationDate = "DeactivationDate",
495
- /** Description of order deactivation (Sales - Order) */
496
- DeactivationDescription = "DeactivationDescription",
497
- /** Reason for deactivating the order (Sales - Order) */
498
- DeactivationReason = "DeactivationReason",
499
- /** the date the order is delivered (Sales - Order) */
500
- DeliveryDate = "DeliveryDate",
533
+ /** The reason for collection attempts stopping (Sales - Order) */
534
+ DcaClosureReason = "DCAClosureReason",
535
+ /** The date the DCA loaded the order (Sales - Order) */
536
+ DcaLoadedDate = "DCALoadedDate",
537
+ /** Data field for Order records. Used by Sales team. */
538
+ Longitude = "Longitude",
539
+ /** Reference identifier for Order relationships. Used for data integrity. */
540
+ DataSetId = "DataSetId",
541
+ /** Data field for Order records. Used by Sales team. */
542
+ Latitude = "Latitude",
501
543
  /** Desired Billing Day (Sales - Order) */
502
544
  DesiredBillingDay = "DesiredBillingDay",
503
- /** length for the items discount duration (Sales - Order) */
504
- DiscountLength = "DiscountLength",
505
- /** the type of discount (Sales - Order) */
506
- DiscountType = "DiscountType",
507
- /** discount duration unit (Sales - Order) */
508
- DiscountUnit = "DiscountUnit",
509
- /** the value to discount (Sales - Order) */
510
- DiscountValue = "DiscountValue",
511
- /** the date the dunning period started (Sales - Order) */
512
- DunningStartDate = "DunningStartDate",
513
- /** the highest status of the invoices in dunning (Sales - Order) */
514
- DunningStatus = "DunningStatus",
545
+ /** The date the order should be moved to deactivated (Sales - Order) */
546
+ DeactivateOnDate = "DeactivateOnDate",
547
+ /** The date the order should be moved to cancelled (Sales - Order) */
548
+ CancelOnDate = "CancelOnDate",
549
+ /** Billing terms i.e NET 15,30 (Sales - Order) */
550
+ BillingTerms = "BillingTerms",
551
+ /** Data field for Order records. Used by Sales team. */
552
+ Uprn = "Uprn",
553
+ /** referral email (Sales - Order) */
554
+ ReferralEmail = "ReferralEmail",
555
+ /** network provider (Sales - Order) */
556
+ Provider = "Provider",
515
557
  /** when the dunning status was last updated (Sales - Order) */
516
558
  DunningStatusUpdatedAt = "DunningStatusUpdatedAt",
517
- /** 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. */
518
- EarliestDueAt = "EarliestDueAt",
559
+ /** The debt collection agency status (Sales - Order) */
560
+ DcaStatus = "DCAStatus",
561
+ /** the price match requested by the customer (Sales - Order) */
562
+ PriceMatchRequested = "PriceMatchRequested",
563
+ /** Billing day in the month (Sales - Order) */
564
+ BillingDay = "BillingDay",
565
+ /** ReferralApprovalDate (Sales - Order) */
566
+ ReferralApprovalDate = "ReferralApprovalDate",
567
+ /** The date the order was rejected in aklamio (Sales - Order) */
568
+ AklamioRejectionDate = "AklamioRejectionDate",
569
+ /** the subscriber id is used as the identifier when provisioning on the network (Sales - Order) */
570
+ SubscriberId = "SubscriberId",
571
+ /** check this box if you want to flag a commission hold on this order (Sales - Order) */
572
+ WithholdCommission = "WithholdCommission",
573
+ /** Aklamio cashback was rejected (Sales - Order) */
574
+ AklamioCashbackRejectionDate = "AklamioCashbackRejectionDate",
575
+ /** Aklamio cashback was applied (Sales - Order) */
576
+ AklamioCashbackVerificationDate = "AklamioCashbackVerificationDate",
577
+ /** When the Cashback was approved (Sales - Order) */
578
+ CashbackApprovalDate = "CashbackApprovalDate",
579
+ /** 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. */
580
+ CommittedDate = "CommittedDate",
581
+ /** Whether a customer already has a battery pack from YouFibre or not */
582
+ BatteryPackProvided = "BatteryPackProvided",
583
+ /** 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) */
584
+ ContractConsent = "ContractConsent",
519
585
  /** 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). */
520
586
  EarlyTerminationFee = "EarlyTerminationFee",
521
- /** ExternalRefBrskFF */
522
- ExternalRefBrskFf = "ExternalRefBrskFF",
523
- /** ExternalRefBrskFNO */
524
- ExternalRefBrskFno = "ExternalRefBrskFNO",
525
- /** ExternalRefBrskISP */
526
- ExternalRefBrskIsp = "ExternalRefBrskISP",
527
- /** ExternalReference */
528
- ExternalReference = "ExternalReference",
529
- /** One Touch Switch reference number */
530
- ExternalReferenceOts = "ExternalReferenceOts",
531
- /** The activation date asked for when the order was placed. Written once at checkout and never changed; RequestedActivationDate moves when the date does. */
532
- FirstRequestedActivationDate = "FirstRequestedActivationDate",
533
- /** Derived from the commitment set: OPEN while any commitment is Pending or Breached, SETTLED when none is. Written only by the commitment lifecycle. */
534
- FulfillmentState = "FulfillmentState",
535
- /** the number of invoices in dunning (Sales - Order) */
536
- InvoicesDunning = "InvoicesDunning",
537
- /** the date the order is issued (Sales - Order) */
538
- IssuedDate = "IssuedDate",
539
- /** To be handled manually by an operator. Default state = false (Sales - Order) */
540
- IsVerified = "IsVerified",
541
- /** Landing Page (Sales - Order) */
542
- LandingPage = "LandingPage",
543
- /** Data field for Order records. Used by Sales team. */
544
- Latitude = "Latitude",
545
- /** LegacyBrskOtsData */
546
- LegacyBrskOtsData = "LegacyBrskOtsData",
547
- /** Data field for Order records. Used by Sales team. */
548
- Longitude = "Longitude",
549
- /** the date the mandate reminder email was sent (Sales - Order) */
550
- MandateReminderEmailSentAt = "MandateReminderEmailSentAt",
551
- /** the date the mandate reminder was sent (Sales - Order) */
552
- MandateReminderSmsSentAt = "MandateReminderSmsSentAt",
553
- /** the date the mandate status was updated (Sales - Order) */
554
- MandateStatusUpdatedAt = "MandateStatusUpdatedAt",
587
+ /** AltContactMethod */
588
+ AltContactMethod = "AltContactMethod",
555
589
  /** MobileCoverage */
556
590
  MobileCoverage = "MobileCoverage",
557
- /** Display name/title for Order records. Primary identifier for Sales team. */
558
- Name = "Name",
559
- /** How many commitments are Pending or Breached. Written only by the lifecycle. */
560
- OpenCommitmentCount = "OpenCommitmentCount",
591
+ /** BatteryPackRequired */
592
+ BatteryPackRequired = "BatteryPackRequired",
593
+ /** LegacyBrskOtsData */
594
+ LegacyBrskOtsData = "LegacyBrskOtsData",
561
595
  /** OtsNotRequiredReason */
562
596
  OtsNotRequiredReason = "OtsNotRequiredReason",
563
- /** Pending Amco Collection Work Order */
564
- PendingAmcoCollection = "PendingAmcoCollection",
565
- /** Pending Amco Dispatch Work Order */
566
- PendingAmcoDispatch = "PendingAmcoDispatch",
567
- /** Pending Amco Replacement WorkOrder */
568
- PendingAmcoReplacement = "PendingAmcoReplacement",
569
- /** the previous order prior to an amendment or recontract (Sales - Order) */
570
- PreviousOrderId = "PreviousOrderId",
571
- /** the price match requested by the customer (Sales - Order) */
572
- PriceMatchRequested = "PriceMatchRequested",
573
- /** network provider (Sales - Order) */
574
- Provider = "Provider",
597
+ /** Aklamio Verification Date (Sales - Order) */
598
+ AklamioVerificationDate = "AklamioVerificationDate",
599
+ /** The type of supplier order required to fulfil this YF order. */
600
+ SupplierOrderType = "SupplierOrderType",
601
+ /** One Touch Switch reference number */
602
+ ExternalReferenceOts = "ExternalReferenceOts",
575
603
  /** Date the order was recontracted (in place). Discriminator + event date. */
576
604
  RecontractDate = "RecontractDate",
577
- /** ReferralApprovalDate (Sales - Order) */
578
- ReferralApprovalDate = "ReferralApprovalDate",
579
- /** referral email (Sales - Order) */
580
- ReferralEmail = "ReferralEmail",
605
+ /** status of the order (must be activated for billing) (Sales - Order) */
606
+ ActivationStatus = "ActivationStatus",
607
+ /** 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). */
608
+ BatteryBackupAnswersSource = "BatteryBackupAnswersSource",
609
+ /** 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. */
610
+ DeactivationDate = "DeactivationDate",
581
611
  /** 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. */
582
612
  RequestedActivationDate = "RequestedActivationDate",
583
- /** the delivery date requested by the customer (Sales - Order) */
584
- RequestedDeliveryDate = "RequestedDeliveryDate",
613
+ /** Derived from the commitment set: OPEN while any commitment is Pending or Breached, SETTLED when none is. Written only by the commitment lifecycle. */
614
+ FulfillmentState = "FulfillmentState",
615
+ /** How many commitments are Pending or Breached. Written only by the lifecycle. */
616
+ OpenCommitmentCount = "OpenCommitmentCount",
617
+ /** 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. */
618
+ EarliestDueAt = "EarliestDueAt",
585
619
  /** 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). */
586
620
  RouterUpgradeDeclined = "RouterUpgradeDeclined",
587
- /** Data field for Order records. Used by Sales team. */
588
- Source = "Source",
589
- /** the subscriber id is used as the identifier when provisioning on the network (Sales - Order) */
590
- SubscriberId = "SubscriberId",
591
- /** subtotal of the prices no taxes (Sales - Order) */
592
- Subtotal = "Subtotal",
593
- /** The type of supplier order required to fulfil this YF order. */
594
- SupplierOrderType = "SupplierOrderType",
595
- /** unit cost for the product derived from product components UnitCost (Sales - Order) */
596
- TaxRate = "TaxRate",
597
- /** total discounts (Sales - Order) */
598
- TotalDiscounts = "TotalDiscounts",
599
- /** total price including taxes and discounts (Sales - Order) */
600
- TotalPrice = "TotalPrice",
601
- /** total taxes (Sales - Order) */
602
- TotalTaxAmount = "TotalTaxAmount",
603
- /** phone number to transfer (Sales - Order) */
604
- TransferPhone = "TransferPhone",
605
- /** trial length is the number of X free periods (Sales - Order) */
606
- TrialLength = "TrialLength",
607
- /** trial unit is the unit of measure for free periods (Sales - Order) */
608
- TrialUnit = "TrialUnit",
609
- /** unique delivery point reference number (Sales - Order) */
610
- Udprn = "UDPRN",
611
- /** unique multiple point reference number (Sales - Order) */
612
- Umprn = "UMPRN",
613
- /** Data field for Order records. Used by Sales team. */
614
- Uprn = "Uprn",
615
- /** Data field for Order records. Used by Sales team. */
616
- VatNumber = "VATNumber",
617
- /** check this box if you want to flag a commission hold on this order (Sales - Order) */
618
- WithholdCommission = "WithholdCommission",
619
- /** WithholdCommissionNotes */
620
- WithholdCommissionNotes = "WithholdCommissionNotes",
621
- /** WithholdCommissionReason */
622
- WithholdCommissionReason = "WithholdCommissionReason"
621
+ /** The activation date asked for when the order was placed. Written once at checkout and never changed; RequestedActivationDate moves when the date does. */
622
+ FirstRequestedActivationDate = "FirstRequestedActivationDate"
623
623
  }
624
624
  /**
625
625
  * Properties for Order records
@@ -627,349 +627,340 @@ export declare enum OrderPropertyKeys {
627
627
  * @see OrderModule:Order
628
628
  */
629
629
  export interface OrderProperties {
630
- /** status of the order (must be activated for billing) (Sales - Order)
630
+ /** Pending Amco Collection Work Order
631
631
  *
632
- * @type {ENUM}
633
- * @default DRAFT
634
- * @enum {OrderActivationStatus}
632
+ * @type {BOOLEAN}
633
+ */
634
+ PendingAmcoCollection: boolean;
635
+ /** ExternalReference
636
+ *
637
+ * @type {TEXT}
638
+ */
639
+ ExternalReference: string;
640
+ /** unit cost for the product derived from product components UnitCost (Sales - Order)
641
+ *
642
+ * @type {PERCENT}
643
+ * @default 0
635
644
  * @hidden This field is hidden in the UI
636
645
  */
637
- ActivationStatus: OrderActivationStatus;
638
- /** active date (Sales - Order)
646
+ TaxRate: number;
647
+ /** Currency code (Sales - Order)
648
+ *
649
+ * @type {ENUM}
650
+ * @default GBP
651
+ * @enum {OrderCurrencyCode}
652
+ */
653
+ CurrencyCode: OrderCurrencyCode;
654
+ /** the delivery date requested by the customer (Sales - Order)
639
655
  *
640
656
  * @type {DATE}
641
657
  * @format DD/MM/YYYY
642
658
  * @hidden This field is hidden in the UI
643
659
  */
644
- ActiveDate: string;
645
- /** true if the customer has an active mandate (Sales - Order)
660
+ RequestedDeliveryDate: string;
661
+ /** Display name/title for Order records. Primary identifier for Sales team.
646
662
  *
647
- * @type {BOOLEAN}
663
+ * @type {TEXT}
664
+ * @placeholder name
648
665
  * @hidden This field is hidden in the UI
649
666
  */
650
- ActiveMandate: boolean;
651
- /** Reference identifier for Order relationships. Used for data integrity.
667
+ Name: string;
668
+ /** the type of the contract (Sales - Order)
652
669
  *
653
- * @type {LOOKUP}
670
+ * @type {ENUM}
671
+ * @enum {OrderContractType}
672
+ * @hidden This field is hidden in the UI
654
673
  */
655
- AddressId: string;
674
+ ContractType: OrderContractType;
675
+ /** unique multiple point reference number (Sales - Order)
676
+ *
677
+ * @type {NUMBER}
678
+ * @default 0
679
+ */
680
+ Umprn: number;
656
681
  /** Affiliate code used when order was placed
657
682
  *
658
683
  * @type {TEXT}
659
684
  */
660
685
  AffiliateCode: string;
661
- /** Aklamio cashback was rejected (Sales - Order)
686
+ /** Pending Amco Replacement WorkOrder
662
687
  *
663
- * @type {DATE}
688
+ * @type {BOOLEAN}
664
689
  */
665
- AklamioCashbackRejectionDate: string;
666
- /** Aklamio cashback was applied (Sales - Order)
690
+ PendingAmcoReplacement: boolean;
691
+ /** BrskOrderStatus
667
692
  *
668
- * @type {DATE}
693
+ * @type {TEXT}
669
694
  */
670
- AklamioCashbackVerificationDate: string;
695
+ BrskOrderStatus: string;
671
696
  /** This order comes because of an Aklamio Reference (Sales - Order)
672
697
  *
673
698
  * @type {BOOLEAN}
674
699
  * @default False
675
700
  */
676
701
  AklamioReferenced: boolean;
677
- /** The date the order was rejected in aklamio (Sales - Order)
678
- *
679
- * @type {DATE}
680
- */
681
- AklamioRejectionDate: string;
682
- /** Aklamio Verification Date (Sales - Order)
702
+ /** total taxes (Sales - Order)
683
703
  *
684
- * @type {DATE}
704
+ * @type {CURRENCY}
705
+ * @default 0
685
706
  * @hidden This field is hidden in the UI
686
707
  */
687
- AklamioVerificationDate: string;
688
- /** alerts that need to be visible on the order (Sales - Order)
708
+ TotalTaxAmount: string;
709
+ /** Data field for Order records. Used by Sales team.
689
710
  *
690
- * @type {TEXT_LONG}
711
+ * @type {TEXT}
712
+ * @default 0
691
713
  * @hidden This field is hidden in the UI
692
714
  */
693
- AlertMessage: string;
694
- /** the date of the alert message (Sales - Order)
715
+ VatNumber: string;
716
+ /** Billing start date (Sales - Order)
695
717
  *
696
718
  * @type {DATE}
697
719
  * @format DD/MM/YYYY
698
720
  * @hidden This field is hidden in the UI
699
721
  */
700
- AlertMessageDate: string;
701
- /** AltContactMethod
722
+ BillingStartDate: string;
723
+ /** trial unit is the unit of measure for free periods (Sales - Order)
702
724
  *
703
725
  * @type {ENUM}
704
- * @enum {OrderAltContactMethod}
705
- */
706
- AltContactMethod: OrderAltContactMethod;
707
- /** the datetime when the amendment was performed (Sales - Order)
708
- *
709
- * @type {DATE}
710
- * @format DD/MM/YYYY
711
- * @hidden This field is hidden in the UI
712
- */
713
- AmendmentDate: string;
714
- /** the average monthly contract value (Sales - Order)
715
- *
716
- * @type {CURRENCY}
717
- * @default 0
726
+ * @default
727
+ * @enum {OrderTrialUnit}
718
728
  * @hidden This field is hidden in the UI
719
729
  */
720
- AverageMonthlyValue: string;
721
- /** 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).
730
+ TrialUnit: OrderTrialUnit;
731
+ /** discount duration unit (Sales - Order)
722
732
  *
723
733
  * @type {ENUM}
724
734
  * @default
725
- * @enum {OrderBatteryBackupAnswersSource}
726
- */
727
- BatteryBackupAnswersSource: OrderBatteryBackupAnswersSource;
728
- /** Whether a customer already has a battery pack from YouFibre or not
729
- *
730
- * @type {BOOLEAN}
731
- * @default
735
+ * @enum {OrderDiscountUnit}
732
736
  * @hidden This field is hidden in the UI
733
737
  */
734
- BatteryPackProvided: boolean;
735
- /** BatteryPackRequired
736
- *
737
- * @type {ENUM}
738
- * @enum {OrderBatteryPackRequired}
739
- */
740
- BatteryPackRequired: OrderBatteryPackRequired;
741
- /** Billing day in the month (Sales - Order)
738
+ DiscountUnit: OrderDiscountUnit;
739
+ /** trial length is the number of X free periods (Sales - Order)
742
740
  *
743
741
  * @type {NUMBER}
742
+ * @hidden This field is hidden in the UI
744
743
  */
745
- BillingDay: number;
746
- /** Billing start date (Sales - Order)
744
+ TrialLength: number;
745
+ /** the datetime when the amendment was performed (Sales - Order)
747
746
  *
748
747
  * @type {DATE}
749
748
  * @format DD/MM/YYYY
750
749
  * @hidden This field is hidden in the UI
751
750
  */
752
- BillingStartDate: string;
753
- /** Billing terms i.e NET 15,30 (Sales - Order)
751
+ AmendmentDate: string;
752
+ /** Monthly contract value (Sales - Order)
754
753
  *
755
- * @type {ENUM}
756
- * @default NET_0
757
- * @enum {OrderBillingTerms}
754
+ * @type {TEXT}
755
+ * @hidden This field is hidden in the UI
758
756
  */
759
- BillingTerms: OrderBillingTerms;
760
- /** BrskOrderStatus
757
+ ContractValueMonthly: string;
758
+ /** WithholdCommissionNotes
761
759
  *
762
- * @type {TEXT}
760
+ * @type {TEXT_LONG}
763
761
  */
764
- BrskOrderStatus: string;
765
- /** 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)
762
+ WithholdCommissionNotes: string;
763
+ /** WithholdCommissionReason
766
764
  *
767
- * @type {DATE}
768
- * @format DD/MM/YYYY
769
- * @hidden This field is hidden in the UI
765
+ * @type {ENUM}
766
+ * @enum {OrderWithholdCommissionReason}
770
767
  */
771
- CancellationEffectiveDate: string;
772
- /** Cancelation reason (Sales - Order)
768
+ WithholdCommissionReason: OrderWithholdCommissionReason;
769
+ /** total discounts (Sales - Order)
773
770
  *
774
- * @type {TEXT}
771
+ * @type {CURRENCY}
772
+ * @default 0
775
773
  * @hidden This field is hidden in the UI
776
774
  */
777
- CancellationReason: string;
778
- /** cancellation reason notes (Sales - Order)
775
+ TotalDiscounts: string;
776
+ /** ExternalRefBrskISP
779
777
  *
780
778
  * @type {TEXT}
781
- * @hidden This field is hidden in the UI
782
779
  */
783
- CancellationReasonNote: string;
784
- /** the date the order was cancelled (Sales - Order)
780
+ ExternalRefBrskIsp: string;
781
+ /** Pending Amco Dispatch Work Order
785
782
  *
786
- * @type {DATE}
787
- * @format DD/MM/YYYY
788
- * @hidden This field is hidden in the UI
783
+ * @type {BOOLEAN}
789
784
  */
790
- CancelledDate: string;
791
- /** The date the order should be moved to cancelled (Sales - Order)
785
+ PendingAmcoDispatch: boolean;
786
+ /** ExternalRefBrskFF
792
787
  *
793
- * @type {DATE}
794
- * @tracked Changes to this field are tracked in audit history
788
+ * @type {TEXT}
795
789
  */
796
- CancelOnDate: string;
797
- /** When the Cashback was approved (Sales - Order)
790
+ ExternalRefBrskFf: string;
791
+ /** ExternalRefBrskFNO
798
792
  *
799
- * @type {DATE}
793
+ * @type {TEXT}
800
794
  */
801
- CashbackApprovalDate: string;
802
- /** 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.
795
+ ExternalRefBrskFno: string;
796
+ /** the date the order is delivered (Sales - Order)
803
797
  *
804
798
  * @type {DATE}
805
- */
806
- CommittedDate: string;
807
- /** the contract buy out amount requested by the customer (Sales - Order)
808
- *
809
- * @type {BOOLEAN}
799
+ * @format DD/MM/YYYY
810
800
  * @hidden This field is hidden in the UI
811
801
  */
812
- ContractBuyOutRequested: boolean;
813
- /** 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)
814
- *
815
- * @type {BOOLEAN}
816
- */
817
- ContractConsent: boolean;
818
- /** the date the contract will end (Sales - Order)
802
+ DeliveryDate: string;
803
+ /** subtotal of the prices no taxes (Sales - Order)
819
804
  *
820
- * @type {DATE}
821
- * @format DD/MM/YYYY
805
+ * @type {CURRENCY}
806
+ * @default 0
822
807
  * @hidden This field is hidden in the UI
823
808
  */
824
- ContractEndDate: string;
825
- /** the number of times the contract has renewed (Sales - Order)
809
+ Subtotal: string;
810
+ /** phone number to transfer (Sales - Order)
826
811
  *
827
- * @type {NUMBER}
812
+ * @type {PHONE_NUMBER}
813
+ * @default
814
+ * @pii This field contains personally identifiable information
828
815
  * @hidden This field is hidden in the UI
829
816
  */
830
- ContractRenewalCount: number;
831
- /** the additional number of times the contract has renewed (Sales - Order)
817
+ TransferPhone: string;
818
+ /** the date the order is issued (Sales - Order)
832
819
  *
833
- * @type {NUMBER}
820
+ * @type {DATE}
821
+ * @format DD/MM/YYYY
834
822
  * @hidden This field is hidden in the UI
835
823
  */
836
- ContractRenewalCountOverride: number;
837
- /** the date the contract start (Sales - Order)
824
+ IssuedDate: string;
825
+ /** active date (Sales - Order)
838
826
  *
839
827
  * @type {DATE}
840
828
  * @format DD/MM/YYYY
841
829
  * @hidden This field is hidden in the UI
842
830
  */
843
- ContractStartDate: string;
844
- /** the type of the contract (Sales - Order)
831
+ ActiveDate: string;
832
+ /** the type of discount (Sales - Order)
845
833
  *
846
834
  * @type {ENUM}
847
- * @enum {OrderContractType}
835
+ * @default
836
+ * @enum {OrderDiscountType}
848
837
  * @hidden This field is hidden in the UI
849
838
  */
850
- ContractType: OrderContractType;
851
- /** Monthly contract value (Sales - Order)
839
+ DiscountType: OrderDiscountType;
840
+ /** Reference identifier for Order relationships. Used for data integrity.
852
841
  *
853
- * @type {TEXT}
854
- * @hidden This field is hidden in the UI
842
+ * @type {LOOKUP}
855
843
  */
856
- ContractValueMonthly: string;
844
+ AddressId: string;
857
845
  /** Total contract value (Sales - Order)
858
846
  *
859
847
  * @type {TEXT}
860
848
  * @hidden This field is hidden in the UI
861
849
  */
862
850
  ContractValueTotal: string;
863
- /** Currency code (Sales - Order)
851
+ /** Reason for deactivating the order (Sales - Order)
864
852
  *
865
853
  * @type {ENUM}
866
- * @default GBP
867
- * @enum {OrderCurrencyCode}
868
- */
869
- CurrencyCode: OrderCurrencyCode;
870
- /** Reference identifier for Order relationships. Used for data integrity.
871
- *
872
- * @type {UUID}
854
+ * @enum {OrderDeactivationReason}
873
855
  * @hidden This field is hidden in the UI
874
856
  */
875
- DataSetId: string;
876
- /** The reason for collection attempts stopping (Sales - Order)
857
+ DeactivationReason: OrderDeactivationReason;
858
+ /** cancellation reason notes (Sales - Order)
877
859
  *
878
860
  * @type {TEXT}
879
861
  * @hidden This field is hidden in the UI
880
862
  */
881
- DcaClosureReason: string;
882
- /** The total value sent to collect (Sales - Order)
863
+ CancellationReasonNote: string;
864
+ /** Cancelation reason (Sales - Order)
883
865
  *
884
- * @type {CURRENCY}
866
+ * @type {TEXT}
885
867
  * @hidden This field is hidden in the UI
886
868
  */
887
- DcaCollectionValue: string;
888
- /** The date the DCA loaded the order (Sales - Order)
869
+ CancellationReason: string;
870
+ /** To be handled manually by an operator. Default state = false (Sales - Order)
889
871
  *
890
- * @type {DATE}
891
- * @format DD/MM/YYYY
872
+ * @type {BOOLEAN}
873
+ * @default false
892
874
  * @hidden This field is hidden in the UI
893
875
  */
894
- DcaLoadedDate: string;
895
- /** The collection value paid to date (Sales - Order)
876
+ IsVerified: boolean;
877
+ /** true if the customer has an active mandate (Sales - Order)
896
878
  *
897
- * @type {CURRENCY}
879
+ * @type {BOOLEAN}
898
880
  * @hidden This field is hidden in the UI
899
881
  */
900
- DcaPaidToDate: string;
901
- /** The debt collection agency status (Sales - Order)
882
+ ActiveMandate: boolean;
883
+ /** the highest status of the invoices in dunning (Sales - Order)
902
884
  *
903
885
  * @type {TEXT}
904
886
  * @hidden This field is hidden in the UI
905
887
  */
906
- DcaStatus: string;
907
- /** The date the order should be moved to deactivated (Sales - Order)
908
- *
909
- * @type {DATE}
910
- * @tracked Changes to this field are tracked in audit history
911
- */
912
- DeactivateOnDate: string;
913
- /** 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.
888
+ DunningStatus: string;
889
+ /** alerts that need to be visible on the order (Sales - Order)
914
890
  *
915
- * @type {DATE}
916
- * @default
891
+ * @type {TEXT_LONG}
892
+ * @hidden This field is hidden in the UI
917
893
  */
918
- DeactivationDate: string;
919
- /** Description of order deactivation (Sales - Order)
894
+ AlertMessage: string;
895
+ /** Data field for Order records. Used by Sales team.
920
896
  *
921
897
  * @type {TEXT}
922
898
  * @hidden This field is hidden in the UI
923
899
  */
924
- DeactivationDescription: string;
925
- /** Reason for deactivating the order (Sales - Order)
900
+ Source: string;
901
+ /** Landing Page (Sales - Order)
926
902
  *
927
- * @type {ENUM}
928
- * @enum {OrderDeactivationReason}
903
+ * @type {TEXT}
929
904
  * @hidden This field is hidden in the UI
930
905
  */
931
- DeactivationReason: OrderDeactivationReason;
932
- /** the date the order is delivered (Sales - Order)
906
+ LandingPage: string;
907
+ /** the date the mandate reminder was sent (Sales - Order)
933
908
  *
934
909
  * @type {DATE}
935
910
  * @format DD/MM/YYYY
936
911
  * @hidden This field is hidden in the UI
937
912
  */
938
- DeliveryDate: string;
939
- /** Desired Billing Day (Sales - Order)
913
+ MandateReminderSmsSentAt: string;
914
+ /** unique delivery point reference number (Sales - Order)
940
915
  *
941
916
  * @type {NUMBER}
917
+ * @default 0
942
918
  */
943
- DesiredBillingDay: number;
919
+ Udprn: number;
920
+ /** the value to discount (Sales - Order)
921
+ *
922
+ * @type {CURRENCY}
923
+ * @default 0
924
+ * @hidden This field is hidden in the UI
925
+ */
926
+ DiscountValue: string;
927
+ /** the number of times the contract has renewed (Sales - Order)
928
+ *
929
+ * @type {NUMBER}
930
+ * @hidden This field is hidden in the UI
931
+ */
932
+ ContractRenewalCount: number;
933
+ /** total price including taxes and discounts (Sales - Order)
934
+ *
935
+ * @type {CURRENCY}
936
+ * @default 0
937
+ * @hidden This field is hidden in the UI
938
+ */
939
+ TotalPrice: string;
944
940
  /** length for the items discount duration (Sales - Order)
945
941
  *
946
942
  * @type {NUMBER}
947
943
  * @hidden This field is hidden in the UI
948
944
  */
949
945
  DiscountLength: number;
950
- /** the type of discount (Sales - Order)
946
+ /** the additional number of times the contract has renewed (Sales - Order)
951
947
  *
952
- * @type {ENUM}
953
- * @default
954
- * @enum {OrderDiscountType}
948
+ * @type {NUMBER}
955
949
  * @hidden This field is hidden in the UI
956
950
  */
957
- DiscountType: OrderDiscountType;
958
- /** discount duration unit (Sales - Order)
951
+ ContractRenewalCountOverride: number;
952
+ /** Description of order deactivation (Sales - Order)
959
953
  *
960
- * @type {ENUM}
961
- * @default
962
- * @enum {OrderDiscountUnit}
954
+ * @type {TEXT}
963
955
  * @hidden This field is hidden in the UI
964
956
  */
965
- DiscountUnit: OrderDiscountUnit;
966
- /** the value to discount (Sales - Order)
957
+ DeactivationDescription: string;
958
+ /** the number of invoices in dunning (Sales - Order)
967
959
  *
968
- * @type {CURRENCY}
969
- * @default 0
960
+ * @type {NUMBER}
970
961
  * @hidden This field is hidden in the UI
971
962
  */
972
- DiscountValue: string;
963
+ InvoicesDunning: number;
973
964
  /** the date the dunning period started (Sales - Order)
974
965
  *
975
966
  * @type {DATE}
@@ -977,343 +968,352 @@ export interface OrderProperties {
977
968
  * @hidden This field is hidden in the UI
978
969
  */
979
970
  DunningStartDate: string;
980
- /** the highest status of the invoices in dunning (Sales - Order)
971
+ /** the average monthly contract value (Sales - Order)
981
972
  *
982
- * @type {TEXT}
973
+ * @type {CURRENCY}
974
+ * @default 0
983
975
  * @hidden This field is hidden in the UI
984
976
  */
985
- DunningStatus: string;
986
- /** when the dunning status was last updated (Sales - Order)
977
+ AverageMonthlyValue: string;
978
+ /** the date of the alert message (Sales - Order)
987
979
  *
988
980
  * @type {DATE}
989
981
  * @format DD/MM/YYYY
990
982
  * @hidden This field is hidden in the UI
991
983
  */
992
- DunningStatusUpdatedAt: string;
993
- /** 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.
984
+ AlertMessageDate: string;
985
+ /** the date the contract start (Sales - Order)
994
986
  *
995
- * @type {DATE_TIME}
996
- * @default
987
+ * @type {DATE}
988
+ * @format DD/MM/YYYY
989
+ * @hidden This field is hidden in the UI
997
990
  */
998
- EarliestDueAt: string;
999
- /** 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).
991
+ ContractStartDate: string;
992
+ /** the date the order was cancelled (Sales - Order)
1000
993
  *
1001
- * @type {NUMBER}
1002
- * @default
994
+ * @type {DATE}
995
+ * @format DD/MM/YYYY
996
+ * @hidden This field is hidden in the UI
1003
997
  */
1004
- EarlyTerminationFee: number;
1005
- /** ExternalRefBrskFF
998
+ CancelledDate: string;
999
+ /** the date the mandate reminder email was sent (Sales - Order)
1006
1000
  *
1007
- * @type {TEXT}
1001
+ * @type {DATE}
1002
+ * @format DD/MM/YYYY
1003
+ * @hidden This field is hidden in the UI
1008
1004
  */
1009
- ExternalRefBrskFf: string;
1010
- /** ExternalRefBrskFNO
1005
+ MandateReminderEmailSentAt: string;
1006
+ /** the date the contract will end (Sales - Order)
1011
1007
  *
1012
- * @type {TEXT}
1008
+ * @type {DATE}
1009
+ * @format DD/MM/YYYY
1010
+ * @hidden This field is hidden in the UI
1013
1011
  */
1014
- ExternalRefBrskFno: string;
1015
- /** ExternalRefBrskISP
1012
+ ContractEndDate: string;
1013
+ /** the previous order prior to an amendment or recontract (Sales - Order)
1016
1014
  *
1017
- * @type {TEXT}
1015
+ * @type {LOOKUP}
1016
+ * @hidden This field is hidden in the UI
1018
1017
  */
1019
- ExternalRefBrskIsp: string;
1020
- /** ExternalReference
1018
+ PreviousOrderId: string;
1019
+ /** 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)
1021
1020
  *
1022
- * @type {TEXT}
1021
+ * @type {DATE}
1022
+ * @format DD/MM/YYYY
1023
+ * @hidden This field is hidden in the UI
1023
1024
  */
1024
- ExternalReference: string;
1025
- /** One Touch Switch reference number
1025
+ CancellationEffectiveDate: string;
1026
+ /** the date the mandate status was updated (Sales - Order)
1026
1027
  *
1027
- * @type {TEXT}
1028
+ * @type {DATE}
1029
+ * @format DD/MM/YYYY
1030
+ * @hidden This field is hidden in the UI
1028
1031
  */
1029
- ExternalReferenceOts: string;
1030
- /** The activation date asked for when the order was placed. Written once at checkout and never changed; RequestedActivationDate moves when the date does.
1032
+ MandateStatusUpdatedAt: string;
1033
+ /** the contract buy out amount requested by the customer (Sales - Order)
1031
1034
  *
1032
- * @type {DATE}
1033
- * @default
1035
+ * @type {BOOLEAN}
1036
+ * @hidden This field is hidden in the UI
1034
1037
  */
1035
- FirstRequestedActivationDate: string;
1036
- /** Derived from the commitment set: OPEN while any commitment is Pending or Breached, SETTLED when none is. Written only by the commitment lifecycle.
1038
+ ContractBuyOutRequested: boolean;
1039
+ /** The total value sent to collect (Sales - Order)
1037
1040
  *
1038
- * @type {ENUM}
1039
- * @default
1040
- * @enum {OrderFulfillmentState}
1041
+ * @type {CURRENCY}
1042
+ * @hidden This field is hidden in the UI
1041
1043
  */
1042
- FulfillmentState: OrderFulfillmentState;
1043
- /** the number of invoices in dunning (Sales - Order)
1044
+ DcaCollectionValue: string;
1045
+ /** The collection value paid to date (Sales - Order)
1044
1046
  *
1045
- * @type {NUMBER}
1047
+ * @type {CURRENCY}
1046
1048
  * @hidden This field is hidden in the UI
1047
1049
  */
1048
- InvoicesDunning: number;
1049
- /** the date the order is issued (Sales - Order)
1050
+ DcaPaidToDate: string;
1051
+ /** The reason for collection attempts stopping (Sales - Order)
1052
+ *
1053
+ * @type {TEXT}
1054
+ * @hidden This field is hidden in the UI
1055
+ */
1056
+ DcaClosureReason: string;
1057
+ /** The date the DCA loaded the order (Sales - Order)
1050
1058
  *
1051
1059
  * @type {DATE}
1052
1060
  * @format DD/MM/YYYY
1053
1061
  * @hidden This field is hidden in the UI
1054
1062
  */
1055
- IssuedDate: string;
1056
- /** To be handled manually by an operator. Default state = false (Sales - Order)
1063
+ DcaLoadedDate: string;
1064
+ /** Data field for Order records. Used by Sales team.
1057
1065
  *
1058
- * @type {BOOLEAN}
1059
- * @default false
1066
+ * @type {TEXT}
1060
1067
  * @hidden This field is hidden in the UI
1061
1068
  */
1062
- IsVerified: boolean;
1063
- /** Landing Page (Sales - Order)
1069
+ Longitude: string;
1070
+ /** Reference identifier for Order relationships. Used for data integrity.
1064
1071
  *
1065
- * @type {TEXT}
1072
+ * @type {UUID}
1066
1073
  * @hidden This field is hidden in the UI
1067
1074
  */
1068
- LandingPage: string;
1075
+ DataSetId: string;
1069
1076
  /** Data field for Order records. Used by Sales team.
1070
1077
  *
1071
1078
  * @type {TEXT}
1072
1079
  * @hidden This field is hidden in the UI
1073
1080
  */
1074
1081
  Latitude: string;
1075
- /** LegacyBrskOtsData
1082
+ /** Desired Billing Day (Sales - Order)
1076
1083
  *
1077
- * @type {JSON}
1084
+ * @type {NUMBER}
1078
1085
  */
1079
- LegacyBrskOtsData: string;
1080
- /** Data field for Order records. Used by Sales team.
1086
+ DesiredBillingDay: number;
1087
+ /** The date the order should be moved to deactivated (Sales - Order)
1081
1088
  *
1082
- * @type {TEXT}
1083
- * @hidden This field is hidden in the UI
1089
+ * @type {DATE}
1090
+ * @tracked Changes to this field are tracked in audit history
1084
1091
  */
1085
- Longitude: string;
1086
- /** the date the mandate reminder email was sent (Sales - Order)
1092
+ DeactivateOnDate: string;
1093
+ /** The date the order should be moved to cancelled (Sales - Order)
1087
1094
  *
1088
1095
  * @type {DATE}
1089
- * @format DD/MM/YYYY
1090
- * @hidden This field is hidden in the UI
1096
+ * @tracked Changes to this field are tracked in audit history
1097
+ */
1098
+ CancelOnDate: string;
1099
+ /** Billing terms i.e NET 15,30 (Sales - Order)
1100
+ *
1101
+ * @type {ENUM}
1102
+ * @default NET_0
1103
+ * @enum {OrderBillingTerms}
1104
+ */
1105
+ BillingTerms: OrderBillingTerms;
1106
+ /** Data field for Order records. Used by Sales team.
1107
+ *
1108
+ * @type {NUMBER}
1109
+ */
1110
+ Uprn: number;
1111
+ /** referral email (Sales - Order)
1112
+ *
1113
+ * @type {TEXT}
1114
+ * @pii This field contains personally identifiable information
1091
1115
  */
1092
- MandateReminderEmailSentAt: string;
1093
- /** the date the mandate reminder was sent (Sales - Order)
1116
+ ReferralEmail: string;
1117
+ /** network provider (Sales - Order)
1094
1118
  *
1095
- * @type {DATE}
1096
- * @format DD/MM/YYYY
1097
- * @hidden This field is hidden in the UI
1119
+ * @type {ENUM}
1120
+ * @default PYOMNI
1121
+ * @enum {OrderProvider}
1098
1122
  */
1099
- MandateReminderSmsSentAt: string;
1100
- /** the date the mandate status was updated (Sales - Order)
1123
+ Provider: OrderProvider;
1124
+ /** when the dunning status was last updated (Sales - Order)
1101
1125
  *
1102
1126
  * @type {DATE}
1103
1127
  * @format DD/MM/YYYY
1104
1128
  * @hidden This field is hidden in the UI
1105
1129
  */
1106
- MandateStatusUpdatedAt: string;
1107
- /** MobileCoverage
1130
+ DunningStatusUpdatedAt: string;
1131
+ /** The debt collection agency status (Sales - Order)
1108
1132
  *
1109
- * @type {ENUM}
1110
- * @enum {OrderMobileCoverage}
1133
+ * @type {TEXT}
1134
+ * @hidden This field is hidden in the UI
1111
1135
  */
1112
- MobileCoverage: OrderMobileCoverage;
1113
- /** Display name/title for Order records. Primary identifier for Sales team.
1136
+ DcaStatus: string;
1137
+ /** the price match requested by the customer (Sales - Order)
1114
1138
  *
1115
- * @type {TEXT}
1116
- * @placeholder name
1139
+ * @type {BOOLEAN}
1117
1140
  * @hidden This field is hidden in the UI
1118
1141
  */
1119
- Name: string;
1120
- /** How many commitments are Pending or Breached. Written only by the lifecycle.
1142
+ PriceMatchRequested: boolean;
1143
+ /** Billing day in the month (Sales - Order)
1121
1144
  *
1122
1145
  * @type {NUMBER}
1123
- * @default
1124
1146
  */
1125
- OpenCommitmentCount: number;
1126
- /** OtsNotRequiredReason
1147
+ BillingDay: number;
1148
+ /** ReferralApprovalDate (Sales - Order)
1127
1149
  *
1128
- * @type {ENUM}
1129
- * @enum {OrderOtsNotRequiredReason}
1150
+ * @type {DATE}
1151
+ * @hidden This field is hidden in the UI
1130
1152
  */
1131
- OtsNotRequiredReason: OrderOtsNotRequiredReason;
1132
- /** Pending Amco Collection Work Order
1153
+ ReferralApprovalDate: string;
1154
+ /** The date the order was rejected in aklamio (Sales - Order)
1133
1155
  *
1134
- * @type {BOOLEAN}
1156
+ * @type {DATE}
1135
1157
  */
1136
- PendingAmcoCollection: boolean;
1137
- /** Pending Amco Dispatch Work Order
1158
+ AklamioRejectionDate: string;
1159
+ /** the subscriber id is used as the identifier when provisioning on the network (Sales - Order)
1138
1160
  *
1139
- * @type {BOOLEAN}
1161
+ * @type {TEXT}
1140
1162
  */
1141
- PendingAmcoDispatch: boolean;
1142
- /** Pending Amco Replacement WorkOrder
1163
+ SubscriberId: string;
1164
+ /** check this box if you want to flag a commission hold on this order (Sales - Order)
1143
1165
  *
1144
1166
  * @type {BOOLEAN}
1145
- */
1146
- PendingAmcoReplacement: boolean;
1147
- /** the previous order prior to an amendment or recontract (Sales - Order)
1148
- *
1149
- * @type {LOOKUP}
1167
+ * @default false
1150
1168
  * @hidden This field is hidden in the UI
1151
1169
  */
1152
- PreviousOrderId: string;
1153
- /** the price match requested by the customer (Sales - Order)
1170
+ WithholdCommission: boolean;
1171
+ /** Aklamio cashback was rejected (Sales - Order)
1154
1172
  *
1155
- * @type {BOOLEAN}
1156
- * @hidden This field is hidden in the UI
1173
+ * @type {DATE}
1157
1174
  */
1158
- PriceMatchRequested: boolean;
1159
- /** network provider (Sales - Order)
1175
+ AklamioCashbackRejectionDate: string;
1176
+ /** Aklamio cashback was applied (Sales - Order)
1160
1177
  *
1161
- * @type {ENUM}
1162
- * @default PYOMNI
1163
- * @enum {OrderProvider}
1178
+ * @type {DATE}
1164
1179
  */
1165
- Provider: OrderProvider;
1166
- /** Date the order was recontracted (in place). Discriminator + event date.
1180
+ AklamioCashbackVerificationDate: string;
1181
+ /** When the Cashback was approved (Sales - Order)
1167
1182
  *
1168
1183
  * @type {DATE}
1169
1184
  */
1170
- RecontractDate: string;
1171
- /** ReferralApprovalDate (Sales - Order)
1185
+ CashbackApprovalDate: string;
1186
+ /** 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.
1172
1187
  *
1173
1188
  * @type {DATE}
1189
+ */
1190
+ CommittedDate: string;
1191
+ /** Whether a customer already has a battery pack from YouFibre or not
1192
+ *
1193
+ * @type {BOOLEAN}
1194
+ * @default
1174
1195
  * @hidden This field is hidden in the UI
1175
1196
  */
1176
- ReferralApprovalDate: string;
1177
- /** referral email (Sales - Order)
1197
+ BatteryPackProvided: boolean;
1198
+ /** 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)
1178
1199
  *
1179
- * @type {TEXT}
1180
- * @pii This field contains personally identifiable information
1200
+ * @type {BOOLEAN}
1181
1201
  */
1182
- ReferralEmail: string;
1183
- /** 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.
1202
+ ContractConsent: boolean;
1203
+ /** 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).
1184
1204
  *
1185
- * @type {DATE}
1205
+ * @type {NUMBER}
1206
+ * @default
1186
1207
  */
1187
- RequestedActivationDate: string;
1188
- /** the delivery date requested by the customer (Sales - Order)
1208
+ EarlyTerminationFee: number;
1209
+ /** AltContactMethod
1189
1210
  *
1190
- * @type {DATE}
1191
- * @format DD/MM/YYYY
1192
- * @hidden This field is hidden in the UI
1211
+ * @type {ENUM}
1212
+ * @enum {OrderAltContactMethod}
1193
1213
  */
1194
- RequestedDeliveryDate: string;
1195
- /** 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).
1214
+ AltContactMethod: OrderAltContactMethod;
1215
+ /** MobileCoverage
1196
1216
  *
1197
- * @type {BOOLEAN}
1198
- * @default
1217
+ * @type {ENUM}
1218
+ * @enum {OrderMobileCoverage}
1199
1219
  */
1200
- RouterUpgradeDeclined: boolean;
1201
- /** Data field for Order records. Used by Sales team.
1220
+ MobileCoverage: OrderMobileCoverage;
1221
+ /** BatteryPackRequired
1202
1222
  *
1203
- * @type {TEXT}
1204
- * @hidden This field is hidden in the UI
1223
+ * @type {ENUM}
1224
+ * @enum {OrderBatteryPackRequired}
1205
1225
  */
1206
- Source: string;
1207
- /** the subscriber id is used as the identifier when provisioning on the network (Sales - Order)
1226
+ BatteryPackRequired: OrderBatteryPackRequired;
1227
+ /** LegacyBrskOtsData
1208
1228
  *
1209
- * @type {TEXT}
1229
+ * @type {JSON}
1210
1230
  */
1211
- SubscriberId: string;
1212
- /** subtotal of the prices no taxes (Sales - Order)
1231
+ LegacyBrskOtsData: string;
1232
+ /** OtsNotRequiredReason
1213
1233
  *
1214
- * @type {CURRENCY}
1215
- * @default 0
1234
+ * @type {ENUM}
1235
+ * @enum {OrderOtsNotRequiredReason}
1236
+ */
1237
+ OtsNotRequiredReason: OrderOtsNotRequiredReason;
1238
+ /** Aklamio Verification Date (Sales - Order)
1239
+ *
1240
+ * @type {DATE}
1216
1241
  * @hidden This field is hidden in the UI
1217
1242
  */
1218
- Subtotal: string;
1243
+ AklamioVerificationDate: string;
1219
1244
  /** The type of supplier order required to fulfil this YF order.
1220
1245
  *
1221
1246
  * @type {ENUM}
1222
1247
  * @enum {OrderSupplierOrderType}
1223
1248
  */
1224
1249
  SupplierOrderType: OrderSupplierOrderType;
1225
- /** unit cost for the product derived from product components UnitCost (Sales - Order)
1250
+ /** One Touch Switch reference number
1226
1251
  *
1227
- * @type {PERCENT}
1228
- * @default 0
1229
- * @hidden This field is hidden in the UI
1252
+ * @type {TEXT}
1230
1253
  */
1231
- TaxRate: number;
1232
- /** total discounts (Sales - Order)
1254
+ ExternalReferenceOts: string;
1255
+ /** Date the order was recontracted (in place). Discriminator + event date.
1233
1256
  *
1234
- * @type {CURRENCY}
1235
- * @default 0
1236
- * @hidden This field is hidden in the UI
1257
+ * @type {DATE}
1237
1258
  */
1238
- TotalDiscounts: string;
1239
- /** total price including taxes and discounts (Sales - Order)
1259
+ RecontractDate: string;
1260
+ /** status of the order (must be activated for billing) (Sales - Order)
1240
1261
  *
1241
- * @type {CURRENCY}
1242
- * @default 0
1262
+ * @type {ENUM}
1263
+ * @default DRAFT
1264
+ * @enum {OrderActivationStatus}
1243
1265
  * @hidden This field is hidden in the UI
1244
1266
  */
1245
- TotalPrice: string;
1246
- /** total taxes (Sales - Order)
1267
+ ActivationStatus: OrderActivationStatus;
1268
+ /** 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).
1247
1269
  *
1248
- * @type {CURRENCY}
1249
- * @default 0
1250
- * @hidden This field is hidden in the UI
1270
+ * @type {ENUM}
1271
+ * @default
1272
+ * @enum {OrderBatteryBackupAnswersSource}
1251
1273
  */
1252
- TotalTaxAmount: string;
1253
- /** phone number to transfer (Sales - Order)
1274
+ BatteryBackupAnswersSource: OrderBatteryBackupAnswersSource;
1275
+ /** 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.
1254
1276
  *
1255
- * @type {PHONE_NUMBER}
1277
+ * @type {DATE}
1256
1278
  * @default
1257
- * @pii This field contains personally identifiable information
1258
- * @hidden This field is hidden in the UI
1259
1279
  */
1260
- TransferPhone: string;
1261
- /** trial length is the number of X free periods (Sales - Order)
1280
+ DeactivationDate: string;
1281
+ /** 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.
1262
1282
  *
1263
- * @type {NUMBER}
1264
- * @hidden This field is hidden in the UI
1283
+ * @type {DATE}
1265
1284
  */
1266
- TrialLength: number;
1267
- /** trial unit is the unit of measure for free periods (Sales - Order)
1285
+ RequestedActivationDate: string;
1286
+ /** Derived from the commitment set: OPEN while any commitment is Pending or Breached, SETTLED when none is. Written only by the commitment lifecycle.
1268
1287
  *
1269
1288
  * @type {ENUM}
1270
1289
  * @default
1271
- * @enum {OrderTrialUnit}
1272
- * @hidden This field is hidden in the UI
1273
- */
1274
- TrialUnit: OrderTrialUnit;
1275
- /** unique delivery point reference number (Sales - Order)
1276
- *
1277
- * @type {NUMBER}
1278
- * @default 0
1279
- */
1280
- Udprn: number;
1281
- /** unique multiple point reference number (Sales - Order)
1282
- *
1283
- * @type {NUMBER}
1284
- * @default 0
1290
+ * @enum {OrderFulfillmentState}
1285
1291
  */
1286
- Umprn: number;
1287
- /** Data field for Order records. Used by Sales team.
1292
+ FulfillmentState: OrderFulfillmentState;
1293
+ /** How many commitments are Pending or Breached. Written only by the lifecycle.
1288
1294
  *
1289
1295
  * @type {NUMBER}
1296
+ * @default
1290
1297
  */
1291
- Uprn: number;
1292
- /** Data field for Order records. Used by Sales team.
1298
+ OpenCommitmentCount: number;
1299
+ /** 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.
1293
1300
  *
1294
- * @type {TEXT}
1295
- * @default 0
1296
- * @hidden This field is hidden in the UI
1301
+ * @type {DATE_TIME}
1302
+ * @default
1297
1303
  */
1298
- VatNumber: string;
1299
- /** check this box if you want to flag a commission hold on this order (Sales - Order)
1304
+ EarliestDueAt: string;
1305
+ /** 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).
1300
1306
  *
1301
1307
  * @type {BOOLEAN}
1302
- * @default false
1303
- * @hidden This field is hidden in the UI
1304
- */
1305
- WithholdCommission: boolean;
1306
- /** WithholdCommissionNotes
1307
- *
1308
- * @type {TEXT_LONG}
1308
+ * @default
1309
1309
  */
1310
- WithholdCommissionNotes: string;
1311
- /** WithholdCommissionReason
1310
+ RouterUpgradeDeclined: boolean;
1311
+ /** The activation date asked for when the order was placed. Written once at checkout and never changed; RequestedActivationDate moves when the date does.
1312
1312
  *
1313
- * @type {ENUM}
1314
- * @enum {OrderWithholdCommissionReason}
1313
+ * @type {DATE}
1314
+ * @default
1315
1315
  */
1316
- WithholdCommissionReason: OrderWithholdCommissionReason;
1316
+ FirstRequestedActivationDate: string;
1317
1317
  }
1318
1318
  /**
1319
1319
  * Order entity from OrderModule