@d19n/youfibre-odin-sdk 2.0.387 → 2.0.389
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.
- package/dist/actions-v2/CreateEquipmentReturnItemDto.d.ts +8 -1
- package/dist/entities-v2/Config.d.ts +8 -8
- package/dist/entities-v2/Config.js +2 -2
- package/dist/entities-v2/EquipmentReturnItem.d.ts +9 -1
- package/dist/entities-v2/EquipmentReturnItem.js +2 -0
- package/dist/entities-v2/Order.d.ts +727 -727
- package/dist/entities-v2/Order.js +358 -358
- package/dist/entities-v2/OrderItem.d.ts +261 -261
- package/dist/entities-v2/OrderItem.js +137 -137
- package/dist/entities-v2/RouterPingSnapshot.d.ts +17 -1
- package/dist/entities-v2/RouterPingSnapshot.js +4 -0
- package/package.json +1 -1
|
@@ -35,6 +35,77 @@ export declare enum OrderItemEntityTypes {
|
|
|
35
35
|
/** Default record type */
|
|
36
36
|
DEFAULT = "DEFAULT"
|
|
37
37
|
}
|
|
38
|
+
/**
|
|
39
|
+
* Valid values for OrderItem.ActivationStatus
|
|
40
|
+
*
|
|
41
|
+
* status of the order item (must be closed for billing) (Sales - OrderItem)
|
|
42
|
+
*
|
|
43
|
+
* @remarks Available options:
|
|
44
|
+
* - `CANCELLED` - Cancelled
|
|
45
|
+
* - `CLOSED` - Closed
|
|
46
|
+
* - `OPEN` - Open
|
|
47
|
+
*/
|
|
48
|
+
export declare enum OrderItemActivationStatus {
|
|
49
|
+
CANCELLED = "CANCELLED",
|
|
50
|
+
CLOSED = "CLOSED",
|
|
51
|
+
OPEN = "OPEN"
|
|
52
|
+
}
|
|
53
|
+
/**
|
|
54
|
+
* Valid values for OrderItem.AmendmentType
|
|
55
|
+
*
|
|
56
|
+
* the type of the product amendment in the order item (Sales - OrderItem)
|
|
57
|
+
*
|
|
58
|
+
* @remarks Available options:
|
|
59
|
+
* - `DOWNGRADE` - Downgrade
|
|
60
|
+
* - `UPGRADE` - Upgrade
|
|
61
|
+
*/
|
|
62
|
+
export declare enum OrderItemAmendmentType {
|
|
63
|
+
DOWNGRADE = "DOWNGRADE",
|
|
64
|
+
UPGRADE = "UPGRADE"
|
|
65
|
+
}
|
|
66
|
+
/**
|
|
67
|
+
* Valid values for OrderItem.BillingPeriodType
|
|
68
|
+
*
|
|
69
|
+
* the billing period for the item (Sales - OrderItem)
|
|
70
|
+
*
|
|
71
|
+
* @remarks Available options:
|
|
72
|
+
* - `DISCOUNT` - Discount
|
|
73
|
+
* - `DISCOUNT2` - Discount 2
|
|
74
|
+
* - `FREE` - Free
|
|
75
|
+
* - `STANDARD` - Standard
|
|
76
|
+
*/
|
|
77
|
+
export declare enum OrderItemBillingPeriodType {
|
|
78
|
+
DISCOUNT = "DISCOUNT",
|
|
79
|
+
DISCOUNT_2 = "DISCOUNT2",
|
|
80
|
+
FREE = "FREE",
|
|
81
|
+
STANDARD = "STANDARD"
|
|
82
|
+
}
|
|
83
|
+
/**
|
|
84
|
+
* Valid values for OrderItem.Discount2Type
|
|
85
|
+
*
|
|
86
|
+
* the type of discount (Sales - OrderItem)
|
|
87
|
+
*
|
|
88
|
+
* @remarks Available options:
|
|
89
|
+
* - `AMOUNT` - Amount
|
|
90
|
+
* - `PERCENT` - Percent
|
|
91
|
+
*/
|
|
92
|
+
export declare enum OrderItemDiscount2Type {
|
|
93
|
+
AMOUNT = "AMOUNT",
|
|
94
|
+
PERCENT = "PERCENT"
|
|
95
|
+
}
|
|
96
|
+
/**
|
|
97
|
+
* Valid values for OrderItem.DiscountType
|
|
98
|
+
*
|
|
99
|
+
* the type of discount (Sales - OrderItem)
|
|
100
|
+
*
|
|
101
|
+
* @remarks Available options:
|
|
102
|
+
* - `AMOUNT` - Amount
|
|
103
|
+
* - `PERCENT` - Percent
|
|
104
|
+
*/
|
|
105
|
+
export declare enum OrderItemDiscountType {
|
|
106
|
+
AMOUNT = "AMOUNT",
|
|
107
|
+
PERCENT = "PERCENT"
|
|
108
|
+
}
|
|
38
109
|
/**
|
|
39
110
|
* Valid values for OrderItem.PriceMatchedTo
|
|
40
111
|
*
|
|
@@ -89,49 +160,6 @@ export declare enum OrderItemTaxable {
|
|
|
89
160
|
NO = "NO",
|
|
90
161
|
YES = "YES"
|
|
91
162
|
}
|
|
92
|
-
/**
|
|
93
|
-
* Valid values for OrderItem.DiscountType
|
|
94
|
-
*
|
|
95
|
-
* the type of discount (Sales - OrderItem)
|
|
96
|
-
*
|
|
97
|
-
* @remarks Available options:
|
|
98
|
-
* - `AMOUNT` - Amount
|
|
99
|
-
* - `PERCENT` - Percent
|
|
100
|
-
*/
|
|
101
|
-
export declare enum OrderItemDiscountType {
|
|
102
|
-
AMOUNT = "AMOUNT",
|
|
103
|
-
PERCENT = "PERCENT"
|
|
104
|
-
}
|
|
105
|
-
/**
|
|
106
|
-
* Valid values for OrderItem.BillingPeriodType
|
|
107
|
-
*
|
|
108
|
-
* the billing period for the item (Sales - OrderItem)
|
|
109
|
-
*
|
|
110
|
-
* @remarks Available options:
|
|
111
|
-
* - `DISCOUNT` - Discount
|
|
112
|
-
* - `DISCOUNT2` - Discount 2
|
|
113
|
-
* - `FREE` - Free
|
|
114
|
-
* - `STANDARD` - Standard
|
|
115
|
-
*/
|
|
116
|
-
export declare enum OrderItemBillingPeriodType {
|
|
117
|
-
DISCOUNT = "DISCOUNT",
|
|
118
|
-
DISCOUNT_2 = "DISCOUNT2",
|
|
119
|
-
FREE = "FREE",
|
|
120
|
-
STANDARD = "STANDARD"
|
|
121
|
-
}
|
|
122
|
-
/**
|
|
123
|
-
* Valid values for OrderItem.AmendmentType
|
|
124
|
-
*
|
|
125
|
-
* the type of the product amendment in the order item (Sales - OrderItem)
|
|
126
|
-
*
|
|
127
|
-
* @remarks Available options:
|
|
128
|
-
* - `DOWNGRADE` - Downgrade
|
|
129
|
-
* - `UPGRADE` - Upgrade
|
|
130
|
-
*/
|
|
131
|
-
export declare enum OrderItemAmendmentType {
|
|
132
|
-
DOWNGRADE = "DOWNGRADE",
|
|
133
|
-
UPGRADE = "UPGRADE"
|
|
134
|
-
}
|
|
135
163
|
/**
|
|
136
164
|
* Valid values for OrderItem.TaxIncluded
|
|
137
165
|
*
|
|
@@ -145,119 +173,91 @@ export declare enum OrderItemTaxIncluded {
|
|
|
145
173
|
NO = "NO",
|
|
146
174
|
YES = "YES"
|
|
147
175
|
}
|
|
148
|
-
/**
|
|
149
|
-
* Valid values for OrderItem.Discount2Type
|
|
150
|
-
*
|
|
151
|
-
* the type of discount (Sales - OrderItem)
|
|
152
|
-
*
|
|
153
|
-
* @remarks Available options:
|
|
154
|
-
* - `AMOUNT` - Amount
|
|
155
|
-
* - `PERCENT` - Percent
|
|
156
|
-
*/
|
|
157
|
-
export declare enum OrderItemDiscount2Type {
|
|
158
|
-
AMOUNT = "AMOUNT",
|
|
159
|
-
PERCENT = "PERCENT"
|
|
160
|
-
}
|
|
161
|
-
/**
|
|
162
|
-
* Valid values for OrderItem.ActivationStatus
|
|
163
|
-
*
|
|
164
|
-
* status of the order item (must be closed for billing) (Sales - OrderItem)
|
|
165
|
-
*
|
|
166
|
-
* @remarks Available options:
|
|
167
|
-
* - `CANCELLED` - Cancelled
|
|
168
|
-
* - `CLOSED` - Closed
|
|
169
|
-
* - `OPEN` - Open
|
|
170
|
-
*/
|
|
171
|
-
export declare enum OrderItemActivationStatus {
|
|
172
|
-
CANCELLED = "CANCELLED",
|
|
173
|
-
CLOSED = "CLOSED",
|
|
174
|
-
OPEN = "OPEN"
|
|
175
|
-
}
|
|
176
176
|
/**
|
|
177
177
|
* Property keys for OrderItem
|
|
178
178
|
* Use these constants instead of string literals for type safety
|
|
179
179
|
*/
|
|
180
180
|
export declare enum OrderItemPropertyKeys {
|
|
181
|
-
/**
|
|
182
|
-
|
|
181
|
+
/** status of the order item (must be closed for billing) (Sales - OrderItem) */
|
|
182
|
+
ActivationStatus = "ActivationStatus",
|
|
183
|
+
/** the type of the product amendment in the order item (Sales - OrderItem) */
|
|
184
|
+
AmendmentType = "AmendmentType",
|
|
185
|
+
/** the billing period for the item (Sales - OrderItem) */
|
|
186
|
+
BillingPeriodType = "BillingPeriodType",
|
|
187
|
+
/** the date the order was activated (Sales - OrderItem) */
|
|
188
|
+
BillingStartDate = "BillingStartDate",
|
|
189
|
+
/** description of the order item (Sales - OrderItem) */
|
|
190
|
+
Description = "Description",
|
|
183
191
|
/** the end date for the 2nd discount period (Sales - OrderItem) */
|
|
184
192
|
Discount2EndDate = "Discount2EndDate",
|
|
185
|
-
/**
|
|
186
|
-
|
|
193
|
+
/** Discount2Length (Sales - OrderItem) */
|
|
194
|
+
Discount2Length = "Discount2Length",
|
|
195
|
+
/** the type of discount (Sales - OrderItem) */
|
|
196
|
+
Discount2Type = "Discount2Type",
|
|
197
|
+
/** the value of the 2nd discount (Sales - OrderItem) */
|
|
198
|
+
Discount2Value = "Discount2Value",
|
|
187
199
|
/** the date the discount period ends (Sales - OrderItem) */
|
|
188
200
|
DiscountEndDate = "DiscountEndDate",
|
|
189
|
-
/**
|
|
190
|
-
|
|
201
|
+
/** DiscountLength (Sales - OrderItem) */
|
|
202
|
+
DiscountLength = "DiscountLength",
|
|
203
|
+
/** the type of discount (Sales - OrderItem) */
|
|
204
|
+
DiscountType = "DiscountType",
|
|
205
|
+
/** the value to discount (Sales - OrderItem) */
|
|
206
|
+
DiscountValue = "DiscountValue",
|
|
191
207
|
/** Fix Brsk Migration */
|
|
192
208
|
ExternalRefBrskIsp = "ExternalRefBrskISP",
|
|
193
|
-
/**
|
|
194
|
-
|
|
209
|
+
/** ExternalReference */
|
|
210
|
+
ExternalReference = "ExternalReference",
|
|
211
|
+
/** name of the order item (Sales - OrderItem) */
|
|
212
|
+
Name = "Name",
|
|
195
213
|
/** id of the service (data/voice) on the providers network (Sales - OrderItem) */
|
|
196
214
|
NetworkServiceId = "NetworkServiceId",
|
|
215
|
+
/** next billing date that this item will be on an invoice (Sales - OrderItem) */
|
|
216
|
+
NextBillingDate = "NextBillingDate",
|
|
217
|
+
/** The item will be invoiced on this date (Sales - OrderItem) */
|
|
218
|
+
NextInvoiceDate = "NextInvoiceDate",
|
|
219
|
+
/** PriceMatchedTo */
|
|
220
|
+
PriceMatchedTo = "PriceMatchedTo",
|
|
221
|
+
/** category of the product being sold (Sales - OrderItem) */
|
|
222
|
+
ProductCategory = "ProductCategory",
|
|
223
|
+
/** product customer type (Sales - OrderItem) */
|
|
224
|
+
ProductCustomerType = "ProductCustomerType",
|
|
225
|
+
/** ProductPbRelationId (Sales - OrderItem) */
|
|
226
|
+
ProductPbRelationId = "ProductPbRelationId",
|
|
227
|
+
/** id of the product (Sales - OrderItem) */
|
|
228
|
+
ProductRef = "ProductRef",
|
|
229
|
+
/** the type of product being sold (Sales - OrderItem) */
|
|
230
|
+
ProductType = "ProductType",
|
|
231
|
+
/** value less discount and taxes, excluding free periods (Sales - OrderItem) */
|
|
232
|
+
ProjectedArpu = "ProjectedARPU",
|
|
197
233
|
/** quantity item (Sales - OrderItem) */
|
|
198
234
|
Quantity = "Quantity",
|
|
235
|
+
/** Fix Brsk migration */
|
|
236
|
+
ServiceId = "ServiceId",
|
|
237
|
+
/** the line item subtotal (Sales - OrderItem) */
|
|
238
|
+
Subtotal = "Subtotal",
|
|
239
|
+
/** is the item taxable (Sales - OrderItem) */
|
|
240
|
+
Taxable = "Taxable",
|
|
241
|
+
/** is tax included in the UnitPrice (Sales - OrderItem) */
|
|
242
|
+
TaxIncluded = "TaxIncluded",
|
|
243
|
+
/** tax rate for the item (Sales - OrderItem) */
|
|
244
|
+
TaxRate = "TaxRate",
|
|
199
245
|
/** total line item discounts (Sales - OrderItem) */
|
|
200
246
|
TotalDiscounts = "TotalDiscounts",
|
|
201
|
-
/** the value of the 2nd discount (Sales - OrderItem) */
|
|
202
|
-
Discount2Value = "Discount2Value",
|
|
203
|
-
/** the type of discount (Sales - OrderItem) */
|
|
204
|
-
DiscountType = "DiscountType",
|
|
205
|
-
/** ExternalReference */
|
|
206
|
-
ExternalReference = "ExternalReference",
|
|
207
|
-
/** the value to discount (Sales - OrderItem) */
|
|
208
|
-
DiscountValue = "DiscountValue",
|
|
209
247
|
/** total price for the line item (Sales - OrderItem) */
|
|
210
248
|
TotalPrice = "TotalPrice",
|
|
211
|
-
/** name of the order item (Sales - OrderItem) */
|
|
212
|
-
Name = "Name",
|
|
213
|
-
/** the type of product being sold (Sales - OrderItem) */
|
|
214
|
-
ProductType = "ProductType",
|
|
215
|
-
/** the billing period for the item (Sales - OrderItem) */
|
|
216
|
-
BillingPeriodType = "BillingPeriodType",
|
|
217
|
-
/** suggested retail price cost + markup (Sales - OrderItem) */
|
|
218
|
-
UnitPrice = "UnitPrice",
|
|
219
249
|
/** total taxes (Sales - OrderItem) */
|
|
220
250
|
TotalTaxAmount = "TotalTaxAmount",
|
|
221
251
|
/** the date the trial period ends (Sales - OrderItem) */
|
|
222
252
|
TrialEndDate = "TrialEndDate",
|
|
223
|
-
/**
|
|
224
|
-
|
|
225
|
-
/** category of the product being sold (Sales - OrderItem) */
|
|
226
|
-
ProductCategory = "ProductCategory",
|
|
227
|
-
/** Discount2Length (Sales - OrderItem) */
|
|
228
|
-
Discount2Length = "Discount2Length",
|
|
229
|
-
/** the line item subtotal (Sales - OrderItem) */
|
|
230
|
-
Subtotal = "Subtotal",
|
|
231
|
-
/** DiscountLength (Sales - OrderItem) */
|
|
232
|
-
DiscountLength = "DiscountLength",
|
|
233
|
-
/** next billing date that this item will be on an invoice (Sales - OrderItem) */
|
|
234
|
-
NextBillingDate = "NextBillingDate",
|
|
235
|
-
/** Virtual Local Area Network Identifier (e.g. 101) (Sales - OrderItem) */
|
|
236
|
-
Vlanid = "VLANID",
|
|
237
|
-
/** the type of the product amendment in the order item (Sales - OrderItem) */
|
|
238
|
-
AmendmentType = "AmendmentType",
|
|
239
|
-
/** the date the order was activated (Sales - OrderItem) */
|
|
240
|
-
BillingStartDate = "BillingStartDate",
|
|
253
|
+
/** the trial length (mapped from the Product<>Pricebook config) (Sales - OrderItem) */
|
|
254
|
+
TrialLength = "TrialLength",
|
|
241
255
|
/** the trial unit (mapped from the Product<>Pricebook config) (Sales - OrderItem) */
|
|
242
256
|
TrialUnit = "TrialUnit",
|
|
243
|
-
/**
|
|
244
|
-
|
|
245
|
-
/**
|
|
246
|
-
|
|
247
|
-
/** The item will be invoiced on this date (Sales - OrderItem) */
|
|
248
|
-
NextInvoiceDate = "NextInvoiceDate",
|
|
249
|
-
/** product customer type (Sales - OrderItem) */
|
|
250
|
-
ProductCustomerType = "ProductCustomerType",
|
|
251
|
-
/** the type of discount (Sales - OrderItem) */
|
|
252
|
-
Discount2Type = "Discount2Type",
|
|
253
|
-
/** status of the order item (must be closed for billing) (Sales - OrderItem) */
|
|
254
|
-
ActivationStatus = "ActivationStatus",
|
|
255
|
-
/** id of the product (Sales - OrderItem) */
|
|
256
|
-
ProductRef = "ProductRef",
|
|
257
|
-
/** description of the order item (Sales - OrderItem) */
|
|
258
|
-
Description = "Description",
|
|
259
|
-
/** tax rate for the item (Sales - OrderItem) */
|
|
260
|
-
TaxRate = "TaxRate"
|
|
257
|
+
/** suggested retail price cost + markup (Sales - OrderItem) */
|
|
258
|
+
UnitPrice = "UnitPrice",
|
|
259
|
+
/** Virtual Local Area Network Identifier (e.g. 101) (Sales - OrderItem) */
|
|
260
|
+
Vlanid = "VLANID"
|
|
261
261
|
}
|
|
262
262
|
/**
|
|
263
263
|
* Properties for OrderItem records
|
|
@@ -265,76 +265,80 @@ export declare enum OrderItemPropertyKeys {
|
|
|
265
265
|
* @see OrderModule:OrderItem
|
|
266
266
|
*/
|
|
267
267
|
export interface OrderItemProperties {
|
|
268
|
-
/**
|
|
268
|
+
/** status of the order item (must be closed for billing) (Sales - OrderItem)
|
|
269
269
|
*
|
|
270
270
|
* @type {ENUM}
|
|
271
|
-
* @
|
|
271
|
+
* @default OPEN
|
|
272
|
+
* @enum {OrderItemActivationStatus}
|
|
273
|
+
* @hidden This field is hidden in the UI
|
|
272
274
|
*/
|
|
273
|
-
|
|
274
|
-
/** the
|
|
275
|
+
ActivationStatus: OrderItemActivationStatus;
|
|
276
|
+
/** the type of the product amendment in the order item (Sales - OrderItem)
|
|
275
277
|
*
|
|
276
|
-
* @type {
|
|
277
|
-
* @
|
|
278
|
+
* @type {ENUM}
|
|
279
|
+
* @enum {OrderItemAmendmentType}
|
|
278
280
|
* @hidden This field is hidden in the UI
|
|
279
281
|
*/
|
|
280
|
-
|
|
281
|
-
/** the
|
|
282
|
+
AmendmentType: OrderItemAmendmentType;
|
|
283
|
+
/** the billing period for the item (Sales - OrderItem)
|
|
282
284
|
*
|
|
283
|
-
* @type {
|
|
285
|
+
* @type {ENUM}
|
|
286
|
+
* @enum {OrderItemBillingPeriodType}
|
|
284
287
|
* @hidden This field is hidden in the UI
|
|
285
288
|
*/
|
|
286
|
-
|
|
287
|
-
/** the date the
|
|
289
|
+
BillingPeriodType: OrderItemBillingPeriodType;
|
|
290
|
+
/** the date the order was activated (Sales - OrderItem)
|
|
288
291
|
*
|
|
289
292
|
* @type {DATE}
|
|
290
293
|
* @format DD/MM/YYYY
|
|
291
294
|
* @hidden This field is hidden in the UI
|
|
292
295
|
*/
|
|
293
|
-
|
|
294
|
-
/**
|
|
295
|
-
*
|
|
296
|
-
* @type {TEXT}
|
|
297
|
-
*/
|
|
298
|
-
ServiceId: string;
|
|
299
|
-
/** Fix Brsk Migration
|
|
296
|
+
BillingStartDate: string;
|
|
297
|
+
/** description of the order item (Sales - OrderItem)
|
|
300
298
|
*
|
|
301
299
|
* @type {TEXT}
|
|
302
|
-
*/
|
|
303
|
-
ExternalRefBrskIsp: string;
|
|
304
|
-
/** is the item taxable (Sales - OrderItem)
|
|
305
|
-
*
|
|
306
|
-
* @type {ENUM}
|
|
307
|
-
* @default YES
|
|
308
|
-
* @enum {OrderItemTaxable}
|
|
309
300
|
* @hidden This field is hidden in the UI
|
|
310
301
|
*/
|
|
311
|
-
|
|
312
|
-
/**
|
|
302
|
+
Description: string;
|
|
303
|
+
/** the end date for the 2nd discount period (Sales - OrderItem)
|
|
313
304
|
*
|
|
314
|
-
* @type {
|
|
305
|
+
* @type {DATE}
|
|
306
|
+
* @format DD/MM/YYYY
|
|
315
307
|
* @hidden This field is hidden in the UI
|
|
316
308
|
*/
|
|
317
|
-
|
|
318
|
-
/**
|
|
309
|
+
Discount2EndDate: string;
|
|
310
|
+
/** Discount2Length (Sales - OrderItem)
|
|
319
311
|
*
|
|
320
312
|
* @type {NUMBER}
|
|
321
|
-
* @default 1
|
|
322
313
|
* @hidden This field is hidden in the UI
|
|
323
314
|
*/
|
|
324
|
-
|
|
325
|
-
/**
|
|
315
|
+
Discount2Length: number;
|
|
316
|
+
/** the type of discount (Sales - OrderItem)
|
|
326
317
|
*
|
|
327
|
-
* @type {
|
|
328
|
-
* @
|
|
318
|
+
* @type {ENUM}
|
|
319
|
+
* @enum {OrderItemDiscount2Type}
|
|
329
320
|
* @hidden This field is hidden in the UI
|
|
330
321
|
*/
|
|
331
|
-
|
|
322
|
+
Discount2Type: OrderItemDiscount2Type;
|
|
332
323
|
/** the value of the 2nd discount (Sales - OrderItem)
|
|
333
324
|
*
|
|
334
325
|
* @type {CURRENCY}
|
|
335
326
|
* @hidden This field is hidden in the UI
|
|
336
327
|
*/
|
|
337
328
|
Discount2Value: string;
|
|
329
|
+
/** the date the discount period ends (Sales - OrderItem)
|
|
330
|
+
*
|
|
331
|
+
* @type {DATE}
|
|
332
|
+
* @format DD/MM/YYYY
|
|
333
|
+
* @hidden This field is hidden in the UI
|
|
334
|
+
*/
|
|
335
|
+
DiscountEndDate: string;
|
|
336
|
+
/** DiscountLength (Sales - OrderItem)
|
|
337
|
+
*
|
|
338
|
+
* @type {NUMBER}
|
|
339
|
+
* @hidden This field is hidden in the UI
|
|
340
|
+
*/
|
|
341
|
+
DiscountLength: number;
|
|
338
342
|
/** the type of discount (Sales - OrderItem)
|
|
339
343
|
*
|
|
340
344
|
* @type {ENUM}
|
|
@@ -343,11 +347,6 @@ export interface OrderItemProperties {
|
|
|
343
347
|
* @hidden This field is hidden in the UI
|
|
344
348
|
*/
|
|
345
349
|
DiscountType: OrderItemDiscountType;
|
|
346
|
-
/** ExternalReference
|
|
347
|
-
*
|
|
348
|
-
* @type {TEXT}
|
|
349
|
-
*/
|
|
350
|
-
ExternalReference: string;
|
|
351
350
|
/** the value to discount (Sales - OrderItem)
|
|
352
351
|
*
|
|
353
352
|
* @type {CURRENCY}
|
|
@@ -355,124 +354,110 @@ export interface OrderItemProperties {
|
|
|
355
354
|
* @hidden This field is hidden in the UI
|
|
356
355
|
*/
|
|
357
356
|
DiscountValue: string;
|
|
358
|
-
/**
|
|
359
|
-
*
|
|
360
|
-
* @type {CURRENCY}
|
|
361
|
-
* @default 0
|
|
362
|
-
* @hidden This field is hidden in the UI
|
|
363
|
-
*/
|
|
364
|
-
TotalPrice: string;
|
|
365
|
-
/** name of the order item (Sales - OrderItem)
|
|
357
|
+
/** Fix Brsk Migration
|
|
366
358
|
*
|
|
367
359
|
* @type {TEXT}
|
|
368
|
-
* @hidden This field is hidden in the UI
|
|
369
360
|
*/
|
|
370
|
-
|
|
371
|
-
/**
|
|
361
|
+
ExternalRefBrskIsp: string;
|
|
362
|
+
/** ExternalReference
|
|
372
363
|
*
|
|
373
364
|
* @type {TEXT}
|
|
374
|
-
* @hidden This field is hidden in the UI
|
|
375
365
|
*/
|
|
376
|
-
|
|
377
|
-
/**
|
|
366
|
+
ExternalReference: string;
|
|
367
|
+
/** name of the order item (Sales - OrderItem)
|
|
378
368
|
*
|
|
379
|
-
* @type {
|
|
380
|
-
* @enum {OrderItemBillingPeriodType}
|
|
369
|
+
* @type {TEXT}
|
|
381
370
|
* @hidden This field is hidden in the UI
|
|
382
371
|
*/
|
|
383
|
-
|
|
384
|
-
/**
|
|
372
|
+
Name: string;
|
|
373
|
+
/** id of the service (data/voice) on the providers network (Sales - OrderItem)
|
|
385
374
|
*
|
|
386
|
-
* @type {
|
|
387
|
-
* @default 0
|
|
375
|
+
* @type {TEXT}
|
|
388
376
|
* @hidden This field is hidden in the UI
|
|
389
377
|
*/
|
|
390
|
-
|
|
391
|
-
/**
|
|
378
|
+
NetworkServiceId: string;
|
|
379
|
+
/** next billing date that this item will be on an invoice (Sales - OrderItem)
|
|
392
380
|
*
|
|
393
|
-
* @type {
|
|
394
|
-
* @
|
|
381
|
+
* @type {DATE}
|
|
382
|
+
* @format DD/MM/YYYY
|
|
395
383
|
* @hidden This field is hidden in the UI
|
|
396
384
|
*/
|
|
397
|
-
|
|
398
|
-
/**
|
|
385
|
+
NextBillingDate: string;
|
|
386
|
+
/** The item will be invoiced on this date (Sales - OrderItem)
|
|
399
387
|
*
|
|
400
388
|
* @type {DATE}
|
|
401
389
|
* @format DD/MM/YYYY
|
|
402
390
|
* @hidden This field is hidden in the UI
|
|
403
391
|
*/
|
|
404
|
-
|
|
405
|
-
/**
|
|
392
|
+
NextInvoiceDate: string;
|
|
393
|
+
/** PriceMatchedTo
|
|
406
394
|
*
|
|
407
|
-
* @type {
|
|
408
|
-
* @
|
|
409
|
-
* @hidden This field is hidden in the UI
|
|
395
|
+
* @type {ENUM}
|
|
396
|
+
* @enum {OrderItemPriceMatchedTo}
|
|
410
397
|
*/
|
|
411
|
-
|
|
398
|
+
PriceMatchedTo: OrderItemPriceMatchedTo;
|
|
412
399
|
/** category of the product being sold (Sales - OrderItem)
|
|
413
400
|
*
|
|
414
401
|
* @type {TEXT}
|
|
415
402
|
* @hidden This field is hidden in the UI
|
|
416
403
|
*/
|
|
417
404
|
ProductCategory: string;
|
|
418
|
-
/**
|
|
419
|
-
*
|
|
420
|
-
* @type {NUMBER}
|
|
421
|
-
* @hidden This field is hidden in the UI
|
|
422
|
-
*/
|
|
423
|
-
Discount2Length: number;
|
|
424
|
-
/** the line item subtotal (Sales - OrderItem)
|
|
405
|
+
/** product customer type (Sales - OrderItem)
|
|
425
406
|
*
|
|
426
|
-
* @type {
|
|
427
|
-
* @hidden This field is hidden in the UI
|
|
407
|
+
* @type {TEXT}
|
|
428
408
|
*/
|
|
429
|
-
|
|
430
|
-
/**
|
|
409
|
+
ProductCustomerType: string;
|
|
410
|
+
/** ProductPbRelationId (Sales - OrderItem)
|
|
431
411
|
*
|
|
432
|
-
* @type {
|
|
412
|
+
* @type {UUID}
|
|
433
413
|
* @hidden This field is hidden in the UI
|
|
434
414
|
*/
|
|
435
|
-
|
|
436
|
-
/**
|
|
415
|
+
ProductPbRelationId: string;
|
|
416
|
+
/** id of the product (Sales - OrderItem)
|
|
437
417
|
*
|
|
438
|
-
* @type {
|
|
439
|
-
* @format DD/MM/YYYY
|
|
418
|
+
* @type {UUID}
|
|
440
419
|
* @hidden This field is hidden in the UI
|
|
441
420
|
*/
|
|
442
|
-
|
|
443
|
-
/**
|
|
421
|
+
ProductRef: string;
|
|
422
|
+
/** the type of product being sold (Sales - OrderItem)
|
|
444
423
|
*
|
|
445
424
|
* @type {TEXT}
|
|
446
|
-
* @default
|
|
447
425
|
* @hidden This field is hidden in the UI
|
|
448
426
|
*/
|
|
449
|
-
|
|
450
|
-
/**
|
|
427
|
+
ProductType: string;
|
|
428
|
+
/** value less discount and taxes, excluding free periods (Sales - OrderItem)
|
|
451
429
|
*
|
|
452
|
-
* @type {
|
|
453
|
-
* @
|
|
430
|
+
* @type {CURRENCY}
|
|
431
|
+
* @default 0
|
|
454
432
|
* @hidden This field is hidden in the UI
|
|
455
433
|
*/
|
|
456
|
-
|
|
457
|
-
/**
|
|
434
|
+
ProjectedArpu: string;
|
|
435
|
+
/** quantity item (Sales - OrderItem)
|
|
458
436
|
*
|
|
459
|
-
* @type {
|
|
460
|
-
* @
|
|
437
|
+
* @type {NUMBER}
|
|
438
|
+
* @default 1
|
|
461
439
|
* @hidden This field is hidden in the UI
|
|
462
440
|
*/
|
|
463
|
-
|
|
464
|
-
/**
|
|
441
|
+
Quantity: number;
|
|
442
|
+
/** Fix Brsk migration
|
|
465
443
|
*
|
|
466
444
|
* @type {TEXT}
|
|
445
|
+
*/
|
|
446
|
+
ServiceId: string;
|
|
447
|
+
/** the line item subtotal (Sales - OrderItem)
|
|
448
|
+
*
|
|
449
|
+
* @type {CURRENCY}
|
|
467
450
|
* @hidden This field is hidden in the UI
|
|
468
451
|
*/
|
|
469
|
-
|
|
470
|
-
/**
|
|
452
|
+
Subtotal: string;
|
|
453
|
+
/** is the item taxable (Sales - OrderItem)
|
|
471
454
|
*
|
|
472
|
-
* @type {
|
|
455
|
+
* @type {ENUM}
|
|
456
|
+
* @default YES
|
|
457
|
+
* @enum {OrderItemTaxable}
|
|
473
458
|
* @hidden This field is hidden in the UI
|
|
474
459
|
*/
|
|
475
|
-
|
|
460
|
+
Taxable: OrderItemTaxable;
|
|
476
461
|
/** is tax included in the UnitPrice (Sales - OrderItem)
|
|
477
462
|
*
|
|
478
463
|
* @type {ENUM}
|
|
@@ -481,52 +466,67 @@ export interface OrderItemProperties {
|
|
|
481
466
|
* @hidden This field is hidden in the UI
|
|
482
467
|
*/
|
|
483
468
|
TaxIncluded: OrderItemTaxIncluded;
|
|
484
|
-
/**
|
|
469
|
+
/** tax rate for the item (Sales - OrderItem)
|
|
485
470
|
*
|
|
486
|
-
* @type {
|
|
487
|
-
* @
|
|
471
|
+
* @type {NUMBER}
|
|
472
|
+
* @default 0
|
|
488
473
|
* @hidden This field is hidden in the UI
|
|
489
474
|
*/
|
|
490
|
-
|
|
491
|
-
/**
|
|
475
|
+
TaxRate: number;
|
|
476
|
+
/** total line item discounts (Sales - OrderItem)
|
|
492
477
|
*
|
|
493
|
-
* @type {
|
|
478
|
+
* @type {CURRENCY}
|
|
479
|
+
* @default 0
|
|
480
|
+
* @hidden This field is hidden in the UI
|
|
494
481
|
*/
|
|
495
|
-
|
|
496
|
-
/** the
|
|
482
|
+
TotalDiscounts: string;
|
|
483
|
+
/** total price for the line item (Sales - OrderItem)
|
|
497
484
|
*
|
|
498
|
-
* @type {
|
|
499
|
-
* @
|
|
485
|
+
* @type {CURRENCY}
|
|
486
|
+
* @default 0
|
|
500
487
|
* @hidden This field is hidden in the UI
|
|
501
488
|
*/
|
|
502
|
-
|
|
503
|
-
/**
|
|
489
|
+
TotalPrice: string;
|
|
490
|
+
/** total taxes (Sales - OrderItem)
|
|
504
491
|
*
|
|
505
|
-
* @type {
|
|
506
|
-
* @default
|
|
507
|
-
* @enum {OrderItemActivationStatus}
|
|
492
|
+
* @type {CURRENCY}
|
|
493
|
+
* @default 0
|
|
508
494
|
* @hidden This field is hidden in the UI
|
|
509
495
|
*/
|
|
510
|
-
|
|
511
|
-
/**
|
|
496
|
+
TotalTaxAmount: string;
|
|
497
|
+
/** the date the trial period ends (Sales - OrderItem)
|
|
512
498
|
*
|
|
513
|
-
* @type {
|
|
499
|
+
* @type {DATE}
|
|
500
|
+
* @format DD/MM/YYYY
|
|
514
501
|
* @hidden This field is hidden in the UI
|
|
515
502
|
*/
|
|
516
|
-
|
|
517
|
-
/**
|
|
503
|
+
TrialEndDate: string;
|
|
504
|
+
/** the trial length (mapped from the Product<>Pricebook config) (Sales - OrderItem)
|
|
505
|
+
*
|
|
506
|
+
* @type {NUMBER}
|
|
507
|
+
* @hidden This field is hidden in the UI
|
|
508
|
+
*/
|
|
509
|
+
TrialLength: number;
|
|
510
|
+
/** the trial unit (mapped from the Product<>Pricebook config) (Sales - OrderItem)
|
|
518
511
|
*
|
|
519
512
|
* @type {TEXT}
|
|
520
513
|
* @hidden This field is hidden in the UI
|
|
521
514
|
*/
|
|
522
|
-
|
|
523
|
-
/**
|
|
515
|
+
TrialUnit: string;
|
|
516
|
+
/** suggested retail price cost + markup (Sales - OrderItem)
|
|
524
517
|
*
|
|
525
|
-
* @type {
|
|
518
|
+
* @type {CURRENCY}
|
|
526
519
|
* @default 0
|
|
527
520
|
* @hidden This field is hidden in the UI
|
|
528
521
|
*/
|
|
529
|
-
|
|
522
|
+
UnitPrice: string;
|
|
523
|
+
/** Virtual Local Area Network Identifier (e.g. 101) (Sales - OrderItem)
|
|
524
|
+
*
|
|
525
|
+
* @type {TEXT}
|
|
526
|
+
* @default
|
|
527
|
+
* @hidden This field is hidden in the UI
|
|
528
|
+
*/
|
|
529
|
+
Vlanid: string;
|
|
530
530
|
}
|
|
531
531
|
/**
|
|
532
532
|
* OrderItem entity from OrderModule
|