@d19n/youfibre-odin-sdk 1.0.345 → 1.0.346

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.
@@ -98,28 +98,25 @@ export declare enum DefaultOrderStageKeys {
98
98
  OrderStagePendingCancellation = "OrderStagePendingCancellation"
99
99
  }
100
100
  /**
101
- * Valid values for Order.CurrencyCode
102
- *
103
- * Currency code (Sales - Order)
104
- *
105
- * @remarks Available options:
106
- * - `GBP`
107
- */
108
- export declare enum OrderCurrencyCode {
109
- GBP = "GBP"
110
- }
111
- /**
112
- * Valid values for Order.DiscountType
101
+ * Valid values for Order.ActivationStatus
113
102
  *
114
- * the type of discount (Sales - Order)
103
+ * status of the order (must be activated for billing) (Sales - Order)
115
104
  *
116
105
  * @remarks Available options:
117
- * - `AMOUNT` - Amount
118
- * - `PERCENT` - Percent
106
+ * - `APPROVAL_PENDING` - Approval Pending
107
+ * - `CLOSED` - Closed
108
+ * - `DRAFT` - Draft
109
+ * - `OPEN` - Open
110
+ * - `PARTIAL` - Partial
111
+ * - `PROCESSING` - Processing
119
112
  */
120
- export declare enum OrderDiscountType {
121
- AMOUNT = "AMOUNT",
122
- PERCENT = "PERCENT"
113
+ export declare enum OrderActivationStatus {
114
+ APPROVAL_PENDING = "APPROVAL_PENDING",
115
+ CLOSED = "CLOSED",
116
+ DRAFT = "DRAFT",
117
+ OPEN = "OPEN",
118
+ PARTIAL = "PARTIAL",
119
+ PROCESSING = "PROCESSING"
123
120
  }
124
121
  /**
125
122
  * Valid values for Order.BillingTerms
@@ -147,38 +144,41 @@ export declare enum OrderBillingTerms {
147
144
  NET_90 = "NET_90"
148
145
  }
149
146
  /**
150
- * Valid values for Order.Provider
147
+ * Valid values for Order.ContractType
151
148
  *
152
- * network provider (Sales - Order)
149
+ * the type of the contract (Sales - Order)
153
150
  *
154
151
  * @remarks Available options:
155
- * - `CITYFIBRE` - CityFibre
156
- * - `NETOMNIA` - Netomnia
157
- * - `NETOMNIA_LEGACY` - Netomnia legacy
158
- * - `PYOMNI` - PyOmni
152
+ * - `ANNUAL_12` - 12 months
153
+ * - `ANNUAL_18` - 18 months
154
+ * - `ANNUAL_19` - 19 months
155
+ * - `MONTHLY` - 1 month rolling
156
+ * - `ANNUAL_20` - 20 months
157
+ * - `ANNUAL_21` - 21 months
158
+ * - `ANNUAL_22` - 22 months
159
+ * - `ANNUAL_23` - 23 months
160
+ * - `ANNUAL_24` - 24 months
161
+ * - `ANNUAL_25` - 25 months
162
+ * - `ANNUAL_26` - 26 months
163
+ * - `ANNUAL_27` - 27 months
164
+ * - `ANNUAL_28` - 28 months
165
+ * - `ANNUAL_29` - 29 months
166
+ * - `ANNUAL_30` - 30 months
167
+ * - ... and 14 more
159
168
  */
160
- export declare enum OrderProvider {
161
- CITY_FIBRE = "CITYFIBRE",
162
- NETOMNIA = "NETOMNIA",
163
- NETOMNIA_LEGACY = "NETOMNIA_LEGACY",
164
- PY_OMNI = "PYOMNI"
169
+ export declare enum OrderContractType {
170
+ NO_CONTRACT = "NONE"
165
171
  }
166
172
  /**
167
- * Valid values for Order.WithholdCommissionReason
173
+ * Valid values for Order.CurrencyCode
168
174
  *
169
- * Withhold Commission Reason
175
+ * Currency code (Sales - Order)
170
176
  *
171
177
  * @remarks Available options:
172
- * - `ETF_VALUE` - ETF over £300
173
- * - `NO_WELCOME_PACK` - No welcome pack
174
- * - `OTHER` - Other
175
- * - `PRICE_MATCH_EVIDENCE` - Price Match evidence insufficient or missing
178
+ * - `GBP`
176
179
  */
177
- export declare enum OrderWithholdCommissionReason {
178
- ETF_OVER_300 = "ETF_VALUE",
179
- NO_WELCOME_PACK = "NO_WELCOME_PACK",
180
- OTHER = "OTHER",
181
- PRICE_MATCH_EVIDENCE_INSUFFICIENT_OR_MISSING = "PRICE_MATCH_EVIDENCE"
180
+ export declare enum OrderCurrencyCode {
181
+ GBP = "GBP"
182
182
  }
183
183
  /**
184
184
  * Valid values for Order.DeactivationReason
@@ -192,51 +192,47 @@ export declare enum OrderDeactivationReason {
192
192
  PAYMENT_OVERDUE = "PAYMENT_OVERDUE"
193
193
  }
194
194
  /**
195
- * Valid values for Order.ActivationStatus
195
+ * Valid values for Order.DiscountType
196
196
  *
197
- * status of the order (must be activated for billing) (Sales - Order)
197
+ * the type of discount (Sales - Order)
198
198
  *
199
199
  * @remarks Available options:
200
- * - `APPROVAL_PENDING` - Approval Pending
201
- * - `CLOSED` - Closed
202
- * - `DRAFT` - Draft
203
- * - `OPEN` - Open
204
- * - `PARTIAL` - Partial
205
- * - `PROCESSING` - Processing
200
+ * - `AMOUNT` - Amount
201
+ * - `PERCENT` - Percent
206
202
  */
207
- export declare enum OrderActivationStatus {
208
- APPROVAL_PENDING = "APPROVAL_PENDING",
209
- CLOSED = "CLOSED",
210
- DRAFT = "DRAFT",
211
- OPEN = "OPEN",
212
- PARTIAL = "PARTIAL",
213
- PROCESSING = "PROCESSING"
203
+ export declare enum OrderDiscountType {
204
+ AMOUNT = "AMOUNT",
205
+ PERCENT = "PERCENT"
214
206
  }
215
207
  /**
216
- * Valid values for Order.ContractType
208
+ * Valid values for Order.DiscountUnit
217
209
  *
218
- * the type of the contract (Sales - Order)
210
+ * discount duration unit (Sales - Order)
219
211
  *
220
212
  * @remarks Available options:
221
- * - `ANNUAL_12` - 12 months
222
- * - `ANNUAL_18` - 18 months
223
- * - `ANNUAL_19` - 19 months
224
- * - `MONTHLY` - 1 month rolling
225
- * - `ANNUAL_20` - 20 months
226
- * - `ANNUAL_21` - 21 months
227
- * - `ANNUAL_22` - 22 months
228
- * - `ANNUAL_23` - 23 months
229
- * - `ANNUAL_24` - 24 months
230
- * - `ANNUAL_25` - 25 months
231
- * - `ANNUAL_26` - 26 months
232
- * - `ANNUAL_27` - 27 months
233
- * - `ANNUAL_28` - 28 months
234
- * - `ANNUAL_29` - 29 months
235
- * - `ANNUAL_30` - 30 months
236
- * - ... and 14 more
213
+ * - `DAYS` - Days
214
+ * - `MONTHS` - Months
237
215
  */
238
- export declare enum OrderContractType {
239
- NO_CONTRACT = "NONE"
216
+ export declare enum OrderDiscountUnit {
217
+ DAYS = "DAYS",
218
+ MONTHS = "MONTHS"
219
+ }
220
+ /**
221
+ * Valid values for Order.Provider
222
+ *
223
+ * network provider (Sales - Order)
224
+ *
225
+ * @remarks Available options:
226
+ * - `CITYFIBRE` - CityFibre
227
+ * - `NETOMNIA` - Netomnia
228
+ * - `NETOMNIA_LEGACY` - Netomnia legacy
229
+ * - `PYOMNI` - PyOmni
230
+ */
231
+ export declare enum OrderProvider {
232
+ CITY_FIBRE = "CITYFIBRE",
233
+ NETOMNIA = "NETOMNIA",
234
+ NETOMNIA_LEGACY = "NETOMNIA_LEGACY",
235
+ PY_OMNI = "PYOMNI"
240
236
  }
241
237
  /**
242
238
  * Valid values for Order.TrialUnit
@@ -252,195 +248,199 @@ export declare enum OrderTrialUnit {
252
248
  MONTHS = "MONTHS"
253
249
  }
254
250
  /**
255
- * Valid values for Order.DiscountUnit
251
+ * Valid values for Order.WithholdCommissionReason
256
252
  *
257
- * discount duration unit (Sales - Order)
253
+ * Withhold Commission Reason
258
254
  *
259
255
  * @remarks Available options:
260
- * - `DAYS` - Days
261
- * - `MONTHS` - Months
256
+ * - `ETF_VALUE` - ETF over £300
257
+ * - `NO_WELCOME_PACK` - No welcome pack
258
+ * - `OTHER` - Other
259
+ * - `PRICE_MATCH_EVIDENCE` - Price Match evidence insufficient or missing
262
260
  */
263
- export declare enum OrderDiscountUnit {
264
- DAYS = "DAYS",
265
- MONTHS = "MONTHS"
261
+ export declare enum OrderWithholdCommissionReason {
262
+ ETF_OVER_300 = "ETF_VALUE",
263
+ NO_WELCOME_PACK = "NO_WELCOME_PACK",
264
+ OTHER = "OTHER",
265
+ PRICE_MATCH_EVIDENCE_INSUFFICIENT_OR_MISSING = "PRICE_MATCH_EVIDENCE"
266
266
  }
267
267
  /**
268
268
  * Property keys for Order
269
269
  * Use these constants instead of string literals for type safety
270
270
  */
271
271
  export declare enum OrderPropertyKeys {
272
- /** Data field for Order records. Used by Sales team. */
273
- VatNumber = "VATNumber",
272
+ /** status of the order (must be activated for billing) (Sales - Order) */
273
+ ActivationStatus = "ActivationStatus",
274
+ /** active date (Sales - Order) */
275
+ ActiveDate = "ActiveDate",
276
+ /** true if the customer has an active mandate (Sales - Order) */
277
+ ActiveMandate = "ActiveMandate",
278
+ /** Reference identifier for Order relationships. Used for data integrity. */
279
+ AddressId = "AddressId",
280
+ /** Affiliate code used when order was placed */
281
+ AffiliateCode = "AffiliateCode",
282
+ /** Aklamio cashback was rejected (Sales - Order) */
283
+ AklamioCashbackRejectionDate = "AklamioCashbackRejectionDate",
284
+ /** Aklamio cashback was applied (Sales - Order) */
285
+ AklamioCashbackVerificationDate = "AklamioCashbackVerificationDate",
286
+ /** This order comes because of an Aklamio Reference (Sales - Order) */
287
+ AklamioReferenced = "AklamioReferenced",
288
+ /** The date the order was rejected in aklamio (Sales - Order) */
289
+ AklamioRejectionDate = "AklamioRejectionDate",
290
+ /** Aklamio Verification Date (Sales - Order) */
291
+ AklamioVerificationDate = "AklamioVerificationDate",
292
+ /** alerts that need to be visible on the order (Sales - Order) */
293
+ AlertMessage = "AlertMessage",
294
+ /** the date of the alert message (Sales - Order) */
295
+ AlertMessageDate = "AlertMessageDate",
274
296
  /** the datetime when the amendment was performed (Sales - Order) */
275
297
  AmendmentDate = "AmendmentDate",
298
+ /** the average monthly contract value (Sales - Order) */
299
+ AverageMonthlyValue = "AverageMonthlyValue",
300
+ /** Billing day in the month (Sales - Order) */
301
+ BillingDay = "BillingDay",
302
+ /** Billing start date (Sales - Order) */
303
+ BillingStartDate = "BillingStartDate",
304
+ /** Billing terms i.e NET 15,30 (Sales - Order) */
305
+ BillingTerms = "BillingTerms",
306
+ /** 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) */
307
+ CancellationEffectiveDate = "CancellationEffectiveDate",
308
+ /** Cancellation reason (Sales - Order) */
309
+ CancellationReason = "CancellationReason",
310
+ /** cancellation reason notes (Sales - Order) */
311
+ CancellationReasonNote = "CancellationReasonNote",
312
+ /** the date the order was cancelled (Sales - Order) */
313
+ CancelledDate = "CancelledDate",
314
+ /** The date the order should be moved to cancelled (Sales - Order) */
315
+ CancelOnDate = "CancelOnDate",
316
+ /** When the Cashback was approved (Sales - Order) */
317
+ CashbackApprovalDate = "CashbackApprovalDate",
318
+ /** the contract buy out amount requested by the customer (Sales - Order) */
319
+ ContractBuyOutRequested = "ContractBuyOutRequested",
320
+ /** the date the contract will end (Sales - Order) */
321
+ ContractEndDate = "ContractEndDate",
322
+ /** the number of times the contract has renewed (Sales - Order) */
323
+ ContractRenewalCount = "ContractRenewalCount",
324
+ /** the additional number of times the contract has renewed (Sales - Order) */
325
+ ContractRenewalCountOverride = "ContractRenewalCountOverride",
326
+ /** the date the contract start (Sales - Order) */
327
+ ContractStartDate = "ContractStartDate",
328
+ /** the type of the contract (Sales - Order) */
329
+ ContractType = "ContractType",
330
+ /** Monthly contract value (Sales - Order) */
331
+ ContractValueMonthly = "ContractValueMonthly",
332
+ /** Total contract value (Sales - Order) */
333
+ ContractValueTotal = "ContractValueTotal",
276
334
  /** Currency code (Sales - Order) */
277
335
  CurrencyCode = "CurrencyCode",
336
+ /** Reference identifier for Order relationships. Used for data integrity. */
337
+ DataSetId = "DataSetId",
338
+ /** The reason for collection attempts stopping (Sales - Order) */
339
+ DcaClosureReason = "DCAClosureReason",
340
+ /** The total value sent to collect (Sales - Order) */
341
+ DcaCollectionValue = "DCACollectionValue",
342
+ /** The date the DCA loaded the order (Sales - Order) */
343
+ DcaLoadedDate = "DCALoadedDate",
344
+ /** The collection value paid to date (Sales - Order) */
345
+ DcaPaidToDate = "DCAPaidToDate",
346
+ /** The debt collection agency status (Sales - Order) */
347
+ DcaStatus = "DCAStatus",
348
+ /** The date the order should be moved to deactivated (Sales - Order) */
349
+ DeactivateOnDate = "DeactivateOnDate",
350
+ /** Description of order deactivation (Sales - Order) */
351
+ DeactivationDescription = "DeactivationDescription",
352
+ /** Reason for deactivating the order (Sales - Order) */
353
+ DeactivationReason = "DeactivationReason",
278
354
  /** the date the order is delivered (Sales - Order) */
279
355
  DeliveryDate = "DeliveryDate",
280
- /** phone number to transfer (Sales - Order) */
281
- TransferPhone = "TransferPhone",
282
- /** the type of discount (Sales - Order) */
283
- DiscountType = "DiscountType",
356
+ /** Desired Billing Day (Sales - Order) */
357
+ DesiredBillingDay = "DesiredBillingDay",
284
358
  /** length for the items discount duration (Sales - Order) */
285
359
  DiscountLength = "DiscountLength",
286
- /** Reference identifier for Order relationships. Used for data integrity. */
287
- AddressId = "AddressId",
288
- /** Billing terms i.e NET 15,30 (Sales - Order) */
289
- BillingTerms = "BillingTerms",
290
- /** the date the order is issued (Sales - Order) */
291
- IssuedDate = "IssuedDate",
360
+ /** the type of discount (Sales - Order) */
361
+ DiscountType = "DiscountType",
362
+ /** discount duration unit (Sales - Order) */
363
+ DiscountUnit = "DiscountUnit",
364
+ /** the value to discount (Sales - Order) */
365
+ DiscountValue = "DiscountValue",
292
366
  /** the date the dunning period started (Sales - Order) */
293
367
  DunningStartDate = "DunningStartDate",
294
- /** Landing Page (Sales - Order) */
295
- LandingPage = "LandingPage",
296
- /** Total contract value (Sales - Order) */
297
- ContractValueTotal = "ContractValueTotal",
298
- /** Monthly contract value (Sales - Order) */
299
- ContractValueMonthly = "ContractValueMonthly",
300
- /** the additional number of times the contract has renewed (Sales - Order) */
301
- ContractRenewalCountOverride = "ContractRenewalCountOverride",
302
- /** To be handled manually by an operator. Default state = false (Sales - Order) */
303
- IsVerified = "IsVerified",
304
368
  /** the highest status of the invoices in dunning (Sales - Order) */
305
369
  DunningStatus = "DunningStatus",
306
- /** the date the mandate reminder was sent (Sales - Order) */
307
- MandateReminderSmsSentAt = "MandateReminderSmsSentAt",
308
370
  /** when the dunning status was last updated (Sales - Order) */
309
371
  DunningStatusUpdatedAt = "DunningStatusUpdatedAt",
310
- /** the date the mandate status was updated (Sales - Order) */
311
- MandateStatusUpdatedAt = "MandateStatusUpdatedAt",
372
+ /** the number of invoices in dunning (Sales - Order) */
373
+ InvoicesDunning = "InvoicesDunning",
374
+ /** the date the order is issued (Sales - Order) */
375
+ IssuedDate = "IssuedDate",
376
+ /** To be handled manually by an operator. Default state = false (Sales - Order) */
377
+ IsVerified = "IsVerified",
378
+ /** Landing Page (Sales - Order) */
379
+ LandingPage = "LandingPage",
312
380
  /** Data field for Order records. Used by Sales team. */
313
381
  Latitude = "Latitude",
314
- /** total discounts (Sales - Order) */
315
- TotalDiscounts = "TotalDiscounts",
316
- /** total price including taxes and discounts (Sales - Order) */
317
- TotalPrice = "TotalPrice",
318
- /** the date the mandate reminder email was sent (Sales - Order) */
319
- MandateReminderEmailSentAt = "MandateReminderEmailSentAt",
320
382
  /** Data field for Order records. Used by Sales team. */
321
383
  Longitude = "Longitude",
384
+ /** the date the mandate reminder email was sent (Sales - Order) */
385
+ MandateReminderEmailSentAt = "MandateReminderEmailSentAt",
386
+ /** the date the mandate reminder was sent (Sales - Order) */
387
+ MandateReminderSmsSentAt = "MandateReminderSmsSentAt",
388
+ /** the date the mandate status was updated (Sales - Order) */
389
+ MandateStatusUpdatedAt = "MandateStatusUpdatedAt",
390
+ /** Display name/title for Order records. Primary identifier for Sales team. */
391
+ Name = "Name",
392
+ /** PendingAmcoCollection */
393
+ PendingAmcoCollection = "PendingAmcoCollection",
394
+ /** PendingAmcoDispatch */
395
+ PendingAmcoDispatch = "PendingAmcoDispatch",
396
+ /** PendingAmcoReplacement */
397
+ PendingAmcoReplacement = "PendingAmcoReplacement",
398
+ /** the previous order prior to an amendment or recontract (Sales - Order) */
399
+ PreviousOrderId = "PreviousOrderId",
322
400
  /** the price match requested by the customer (Sales - Order) */
323
401
  PriceMatchRequested = "PriceMatchRequested",
324
- /** ReferralApprovalDate (Sales - Order) */
325
- ReferralApprovalDate = "ReferralApprovalDate",
326
402
  /** network provider (Sales - Order) */
327
403
  Provider = "Provider",
404
+ /** ReferralApprovalDate (Sales - Order) */
405
+ ReferralApprovalDate = "ReferralApprovalDate",
406
+ /** referral email (Sales - Order) */
407
+ ReferralEmail = "ReferralEmail",
408
+ /** the delivery date requested by the customer (Sales - Order) */
409
+ RequestedDeliveryDate = "RequestedDeliveryDate",
410
+ /** Data field for Order records. Used by Sales team. */
411
+ Source = "Source",
328
412
  /** the subscriber id is used as the identifier when provisioning on the network (Sales - Order) */
329
413
  SubscriberId = "SubscriberId",
330
- /** total taxes (Sales - Order) */
331
- TotalTaxAmount = "TotalTaxAmount",
332
- /** unit cost for the product derived from product components UnitCost (Sales - Order) */
333
- TaxRate = "TaxRate",
334
414
  /** subtotal of the prices no taxes (Sales - Order) */
335
415
  Subtotal = "Subtotal",
336
- /** Display name/title for Order records. Primary identifier for Sales team. */
337
- Name = "Name",
338
- /** Data field for Order records. Used by Sales team. */
339
- Source = "Source",
340
- /** referral email (Sales - Order) */
341
- ReferralEmail = "ReferralEmail",
416
+ /** unit cost for the product derived from product components UnitCost (Sales - Order) */
417
+ TaxRate = "TaxRate",
418
+ /** total discounts (Sales - Order) */
419
+ TotalDiscounts = "TotalDiscounts",
420
+ /** total price including taxes and discounts (Sales - Order) */
421
+ TotalPrice = "TotalPrice",
422
+ /** total taxes (Sales - Order) */
423
+ TotalTaxAmount = "TotalTaxAmount",
424
+ /** phone number to transfer (Sales - Order) */
425
+ TransferPhone = "TransferPhone",
342
426
  /** trial length is the number of X free periods (Sales - Order) */
343
427
  TrialLength = "TrialLength",
344
- /** Withhold Commission Reason */
345
- WithholdCommissionReason = "WithholdCommissionReason",
346
- /** Withhold Commission Notes */
347
- WithholdCommissionNotes = "WithholdCommissionNotes",
348
- /** Billing start date (Sales - Order) */
349
- BillingStartDate = "BillingStartDate",
350
- /** Reason for deactivating the order (Sales - Order) */
351
- DeactivationReason = "DeactivationReason",
352
- /** cancellation reason notes (Sales - Order) */
353
- CancellationReasonNote = "CancellationReasonNote",
354
- /** alerts that need to be visible on the order (Sales - Order) */
355
- AlertMessage = "AlertMessage",
356
- /** the date of the alert message (Sales - Order) */
357
- AlertMessageDate = "AlertMessageDate",
358
- /** the date the contract will end (Sales - Order) */
359
- ContractEndDate = "ContractEndDate",
360
- /** 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) */
361
- CancellationEffectiveDate = "CancellationEffectiveDate",
362
- /** Reference identifier for Order relationships. Used for data integrity. */
363
- DataSetId = "DataSetId",
364
- /** Billing day in the month (Sales - Order) */
365
- BillingDay = "BillingDay",
366
- /** The date the order was rejected in aklamio (Sales - Order) */
367
- AklamioRejectionDate = "AklamioRejectionDate",
368
- /** Cancellation reason (Sales - Order) */
369
- CancellationReason = "CancellationReason",
370
- /** active date (Sales - Order) */
371
- ActiveDate = "ActiveDate",
372
- /** This order comes because of an Aklamio Reference (Sales - Order) */
373
- AklamioReferenced = "AklamioReferenced",
374
- /** true if the customer has an active mandate (Sales - Order) */
375
- ActiveMandate = "ActiveMandate",
376
- /** the average monthly contract value (Sales - Order) */
377
- AverageMonthlyValue = "AverageMonthlyValue",
378
- /** the date the order was cancelled (Sales - Order) */
379
- CancelledDate = "CancelledDate",
380
- /** The debt collection agency status (Sales - Order) */
381
- DcaStatus = "DCAStatus",
382
- /** The total value sent to collect (Sales - Order) */
383
- DcaCollectionValue = "DCACollectionValue",
384
- /** The date the DCA loaded the order (Sales - Order) */
385
- DcaLoadedDate = "DCALoadedDate",
386
- /** Desired Billing Day (Sales - Order) */
387
- DesiredBillingDay = "DesiredBillingDay",
388
- /** Description of order deactivation (Sales - Order) */
389
- DeactivationDescription = "DeactivationDescription",
390
- /** the contract buy out amount requested by the customer (Sales - Order) */
391
- ContractBuyOutRequested = "ContractBuyOutRequested",
428
+ /** trial unit is the unit of measure for free periods (Sales - Order) */
429
+ TrialUnit = "TrialUnit",
392
430
  /** unique delivery point reference number (Sales - Order) */
393
431
  Udprn = "UDPRN",
394
- /** The reason for collection attempts stopping (Sales - Order) */
395
- DcaClosureReason = "DCAClosureReason",
396
432
  /** unique multiple point reference number (Sales - Order) */
397
433
  Umprn = "UMPRN",
398
- /** Aklamio cashback was rejected (Sales - Order) */
399
- AklamioCashbackRejectionDate = "AklamioCashbackRejectionDate",
400
- /** Aklamio cashback was applied (Sales - Order) */
401
- AklamioCashbackVerificationDate = "AklamioCashbackVerificationDate",
402
- /** When the Cashback was approved (Sales - Order) */
403
- CashbackApprovalDate = "CashbackApprovalDate",
404
- /** The date the order should be moved to deactivated (Sales - Order) */
405
- DeactivateOnDate = "DeactivateOnDate",
406
- /** The date the order should be moved to cancelled (Sales - Order) */
407
- CancelOnDate = "CancelOnDate",
408
434
  /** Data field for Order records. Used by Sales team. */
409
435
  Uprn = "Uprn",
410
- /** the value to discount (Sales - Order) */
411
- DiscountValue = "DiscountValue",
412
- /** the number of times the contract has renewed (Sales - Order) */
413
- ContractRenewalCount = "ContractRenewalCount",
414
- /** the number of invoices in dunning (Sales - Order) */
415
- InvoicesDunning = "InvoicesDunning",
416
- /** status of the order (must be activated for billing) (Sales - Order) */
417
- ActivationStatus = "ActivationStatus",
418
- /** the delivery date requested by the customer (Sales - Order) */
419
- RequestedDeliveryDate = "RequestedDeliveryDate",
420
- /** the type of the contract (Sales - Order) */
421
- ContractType = "ContractType",
422
- /** trial unit is the unit of measure for free periods (Sales - Order) */
423
- TrialUnit = "TrialUnit",
424
- /** discount duration unit (Sales - Order) */
425
- DiscountUnit = "DiscountUnit",
426
- /** the previous order prior to an amendment or recontract (Sales - Order) */
427
- PreviousOrderId = "PreviousOrderId",
428
- /** The collection value paid to date (Sales - Order) */
429
- DcaPaidToDate = "DCAPaidToDate",
430
- /** Aklamio Verification Date (Sales - Order) */
431
- AklamioVerificationDate = "AklamioVerificationDate",
432
- /** the date the contract start (Sales - Order) */
433
- ContractStartDate = "ContractStartDate",
436
+ /** Data field for Order records. Used by Sales team. */
437
+ VatNumber = "VATNumber",
434
438
  /** check this box if you want to flag a commission hold on this order (Sales - Order) */
435
439
  WithholdCommission = "WithholdCommission",
436
- /** PendingAmcoReplacement */
437
- PendingAmcoReplacement = "PendingAmcoReplacement",
438
- /** PendingAmcoDispatch */
439
- PendingAmcoDispatch = "PendingAmcoDispatch",
440
- /** PendingAmcoCollection */
441
- PendingAmcoCollection = "PendingAmcoCollection",
442
- /** Affiliate code used when order was placed */
443
- AffiliateCode = "AffiliateCode"
440
+ /** Withhold Commission Notes */
441
+ WithholdCommissionNotes = "WithholdCommissionNotes",
442
+ /** Withhold Commission Reason */
443
+ WithholdCommissionReason = "WithholdCommissionReason"
444
444
  }
445
445
  /**
446
446
  * Properties for Order records
@@ -448,261 +448,254 @@ export declare enum OrderPropertyKeys {
448
448
  * @see OrderModule:Order
449
449
  */
450
450
  export interface OrderProperties {
451
- /** Data field for Order records. Used by Sales team.
451
+ /** status of the order (must be activated for billing) (Sales - Order)
452
452
  *
453
- * @type {TEXT}
454
- * @default 0
453
+ * @type {ENUM}
454
+ * @default DRAFT
455
+ * @enum {OrderActivationStatus}
455
456
  * @hidden This field is hidden in the UI
456
457
  */
457
- VatNumber: string;
458
- /** the datetime when the amendment was performed (Sales - Order)
458
+ ActivationStatus: OrderActivationStatus;
459
+ /** active date (Sales - Order)
459
460
  *
460
461
  * @type {DATE}
461
462
  * @format DD/MM/YYYY
462
463
  * @hidden This field is hidden in the UI
463
464
  */
464
- AmendmentDate: string;
465
- /** Currency code (Sales - Order)
465
+ ActiveDate: string;
466
+ /** true if the customer has an active mandate (Sales - Order)
466
467
  *
467
- * @type {ENUM}
468
- * @default GBP
469
- * @enum {OrderCurrencyCode}
468
+ * @type {BOOLEAN}
469
+ * @hidden This field is hidden in the UI
470
470
  */
471
- CurrencyCode: OrderCurrencyCode;
472
- /** the date the order is delivered (Sales - Order)
471
+ ActiveMandate: boolean;
472
+ /** Reference identifier for Order relationships. Used for data integrity.
473
473
  *
474
- * @type {DATE}
475
- * @format DD/MM/YYYY
476
- * @hidden This field is hidden in the UI
474
+ * @type {LOOKUP}
477
475
  */
478
- DeliveryDate: string;
479
- /** phone number to transfer (Sales - Order)
476
+ AddressId: string;
477
+ /** Affiliate code used when order was placed
480
478
  *
481
- * @type {PHONE_NUMBER}
482
- * @default
483
- * @pii This field contains personally identifiable information
484
- * @hidden This field is hidden in the UI
479
+ * @type {TEXT}
485
480
  */
486
- TransferPhone: string;
487
- /** the type of discount (Sales - Order)
481
+ AffiliateCode: string;
482
+ /** Aklamio cashback was rejected (Sales - Order)
488
483
  *
489
- * @type {ENUM}
490
- * @default
491
- * @enum {OrderDiscountType}
492
- * @hidden This field is hidden in the UI
484
+ * @type {DATE}
493
485
  */
494
- DiscountType: OrderDiscountType;
495
- /** length for the items discount duration (Sales - Order)
486
+ AklamioCashbackRejectionDate: string;
487
+ /** Aklamio cashback was applied (Sales - Order)
496
488
  *
497
- * @type {NUMBER}
498
- * @hidden This field is hidden in the UI
489
+ * @type {DATE}
499
490
  */
500
- DiscountLength: number;
501
- /** Reference identifier for Order relationships. Used for data integrity.
491
+ AklamioCashbackVerificationDate: string;
492
+ /** This order comes because of an Aklamio Reference (Sales - Order)
502
493
  *
503
- * @type {LOOKUP}
494
+ * @type {BOOLEAN}
495
+ * @default False
504
496
  */
505
- AddressId: string;
506
- /** Billing terms i.e NET 15,30 (Sales - Order)
497
+ AklamioReferenced: boolean;
498
+ /** The date the order was rejected in aklamio (Sales - Order)
507
499
  *
508
- * @type {ENUM}
509
- * @default NET_0
510
- * @enum {OrderBillingTerms}
500
+ * @type {DATE}
501
+ */
502
+ AklamioRejectionDate: string;
503
+ /** Aklamio Verification Date (Sales - Order)
504
+ *
505
+ * @type {DATE}
506
+ * @hidden This field is hidden in the UI
507
+ */
508
+ AklamioVerificationDate: string;
509
+ /** alerts that need to be visible on the order (Sales - Order)
510
+ *
511
+ * @type {TEXT_LONG}
512
+ * @hidden This field is hidden in the UI
511
513
  */
512
- BillingTerms: OrderBillingTerms;
513
- /** the date the order is issued (Sales - Order)
514
+ AlertMessage: string;
515
+ /** the date of the alert message (Sales - Order)
514
516
  *
515
517
  * @type {DATE}
516
518
  * @format DD/MM/YYYY
517
519
  * @hidden This field is hidden in the UI
518
520
  */
519
- IssuedDate: string;
520
- /** the date the dunning period started (Sales - Order)
521
+ AlertMessageDate: string;
522
+ /** the datetime when the amendment was performed (Sales - Order)
521
523
  *
522
524
  * @type {DATE}
523
525
  * @format DD/MM/YYYY
524
526
  * @hidden This field is hidden in the UI
525
527
  */
526
- DunningStartDate: string;
527
- /** Landing Page (Sales - Order)
528
+ AmendmentDate: string;
529
+ /** the average monthly contract value (Sales - Order)
528
530
  *
529
- * @type {TEXT}
531
+ * @type {CURRENCY}
532
+ * @default 0
530
533
  * @hidden This field is hidden in the UI
531
534
  */
532
- LandingPage: string;
533
- /** Total contract value (Sales - Order)
535
+ AverageMonthlyValue: string;
536
+ /** Billing day in the month (Sales - Order)
534
537
  *
535
- * @type {TEXT}
536
- * @hidden This field is hidden in the UI
538
+ * @type {NUMBER}
537
539
  */
538
- ContractValueTotal: string;
539
- /** Monthly contract value (Sales - Order)
540
+ BillingDay: number;
541
+ /** Billing start date (Sales - Order)
540
542
  *
541
- * @type {TEXT}
543
+ * @type {DATE}
544
+ * @format DD/MM/YYYY
542
545
  * @hidden This field is hidden in the UI
543
546
  */
544
- ContractValueMonthly: string;
545
- /** the additional number of times the contract has renewed (Sales - Order)
547
+ BillingStartDate: string;
548
+ /** Billing terms i.e NET 15,30 (Sales - Order)
546
549
  *
547
- * @type {NUMBER}
548
- * @hidden This field is hidden in the UI
550
+ * @type {ENUM}
551
+ * @default NET_0
552
+ * @enum {OrderBillingTerms}
549
553
  */
550
- ContractRenewalCountOverride: number;
551
- /** To be handled manually by an operator. Default state = false (Sales - Order)
554
+ BillingTerms: OrderBillingTerms;
555
+ /** 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)
552
556
  *
553
- * @type {BOOLEAN}
554
- * @default false
557
+ * @type {DATE}
558
+ * @format DD/MM/YYYY
555
559
  * @hidden This field is hidden in the UI
556
560
  */
557
- IsVerified: boolean;
558
- /** the highest status of the invoices in dunning (Sales - Order)
561
+ CancellationEffectiveDate: string;
562
+ /** Cancellation reason (Sales - Order)
559
563
  *
560
564
  * @type {TEXT}
561
565
  * @hidden This field is hidden in the UI
562
566
  */
563
- DunningStatus: string;
564
- /** the date the mandate reminder was sent (Sales - Order)
567
+ CancellationReason: string;
568
+ /** cancellation reason notes (Sales - Order)
565
569
  *
566
- * @type {DATE}
567
- * @format DD/MM/YYYY
570
+ * @type {TEXT}
568
571
  * @hidden This field is hidden in the UI
569
572
  */
570
- MandateReminderSmsSentAt: string;
571
- /** when the dunning status was last updated (Sales - Order)
573
+ CancellationReasonNote: string;
574
+ /** the date the order was cancelled (Sales - Order)
572
575
  *
573
576
  * @type {DATE}
574
577
  * @format DD/MM/YYYY
575
578
  * @hidden This field is hidden in the UI
576
579
  */
577
- DunningStatusUpdatedAt: string;
578
- /** the date the mandate status was updated (Sales - Order)
580
+ CancelledDate: string;
581
+ /** The date the order should be moved to cancelled (Sales - Order)
579
582
  *
580
583
  * @type {DATE}
581
- * @format DD/MM/YYYY
582
- * @hidden This field is hidden in the UI
583
- */
584
- MandateStatusUpdatedAt: string;
585
- /** Data field for Order records. Used by Sales team.
586
- *
587
- * @type {TEXT}
588
- * @hidden This field is hidden in the UI
584
+ * @tracked Changes to this field are tracked in audit history
589
585
  */
590
- Latitude: string;
591
- /** total discounts (Sales - Order)
586
+ CancelOnDate: string;
587
+ /** When the Cashback was approved (Sales - Order)
592
588
  *
593
- * @type {CURRENCY}
594
- * @default 0
595
- * @hidden This field is hidden in the UI
589
+ * @type {DATE}
596
590
  */
597
- TotalDiscounts: string;
598
- /** total price including taxes and discounts (Sales - Order)
591
+ CashbackApprovalDate: string;
592
+ /** the contract buy out amount requested by the customer (Sales - Order)
599
593
  *
600
- * @type {CURRENCY}
601
- * @default 0
594
+ * @type {BOOLEAN}
602
595
  * @hidden This field is hidden in the UI
603
596
  */
604
- TotalPrice: string;
605
- /** the date the mandate reminder email was sent (Sales - Order)
597
+ ContractBuyOutRequested: boolean;
598
+ /** the date the contract will end (Sales - Order)
606
599
  *
607
600
  * @type {DATE}
608
601
  * @format DD/MM/YYYY
609
602
  * @hidden This field is hidden in the UI
610
603
  */
611
- MandateReminderEmailSentAt: string;
612
- /** Data field for Order records. Used by Sales team.
604
+ ContractEndDate: string;
605
+ /** the number of times the contract has renewed (Sales - Order)
613
606
  *
614
- * @type {TEXT}
607
+ * @type {NUMBER}
615
608
  * @hidden This field is hidden in the UI
616
609
  */
617
- Longitude: string;
618
- /** the price match requested by the customer (Sales - Order)
610
+ ContractRenewalCount: number;
611
+ /** the additional number of times the contract has renewed (Sales - Order)
619
612
  *
620
- * @type {BOOLEAN}
613
+ * @type {NUMBER}
621
614
  * @hidden This field is hidden in the UI
622
615
  */
623
- PriceMatchRequested: boolean;
624
- /** ReferralApprovalDate (Sales - Order)
616
+ ContractRenewalCountOverride: number;
617
+ /** the date the contract start (Sales - Order)
625
618
  *
626
619
  * @type {DATE}
620
+ * @format DD/MM/YYYY
627
621
  * @hidden This field is hidden in the UI
628
622
  */
629
- ReferralApprovalDate: string;
630
- /** network provider (Sales - Order)
623
+ ContractStartDate: string;
624
+ /** the type of the contract (Sales - Order)
631
625
  *
632
626
  * @type {ENUM}
633
- * @default NETOMNIA_LEGACY
634
- * @enum {OrderProvider}
627
+ * @enum {OrderContractType}
628
+ * @hidden This field is hidden in the UI
635
629
  */
636
- Provider: OrderProvider;
637
- /** the subscriber id is used as the identifier when provisioning on the network (Sales - Order)
630
+ ContractType: OrderContractType;
631
+ /** Monthly contract value (Sales - Order)
638
632
  *
639
633
  * @type {TEXT}
634
+ * @hidden This field is hidden in the UI
640
635
  */
641
- SubscriberId: string;
642
- /** total taxes (Sales - Order)
636
+ ContractValueMonthly: string;
637
+ /** Total contract value (Sales - Order)
643
638
  *
644
- * @type {CURRENCY}
645
- * @default 0
639
+ * @type {TEXT}
646
640
  * @hidden This field is hidden in the UI
647
641
  */
648
- TotalTaxAmount: string;
649
- /** unit cost for the product derived from product components UnitCost (Sales - Order)
642
+ ContractValueTotal: string;
643
+ /** Currency code (Sales - Order)
650
644
  *
651
- * @type {PERCENT}
652
- * @default 0
653
- * @hidden This field is hidden in the UI
645
+ * @type {ENUM}
646
+ * @default GBP
647
+ * @enum {OrderCurrencyCode}
654
648
  */
655
- TaxRate: number;
656
- /** subtotal of the prices no taxes (Sales - Order)
649
+ CurrencyCode: OrderCurrencyCode;
650
+ /** Reference identifier for Order relationships. Used for data integrity.
657
651
  *
658
- * @type {CURRENCY}
659
- * @default 0
652
+ * @type {UUID}
660
653
  * @hidden This field is hidden in the UI
661
654
  */
662
- Subtotal: string;
663
- /** Display name/title for Order records. Primary identifier for Sales team.
655
+ DataSetId: string;
656
+ /** The reason for collection attempts stopping (Sales - Order)
664
657
  *
665
658
  * @type {TEXT}
666
- * @placeholder name
667
659
  * @hidden This field is hidden in the UI
668
660
  */
669
- Name: string;
670
- /** Data field for Order records. Used by Sales team.
661
+ DcaClosureReason: string;
662
+ /** The total value sent to collect (Sales - Order)
671
663
  *
672
- * @type {TEXT}
664
+ * @type {CURRENCY}
673
665
  * @hidden This field is hidden in the UI
674
666
  */
675
- Source: string;
676
- /** referral email (Sales - Order)
667
+ DcaCollectionValue: string;
668
+ /** The date the DCA loaded the order (Sales - Order)
677
669
  *
678
- * @type {TEXT}
679
- * @pii This field contains personally identifiable information
670
+ * @type {DATE}
671
+ * @format DD/MM/YYYY
672
+ * @hidden This field is hidden in the UI
680
673
  */
681
- ReferralEmail: string;
682
- /** trial length is the number of X free periods (Sales - Order)
674
+ DcaLoadedDate: string;
675
+ /** The collection value paid to date (Sales - Order)
683
676
  *
684
- * @type {NUMBER}
677
+ * @type {CURRENCY}
685
678
  * @hidden This field is hidden in the UI
686
679
  */
687
- TrialLength: number;
688
- /** Withhold Commission Reason
680
+ DcaPaidToDate: string;
681
+ /** The debt collection agency status (Sales - Order)
689
682
  *
690
- * @type {ENUM}
691
- * @enum {OrderWithholdCommissionReason}
683
+ * @type {TEXT}
684
+ * @hidden This field is hidden in the UI
692
685
  */
693
- WithholdCommissionReason: OrderWithholdCommissionReason;
694
- /** Withhold Commission Notes
686
+ DcaStatus: string;
687
+ /** The date the order should be moved to deactivated (Sales - Order)
695
688
  *
696
- * @type {TEXT_LONG}
689
+ * @type {DATE}
690
+ * @tracked Changes to this field are tracked in audit history
697
691
  */
698
- WithholdCommissionNotes: string;
699
- /** Billing start date (Sales - Order)
692
+ DeactivateOnDate: string;
693
+ /** Description of order deactivation (Sales - Order)
700
694
  *
701
- * @type {DATE}
702
- * @format DD/MM/YYYY
695
+ * @type {TEXT}
703
696
  * @hidden This field is hidden in the UI
704
697
  */
705
- BillingStartDate: string;
698
+ DeactivationDescription: string;
706
699
  /** Reason for deactivating the order (Sales - Order)
707
700
  *
708
701
  * @type {ENUM}
@@ -710,262 +703,278 @@ export interface OrderProperties {
710
703
  * @hidden This field is hidden in the UI
711
704
  */
712
705
  DeactivationReason: OrderDeactivationReason;
713
- /** cancellation reason notes (Sales - Order)
706
+ /** the date the order is delivered (Sales - Order)
714
707
  *
715
- * @type {TEXT}
708
+ * @type {DATE}
709
+ * @format DD/MM/YYYY
716
710
  * @hidden This field is hidden in the UI
717
711
  */
718
- CancellationReasonNote: string;
719
- /** alerts that need to be visible on the order (Sales - Order)
712
+ DeliveryDate: string;
713
+ /** Desired Billing Day (Sales - Order)
720
714
  *
721
- * @type {TEXT_LONG}
722
- * @hidden This field is hidden in the UI
715
+ * @type {NUMBER}
723
716
  */
724
- AlertMessage: string;
725
- /** the date of the alert message (Sales - Order)
717
+ DesiredBillingDay: number;
718
+ /** length for the items discount duration (Sales - Order)
726
719
  *
727
- * @type {DATE}
728
- * @format DD/MM/YYYY
720
+ * @type {NUMBER}
729
721
  * @hidden This field is hidden in the UI
730
722
  */
731
- AlertMessageDate: string;
732
- /** the date the contract will end (Sales - Order)
723
+ DiscountLength: number;
724
+ /** the type of discount (Sales - Order)
733
725
  *
734
- * @type {DATE}
735
- * @format DD/MM/YYYY
726
+ * @type {ENUM}
727
+ * @default
728
+ * @enum {OrderDiscountType}
736
729
  * @hidden This field is hidden in the UI
737
730
  */
738
- ContractEndDate: string;
739
- /** 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)
731
+ DiscountType: OrderDiscountType;
732
+ /** discount duration unit (Sales - Order)
740
733
  *
741
- * @type {DATE}
742
- * @format DD/MM/YYYY
734
+ * @type {ENUM}
735
+ * @default
736
+ * @enum {OrderDiscountUnit}
743
737
  * @hidden This field is hidden in the UI
744
738
  */
745
- CancellationEffectiveDate: string;
746
- /** Reference identifier for Order relationships. Used for data integrity.
739
+ DiscountUnit: OrderDiscountUnit;
740
+ /** the value to discount (Sales - Order)
747
741
  *
748
- * @type {UUID}
742
+ * @type {CURRENCY}
743
+ * @default 0
749
744
  * @hidden This field is hidden in the UI
750
745
  */
751
- DataSetId: string;
752
- /** Billing day in the month (Sales - Order)
753
- *
754
- * @type {NUMBER}
755
- */
756
- BillingDay: number;
757
- /** The date the order was rejected in aklamio (Sales - Order)
746
+ DiscountValue: string;
747
+ /** the date the dunning period started (Sales - Order)
758
748
  *
759
749
  * @type {DATE}
750
+ * @format DD/MM/YYYY
751
+ * @hidden This field is hidden in the UI
760
752
  */
761
- AklamioRejectionDate: string;
762
- /** Cancellation reason (Sales - Order)
753
+ DunningStartDate: string;
754
+ /** the highest status of the invoices in dunning (Sales - Order)
763
755
  *
764
756
  * @type {TEXT}
765
757
  * @hidden This field is hidden in the UI
766
758
  */
767
- CancellationReason: string;
768
- /** active date (Sales - Order)
759
+ DunningStatus: string;
760
+ /** when the dunning status was last updated (Sales - Order)
769
761
  *
770
762
  * @type {DATE}
771
763
  * @format DD/MM/YYYY
772
764
  * @hidden This field is hidden in the UI
773
765
  */
774
- ActiveDate: string;
775
- /** This order comes because of an Aklamio Reference (Sales - Order)
766
+ DunningStatusUpdatedAt: string;
767
+ /** the number of invoices in dunning (Sales - Order)
776
768
  *
777
- * @type {BOOLEAN}
778
- * @default False
769
+ * @type {NUMBER}
770
+ * @hidden This field is hidden in the UI
779
771
  */
780
- AklamioReferenced: boolean;
781
- /** true if the customer has an active mandate (Sales - Order)
772
+ InvoicesDunning: number;
773
+ /** the date the order is issued (Sales - Order)
774
+ *
775
+ * @type {DATE}
776
+ * @format DD/MM/YYYY
777
+ * @hidden This field is hidden in the UI
778
+ */
779
+ IssuedDate: string;
780
+ /** To be handled manually by an operator. Default state = false (Sales - Order)
782
781
  *
783
782
  * @type {BOOLEAN}
783
+ * @default false
784
784
  * @hidden This field is hidden in the UI
785
785
  */
786
- ActiveMandate: boolean;
787
- /** the average monthly contract value (Sales - Order)
786
+ IsVerified: boolean;
787
+ /** Landing Page (Sales - Order)
788
788
  *
789
- * @type {CURRENCY}
790
- * @default 0
789
+ * @type {TEXT}
791
790
  * @hidden This field is hidden in the UI
792
791
  */
793
- AverageMonthlyValue: string;
794
- /** the date the order was cancelled (Sales - Order)
792
+ LandingPage: string;
793
+ /** Data field for Order records. Used by Sales team.
795
794
  *
796
- * @type {DATE}
797
- * @format DD/MM/YYYY
795
+ * @type {TEXT}
798
796
  * @hidden This field is hidden in the UI
799
797
  */
800
- CancelledDate: string;
801
- /** The debt collection agency status (Sales - Order)
798
+ Latitude: string;
799
+ /** Data field for Order records. Used by Sales team.
802
800
  *
803
801
  * @type {TEXT}
804
802
  * @hidden This field is hidden in the UI
805
803
  */
806
- DcaStatus: string;
807
- /** The total value sent to collect (Sales - Order)
804
+ Longitude: string;
805
+ /** the date the mandate reminder email was sent (Sales - Order)
808
806
  *
809
- * @type {CURRENCY}
807
+ * @type {DATE}
808
+ * @format DD/MM/YYYY
810
809
  * @hidden This field is hidden in the UI
811
810
  */
812
- DcaCollectionValue: string;
813
- /** The date the DCA loaded the order (Sales - Order)
811
+ MandateReminderEmailSentAt: string;
812
+ /** the date the mandate reminder was sent (Sales - Order)
814
813
  *
815
814
  * @type {DATE}
816
815
  * @format DD/MM/YYYY
817
816
  * @hidden This field is hidden in the UI
818
817
  */
819
- DcaLoadedDate: string;
820
- /** Desired Billing Day (Sales - Order)
818
+ MandateReminderSmsSentAt: string;
819
+ /** the date the mandate status was updated (Sales - Order)
821
820
  *
822
- * @type {NUMBER}
821
+ * @type {DATE}
822
+ * @format DD/MM/YYYY
823
+ * @hidden This field is hidden in the UI
823
824
  */
824
- DesiredBillingDay: number;
825
- /** Description of order deactivation (Sales - Order)
825
+ MandateStatusUpdatedAt: string;
826
+ /** Display name/title for Order records. Primary identifier for Sales team.
826
827
  *
827
828
  * @type {TEXT}
829
+ * @placeholder name
828
830
  * @hidden This field is hidden in the UI
829
831
  */
830
- DeactivationDescription: string;
831
- /** the contract buy out amount requested by the customer (Sales - Order)
832
+ Name: string;
833
+ /** PendingAmcoCollection
832
834
  *
833
835
  * @type {BOOLEAN}
834
- * @hidden This field is hidden in the UI
835
836
  */
836
- ContractBuyOutRequested: boolean;
837
- /** unique delivery point reference number (Sales - Order)
837
+ PendingAmcoCollection: boolean;
838
+ /** PendingAmcoDispatch
838
839
  *
839
- * @type {NUMBER}
840
- * @default 0
840
+ * @type {BOOLEAN}
841
841
  */
842
- Udprn: number;
843
- /** The reason for collection attempts stopping (Sales - Order)
842
+ PendingAmcoDispatch: boolean;
843
+ /** PendingAmcoReplacement
844
844
  *
845
- * @type {TEXT}
846
- * @hidden This field is hidden in the UI
845
+ * @type {BOOLEAN}
847
846
  */
848
- DcaClosureReason: string;
849
- /** unique multiple point reference number (Sales - Order)
847
+ PendingAmcoReplacement: boolean;
848
+ /** the previous order prior to an amendment or recontract (Sales - Order)
850
849
  *
851
- * @type {NUMBER}
852
- * @default 0
850
+ * @type {LOOKUP}
851
+ * @hidden This field is hidden in the UI
853
852
  */
854
- Umprn: number;
855
- /** Aklamio cashback was rejected (Sales - Order)
853
+ PreviousOrderId: string;
854
+ /** the price match requested by the customer (Sales - Order)
856
855
  *
857
- * @type {DATE}
856
+ * @type {BOOLEAN}
857
+ * @hidden This field is hidden in the UI
858
858
  */
859
- AklamioCashbackRejectionDate: string;
860
- /** Aklamio cashback was applied (Sales - Order)
859
+ PriceMatchRequested: boolean;
860
+ /** network provider (Sales - Order)
861
861
  *
862
- * @type {DATE}
862
+ * @type {ENUM}
863
+ * @default NETOMNIA_LEGACY
864
+ * @enum {OrderProvider}
863
865
  */
864
- AklamioCashbackVerificationDate: string;
865
- /** When the Cashback was approved (Sales - Order)
866
+ Provider: OrderProvider;
867
+ /** ReferralApprovalDate (Sales - Order)
866
868
  *
867
869
  * @type {DATE}
870
+ * @hidden This field is hidden in the UI
868
871
  */
869
- CashbackApprovalDate: string;
870
- /** The date the order should be moved to deactivated (Sales - Order)
872
+ ReferralApprovalDate: string;
873
+ /** referral email (Sales - Order)
871
874
  *
872
- * @type {DATE}
873
- * @tracked Changes to this field are tracked in audit history
875
+ * @type {TEXT}
876
+ * @pii This field contains personally identifiable information
874
877
  */
875
- DeactivateOnDate: string;
876
- /** The date the order should be moved to cancelled (Sales - Order)
878
+ ReferralEmail: string;
879
+ /** the delivery date requested by the customer (Sales - Order)
877
880
  *
878
881
  * @type {DATE}
879
- * @tracked Changes to this field are tracked in audit history
882
+ * @format DD/MM/YYYY
883
+ * @hidden This field is hidden in the UI
880
884
  */
881
- CancelOnDate: string;
885
+ RequestedDeliveryDate: string;
882
886
  /** Data field for Order records. Used by Sales team.
883
887
  *
884
- * @type {NUMBER}
888
+ * @type {TEXT}
889
+ * @hidden This field is hidden in the UI
885
890
  */
886
- Uprn: number;
887
- /** the value to discount (Sales - Order)
891
+ Source: string;
892
+ /** the subscriber id is used as the identifier when provisioning on the network (Sales - Order)
893
+ *
894
+ * @type {TEXT}
895
+ */
896
+ SubscriberId: string;
897
+ /** subtotal of the prices no taxes (Sales - Order)
888
898
  *
889
899
  * @type {CURRENCY}
890
900
  * @default 0
891
901
  * @hidden This field is hidden in the UI
892
902
  */
893
- DiscountValue: string;
894
- /** the number of times the contract has renewed (Sales - Order)
903
+ Subtotal: string;
904
+ /** unit cost for the product derived from product components UnitCost (Sales - Order)
895
905
  *
896
- * @type {NUMBER}
906
+ * @type {PERCENT}
907
+ * @default 0
897
908
  * @hidden This field is hidden in the UI
898
909
  */
899
- ContractRenewalCount: number;
900
- /** the number of invoices in dunning (Sales - Order)
910
+ TaxRate: number;
911
+ /** total discounts (Sales - Order)
901
912
  *
902
- * @type {NUMBER}
913
+ * @type {CURRENCY}
914
+ * @default 0
903
915
  * @hidden This field is hidden in the UI
904
916
  */
905
- InvoicesDunning: number;
906
- /** status of the order (must be activated for billing) (Sales - Order)
917
+ TotalDiscounts: string;
918
+ /** total price including taxes and discounts (Sales - Order)
907
919
  *
908
- * @type {ENUM}
909
- * @default DRAFT
910
- * @enum {OrderActivationStatus}
920
+ * @type {CURRENCY}
921
+ * @default 0
911
922
  * @hidden This field is hidden in the UI
912
923
  */
913
- ActivationStatus: OrderActivationStatus;
914
- /** the delivery date requested by the customer (Sales - Order)
924
+ TotalPrice: string;
925
+ /** total taxes (Sales - Order)
915
926
  *
916
- * @type {DATE}
917
- * @format DD/MM/YYYY
927
+ * @type {CURRENCY}
928
+ * @default 0
918
929
  * @hidden This field is hidden in the UI
919
930
  */
920
- RequestedDeliveryDate: string;
921
- /** the type of the contract (Sales - Order)
931
+ TotalTaxAmount: string;
932
+ /** phone number to transfer (Sales - Order)
922
933
  *
923
- * @type {ENUM}
924
- * @enum {OrderContractType}
934
+ * @type {PHONE_NUMBER}
935
+ * @default
936
+ * @pii This field contains personally identifiable information
925
937
  * @hidden This field is hidden in the UI
926
938
  */
927
- ContractType: OrderContractType;
928
- /** trial unit is the unit of measure for free periods (Sales - Order)
939
+ TransferPhone: string;
940
+ /** trial length is the number of X free periods (Sales - Order)
929
941
  *
930
- * @type {ENUM}
931
- * @default
932
- * @enum {OrderTrialUnit}
942
+ * @type {NUMBER}
933
943
  * @hidden This field is hidden in the UI
934
944
  */
935
- TrialUnit: OrderTrialUnit;
936
- /** discount duration unit (Sales - Order)
945
+ TrialLength: number;
946
+ /** trial unit is the unit of measure for free periods (Sales - Order)
937
947
  *
938
948
  * @type {ENUM}
939
949
  * @default
940
- * @enum {OrderDiscountUnit}
950
+ * @enum {OrderTrialUnit}
941
951
  * @hidden This field is hidden in the UI
942
952
  */
943
- DiscountUnit: OrderDiscountUnit;
944
- /** the previous order prior to an amendment or recontract (Sales - Order)
953
+ TrialUnit: OrderTrialUnit;
954
+ /** unique delivery point reference number (Sales - Order)
945
955
  *
946
- * @type {LOOKUP}
947
- * @hidden This field is hidden in the UI
956
+ * @type {NUMBER}
957
+ * @default 0
948
958
  */
949
- PreviousOrderId: string;
950
- /** The collection value paid to date (Sales - Order)
959
+ Udprn: number;
960
+ /** unique multiple point reference number (Sales - Order)
951
961
  *
952
- * @type {CURRENCY}
953
- * @hidden This field is hidden in the UI
962
+ * @type {NUMBER}
963
+ * @default 0
954
964
  */
955
- DcaPaidToDate: string;
956
- /** Aklamio Verification Date (Sales - Order)
965
+ Umprn: number;
966
+ /** Data field for Order records. Used by Sales team.
957
967
  *
958
- * @type {DATE}
959
- * @hidden This field is hidden in the UI
968
+ * @type {NUMBER}
960
969
  */
961
- AklamioVerificationDate: string;
962
- /** the date the contract start (Sales - Order)
970
+ Uprn: number;
971
+ /** Data field for Order records. Used by Sales team.
963
972
  *
964
- * @type {DATE}
965
- * @format DD/MM/YYYY
973
+ * @type {TEXT}
974
+ * @default 0
966
975
  * @hidden This field is hidden in the UI
967
976
  */
968
- ContractStartDate: string;
977
+ VatNumber: string;
969
978
  /** check this box if you want to flag a commission hold on this order (Sales - Order)
970
979
  *
971
980
  * @type {BOOLEAN}
@@ -973,26 +982,17 @@ export interface OrderProperties {
973
982
  * @hidden This field is hidden in the UI
974
983
  */
975
984
  WithholdCommission: boolean;
976
- /** PendingAmcoReplacement
977
- *
978
- * @type {BOOLEAN}
979
- */
980
- PendingAmcoReplacement: boolean;
981
- /** PendingAmcoDispatch
982
- *
983
- * @type {BOOLEAN}
984
- */
985
- PendingAmcoDispatch: boolean;
986
- /** PendingAmcoCollection
985
+ /** Withhold Commission Notes
987
986
  *
988
- * @type {BOOLEAN}
987
+ * @type {TEXT_LONG}
989
988
  */
990
- PendingAmcoCollection: boolean;
991
- /** Affiliate code used when order was placed
989
+ WithholdCommissionNotes: string;
990
+ /** Withhold Commission Reason
992
991
  *
993
- * @type {TEXT}
992
+ * @type {ENUM}
993
+ * @enum {OrderWithholdCommissionReason}
994
994
  */
995
- AffiliateCode: string;
995
+ WithholdCommissionReason: OrderWithholdCommissionReason;
996
996
  }
997
997
  /**
998
998
  * Order entity from OrderModule