@d19n/youfibre-odin-sdk 2.0.20 → 2.0.21

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