@mj-biz-apps/orders-entities 5.27.0 → 5.29.0
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/generated/entities/__mj_BizAppsOrders.d.ts +757 -94
- package/dist/generated/entities/__mj_BizAppsOrders.d.ts.map +1 -1
- package/dist/generated/entities/__mj_BizAppsOrders.js +1303 -189
- package/dist/generated/entities/__mj_BizAppsOrders.js.map +1 -1
- package/dist/generated/remote_operations.d.ts +565 -312
- package/dist/generated/remote_operations.d.ts.map +1 -1
- package/dist/generated/remote_operations.js +154 -100
- package/dist/generated/remote_operations.js.map +1 -1
- package/dist/index.d.ts +1 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +2 -0
- package/dist/index.js.map +1 -1
- package/dist/renewal-price.d.ts +88 -0
- package/dist/renewal-price.d.ts.map +1 -0
- package/dist/renewal-price.js +101 -0
- package/dist/renewal-price.js.map +1 -0
- package/package.json +3 -3
|
@@ -646,8 +646,9 @@ export declare const mjBizAppsOrdersEventOrderLineSchema: z.ZodObject<{
|
|
|
646
646
|
BilledToDate: z.ZodNumber;
|
|
647
647
|
RecognizedToDate: z.ZodNumber;
|
|
648
648
|
ShipToAddressSnapshot: z.ZodNullable<z.ZodString>;
|
|
649
|
-
Person: z.ZodString;
|
|
650
649
|
SubscriptionAction: z.ZodNullable<z.ZodString>;
|
|
650
|
+
AcknowledgesCoverageOverlap: z.ZodBoolean;
|
|
651
|
+
Person: z.ZodString;
|
|
651
652
|
}, "strip", z.ZodTypeAny, {
|
|
652
653
|
ID?: string;
|
|
653
654
|
Description?: string;
|
|
@@ -703,6 +704,7 @@ export declare const mjBizAppsOrdersEventOrderLineSchema: z.ZodObject<{
|
|
|
703
704
|
RecognizedToDate?: number;
|
|
704
705
|
ShipToAddressSnapshot?: string;
|
|
705
706
|
SubscriptionAction?: string;
|
|
707
|
+
AcknowledgesCoverageOverlap?: boolean;
|
|
706
708
|
}, {
|
|
707
709
|
ID?: string;
|
|
708
710
|
Description?: string;
|
|
@@ -758,6 +760,7 @@ export declare const mjBizAppsOrdersEventOrderLineSchema: z.ZodObject<{
|
|
|
758
760
|
RecognizedToDate?: number;
|
|
759
761
|
ShipToAddressSnapshot?: string;
|
|
760
762
|
SubscriptionAction?: string;
|
|
763
|
+
AcknowledgesCoverageOverlap?: boolean;
|
|
761
764
|
}>;
|
|
762
765
|
export type mjBizAppsOrdersEventOrderLineEntityType = z.infer<typeof mjBizAppsOrdersEventOrderLineSchema>;
|
|
763
766
|
/**
|
|
@@ -795,6 +798,8 @@ export declare const mjBizAppsOrdersEventProductSchema: z.ZodObject<{
|
|
|
795
798
|
EntitlementValidityMode: z.ZodNullable<z.ZodString>;
|
|
796
799
|
PricingDriverClass: z.ZodNullable<z.ZodString>;
|
|
797
800
|
MaxQuantityPerLine: z.ZodNullable<z.ZodNumber>;
|
|
801
|
+
SubscriptionFamilyID: z.ZodNullable<z.ZodString>;
|
|
802
|
+
RenewalIncreasePercent: z.ZodNullable<z.ZodNumber>;
|
|
798
803
|
VenueAddress: z.ZodNullable<z.ZodString>;
|
|
799
804
|
}, "strip", z.ZodTypeAny, {
|
|
800
805
|
ID?: string;
|
|
@@ -828,6 +833,8 @@ export declare const mjBizAppsOrdersEventProductSchema: z.ZodObject<{
|
|
|
828
833
|
EntitlementValidityMode?: string;
|
|
829
834
|
PricingDriverClass?: string;
|
|
830
835
|
MaxQuantityPerLine?: number;
|
|
836
|
+
SubscriptionFamilyID?: string;
|
|
837
|
+
RenewalIncreasePercent?: number;
|
|
831
838
|
VenueAddress?: string;
|
|
832
839
|
}, {
|
|
833
840
|
ID?: string;
|
|
@@ -861,6 +868,8 @@ export declare const mjBizAppsOrdersEventProductSchema: z.ZodObject<{
|
|
|
861
868
|
EntitlementValidityMode?: string;
|
|
862
869
|
PricingDriverClass?: string;
|
|
863
870
|
MaxQuantityPerLine?: number;
|
|
871
|
+
SubscriptionFamilyID?: string;
|
|
872
|
+
RenewalIncreasePercent?: number;
|
|
864
873
|
VenueAddress?: string;
|
|
865
874
|
}>;
|
|
866
875
|
export type mjBizAppsOrdersEventProductEntityType = z.infer<typeof mjBizAppsOrdersEventProductSchema>;
|
|
@@ -1286,12 +1295,14 @@ export declare const mjBizAppsOrdersOrderCompanyPolicySchema: z.ZodObject<{
|
|
|
1286
1295
|
__mj_CreatedAt: z.ZodDate;
|
|
1287
1296
|
__mj_UpdatedAt: z.ZodDate;
|
|
1288
1297
|
PricingDriverClass: z.ZodNullable<z.ZodString>;
|
|
1298
|
+
RenewalIncreasePercent: z.ZodNullable<z.ZodNumber>;
|
|
1289
1299
|
DefaultPriceList: z.ZodNullable<z.ZodString>;
|
|
1290
1300
|
}, "strip", z.ZodTypeAny, {
|
|
1291
1301
|
ID?: string;
|
|
1292
1302
|
__mj_CreatedAt?: Date;
|
|
1293
1303
|
__mj_UpdatedAt?: Date;
|
|
1294
1304
|
PricingDriverClass?: string;
|
|
1305
|
+
RenewalIncreasePercent?: number;
|
|
1295
1306
|
AllowPromotionStacking?: boolean;
|
|
1296
1307
|
StackingMode?: "Additive" | "Sequential";
|
|
1297
1308
|
RefuseUnpricedLines?: boolean;
|
|
@@ -1303,6 +1314,7 @@ export declare const mjBizAppsOrdersOrderCompanyPolicySchema: z.ZodObject<{
|
|
|
1303
1314
|
__mj_CreatedAt?: Date;
|
|
1304
1315
|
__mj_UpdatedAt?: Date;
|
|
1305
1316
|
PricingDriverClass?: string;
|
|
1317
|
+
RenewalIncreasePercent?: number;
|
|
1306
1318
|
AllowPromotionStacking?: boolean;
|
|
1307
1319
|
StackingMode?: "Additive" | "Sequential";
|
|
1308
1320
|
RefuseUnpricedLines?: boolean;
|
|
@@ -1896,6 +1908,7 @@ export declare const mjBizAppsOrdersOrderLineSchema: z.ZodObject<{
|
|
|
1896
1908
|
RecognizedToDate: z.ZodNumber;
|
|
1897
1909
|
ShipToAddressSnapshot: z.ZodNullable<z.ZodString>;
|
|
1898
1910
|
SubscriptionAction: z.ZodNullable<z.ZodUnion<[z.ZodLiteral<"CreateNew">, z.ZodLiteral<"ExtendExisting">]>>;
|
|
1911
|
+
AcknowledgesCoverageOverlap: z.ZodBoolean;
|
|
1899
1912
|
OrderHeader: z.ZodString;
|
|
1900
1913
|
Product: z.ZodString;
|
|
1901
1914
|
Company: z.ZodString;
|
|
@@ -1957,6 +1970,7 @@ export declare const mjBizAppsOrdersOrderLineSchema: z.ZodObject<{
|
|
|
1957
1970
|
RecognizedToDate?: number;
|
|
1958
1971
|
ShipToAddressSnapshot?: string;
|
|
1959
1972
|
SubscriptionAction?: "CreateNew" | "ExtendExisting";
|
|
1973
|
+
AcknowledgesCoverageOverlap?: boolean;
|
|
1960
1974
|
ShipToOrganization?: string;
|
|
1961
1975
|
ShipToPerson?: string;
|
|
1962
1976
|
Product?: string;
|
|
@@ -2013,6 +2027,7 @@ export declare const mjBizAppsOrdersOrderLineSchema: z.ZodObject<{
|
|
|
2013
2027
|
RecognizedToDate?: number;
|
|
2014
2028
|
ShipToAddressSnapshot?: string;
|
|
2015
2029
|
SubscriptionAction?: "CreateNew" | "ExtendExisting";
|
|
2030
|
+
AcknowledgesCoverageOverlap?: boolean;
|
|
2016
2031
|
ShipToOrganization?: string;
|
|
2017
2032
|
ShipToPerson?: string;
|
|
2018
2033
|
Product?: string;
|
|
@@ -2850,6 +2865,7 @@ export declare const mjBizAppsOrdersProductCategorySchema: z.ZodObject<{
|
|
|
2850
2865
|
__mj_CreatedAt: z.ZodDate;
|
|
2851
2866
|
__mj_UpdatedAt: z.ZodDate;
|
|
2852
2867
|
PricingDriverClass: z.ZodNullable<z.ZodString>;
|
|
2868
|
+
RenewalIncreasePercent: z.ZodNullable<z.ZodNumber>;
|
|
2853
2869
|
Company: z.ZodString;
|
|
2854
2870
|
ParentProductCategory: z.ZodNullable<z.ZodString>;
|
|
2855
2871
|
RootParentProductCategoryID: z.ZodNullable<z.ZodString>;
|
|
@@ -2868,6 +2884,7 @@ export declare const mjBizAppsOrdersProductCategorySchema: z.ZodObject<{
|
|
|
2868
2884
|
CompanyID?: string;
|
|
2869
2885
|
Company?: string;
|
|
2870
2886
|
PricingDriverClass?: string;
|
|
2887
|
+
RenewalIncreasePercent?: number;
|
|
2871
2888
|
ParentProductCategoryID?: string;
|
|
2872
2889
|
DefaultIsTaxable?: boolean;
|
|
2873
2890
|
DefaultTaxCategory?: string;
|
|
@@ -2891,6 +2908,7 @@ export declare const mjBizAppsOrdersProductCategorySchema: z.ZodObject<{
|
|
|
2891
2908
|
CompanyID?: string;
|
|
2892
2909
|
Company?: string;
|
|
2893
2910
|
PricingDriverClass?: string;
|
|
2911
|
+
RenewalIncreasePercent?: number;
|
|
2894
2912
|
ParentProductCategoryID?: string;
|
|
2895
2913
|
DefaultIsTaxable?: boolean;
|
|
2896
2914
|
DefaultTaxCategory?: string;
|
|
@@ -3157,12 +3175,15 @@ export declare const mjBizAppsOrdersProductSchema: z.ZodObject<{
|
|
|
3157
3175
|
__mj_UpdatedAt: z.ZodDate;
|
|
3158
3176
|
PricingDriverClass: z.ZodNullable<z.ZodString>;
|
|
3159
3177
|
MaxQuantityPerLine: z.ZodNullable<z.ZodNumber>;
|
|
3178
|
+
SubscriptionFamilyID: z.ZodNullable<z.ZodString>;
|
|
3179
|
+
RenewalIncreasePercent: z.ZodNullable<z.ZodNumber>;
|
|
3160
3180
|
ProductType: z.ZodString;
|
|
3161
3181
|
ProductCategory: z.ZodString;
|
|
3162
3182
|
Company: z.ZodString;
|
|
3163
3183
|
SuccessorProduct: z.ZodNullable<z.ZodString>;
|
|
3164
3184
|
RevenueRecognitionType: z.ZodString;
|
|
3165
3185
|
SubscriptionType: z.ZodNullable<z.ZodString>;
|
|
3186
|
+
SubscriptionFamily: z.ZodNullable<z.ZodString>;
|
|
3166
3187
|
}, "strip", z.ZodTypeAny, {
|
|
3167
3188
|
ID?: string;
|
|
3168
3189
|
Name?: string;
|
|
@@ -3188,11 +3209,14 @@ export declare const mjBizAppsOrdersProductSchema: z.ZodObject<{
|
|
|
3188
3209
|
EntitlementValidityMode?: "EventWindow" | "FixedDuration" | "Perpetual" | "SubscriptionTerm";
|
|
3189
3210
|
PricingDriverClass?: string;
|
|
3190
3211
|
MaxQuantityPerLine?: number;
|
|
3212
|
+
SubscriptionFamilyID?: string;
|
|
3213
|
+
RenewalIncreasePercent?: number;
|
|
3191
3214
|
ProductCategory?: string;
|
|
3192
3215
|
ProductType?: string;
|
|
3193
3216
|
SuccessorProduct?: string;
|
|
3194
3217
|
RevenueRecognitionType?: string;
|
|
3195
3218
|
SubscriptionType?: string;
|
|
3219
|
+
SubscriptionFamily?: string;
|
|
3196
3220
|
}, {
|
|
3197
3221
|
ID?: string;
|
|
3198
3222
|
Name?: string;
|
|
@@ -3218,11 +3242,14 @@ export declare const mjBizAppsOrdersProductSchema: z.ZodObject<{
|
|
|
3218
3242
|
EntitlementValidityMode?: "EventWindow" | "FixedDuration" | "Perpetual" | "SubscriptionTerm";
|
|
3219
3243
|
PricingDriverClass?: string;
|
|
3220
3244
|
MaxQuantityPerLine?: number;
|
|
3245
|
+
SubscriptionFamilyID?: string;
|
|
3246
|
+
RenewalIncreasePercent?: number;
|
|
3221
3247
|
ProductCategory?: string;
|
|
3222
3248
|
ProductType?: string;
|
|
3223
3249
|
SuccessorProduct?: string;
|
|
3224
3250
|
RevenueRecognitionType?: string;
|
|
3225
3251
|
SubscriptionType?: string;
|
|
3252
|
+
SubscriptionFamily?: string;
|
|
3226
3253
|
}>;
|
|
3227
3254
|
export type mjBizAppsOrdersProductEntityType = z.infer<typeof mjBizAppsOrdersProductSchema>;
|
|
3228
3255
|
/**
|
|
@@ -3710,6 +3737,41 @@ export declare const mjBizAppsOrdersSubscriptionEventSchema: z.ZodObject<{
|
|
|
3710
3737
|
EventData?: string;
|
|
3711
3738
|
}>;
|
|
3712
3739
|
export type mjBizAppsOrdersSubscriptionEventEntityType = z.infer<typeof mjBizAppsOrdersSubscriptionEventSchema>;
|
|
3740
|
+
/**
|
|
3741
|
+
* zod schema definition for the entity MJ_BizApps_Orders: Subscription Families
|
|
3742
|
+
*/
|
|
3743
|
+
export declare const mjBizAppsOrdersSubscriptionFamilySchema: z.ZodObject<{
|
|
3744
|
+
ID: z.ZodString;
|
|
3745
|
+
CompanyID: z.ZodString;
|
|
3746
|
+
Code: z.ZodString;
|
|
3747
|
+
Name: z.ZodString;
|
|
3748
|
+
Description: z.ZodNullable<z.ZodString>;
|
|
3749
|
+
IsActive: z.ZodBoolean;
|
|
3750
|
+
__mj_CreatedAt: z.ZodDate;
|
|
3751
|
+
__mj_UpdatedAt: z.ZodDate;
|
|
3752
|
+
Company: z.ZodString;
|
|
3753
|
+
}, "strip", z.ZodTypeAny, {
|
|
3754
|
+
ID?: string;
|
|
3755
|
+
Code?: string;
|
|
3756
|
+
Name?: string;
|
|
3757
|
+
Description?: string;
|
|
3758
|
+
IsActive?: boolean;
|
|
3759
|
+
__mj_CreatedAt?: Date;
|
|
3760
|
+
__mj_UpdatedAt?: Date;
|
|
3761
|
+
CompanyID?: string;
|
|
3762
|
+
Company?: string;
|
|
3763
|
+
}, {
|
|
3764
|
+
ID?: string;
|
|
3765
|
+
Code?: string;
|
|
3766
|
+
Name?: string;
|
|
3767
|
+
Description?: string;
|
|
3768
|
+
IsActive?: boolean;
|
|
3769
|
+
__mj_CreatedAt?: Date;
|
|
3770
|
+
__mj_UpdatedAt?: Date;
|
|
3771
|
+
CompanyID?: string;
|
|
3772
|
+
Company?: string;
|
|
3773
|
+
}>;
|
|
3774
|
+
export type mjBizAppsOrdersSubscriptionFamilyEntityType = z.infer<typeof mjBizAppsOrdersSubscriptionFamilySchema>;
|
|
3713
3775
|
/**
|
|
3714
3776
|
* zod schema definition for the entity MJ_BizApps_Orders: Subscription Sequences
|
|
3715
3777
|
*/
|
|
@@ -3913,6 +3975,8 @@ export declare const mjBizAppsOrdersSubscriptionSchema: z.ZodObject<{
|
|
|
3913
3975
|
__mj_CreatedAt: z.ZodDate;
|
|
3914
3976
|
__mj_UpdatedAt: z.ZodDate;
|
|
3915
3977
|
DefaultCustomerPaymentMethodID: z.ZodNullable<z.ZodString>;
|
|
3978
|
+
RenewalIncreasePercent: z.ZodNullable<z.ZodNumber>;
|
|
3979
|
+
CarryDiscountOnRenewal: z.ZodBoolean;
|
|
3916
3980
|
Company: z.ZodString;
|
|
3917
3981
|
SubscriptionType: z.ZodString;
|
|
3918
3982
|
Product: z.ZodString;
|
|
@@ -3934,6 +3998,7 @@ export declare const mjBizAppsOrdersSubscriptionSchema: z.ZodObject<{
|
|
|
3934
3998
|
BeneficiaryPerson?: string;
|
|
3935
3999
|
ProductID?: string;
|
|
3936
4000
|
SubscriptionTypeID?: string;
|
|
4001
|
+
RenewalIncreasePercent?: number;
|
|
3937
4002
|
PaymentProviderID?: string;
|
|
3938
4003
|
PaymentProvider?: string;
|
|
3939
4004
|
CanceledAt?: Date;
|
|
@@ -3950,6 +4015,7 @@ export declare const mjBizAppsOrdersSubscriptionSchema: z.ZodObject<{
|
|
|
3950
4015
|
MigratesFromSubscriptionID?: string;
|
|
3951
4016
|
MigratesToSubscriptionID?: string;
|
|
3952
4017
|
DefaultCustomerPaymentMethodID?: string;
|
|
4018
|
+
CarryDiscountOnRenewal?: boolean;
|
|
3953
4019
|
HolderOrganization?: string;
|
|
3954
4020
|
MigratesFromSubscription?: string;
|
|
3955
4021
|
MigratesToSubscription?: string;
|
|
@@ -3966,6 +4032,7 @@ export declare const mjBizAppsOrdersSubscriptionSchema: z.ZodObject<{
|
|
|
3966
4032
|
BeneficiaryPerson?: string;
|
|
3967
4033
|
ProductID?: string;
|
|
3968
4034
|
SubscriptionTypeID?: string;
|
|
4035
|
+
RenewalIncreasePercent?: number;
|
|
3969
4036
|
PaymentProviderID?: string;
|
|
3970
4037
|
PaymentProvider?: string;
|
|
3971
4038
|
CanceledAt?: Date;
|
|
@@ -3982,6 +4049,7 @@ export declare const mjBizAppsOrdersSubscriptionSchema: z.ZodObject<{
|
|
|
3982
4049
|
MigratesFromSubscriptionID?: string;
|
|
3983
4050
|
MigratesToSubscriptionID?: string;
|
|
3984
4051
|
DefaultCustomerPaymentMethodID?: string;
|
|
4052
|
+
CarryDiscountOnRenewal?: boolean;
|
|
3985
4053
|
HolderOrganization?: string;
|
|
3986
4054
|
MigratesFromSubscription?: string;
|
|
3987
4055
|
MigratesToSubscription?: string;
|
|
@@ -4137,6 +4205,21 @@ export declare class mjBizAppsOrdersCheckoutSessionStepEntity extends BaseEntity
|
|
|
4137
4205
|
*/
|
|
4138
4206
|
Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
|
|
4139
4207
|
/**
|
|
4208
|
+
* Validate() method override for MJ_BizApps_Orders: Checkout Session Steps entity. This is an auto-generated method that invokes the generated validators for this entity for the following fields:
|
|
4209
|
+
* * Attempts: The number of attempts must be zero or a positive number. This ensures that the system does not record negative attempt counts.
|
|
4210
|
+
* @public
|
|
4211
|
+
* @method
|
|
4212
|
+
* @override
|
|
4213
|
+
*/
|
|
4214
|
+
Validate(): ValidationResult;
|
|
4215
|
+
/**
|
|
4216
|
+
* The number of attempts must be zero or a positive number. This ensures that the system does not record negative attempt counts.
|
|
4217
|
+
* @param result - the ValidationResult object to add any errors or warnings to
|
|
4218
|
+
* @public
|
|
4219
|
+
* @method
|
|
4220
|
+
*/
|
|
4221
|
+
ValidateAttemptsGreaterThanOrEqualToZero(result: ValidationResult): void;
|
|
4222
|
+
/**
|
|
4140
4223
|
* * Field Name: ID
|
|
4141
4224
|
* * Display Name: ID
|
|
4142
4225
|
* * SQL Data Type: uniqueidentifier
|
|
@@ -4708,14 +4791,14 @@ export declare class mjBizAppsOrdersCustomerPaymentMethodEntity extends BaseEnti
|
|
|
4708
4791
|
Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
|
|
4709
4792
|
/**
|
|
4710
4793
|
* Validate() method override for MJ_BizApps_Orders: Customer Payment Methods entity. This is an auto-generated method that invokes the generated validators for this entity for the following fields:
|
|
4711
|
-
* * Table-Level:
|
|
4794
|
+
* * Table-Level: Each record must be associated with an owner, requiring either an Owner Person or an Owner Organization to be specified.
|
|
4712
4795
|
* @public
|
|
4713
4796
|
* @method
|
|
4714
4797
|
* @override
|
|
4715
4798
|
*/
|
|
4716
4799
|
Validate(): ValidationResult;
|
|
4717
4800
|
/**
|
|
4718
|
-
*
|
|
4801
|
+
* Each record must be associated with an owner, requiring either an Owner Person or an Owner Organization to be specified.
|
|
4719
4802
|
* @param result - the ValidationResult object to add any errors or warnings to
|
|
4720
4803
|
* @public
|
|
4721
4804
|
* @method
|
|
@@ -4837,7 +4920,7 @@ export declare class mjBizAppsOrdersCustomerPaymentTermsEntity extends BaseEntit
|
|
|
4837
4920
|
Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
|
|
4838
4921
|
/**
|
|
4839
4922
|
* Validate() method override for MJ_BizApps_Orders: Customer Payment Terms entity. This is an auto-generated method that invokes the generated validators for this entity for the following fields:
|
|
4840
|
-
* * Table-Level: If both
|
|
4923
|
+
* * Table-Level: If both the start date and end date are specified, the end date must be later than the start date.
|
|
4841
4924
|
* * Table-Level: Each record must be associated with either an Organization or a Person, but not both. One of these associations is required to ensure proper ownership.
|
|
4842
4925
|
* @public
|
|
4843
4926
|
* @method
|
|
@@ -4845,7 +4928,7 @@ export declare class mjBizAppsOrdersCustomerPaymentTermsEntity extends BaseEntit
|
|
|
4845
4928
|
*/
|
|
4846
4929
|
Validate(): ValidationResult;
|
|
4847
4930
|
/**
|
|
4848
|
-
* If both
|
|
4931
|
+
* If both the start date and end date are specified, the end date must be later than the start date.
|
|
4849
4932
|
* @param result - the ValidationResult object to add any errors or warnings to
|
|
4850
4933
|
* @public
|
|
4851
4934
|
* @method
|
|
@@ -5154,6 +5237,21 @@ export declare class mjBizAppsOrdersDimensionDefaultEntity extends BaseEntity<mj
|
|
|
5154
5237
|
*/
|
|
5155
5238
|
Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
|
|
5156
5239
|
/**
|
|
5240
|
+
* Validate() method override for MJ_BizApps_Orders: Dimension Defaults entity. This is an auto-generated method that invokes the generated validators for this entity for the following fields:
|
|
5241
|
+
* * Table-Level: The end date and time must be after the start date and time when both are provided.
|
|
5242
|
+
* @public
|
|
5243
|
+
* @method
|
|
5244
|
+
* @override
|
|
5245
|
+
*/
|
|
5246
|
+
Validate(): ValidationResult;
|
|
5247
|
+
/**
|
|
5248
|
+
* The end date and time must be after the start date and time when both are provided.
|
|
5249
|
+
* @param result - the ValidationResult object to add any errors or warnings to
|
|
5250
|
+
* @public
|
|
5251
|
+
* @method
|
|
5252
|
+
*/
|
|
5253
|
+
ValidateEndedAtAfterStartedAt(result: ValidationResult): void;
|
|
5254
|
+
/**
|
|
5157
5255
|
* * Field Name: ID
|
|
5158
5256
|
* * Display Name: ID
|
|
5159
5257
|
* * SQL Data Type: uniqueidentifier
|
|
@@ -5292,6 +5390,37 @@ export declare class mjBizAppsOrdersEntitlementAccessOverrideEntity extends Base
|
|
|
5292
5390
|
*/
|
|
5293
5391
|
Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
|
|
5294
5392
|
/**
|
|
5393
|
+
* Validate() method override for MJ_BizApps_Orders: Entitlement Access Overrides entity. This is an auto-generated method that invokes the generated validators for this entity for the following fields:
|
|
5394
|
+
* * Reason: The reason field cannot be empty or consist only of whitespace characters.
|
|
5395
|
+
* * Table-Level: Both the Approval Task ID and the Approval Task Raised At timestamp must either be set together or both left blank to ensure data consistency.
|
|
5396
|
+
* * Table-Level: Enforces that decision details (who decided and when) are only populated when appropriate for the record's status. 'Requested' records must not have decision details, 'Withdrawn' records must have a decision date, and 'Expired', 'Rejected', or 'Approved' records must have both a decision maker and a decision date.
|
|
5397
|
+
* @public
|
|
5398
|
+
* @method
|
|
5399
|
+
* @override
|
|
5400
|
+
*/
|
|
5401
|
+
Validate(): ValidationResult;
|
|
5402
|
+
/**
|
|
5403
|
+
* The reason field cannot be empty or consist only of whitespace characters.
|
|
5404
|
+
* @param result - the ValidationResult object to add any errors or warnings to
|
|
5405
|
+
* @public
|
|
5406
|
+
* @method
|
|
5407
|
+
*/
|
|
5408
|
+
ValidateReasonNotEmpty(result: ValidationResult): void;
|
|
5409
|
+
/**
|
|
5410
|
+
* Both the Approval Task ID and the Approval Task Raised At timestamp must either be set together or both left blank to ensure data consistency.
|
|
5411
|
+
* @param result - the ValidationResult object to add any errors or warnings to
|
|
5412
|
+
* @public
|
|
5413
|
+
* @method
|
|
5414
|
+
*/
|
|
5415
|
+
ValidateApprovalTaskAndRaisedAtCoexistence(result: ValidationResult): void;
|
|
5416
|
+
/**
|
|
5417
|
+
* Enforces that decision details (who decided and when) are only populated when appropriate for the record's status. 'Requested' records must not have decision details, 'Withdrawn' records must have a decision date, and 'Expired', 'Rejected', or 'Approved' records must have both a decision maker and a decision date.
|
|
5418
|
+
* @param result - the ValidationResult object to add any errors or warnings to
|
|
5419
|
+
* @public
|
|
5420
|
+
* @method
|
|
5421
|
+
*/
|
|
5422
|
+
ValidateDecisionFieldsByStatus(result: ValidationResult): void;
|
|
5423
|
+
/**
|
|
5295
5424
|
* * Field Name: ID
|
|
5296
5425
|
* * Display Name: ID
|
|
5297
5426
|
* * SQL Data Type: uniqueidentifier
|
|
@@ -5477,7 +5606,8 @@ export declare class mjBizAppsOrdersEntitlementGrantEntity extends BaseEntity<mj
|
|
|
5477
5606
|
Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
|
|
5478
5607
|
/**
|
|
5479
5608
|
* Validate() method override for MJ_BizApps_Orders: Entitlement Grants entity. This is an auto-generated method that invokes the generated validators for this entity for the following fields:
|
|
5480
|
-
* * Table-Level: If the status is 'Revoked', a revocation date must be
|
|
5609
|
+
* * Table-Level: If the status is set to 'Revoked', a revocation date must be provided. Conversely, if the status is not 'Revoked', the revocation date must be empty.
|
|
5610
|
+
* * Table-Level: Active entitlements cannot have a suspension date or suspension reason.
|
|
5481
5611
|
* * Table-Level: The validity end date must be on or after the validity start date if both dates are specified.
|
|
5482
5612
|
* @public
|
|
5483
5613
|
* @method
|
|
@@ -5485,13 +5615,20 @@ export declare class mjBizAppsOrdersEntitlementGrantEntity extends BaseEntity<mj
|
|
|
5485
5615
|
*/
|
|
5486
5616
|
Validate(): ValidationResult;
|
|
5487
5617
|
/**
|
|
5488
|
-
* If the status is 'Revoked', a revocation date must be
|
|
5618
|
+
* If the status is set to 'Revoked', a revocation date must be provided. Conversely, if the status is not 'Revoked', the revocation date must be empty.
|
|
5489
5619
|
* @param result - the ValidationResult object to add any errors or warnings to
|
|
5490
5620
|
* @public
|
|
5491
5621
|
* @method
|
|
5492
5622
|
*/
|
|
5493
5623
|
ValidateRevokedAtMatchesStatus(result: ValidationResult): void;
|
|
5494
5624
|
/**
|
|
5625
|
+
* Active entitlements cannot have a suspension date or suspension reason.
|
|
5626
|
+
* @param result - the ValidationResult object to add any errors or warnings to
|
|
5627
|
+
* @public
|
|
5628
|
+
* @method
|
|
5629
|
+
*/
|
|
5630
|
+
ValidateSuspensionDetailsForActiveStatus(result: ValidationResult): void;
|
|
5631
|
+
/**
|
|
5495
5632
|
* The validity end date must be on or after the validity start date if both dates are specified.
|
|
5496
5633
|
* @param result - the ValidationResult object to add any errors or warnings to
|
|
5497
5634
|
* @public
|
|
@@ -6151,12 +6288,6 @@ export declare class mjBizAppsOrdersEventOrderLineEntity extends BaseEntity<mjBi
|
|
|
6151
6288
|
get ShipToAddressSnapshot(): string | null;
|
|
6152
6289
|
set ShipToAddressSnapshot(value: string | null);
|
|
6153
6290
|
/**
|
|
6154
|
-
* * Field Name: Person
|
|
6155
|
-
* * Display Name: Person
|
|
6156
|
-
* * SQL Data Type: nvarchar(201)
|
|
6157
|
-
*/
|
|
6158
|
-
get Person(): string;
|
|
6159
|
-
/**
|
|
6160
6291
|
* * Field Name: SubscriptionAction
|
|
6161
6292
|
* * Display Name: Subscription Action
|
|
6162
6293
|
* * SQL Data Type: nvarchar(20)
|
|
@@ -6164,6 +6295,20 @@ export declare class mjBizAppsOrdersEventOrderLineEntity extends BaseEntity<mjBi
|
|
|
6164
6295
|
*/
|
|
6165
6296
|
get SubscriptionAction(): string | null;
|
|
6166
6297
|
set SubscriptionAction(value: string | null);
|
|
6298
|
+
/**
|
|
6299
|
+
* * Field Name: AcknowledgesCoverageOverlap
|
|
6300
|
+
* * Display Name: Acknowledges Coverage Overlap
|
|
6301
|
+
* * SQL Data Type: bit
|
|
6302
|
+
* * IS-A Source: Inherited from MJ_BizApps_Orders: Order Lines
|
|
6303
|
+
*/
|
|
6304
|
+
get AcknowledgesCoverageOverlap(): boolean;
|
|
6305
|
+
set AcknowledgesCoverageOverlap(value: boolean);
|
|
6306
|
+
/**
|
|
6307
|
+
* * Field Name: Person
|
|
6308
|
+
* * Display Name: Person
|
|
6309
|
+
* * SQL Data Type: nvarchar(201)
|
|
6310
|
+
*/
|
|
6311
|
+
get Person(): string;
|
|
6167
6312
|
}
|
|
6168
6313
|
/**
|
|
6169
6314
|
* MJ_BizApps_Orders: Event Products - strongly typed entity sub-class
|
|
@@ -6191,7 +6336,7 @@ export declare class mjBizAppsOrdersEventProductEntity extends BaseEntity<mjBizA
|
|
|
6191
6336
|
Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
|
|
6192
6337
|
/**
|
|
6193
6338
|
* Validate() method override for MJ_BizApps_Orders: Event Products entity. This is an auto-generated method that invokes the generated validators for this entity for the following fields:
|
|
6194
|
-
* * Capacity:
|
|
6339
|
+
* * Capacity: The capacity, if specified, must be a positive number greater than zero.
|
|
6195
6340
|
* * Table-Level: The event end date and time must be on or after the event start date and time, if an end date is provided.
|
|
6196
6341
|
* @public
|
|
6197
6342
|
* @method
|
|
@@ -6199,7 +6344,7 @@ export declare class mjBizAppsOrdersEventProductEntity extends BaseEntity<mjBizA
|
|
|
6199
6344
|
*/
|
|
6200
6345
|
Validate(): ValidationResult;
|
|
6201
6346
|
/**
|
|
6202
|
-
*
|
|
6347
|
+
* The capacity, if specified, must be a positive number greater than zero.
|
|
6203
6348
|
* @param result - the ValidationResult object to add any errors or warnings to
|
|
6204
6349
|
* @public
|
|
6205
6350
|
* @method
|
|
@@ -6222,7 +6367,7 @@ export declare class mjBizAppsOrdersEventProductEntity extends BaseEntity<mjBizA
|
|
|
6222
6367
|
set ID(value: string);
|
|
6223
6368
|
/**
|
|
6224
6369
|
* * Field Name: EventStartsAt
|
|
6225
|
-
* * Display Name: Starts At
|
|
6370
|
+
* * Display Name: Event Starts At
|
|
6226
6371
|
* * SQL Data Type: datetimeoffset
|
|
6227
6372
|
* * Description: UTC start of the event (also the SingleDate recognition date for Deferred event products).
|
|
6228
6373
|
*/
|
|
@@ -6230,7 +6375,7 @@ export declare class mjBizAppsOrdersEventProductEntity extends BaseEntity<mjBizA
|
|
|
6230
6375
|
set EventStartsAt(value: Date);
|
|
6231
6376
|
/**
|
|
6232
6377
|
* * Field Name: EventEndsAt
|
|
6233
|
-
* * Display Name: Ends At
|
|
6378
|
+
* * Display Name: Event Ends At
|
|
6234
6379
|
* * SQL Data Type: datetimeoffset
|
|
6235
6380
|
* * Description: UTC end of the event.
|
|
6236
6381
|
*/
|
|
@@ -6467,6 +6612,22 @@ export declare class mjBizAppsOrdersEventProductEntity extends BaseEntity<mjBizA
|
|
|
6467
6612
|
get MaxQuantityPerLine(): number | null;
|
|
6468
6613
|
set MaxQuantityPerLine(value: number | null);
|
|
6469
6614
|
/**
|
|
6615
|
+
* * Field Name: SubscriptionFamilyID
|
|
6616
|
+
* * Display Name: Subscription Family
|
|
6617
|
+
* * SQL Data Type: uniqueidentifier
|
|
6618
|
+
* * IS-A Source: Inherited from MJ_BizApps_Orders: Products
|
|
6619
|
+
*/
|
|
6620
|
+
get SubscriptionFamilyID(): string | null;
|
|
6621
|
+
set SubscriptionFamilyID(value: string | null);
|
|
6622
|
+
/**
|
|
6623
|
+
* * Field Name: RenewalIncreasePercent
|
|
6624
|
+
* * Display Name: Renewal Increase Percent
|
|
6625
|
+
* * SQL Data Type: decimal(7, 4)
|
|
6626
|
+
* * IS-A Source: Inherited from MJ_BizApps_Orders: Products
|
|
6627
|
+
*/
|
|
6628
|
+
get RenewalIncreasePercent(): number | null;
|
|
6629
|
+
set RenewalIncreasePercent(value: number | null);
|
|
6630
|
+
/**
|
|
6470
6631
|
* * Field Name: VenueAddress
|
|
6471
6632
|
* * Display Name: Venue Address Details
|
|
6472
6633
|
* * SQL Data Type: nvarchar(255)
|
|
@@ -6498,6 +6659,21 @@ export declare class mjBizAppsOrdersExternalCustomerEntity extends BaseEntity<mj
|
|
|
6498
6659
|
*/
|
|
6499
6660
|
Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
|
|
6500
6661
|
/**
|
|
6662
|
+
* Validate() method override for MJ_BizApps_Orders: External Customers entity. This is an auto-generated method that invokes the generated validators for this entity for the following fields:
|
|
6663
|
+
* * Table-Level: Exactly one of Bill To Organization or Bill To Person must be specified. You cannot specify both, and you cannot leave both empty.
|
|
6664
|
+
* @public
|
|
6665
|
+
* @method
|
|
6666
|
+
* @override
|
|
6667
|
+
*/
|
|
6668
|
+
Validate(): ValidationResult;
|
|
6669
|
+
/**
|
|
6670
|
+
* Exactly one of Bill To Organization or Bill To Person must be specified. You cannot specify both, and you cannot leave both empty.
|
|
6671
|
+
* @param result - the ValidationResult object to add any errors or warnings to
|
|
6672
|
+
* @public
|
|
6673
|
+
* @method
|
|
6674
|
+
*/
|
|
6675
|
+
ValidateBillToOrganizationOrPerson(result: ValidationResult): void;
|
|
6676
|
+
/**
|
|
6501
6677
|
* * Field Name: ID
|
|
6502
6678
|
* * Display Name: ID
|
|
6503
6679
|
* * SQL Data Type: uniqueidentifier
|
|
@@ -6606,6 +6782,29 @@ export declare class mjBizAppsOrdersExternalInvoiceEntity extends BaseEntity<mjB
|
|
|
6606
6782
|
*/
|
|
6607
6783
|
Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
|
|
6608
6784
|
/**
|
|
6785
|
+
* Validate() method override for MJ_BizApps_Orders: External Invoices entity. This is an auto-generated method that invokes the generated validators for this entity for the following fields:
|
|
6786
|
+
* * Amount: The amount must be greater than zero to ensure valid financial transactions.
|
|
6787
|
+
* * Table-Level: Invoices with a status of 'Sent' must have both an external invoice reference and a sent timestamp to ensure proper tracking and synchronization.
|
|
6788
|
+
* @public
|
|
6789
|
+
* @method
|
|
6790
|
+
* @override
|
|
6791
|
+
*/
|
|
6792
|
+
Validate(): ValidationResult;
|
|
6793
|
+
/**
|
|
6794
|
+
* The amount must be greater than zero to ensure valid financial transactions.
|
|
6795
|
+
* @param result - the ValidationResult object to add any errors or warnings to
|
|
6796
|
+
* @public
|
|
6797
|
+
* @method
|
|
6798
|
+
*/
|
|
6799
|
+
ValidateAmountGreaterThanZero(result: ValidationResult): void;
|
|
6800
|
+
/**
|
|
6801
|
+
* Invoices with a status of 'Sent' must have both an external invoice reference and a sent timestamp to ensure proper tracking and synchronization.
|
|
6802
|
+
* @param result - the ValidationResult object to add any errors or warnings to
|
|
6803
|
+
* @public
|
|
6804
|
+
* @method
|
|
6805
|
+
*/
|
|
6806
|
+
ValidateSentStatusRequiresExternalRefAndSentAt(result: ValidationResult): void;
|
|
6807
|
+
/**
|
|
6609
6808
|
* * Field Name: ID
|
|
6610
6809
|
* * Display Name: ID
|
|
6611
6810
|
* * SQL Data Type: uniqueidentifier
|
|
@@ -6848,6 +7047,21 @@ export declare class mjBizAppsOrdersExternalPaymentEntity extends BaseEntity<mjB
|
|
|
6848
7047
|
*/
|
|
6849
7048
|
Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
|
|
6850
7049
|
/**
|
|
7050
|
+
* Validate() method override for MJ_BizApps_Orders: External Payments entity. This is an auto-generated method that invokes the generated validators for this entity for the following fields:
|
|
7051
|
+
* * Table-Level: Payments with a disposition of 'Captured' must have an associated Payment Header ID.
|
|
7052
|
+
* @public
|
|
7053
|
+
* @method
|
|
7054
|
+
* @override
|
|
7055
|
+
*/
|
|
7056
|
+
Validate(): ValidationResult;
|
|
7057
|
+
/**
|
|
7058
|
+
* Payments with a disposition of 'Captured' must have an associated Payment Header ID.
|
|
7059
|
+
* @param result - the ValidationResult object to add any errors or warnings to
|
|
7060
|
+
* @public
|
|
7061
|
+
* @method
|
|
7062
|
+
*/
|
|
7063
|
+
ValidatePaymentHeaderIdWhenCaptured(result: ValidationResult): void;
|
|
7064
|
+
/**
|
|
6851
7065
|
* * Field Name: ID
|
|
6852
7066
|
* * Display Name: ID
|
|
6853
7067
|
* * SQL Data Type: uniqueidentifier
|
|
@@ -6934,10 +7148,10 @@ export declare class mjBizAppsOrdersExternalPaymentEntity extends BaseEntity<mjB
|
|
|
6934
7148
|
* * Refused
|
|
6935
7149
|
* * ReversalNeeded
|
|
6936
7150
|
* * Unmatched
|
|
6937
|
-
* * Description: Captured, Held (pending or unknown status), Unmatched (an invoice we did not issue), Refused (Orders.CapturePayment refused it — a split-company order, an ambiguous payer, a configuration fault), Ignored (nothing to do, or set aside by a person), ReversalNeeded (captured, and the rail now reports it reversed).
|
|
7151
|
+
* * Description: Captured, Held (pending or unknown status), Unmatched (an invoice we did not issue), Refused (Orders.CapturePayment refused it — a split-company order, an ambiguous payer, a configuration fault), Ignored (nothing to do, or set aside by a person), Reapplied (captured, and the rail has since applied it to different invoices), ReversalNeeded (captured, and the rail now reports it reversed).
|
|
6938
7152
|
*/
|
|
6939
|
-
get Disposition(): 'Captured' | 'Held' | 'Ignored' | 'Refused' | 'ReversalNeeded' | 'Unmatched';
|
|
6940
|
-
set Disposition(value: 'Captured' | 'Held' | 'Ignored' | 'Refused' | 'ReversalNeeded' | 'Unmatched');
|
|
7153
|
+
get Disposition(): 'Captured' | 'Held' | 'Ignored' | 'Reapplied' | 'Refused' | 'ReversalNeeded' | 'Unmatched';
|
|
7154
|
+
set Disposition(value: 'Captured' | 'Held' | 'Ignored' | 'Reapplied' | 'Refused' | 'ReversalNeeded' | 'Unmatched');
|
|
6941
7155
|
/**
|
|
6942
7156
|
* * Field Name: DispositionReason
|
|
6943
7157
|
* * Display Name: Disposition Reason
|
|
@@ -7105,7 +7319,7 @@ export declare class mjBizAppsOrdersOrderAdjustmentEntity extends BaseEntity<mjB
|
|
|
7105
7319
|
/**
|
|
7106
7320
|
* Validate() method override for MJ_BizApps_Orders: Order Adjustments entity. This is an auto-generated method that invokes the generated validators for this entity for the following fields:
|
|
7107
7321
|
* * Amount: The amount must be greater than zero to ensure all entries represent a positive financial value.
|
|
7108
|
-
* * Table-Level: Either a promotion must be selected or a reason must be provided
|
|
7322
|
+
* * Table-Level: Either a promotion must be selected or a reason must be provided to explain why the adjustment was applied.
|
|
7109
7323
|
* @public
|
|
7110
7324
|
* @method
|
|
7111
7325
|
* @override
|
|
@@ -7119,7 +7333,7 @@ export declare class mjBizAppsOrdersOrderAdjustmentEntity extends BaseEntity<mjB
|
|
|
7119
7333
|
*/
|
|
7120
7334
|
ValidateAmountGreaterThanZero(result: ValidationResult): void;
|
|
7121
7335
|
/**
|
|
7122
|
-
* Either a promotion must be selected or a reason must be provided
|
|
7336
|
+
* Either a promotion must be selected or a reason must be provided to explain why the adjustment was applied.
|
|
7123
7337
|
* @param result - the ValidationResult object to add any errors or warnings to
|
|
7124
7338
|
* @public
|
|
7125
7339
|
* @method
|
|
@@ -7636,6 +7850,21 @@ export declare class mjBizAppsOrdersOrderCompanyPolicyEntity extends BaseEntity<
|
|
|
7636
7850
|
*/
|
|
7637
7851
|
Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
|
|
7638
7852
|
/**
|
|
7853
|
+
* Validate() method override for MJ_BizApps_Orders: Order Company Policies entity. This is an auto-generated method that invokes the generated validators for this entity for the following fields:
|
|
7854
|
+
* * RenewalIncreasePercent: The renewal increase percentage must be between 0 and 100 percent, or left empty.
|
|
7855
|
+
* @public
|
|
7856
|
+
* @method
|
|
7857
|
+
* @override
|
|
7858
|
+
*/
|
|
7859
|
+
Validate(): ValidationResult;
|
|
7860
|
+
/**
|
|
7861
|
+
* The renewal increase percentage must be between 0 and 100 percent, or left empty.
|
|
7862
|
+
* @param result - the ValidationResult object to add any errors or warnings to
|
|
7863
|
+
* @public
|
|
7864
|
+
* @method
|
|
7865
|
+
*/
|
|
7866
|
+
ValidateRenewalIncreasePercentRange(result: ValidationResult): void;
|
|
7867
|
+
/**
|
|
7639
7868
|
* * Field Name: ID
|
|
7640
7869
|
* * Display Name: ID
|
|
7641
7870
|
* * SQL Data Type: uniqueidentifier
|
|
@@ -7713,6 +7942,14 @@ export declare class mjBizAppsOrdersOrderCompanyPolicyEntity extends BaseEntity<
|
|
|
7713
7942
|
get PricingDriverClass(): string | null;
|
|
7714
7943
|
set PricingDriverClass(value: string | null);
|
|
7715
7944
|
/**
|
|
7945
|
+
* * Field Name: RenewalIncreasePercent
|
|
7946
|
+
* * Display Name: Renewal Increase Percent
|
|
7947
|
+
* * SQL Data Type: decimal(7, 4)
|
|
7948
|
+
* * Description: Percent added to a subscription's price when it renews, for every product this company sells. The last step of the inheritance walk: a subscription, its product or its product category overrides it. NULL means no increase. The increase applies from the first day of the renewal term, so every invoice in that term carries the same price.
|
|
7949
|
+
*/
|
|
7950
|
+
get RenewalIncreasePercent(): number | null;
|
|
7951
|
+
set RenewalIncreasePercent(value: number | null);
|
|
7952
|
+
/**
|
|
7716
7953
|
* * Field Name: DefaultPriceList
|
|
7717
7954
|
* * Display Name: Default Price List
|
|
7718
7955
|
* * SQL Data Type: nvarchar(200)
|
|
@@ -7744,6 +7981,77 @@ export declare class mjBizAppsOrdersOrderConcessionEntity extends BaseEntity<mjB
|
|
|
7744
7981
|
*/
|
|
7745
7982
|
Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
|
|
7746
7983
|
/**
|
|
7984
|
+
* Validate() method override for MJ_BizApps_Orders: Order Concessions entity. This is an auto-generated method that invokes the generated validators for this entity for the following fields:
|
|
7985
|
+
* * ComputedValue: The computed value must be greater than or equal to zero.
|
|
7986
|
+
* * CumulativeShare: Cumulative share must be greater than or equal to zero to ensure that negative values are not recorded.
|
|
7987
|
+
* * Table-Level: If the status is 'Pending', decision details are not required. However, if the status is changed to anything other than 'Pending', both the deciding user and the decision timestamp must be provided.
|
|
7988
|
+
* * Table-Level: If the delivery form is set to 'Duration', a valid subscription term must be specified and the number of added days must be greater than zero.
|
|
7989
|
+
* * Table-Level: If the delivery form is set to 'Seats', an order line must be specified and the added quantity must be greater than zero.
|
|
7990
|
+
* * Table-Level: If the delivery form is set to 'Scope' or 'Price', an order line must be specified.
|
|
7991
|
+
* * Table-Level: Payment terms can only be specified when the delivery form is set to 'Terms'. If the delivery form is anything else, both the prior and new payment terms must be empty.
|
|
7992
|
+
* * Table-Level: When the delivery form is set to 'Terms', a new payment terms type and added days must be specified, the new payment terms must differ from the prior payment terms, and order line, subscription term, and added quantity must remain empty.
|
|
7993
|
+
* @public
|
|
7994
|
+
* @method
|
|
7995
|
+
* @override
|
|
7996
|
+
*/
|
|
7997
|
+
Validate(): ValidationResult;
|
|
7998
|
+
/**
|
|
7999
|
+
* The computed value must be greater than or equal to zero.
|
|
8000
|
+
* @param result - the ValidationResult object to add any errors or warnings to
|
|
8001
|
+
* @public
|
|
8002
|
+
* @method
|
|
8003
|
+
*/
|
|
8004
|
+
ValidateComputedValueGreaterThanOrEqualToZero(result: ValidationResult): void;
|
|
8005
|
+
/**
|
|
8006
|
+
* Cumulative share must be greater than or equal to zero to ensure that negative values are not recorded.
|
|
8007
|
+
* @param result - the ValidationResult object to add any errors or warnings to
|
|
8008
|
+
* @public
|
|
8009
|
+
* @method
|
|
8010
|
+
*/
|
|
8011
|
+
ValidateCumulativeShareGreaterThanOrEqualToZero(result: ValidationResult): void;
|
|
8012
|
+
/**
|
|
8013
|
+
* If the status is 'Pending', decision details are not required. However, if the status is changed to anything other than 'Pending', both the deciding user and the decision timestamp must be provided.
|
|
8014
|
+
* @param result - the ValidationResult object to add any errors or warnings to
|
|
8015
|
+
* @public
|
|
8016
|
+
* @method
|
|
8017
|
+
*/
|
|
8018
|
+
ValidateDecisionDetailsByStatus(result: ValidationResult): void;
|
|
8019
|
+
/**
|
|
8020
|
+
* If the delivery form is set to 'Duration', a valid subscription term must be specified and the number of added days must be greater than zero.
|
|
8021
|
+
* @param result - the ValidationResult object to add any errors or warnings to
|
|
8022
|
+
* @public
|
|
8023
|
+
* @method
|
|
8024
|
+
*/
|
|
8025
|
+
ValidateDeliveryFormDurationRequirements(result: ValidationResult): void;
|
|
8026
|
+
/**
|
|
8027
|
+
* If the delivery form is set to 'Seats', an order line must be specified and the added quantity must be greater than zero.
|
|
8028
|
+
* @param result - the ValidationResult object to add any errors or warnings to
|
|
8029
|
+
* @public
|
|
8030
|
+
* @method
|
|
8031
|
+
*/
|
|
8032
|
+
ValidateDeliveryFormSeatsRequirements(result: ValidationResult): void;
|
|
8033
|
+
/**
|
|
8034
|
+
* If the delivery form is set to 'Scope' or 'Price', an order line must be specified.
|
|
8035
|
+
* @param result - the ValidationResult object to add any errors or warnings to
|
|
8036
|
+
* @public
|
|
8037
|
+
* @method
|
|
8038
|
+
*/
|
|
8039
|
+
ValidateOrderLineRequiredForScopeOrPriceDeliveryForm(result: ValidationResult): void;
|
|
8040
|
+
/**
|
|
8041
|
+
* Payment terms can only be specified when the delivery form is set to 'Terms'. If the delivery form is anything else, both the prior and new payment terms must be empty.
|
|
8042
|
+
* @param result - the ValidationResult object to add any errors or warnings to
|
|
8043
|
+
* @public
|
|
8044
|
+
* @method
|
|
8045
|
+
*/
|
|
8046
|
+
ValidatePaymentTermsOnlyForTermsDeliveryForm(result: ValidationResult): void;
|
|
8047
|
+
/**
|
|
8048
|
+
* When the delivery form is set to 'Terms', a new payment terms type and added days must be specified, the new payment terms must differ from the prior payment terms, and order line, subscription term, and added quantity must remain empty.
|
|
8049
|
+
* @param result - the ValidationResult object to add any errors or warnings to
|
|
8050
|
+
* @public
|
|
8051
|
+
* @method
|
|
8052
|
+
*/
|
|
8053
|
+
ValidateTermsDeliveryFormConstraints(result: ValidationResult): void;
|
|
8054
|
+
/**
|
|
7747
8055
|
* * Field Name: ID
|
|
7748
8056
|
* * Display Name: ID
|
|
7749
8057
|
* * SQL Data Type: uniqueidentifier
|
|
@@ -8014,6 +8322,29 @@ export declare class mjBizAppsOrdersOrderHeaderPaymentScheduleEntity extends Bas
|
|
|
8014
8322
|
*/
|
|
8015
8323
|
Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
|
|
8016
8324
|
/**
|
|
8325
|
+
* Validate() method override for MJ_BizApps_Orders: Order Header Payment Schedules entity. This is an auto-generated method that invokes the generated validators for this entity for the following fields:
|
|
8326
|
+
* * Amount: The amount must be greater than zero to ensure valid financial calculations and prevent negative or zero-value transactions.
|
|
8327
|
+
* * Table-Level: Invoices must either be in Canceled or Scheduled status, or they must have both a Document Number and an Invoice Date specified.
|
|
8328
|
+
* @public
|
|
8329
|
+
* @method
|
|
8330
|
+
* @override
|
|
8331
|
+
*/
|
|
8332
|
+
Validate(): ValidationResult;
|
|
8333
|
+
/**
|
|
8334
|
+
* The amount must be greater than zero to ensure valid financial calculations and prevent negative or zero-value transactions.
|
|
8335
|
+
* @param result - the ValidationResult object to add any errors or warnings to
|
|
8336
|
+
* @public
|
|
8337
|
+
* @method
|
|
8338
|
+
*/
|
|
8339
|
+
ValidateAmountGreaterThanZero(result: ValidationResult): void;
|
|
8340
|
+
/**
|
|
8341
|
+
* Invoices must either be in Canceled or Scheduled status, or they must have both a Document Number and an Invoice Date specified.
|
|
8342
|
+
* @param result - the ValidationResult object to add any errors or warnings to
|
|
8343
|
+
* @public
|
|
8344
|
+
* @method
|
|
8345
|
+
*/
|
|
8346
|
+
ValidateStatusAndInvoiceDetails(result: ValidationResult): void;
|
|
8347
|
+
/**
|
|
8017
8348
|
* * Field Name: ID
|
|
8018
8349
|
* * Display Name: ID
|
|
8019
8350
|
* * SQL Data Type: uniqueidentifier
|
|
@@ -8296,19 +8627,35 @@ export declare class mjBizAppsOrdersOrderHeaderEntity extends BaseEntity<mjBizAp
|
|
|
8296
8627
|
Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
|
|
8297
8628
|
/**
|
|
8298
8629
|
* Validate() method override for MJ_BizApps_Orders: Order Headers entity. This is an auto-generated method that invokes the generated validators for this entity for the following fields:
|
|
8630
|
+
* * BillToAddressSnapshot: The Bill To Address Snapshot, if provided, must be a valid JSON-formatted string to ensure structured address data is correctly preserved.
|
|
8299
8631
|
* * InitialPaymentAmount: The initial payment amount must be greater than or equal to zero to ensure that negative payments are not recorded.
|
|
8632
|
+
* * ShipToAddressSnapshot: The shipping address snapshot must be in a valid JSON format if it is provided.
|
|
8300
8633
|
* @public
|
|
8301
8634
|
* @method
|
|
8302
8635
|
* @override
|
|
8303
8636
|
*/
|
|
8304
8637
|
Validate(): ValidationResult;
|
|
8305
8638
|
/**
|
|
8639
|
+
* The Bill To Address Snapshot, if provided, must be a valid JSON-formatted string to ensure structured address data is correctly preserved.
|
|
8640
|
+
* @param result - the ValidationResult object to add any errors or warnings to
|
|
8641
|
+
* @public
|
|
8642
|
+
* @method
|
|
8643
|
+
*/
|
|
8644
|
+
ValidateBillToAddressSnapshotIsJson(result: ValidationResult): void;
|
|
8645
|
+
/**
|
|
8306
8646
|
* The initial payment amount must be greater than or equal to zero to ensure that negative payments are not recorded.
|
|
8307
8647
|
* @param result - the ValidationResult object to add any errors or warnings to
|
|
8308
8648
|
* @public
|
|
8309
8649
|
* @method
|
|
8310
8650
|
*/
|
|
8311
|
-
|
|
8651
|
+
ValidateInitialPaymentAmountGreaterThanOrEqualToZero(result: ValidationResult): void;
|
|
8652
|
+
/**
|
|
8653
|
+
* The shipping address snapshot must be in a valid JSON format if it is provided.
|
|
8654
|
+
* @param result - the ValidationResult object to add any errors or warnings to
|
|
8655
|
+
* @public
|
|
8656
|
+
* @method
|
|
8657
|
+
*/
|
|
8658
|
+
ValidateShipToAddressSnapshotIsJson(result: ValidationResult): void;
|
|
8312
8659
|
/**
|
|
8313
8660
|
* * Field Name: ID
|
|
8314
8661
|
* * Display Name: ID
|
|
@@ -8740,25 +9087,25 @@ export declare class mjBizAppsOrdersOrderHeaderEntity extends BaseEntity<mjBizAp
|
|
|
8740
9087
|
get ConfirmedByUser(): string | null;
|
|
8741
9088
|
/**
|
|
8742
9089
|
* * Field Name: __mj_Latitude_BillToAddressID
|
|
8743
|
-
* * Display Name: Billing Latitude
|
|
9090
|
+
* * Display Name: Billing Address Latitude
|
|
8744
9091
|
* * SQL Data Type: decimal(9, 6)
|
|
8745
9092
|
*/
|
|
8746
9093
|
get __mj_Latitude_BillToAddressID(): number | null;
|
|
8747
9094
|
/**
|
|
8748
9095
|
* * Field Name: __mj_Longitude_BillToAddressID
|
|
8749
|
-
* * Display Name: Billing Longitude
|
|
9096
|
+
* * Display Name: Billing Address Longitude
|
|
8750
9097
|
* * SQL Data Type: decimal(9, 6)
|
|
8751
9098
|
*/
|
|
8752
9099
|
get __mj_Longitude_BillToAddressID(): number | null;
|
|
8753
9100
|
/**
|
|
8754
9101
|
* * Field Name: __mj_Latitude_ShipToAddressID
|
|
8755
|
-
* * Display Name: Shipping Latitude
|
|
9102
|
+
* * Display Name: Shipping Address Latitude
|
|
8756
9103
|
* * SQL Data Type: decimal(9, 6)
|
|
8757
9104
|
*/
|
|
8758
9105
|
get __mj_Latitude_ShipToAddressID(): number | null;
|
|
8759
9106
|
/**
|
|
8760
9107
|
* * Field Name: __mj_Longitude_ShipToAddressID
|
|
8761
|
-
* * Display Name: Shipping Longitude
|
|
9108
|
+
* * Display Name: Shipping Address Longitude
|
|
8762
9109
|
* * SQL Data Type: decimal(9, 6)
|
|
8763
9110
|
*/
|
|
8764
9111
|
get __mj_Longitude_ShipToAddressID(): number | null;
|
|
@@ -8974,19 +9321,19 @@ export declare class mjBizAppsOrdersOrderLinePriceComponentEntity extends BaseEn
|
|
|
8974
9321
|
Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
|
|
8975
9322
|
/**
|
|
8976
9323
|
* Validate() method override for MJ_BizApps_Orders: Order Line Price Components entity. This is an auto-generated method that invokes the generated validators for this entity for the following fields:
|
|
8977
|
-
* * Table-Level: Both Source Entity ID and Source Record ID must either be provided together or both left blank.
|
|
9324
|
+
* * Table-Level: Both Source Entity ID and Source Record ID must either be provided together or both left blank. Specifying only one of these fields is not allowed.
|
|
8978
9325
|
* @public
|
|
8979
9326
|
* @method
|
|
8980
9327
|
* @override
|
|
8981
9328
|
*/
|
|
8982
9329
|
Validate(): ValidationResult;
|
|
8983
9330
|
/**
|
|
8984
|
-
* Both Source Entity ID and Source Record ID must either be provided together or both left blank.
|
|
9331
|
+
* Both Source Entity ID and Source Record ID must either be provided together or both left blank. Specifying only one of these fields is not allowed.
|
|
8985
9332
|
* @param result - the ValidationResult object to add any errors or warnings to
|
|
8986
9333
|
* @public
|
|
8987
9334
|
* @method
|
|
8988
9335
|
*/
|
|
8989
|
-
|
|
9336
|
+
ValidateSourceEntityAndRecordCoexistence(result: ValidationResult): void;
|
|
8990
9337
|
/**
|
|
8991
9338
|
* * Field Name: ID
|
|
8992
9339
|
* * Display Name: ID
|
|
@@ -9111,6 +9458,29 @@ export declare class mjBizAppsOrdersOrderLineProgressMeasurementEntity extends B
|
|
|
9111
9458
|
*/
|
|
9112
9459
|
Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
|
|
9113
9460
|
/**
|
|
9461
|
+
* Validate() method override for MJ_BizApps_Orders: Order Line Progress Measurements entity. This is an auto-generated method that invokes the generated validators for this entity for the following fields:
|
|
9462
|
+
* * PercentComplete: The percent complete value must be a decimal between 0 and 1 (inclusive), representing a percentage from 0% to 100%.
|
|
9463
|
+
* * Table-Level: A measurement record cannot supersede itself. The Supersedes Measurement ID must be different from the record's own ID.
|
|
9464
|
+
* @public
|
|
9465
|
+
* @method
|
|
9466
|
+
* @override
|
|
9467
|
+
*/
|
|
9468
|
+
Validate(): ValidationResult;
|
|
9469
|
+
/**
|
|
9470
|
+
* The percent complete value must be a decimal between 0 and 1 (inclusive), representing a percentage from 0% to 100%.
|
|
9471
|
+
* @param result - the ValidationResult object to add any errors or warnings to
|
|
9472
|
+
* @public
|
|
9473
|
+
* @method
|
|
9474
|
+
*/
|
|
9475
|
+
ValidatePercentCompleteRange(result: ValidationResult): void;
|
|
9476
|
+
/**
|
|
9477
|
+
* A measurement record cannot supersede itself. The Supersedes Measurement ID must be different from the record's own ID.
|
|
9478
|
+
* @param result - the ValidationResult object to add any errors or warnings to
|
|
9479
|
+
* @public
|
|
9480
|
+
* @method
|
|
9481
|
+
*/
|
|
9482
|
+
ValidateSupersedesMeasurementIDNotEqualToID(result: ValidationResult): void;
|
|
9483
|
+
/**
|
|
9114
9484
|
* * Field Name: ID
|
|
9115
9485
|
* * Display Name: ID
|
|
9116
9486
|
* * SQL Data Type: uniqueidentifier
|
|
@@ -9325,14 +9695,15 @@ export declare class mjBizAppsOrdersOrderLineEntity extends BaseEntity<mjBizApps
|
|
|
9325
9695
|
Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
|
|
9326
9696
|
/**
|
|
9327
9697
|
* Validate() method override for MJ_BizApps_Orders: Order Lines entity. This is an auto-generated method that invokes the generated validators for this entity for the following fields:
|
|
9328
|
-
* * DiscountAmount: The discount amount
|
|
9698
|
+
* * DiscountAmount: The discount amount applied to an order line cannot be a negative value.
|
|
9329
9699
|
* * DiscountPct: Discount percentage must be a value between 0 and 1 (inclusive), representing a range of 0% to 100%.
|
|
9330
9700
|
* * Quantity: The quantity specified for the line item must not be zero.
|
|
9701
|
+
* * ShipToAddressSnapshot: If a ship-to address snapshot is provided, it must be in a valid JSON format to ensure structured address data is stored correctly.
|
|
9331
9702
|
* * UnitPrice: The unit price for any item must be zero or greater. Negative prices are not allowed.
|
|
9332
|
-
* * Table-Level:
|
|
9703
|
+
* * Table-Level: Dimension and Dimension Value must either both be specified or both be left blank. You cannot provide one without the other.
|
|
9333
9704
|
* * Table-Level: An order line cannot be its own parent. If a parent order line is specified, it must refer to a different order line.
|
|
9334
9705
|
* * Table-Level: If an order line's quantity is marked as overridden, it must be associated with a parent order line.
|
|
9335
|
-
* * Table-Level: If an order line is designated as a rollup parent, its
|
|
9706
|
+
* * Table-Level: If an order line is designated as a rollup parent, its discount amount, charge amount, and line tax must all be zero.
|
|
9336
9707
|
* * Table-Level: If both the service period start and end dates are provided, the end date must be on or after the start date.
|
|
9337
9708
|
* @public
|
|
9338
9709
|
* @method
|
|
@@ -9340,7 +9711,7 @@ export declare class mjBizAppsOrdersOrderLineEntity extends BaseEntity<mjBizApps
|
|
|
9340
9711
|
*/
|
|
9341
9712
|
Validate(): ValidationResult;
|
|
9342
9713
|
/**
|
|
9343
|
-
* The discount amount
|
|
9714
|
+
* The discount amount applied to an order line cannot be a negative value.
|
|
9344
9715
|
* @param result - the ValidationResult object to add any errors or warnings to
|
|
9345
9716
|
* @public
|
|
9346
9717
|
* @method
|
|
@@ -9361,6 +9732,13 @@ export declare class mjBizAppsOrdersOrderLineEntity extends BaseEntity<mjBizApps
|
|
|
9361
9732
|
*/
|
|
9362
9733
|
ValidateQuantityNotZero(result: ValidationResult): void;
|
|
9363
9734
|
/**
|
|
9735
|
+
* If a ship-to address snapshot is provided, it must be in a valid JSON format to ensure structured address data is stored correctly.
|
|
9736
|
+
* @param result - the ValidationResult object to add any errors or warnings to
|
|
9737
|
+
* @public
|
|
9738
|
+
* @method
|
|
9739
|
+
*/
|
|
9740
|
+
ValidateShipToAddressSnapshotIsJson(result: ValidationResult): void;
|
|
9741
|
+
/**
|
|
9364
9742
|
* The unit price for any item must be zero or greater. Negative prices are not allowed.
|
|
9365
9743
|
* @param result - the ValidationResult object to add any errors or warnings to
|
|
9366
9744
|
* @public
|
|
@@ -9368,7 +9746,7 @@ export declare class mjBizAppsOrdersOrderLineEntity extends BaseEntity<mjBizApps
|
|
|
9368
9746
|
*/
|
|
9369
9747
|
ValidateUnitPriceIsNonNegative(result: ValidationResult): void;
|
|
9370
9748
|
/**
|
|
9371
|
-
*
|
|
9749
|
+
* Dimension and Dimension Value must either both be specified or both be left blank. You cannot provide one without the other.
|
|
9372
9750
|
* @param result - the ValidationResult object to add any errors or warnings to
|
|
9373
9751
|
* @public
|
|
9374
9752
|
* @method
|
|
@@ -9389,7 +9767,7 @@ export declare class mjBizAppsOrdersOrderLineEntity extends BaseEntity<mjBizApps
|
|
|
9389
9767
|
*/
|
|
9390
9768
|
ValidateParentOrderLineRequiredWhenQuantityOverridden(result: ValidationResult): void;
|
|
9391
9769
|
/**
|
|
9392
|
-
* If an order line is designated as a rollup parent, its
|
|
9770
|
+
* If an order line is designated as a rollup parent, its discount amount, charge amount, and line tax must all be zero.
|
|
9393
9771
|
* @param result - the ValidationResult object to add any errors or warnings to
|
|
9394
9772
|
* @public
|
|
9395
9773
|
* @method
|
|
@@ -9461,7 +9839,7 @@ export declare class mjBizAppsOrdersOrderLineEntity extends BaseEntity<mjBizApps
|
|
|
9461
9839
|
set UnitPrice(value: number);
|
|
9462
9840
|
/**
|
|
9463
9841
|
* * Field Name: ProductPriceID
|
|
9464
|
-
* * Display Name: Product Price
|
|
9842
|
+
* * Display Name: Product Price Rule
|
|
9465
9843
|
* * SQL Data Type: uniqueidentifier
|
|
9466
9844
|
* * Related Entity/Foreign Key: MJ_BizApps_Orders: Product Prices (vwProductPrices.ID)
|
|
9467
9845
|
* * Description: Which price RULE produced UnitPrice. UnitPrice still stamps; this records why, so a disputed invoice can be traced back to the rule that priced it. NULL when the caller supplied the price directly, which remains valid.
|
|
@@ -9470,7 +9848,7 @@ export declare class mjBizAppsOrdersOrderLineEntity extends BaseEntity<mjBizApps
|
|
|
9470
9848
|
set ProductPriceID(value: string | null);
|
|
9471
9849
|
/**
|
|
9472
9850
|
* * Field Name: DiscountPct
|
|
9473
|
-
* * Display Name: Discount
|
|
9851
|
+
* * Display Name: Discount Percentage
|
|
9474
9852
|
* * SQL Data Type: decimal(7, 4)
|
|
9475
9853
|
* * Default Value: 0
|
|
9476
9854
|
* * Description: Line discount as a fraction (0 to 1; e.g. 0.10 = ten percent off). Applied in LineTotalNet = Quantity * UnitPrice * (1 - DiscountPct).
|
|
@@ -9488,7 +9866,7 @@ export declare class mjBizAppsOrdersOrderLineEntity extends BaseEntity<mjBizApps
|
|
|
9488
9866
|
set DiscountAmount(value: number);
|
|
9489
9867
|
/**
|
|
9490
9868
|
* * Field Name: LineTotalNet
|
|
9491
|
-
* * Display Name:
|
|
9869
|
+
* * Display Name: Line Total Net
|
|
9492
9870
|
* * SQL Data Type: decimal(18, 2)
|
|
9493
9871
|
* * Description: Engine-computed stored net line total = (Quantity * UnitPrice * (1 - DiscountPct)) - DiscountAmount, floored at zero. Frozen after Confirm.
|
|
9494
9872
|
*/
|
|
@@ -9505,7 +9883,7 @@ export declare class mjBizAppsOrdersOrderLineEntity extends BaseEntity<mjBizApps
|
|
|
9505
9883
|
set ChargeAmount(value: number);
|
|
9506
9884
|
/**
|
|
9507
9885
|
* * Field Name: LineTax
|
|
9508
|
-
* * Display Name: Tax
|
|
9886
|
+
* * Display Name: Line Tax
|
|
9509
9887
|
* * SQL Data Type: decimal(18, 2)
|
|
9510
9888
|
* * Default Value: 0
|
|
9511
9889
|
* * Description: Tax amount for this line. 0 until the tax subsystem lands (O4).
|
|
@@ -9514,7 +9892,7 @@ export declare class mjBizAppsOrdersOrderLineEntity extends BaseEntity<mjBizApps
|
|
|
9514
9892
|
set LineTax(value: number);
|
|
9515
9893
|
/**
|
|
9516
9894
|
* * Field Name: LineTotalGross
|
|
9517
|
-
* * Display Name:
|
|
9895
|
+
* * Display Name: Line Total Gross
|
|
9518
9896
|
* * SQL Data Type: decimal(18, 2)
|
|
9519
9897
|
* * Description: Engine-computed stored gross line total = LineTotalNet + LineTax + ChargeAmount. Frozen after Confirm.
|
|
9520
9898
|
*/
|
|
@@ -9673,15 +10051,15 @@ export declare class mjBizAppsOrdersOrderLineEntity extends BaseEntity<mjBizApps
|
|
|
9673
10051
|
set PriceOverridden(value: boolean);
|
|
9674
10052
|
/**
|
|
9675
10053
|
* * Field Name: PriceOverrideReason
|
|
9676
|
-
* * Display Name:
|
|
10054
|
+
* * Display Name: Override Explanation
|
|
9677
10055
|
* * SQL Data Type: nvarchar(MAX)
|
|
9678
|
-
* * Description:
|
|
10056
|
+
* * Description: Why this line's price was moved off the default. Required when PriceOverridden is set: a save that flags the price as overridden and gives no reason is refused. NULL when the price is the default.
|
|
9679
10057
|
*/
|
|
9680
10058
|
get PriceOverrideReason(): string | null;
|
|
9681
10059
|
set PriceOverrideReason(value: string | null);
|
|
9682
10060
|
/**
|
|
9683
10061
|
* * Field Name: DimensionID
|
|
9684
|
-
* * Display Name: Dimension
|
|
10062
|
+
* * Display Name: Dimension ID
|
|
9685
10063
|
* * SQL Data Type: uniqueidentifier
|
|
9686
10064
|
* * Related Entity/Foreign Key: MJ_BizApps_Accounting: Dimensions (vwDimensions.ID)
|
|
9687
10065
|
* * Description: The GL dimension this line is tagged on — the analysis axis, from __mj_BizAppsAccounting.Dimension. NULL leaves the line untagged, which books a valid entry that simply cannot be reported on by dimension. Set together with DimensionValueID (CK_OrderLine_DimensionPair).
|
|
@@ -9690,7 +10068,7 @@ export declare class mjBizAppsOrdersOrderLineEntity extends BaseEntity<mjBizApps
|
|
|
9690
10068
|
set DimensionID(value: string | null);
|
|
9691
10069
|
/**
|
|
9692
10070
|
* * Field Name: DimensionValueID
|
|
9693
|
-
* * Display Name: Dimension Value
|
|
10071
|
+
* * Display Name: Dimension Value ID
|
|
9694
10072
|
* * SQL Data Type: uniqueidentifier
|
|
9695
10073
|
* * Related Entity/Foreign Key: MJ_BizApps_Accounting: Dimension Values (vwDimensionValues.ID)
|
|
9696
10074
|
* * Description: The value of DimensionID this line is tagged with, from __mj_BizAppsAccounting.DimensionValue. Carried with DimensionID onto every journal entry line the order line produces. Set together with DimensionID (CK_OrderLine_DimensionPair).
|
|
@@ -9736,98 +10114,107 @@ export declare class mjBizAppsOrdersOrderLineEntity extends BaseEntity<mjBizApps
|
|
|
9736
10114
|
get SubscriptionAction(): 'CreateNew' | 'ExtendExisting' | null;
|
|
9737
10115
|
set SubscriptionAction(value: 'CreateNew' | 'ExtendExisting' | null);
|
|
9738
10116
|
/**
|
|
10117
|
+
* * Field Name: AcknowledgesCoverageOverlap
|
|
10118
|
+
* * Display Name: Acknowledges Coverage Overlap
|
|
10119
|
+
* * SQL Data Type: bit
|
|
10120
|
+
* * Default Value: 0
|
|
10121
|
+
* * Description: True when this line is meant to run alongside coverage the holder already has for another band of the same subscription family. Under ExtendExisting, confirm refuses an overlapping line unless this is set. Ignored under AllowMultiple, which permits the overlap, and under RejectDuplicate, which refuses it regardless.
|
|
10122
|
+
*/
|
|
10123
|
+
get AcknowledgesCoverageOverlap(): boolean;
|
|
10124
|
+
set AcknowledgesCoverageOverlap(value: boolean);
|
|
10125
|
+
/**
|
|
9739
10126
|
* * Field Name: OrderHeader
|
|
9740
|
-
* * Display Name: Order Header
|
|
10127
|
+
* * Display Name: Order Header
|
|
9741
10128
|
* * SQL Data Type: nvarchar(40)
|
|
9742
10129
|
*/
|
|
9743
10130
|
get OrderHeader(): string;
|
|
9744
10131
|
/**
|
|
9745
10132
|
* * Field Name: Product
|
|
9746
|
-
* * Display Name: Product
|
|
10133
|
+
* * Display Name: Product Name
|
|
9747
10134
|
* * SQL Data Type: nvarchar(200)
|
|
9748
10135
|
*/
|
|
9749
10136
|
get Product(): string;
|
|
9750
10137
|
/**
|
|
9751
10138
|
* * Field Name: Company
|
|
9752
|
-
* * Display Name: Company
|
|
10139
|
+
* * Display Name: Company Name
|
|
9753
10140
|
* * SQL Data Type: nvarchar(50)
|
|
9754
10141
|
*/
|
|
9755
10142
|
get Company(): string;
|
|
9756
10143
|
/**
|
|
9757
10144
|
* * Field Name: ProductPrice
|
|
9758
|
-
* * Display Name: Product Price
|
|
10145
|
+
* * Display Name: Product Price
|
|
9759
10146
|
* * SQL Data Type: nvarchar(100)
|
|
9760
10147
|
*/
|
|
9761
10148
|
get ProductPrice(): string | null;
|
|
9762
10149
|
/**
|
|
9763
10150
|
* * Field Name: ShipToOrganization
|
|
9764
|
-
* * Display Name: Ship To Organization
|
|
10151
|
+
* * Display Name: Ship To Organization Name
|
|
9765
10152
|
* * SQL Data Type: nvarchar(255)
|
|
9766
10153
|
*/
|
|
9767
10154
|
get ShipToOrganization(): string | null;
|
|
9768
10155
|
/**
|
|
9769
10156
|
* * Field Name: ShipToPerson
|
|
9770
|
-
* * Display Name: Ship To Person
|
|
10157
|
+
* * Display Name: Ship To Person Name
|
|
9771
10158
|
* * SQL Data Type: nvarchar(201)
|
|
9772
10159
|
*/
|
|
9773
10160
|
get ShipToPerson(): string | null;
|
|
9774
10161
|
/**
|
|
9775
10162
|
* * Field Name: SourceBundleProduct
|
|
9776
|
-
* * Display Name: Source Bundle Product
|
|
10163
|
+
* * Display Name: Source Bundle Product Name
|
|
9777
10164
|
* * SQL Data Type: nvarchar(200)
|
|
9778
10165
|
*/
|
|
9779
10166
|
get SourceBundleProduct(): string | null;
|
|
9780
10167
|
/**
|
|
9781
10168
|
* * Field Name: Subscription
|
|
9782
|
-
* * Display Name: Subscription
|
|
10169
|
+
* * Display Name: Subscription
|
|
9783
10170
|
* * SQL Data Type: nvarchar(40)
|
|
9784
10171
|
*/
|
|
9785
10172
|
get Subscription(): string | null;
|
|
9786
10173
|
/**
|
|
9787
10174
|
* * Field Name: JournalEntry
|
|
9788
|
-
* * Display Name: Journal Entry
|
|
10175
|
+
* * Display Name: Journal Entry Reference
|
|
9789
10176
|
* * SQL Data Type: nvarchar(40)
|
|
9790
10177
|
*/
|
|
9791
10178
|
get JournalEntry(): string | null;
|
|
9792
10179
|
/**
|
|
9793
10180
|
* * Field Name: Dimension
|
|
9794
|
-
* * Display Name: Dimension
|
|
10181
|
+
* * Display Name: Dimension
|
|
9795
10182
|
* * SQL Data Type: nvarchar(100)
|
|
9796
10183
|
*/
|
|
9797
10184
|
get Dimension(): string | null;
|
|
9798
10185
|
/**
|
|
9799
10186
|
* * Field Name: DimensionValue
|
|
9800
|
-
* * Display Name: Dimension Value
|
|
10187
|
+
* * Display Name: Dimension Value
|
|
9801
10188
|
* * SQL Data Type: nvarchar(200)
|
|
9802
10189
|
*/
|
|
9803
10190
|
get DimensionValue(): string | null;
|
|
9804
10191
|
/**
|
|
9805
10192
|
* * Field Name: RootParentOrderLineID
|
|
9806
|
-
* * Display Name: Root Parent Order Line
|
|
10193
|
+
* * Display Name: Root Parent Order Line ID
|
|
9807
10194
|
* * SQL Data Type: uniqueidentifier
|
|
9808
10195
|
*/
|
|
9809
10196
|
get RootParentOrderLineID(): string | null;
|
|
9810
10197
|
/**
|
|
9811
10198
|
* * Field Name: ParentOrderLineIDDepth
|
|
9812
|
-
* * Display Name: Parent Line Depth
|
|
10199
|
+
* * Display Name: Parent Order Line ID Depth
|
|
9813
10200
|
* * SQL Data Type: int
|
|
9814
10201
|
*/
|
|
9815
10202
|
get ParentOrderLineIDDepth(): number | null;
|
|
9816
10203
|
/**
|
|
9817
10204
|
* * Field Name: ParentOrderLineIDPath
|
|
9818
|
-
* * Display Name: Parent Line Path
|
|
10205
|
+
* * Display Name: Parent Order Line ID Path
|
|
9819
10206
|
* * SQL Data Type: nvarchar(MAX)
|
|
9820
10207
|
*/
|
|
9821
10208
|
get ParentOrderLineIDPath(): string | null;
|
|
9822
10209
|
/**
|
|
9823
10210
|
* * Field Name: ParentOrderLineIDIsLeaf
|
|
9824
|
-
* * Display Name: Is Leaf
|
|
10211
|
+
* * Display Name: Parent Order Line ID Is Leaf
|
|
9825
10212
|
* * SQL Data Type: bit
|
|
9826
10213
|
*/
|
|
9827
10214
|
get ParentOrderLineIDIsLeaf(): boolean | null;
|
|
9828
10215
|
/**
|
|
9829
10216
|
* * Field Name: ParentOrderLineIDChildCount
|
|
9830
|
-
* * Display Name:
|
|
10217
|
+
* * Display Name: Parent Order Line ID Child Count
|
|
9831
10218
|
* * SQL Data Type: int
|
|
9832
10219
|
*/
|
|
9833
10220
|
get ParentOrderLineIDChildCount(): number | null;
|
|
@@ -9859,7 +10246,7 @@ export declare class mjBizAppsOrdersOrderSequenceEntity extends BaseEntity<mjBiz
|
|
|
9859
10246
|
/**
|
|
9860
10247
|
* Validate() method override for MJ_BizApps_Orders: Order Sequences entity. This is an auto-generated method that invokes the generated validators for this entity for the following fields:
|
|
9861
10248
|
* * ID: The ID of the record must be exactly 1, ensuring that only a single system configuration record exists in this table.
|
|
9862
|
-
* * NextSequenceNumber: The next sequence number must be a positive
|
|
10249
|
+
* * NextSequenceNumber: The next sequence number must be a positive number greater than zero to maintain valid sequencing.
|
|
9863
10250
|
* @public
|
|
9864
10251
|
* @method
|
|
9865
10252
|
* @override
|
|
@@ -9873,7 +10260,7 @@ export declare class mjBizAppsOrdersOrderSequenceEntity extends BaseEntity<mjBiz
|
|
|
9873
10260
|
*/
|
|
9874
10261
|
ValidateIdEqualsOne(result: ValidationResult): void;
|
|
9875
10262
|
/**
|
|
9876
|
-
* The next sequence number must be a positive
|
|
10263
|
+
* The next sequence number must be a positive number greater than zero to maintain valid sequencing.
|
|
9877
10264
|
* @param result - the ValidationResult object to add any errors or warnings to
|
|
9878
10265
|
* @public
|
|
9879
10266
|
* @method
|
|
@@ -9936,6 +10323,29 @@ export declare class mjBizAppsOrdersOutboundDeliveryEntity extends BaseEntity<mj
|
|
|
9936
10323
|
*/
|
|
9937
10324
|
Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
|
|
9938
10325
|
/**
|
|
10326
|
+
* Validate() method override for MJ_BizApps_Orders: Outbound Deliveries entity. This is an auto-generated method that invokes the generated validators for this entity for the following fields:
|
|
10327
|
+
* * Attempts: The number of delivery attempts must be zero or a positive number to ensure accurate tracking of system retries.
|
|
10328
|
+
* * Table-Level: A delivery timestamp must be provided if and only if the status is 'Delivered'. If the status is not 'Delivered', the delivery timestamp must be empty.
|
|
10329
|
+
* @public
|
|
10330
|
+
* @method
|
|
10331
|
+
* @override
|
|
10332
|
+
*/
|
|
10333
|
+
Validate(): ValidationResult;
|
|
10334
|
+
/**
|
|
10335
|
+
* The number of delivery attempts must be zero or a positive number to ensure accurate tracking of system retries.
|
|
10336
|
+
* @param result - the ValidationResult object to add any errors or warnings to
|
|
10337
|
+
* @public
|
|
10338
|
+
* @method
|
|
10339
|
+
*/
|
|
10340
|
+
ValidateAttemptsGreaterThanOrEqualToZero(result: ValidationResult): void;
|
|
10341
|
+
/**
|
|
10342
|
+
* A delivery timestamp must be provided if and only if the status is 'Delivered'. If the status is not 'Delivered', the delivery timestamp must be empty.
|
|
10343
|
+
* @param result - the ValidationResult object to add any errors or warnings to
|
|
10344
|
+
* @public
|
|
10345
|
+
* @method
|
|
10346
|
+
*/
|
|
10347
|
+
ValidateDeliveredAtComparedToStatus(result: ValidationResult): void;
|
|
10348
|
+
/**
|
|
9939
10349
|
* * Field Name: ID
|
|
9940
10350
|
* * Display Name: ID
|
|
9941
10351
|
* * SQL Data Type: uniqueidentifier
|
|
@@ -10081,6 +10491,21 @@ export declare class mjBizAppsOrdersOutboundEventEntity extends BaseEntity<mjBiz
|
|
|
10081
10491
|
*/
|
|
10082
10492
|
Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
|
|
10083
10493
|
/**
|
|
10494
|
+
* Validate() method override for MJ_BizApps_Orders: Outbound Events entity. This is an auto-generated method that invokes the generated validators for this entity for the following fields:
|
|
10495
|
+
* * Table-Level: Ensures that the event type is restricted to either 'OrderConfirmed' or 'GrantStatusChanged', and guarantees that the corresponding identifier (OrderHeaderID or EntitlementGrantID) is provided based on the event type.
|
|
10496
|
+
* @public
|
|
10497
|
+
* @method
|
|
10498
|
+
* @override
|
|
10499
|
+
*/
|
|
10500
|
+
Validate(): ValidationResult;
|
|
10501
|
+
/**
|
|
10502
|
+
* Ensures that the event type is restricted to either 'OrderConfirmed' or 'GrantStatusChanged', and guarantees that the corresponding identifier (OrderHeaderID or EntitlementGrantID) is provided based on the event type.
|
|
10503
|
+
* @param result - the ValidationResult object to add any errors or warnings to
|
|
10504
|
+
* @public
|
|
10505
|
+
* @method
|
|
10506
|
+
*/
|
|
10507
|
+
ValidateEventTypeAndAssociatedIdentifiers(result: ValidationResult): void;
|
|
10508
|
+
/**
|
|
10084
10509
|
* * Field Name: ID
|
|
10085
10510
|
* * Display Name: ID
|
|
10086
10511
|
* * SQL Data Type: uniqueidentifier
|
|
@@ -10181,14 +10606,14 @@ export declare class mjBizAppsOrdersPaymentDetailEntity extends BaseEntity<mjBiz
|
|
|
10181
10606
|
Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
|
|
10182
10607
|
/**
|
|
10183
10608
|
* Validate() method override for MJ_BizApps_Orders: Payment Details entity. This is an auto-generated method that invokes the generated validators for this entity for the following fields:
|
|
10184
|
-
* * ExpiryMonth: The
|
|
10609
|
+
* * ExpiryMonth: The expiry month, if specified, must be a valid month number between 1 and 12.
|
|
10185
10610
|
* @public
|
|
10186
10611
|
* @method
|
|
10187
10612
|
* @override
|
|
10188
10613
|
*/
|
|
10189
10614
|
Validate(): ValidationResult;
|
|
10190
10615
|
/**
|
|
10191
|
-
* The
|
|
10616
|
+
* The expiry month, if specified, must be a valid month number between 1 and 12.
|
|
10192
10617
|
* @param result - the ValidationResult object to add any errors or warnings to
|
|
10193
10618
|
* @public
|
|
10194
10619
|
* @method
|
|
@@ -10449,6 +10874,21 @@ export declare class mjBizAppsOrdersPaymentHeaderEntity extends BaseEntity<mjBiz
|
|
|
10449
10874
|
*/
|
|
10450
10875
|
Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
|
|
10451
10876
|
/**
|
|
10877
|
+
* Validate() method override for MJ_BizApps_Orders: Payment Headers entity. This is an auto-generated method that invokes the generated validators for this entity for the following fields:
|
|
10878
|
+
* * Table-Level: A payment must either have both a reversed payment reference and a reversal source, or have neither. This ensures that reversal details are fully documented when a payment is reversed, and not populated for standard payments.
|
|
10879
|
+
* @public
|
|
10880
|
+
* @method
|
|
10881
|
+
* @override
|
|
10882
|
+
*/
|
|
10883
|
+
Validate(): ValidationResult;
|
|
10884
|
+
/**
|
|
10885
|
+
* A payment must either have both a reversed payment reference and a reversal source, or have neither. This ensures that reversal details are fully documented when a payment is reversed, and not populated for standard payments.
|
|
10886
|
+
* @param result - the ValidationResult object to add any errors or warnings to
|
|
10887
|
+
* @public
|
|
10888
|
+
* @method
|
|
10889
|
+
*/
|
|
10890
|
+
ValidateReversesPaymentHeaderAndReversalSourceCoexistence(result: ValidationResult): void;
|
|
10891
|
+
/**
|
|
10452
10892
|
* * Field Name: ID
|
|
10453
10893
|
* * Display Name: ID
|
|
10454
10894
|
* * SQL Data Type: uniqueidentifier
|
|
@@ -11456,14 +11896,14 @@ export declare class mjBizAppsOrdersPaymentTermsTypeEntity extends BaseEntity<mj
|
|
|
11456
11896
|
Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
|
|
11457
11897
|
/**
|
|
11458
11898
|
* Validate() method override for MJ_BizApps_Orders: Payment Terms Types entity. This is an auto-generated method that invokes the generated validators for this entity for the following fields:
|
|
11459
|
-
* * NetDays: Net Days must be
|
|
11899
|
+
* * NetDays: Net Days must be greater than or equal to 0 to ensure payment terms or durations are not negative.
|
|
11460
11900
|
* @public
|
|
11461
11901
|
* @method
|
|
11462
11902
|
* @override
|
|
11463
11903
|
*/
|
|
11464
11904
|
Validate(): ValidationResult;
|
|
11465
11905
|
/**
|
|
11466
|
-
* Net Days must be
|
|
11906
|
+
* Net Days must be greater than or equal to 0 to ensure payment terms or durations are not negative.
|
|
11467
11907
|
* @param result - the ValidationResult object to add any errors or warnings to
|
|
11468
11908
|
* @public
|
|
11469
11909
|
* @method
|
|
@@ -11692,7 +12132,7 @@ export declare class mjBizAppsOrdersPriceListAssignmentEntity extends BaseEntity
|
|
|
11692
12132
|
/**
|
|
11693
12133
|
* Validate() method override for MJ_BizApps_Orders: Price List Assignments entity. This is an auto-generated method that invokes the generated validators for this entity for the following fields:
|
|
11694
12134
|
* * Table-Level: If both a start date and an end date are specified, the end date must be later than the start date.
|
|
11695
|
-
* * Table-Level: Each record must be associated with either an Organization or a Person, but not both.
|
|
12135
|
+
* * Table-Level: Each record must be associated with either an Organization or a Person, but not both. Exactly one of these associations is required.
|
|
11696
12136
|
* @public
|
|
11697
12137
|
* @method
|
|
11698
12138
|
* @override
|
|
@@ -11706,12 +12146,12 @@ export declare class mjBizAppsOrdersPriceListAssignmentEntity extends BaseEntity
|
|
|
11706
12146
|
*/
|
|
11707
12147
|
ValidateEndedAtAfterStartedAt(result: ValidationResult): void;
|
|
11708
12148
|
/**
|
|
11709
|
-
* Each record must be associated with either an Organization or a Person, but not both.
|
|
12149
|
+
* Each record must be associated with either an Organization or a Person, but not both. Exactly one of these associations is required.
|
|
11710
12150
|
* @param result - the ValidationResult object to add any errors or warnings to
|
|
11711
12151
|
* @public
|
|
11712
12152
|
* @method
|
|
11713
12153
|
*/
|
|
11714
|
-
|
|
12154
|
+
ValidateExclusiveOrganizationOrPerson(result: ValidationResult): void;
|
|
11715
12155
|
/**
|
|
11716
12156
|
* * Field Name: ID
|
|
11717
12157
|
* * Display Name: ID
|
|
@@ -12197,6 +12637,7 @@ export declare class mjBizAppsOrdersProductCategoryEntity extends BaseEntity<mjB
|
|
|
12197
12637
|
Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
|
|
12198
12638
|
/**
|
|
12199
12639
|
* Validate() method override for MJ_BizApps_Orders: Product Categories entity. This is an auto-generated method that invokes the generated validators for this entity for the following fields:
|
|
12640
|
+
* * RenewalIncreasePercent: The renewal increase percentage must be between 0% and 100% if it is specified, ensuring that any rate adjustments fall within a valid range.
|
|
12200
12641
|
* * Table-Level: A product category cannot be its own parent category to prevent circular references in the category hierarchy.
|
|
12201
12642
|
* @public
|
|
12202
12643
|
* @method
|
|
@@ -12204,6 +12645,13 @@ export declare class mjBizAppsOrdersProductCategoryEntity extends BaseEntity<mjB
|
|
|
12204
12645
|
*/
|
|
12205
12646
|
Validate(): ValidationResult;
|
|
12206
12647
|
/**
|
|
12648
|
+
* The renewal increase percentage must be between 0% and 100% if it is specified, ensuring that any rate adjustments fall within a valid range.
|
|
12649
|
+
* @param result - the ValidationResult object to add any errors or warnings to
|
|
12650
|
+
* @public
|
|
12651
|
+
* @method
|
|
12652
|
+
*/
|
|
12653
|
+
ValidateRenewalIncreasePercentRange(result: ValidationResult): void;
|
|
12654
|
+
/**
|
|
12207
12655
|
* A product category cannot be its own parent category to prevent circular references in the category hierarchy.
|
|
12208
12656
|
* @param result - the ValidationResult object to add any errors or warnings to
|
|
12209
12657
|
* @public
|
|
@@ -12344,6 +12792,14 @@ export declare class mjBizAppsOrdersProductCategoryEntity extends BaseEntity<mjB
|
|
|
12344
12792
|
get PricingDriverClass(): string | null;
|
|
12345
12793
|
set PricingDriverClass(value: string | null);
|
|
12346
12794
|
/**
|
|
12795
|
+
* * Field Name: RenewalIncreasePercent
|
|
12796
|
+
* * Display Name: Renewal Increase Percent
|
|
12797
|
+
* * SQL Data Type: decimal(7, 4)
|
|
12798
|
+
* * Description: Percent added to a subscription's price when it renews, for every product in this category and its child categories. NULL means inherit from the parent category, then the company's OrderCompanyPolicy. A subscription or product value overrides it.
|
|
12799
|
+
*/
|
|
12800
|
+
get RenewalIncreasePercent(): number | null;
|
|
12801
|
+
set RenewalIncreasePercent(value: number | null);
|
|
12802
|
+
/**
|
|
12347
12803
|
* * Field Name: Company
|
|
12348
12804
|
* * Display Name: Company
|
|
12349
12805
|
* * SQL Data Type: nvarchar(50)
|
|
@@ -12413,8 +12869,9 @@ export declare class mjBizAppsOrdersProductEntitlementEntity extends BaseEntity<
|
|
|
12413
12869
|
/**
|
|
12414
12870
|
* Validate() method override for MJ_BizApps_Orders: Product Entitlements entity. This is an auto-generated method that invokes the generated validators for this entity for the following fields:
|
|
12415
12871
|
* * AccessLagHours: Access lag hours, if specified, must be a non-negative number (0 or greater).
|
|
12416
|
-
* * AccessLeadHours: Access lead hours, if
|
|
12417
|
-
* * Table-Level:
|
|
12872
|
+
* * AccessLeadHours: Access lead hours, if specified, must be a non-negative value of 0 or greater.
|
|
12873
|
+
* * Table-Level: Choice Group Key and Choice Option Value must either both be provided or both be left empty to ensure data consistency.
|
|
12874
|
+
* * Table-Level: When the Validity Mode is set to 'FixedDuration', the Validity Duration (in days) must be greater than 0.
|
|
12418
12875
|
* @public
|
|
12419
12876
|
* @method
|
|
12420
12877
|
* @override
|
|
@@ -12428,19 +12885,26 @@ export declare class mjBizAppsOrdersProductEntitlementEntity extends BaseEntity<
|
|
|
12428
12885
|
*/
|
|
12429
12886
|
ValidateAccessLagHoursGreaterThanOrEqualToZero(result: ValidationResult): void;
|
|
12430
12887
|
/**
|
|
12431
|
-
* Access lead hours, if
|
|
12888
|
+
* Access lead hours, if specified, must be a non-negative value of 0 or greater.
|
|
12432
12889
|
* @param result - the ValidationResult object to add any errors or warnings to
|
|
12433
12890
|
* @public
|
|
12434
12891
|
* @method
|
|
12435
12892
|
*/
|
|
12436
12893
|
ValidateAccessLeadHoursNonNegative(result: ValidationResult): void;
|
|
12437
12894
|
/**
|
|
12438
|
-
*
|
|
12895
|
+
* Choice Group Key and Choice Option Value must either both be provided or both be left empty to ensure data consistency.
|
|
12896
|
+
* @param result - the ValidationResult object to add any errors or warnings to
|
|
12897
|
+
* @public
|
|
12898
|
+
* @method
|
|
12899
|
+
*/
|
|
12900
|
+
ValidateChoiceGroupKeyAndOptionValue(result: ValidationResult): void;
|
|
12901
|
+
/**
|
|
12902
|
+
* When the Validity Mode is set to 'FixedDuration', the Validity Duration (in days) must be greater than 0.
|
|
12439
12903
|
* @param result - the ValidationResult object to add any errors or warnings to
|
|
12440
12904
|
* @public
|
|
12441
12905
|
* @method
|
|
12442
12906
|
*/
|
|
12443
|
-
|
|
12907
|
+
ValidateValidityDurationForFixedDuration(result: ValidationResult): void;
|
|
12444
12908
|
/**
|
|
12445
12909
|
* * Field Name: ID
|
|
12446
12910
|
* * Display Name: ID
|
|
@@ -12609,11 +13073,11 @@ export declare class mjBizAppsOrdersProductPriceEntity extends BaseEntity<mjBizA
|
|
|
12609
13073
|
Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
|
|
12610
13074
|
/**
|
|
12611
13075
|
* Validate() method override for MJ_BizApps_Orders: Product Prices entity. This is an auto-generated method that invokes the generated validators for this entity for the following fields:
|
|
12612
|
-
* * Applicability: The applicability details, if provided, must be a valid JSON
|
|
13076
|
+
* * Applicability: The applicability details, if provided, must be a valid JSON formatted string to ensure structured data integrity.
|
|
12613
13077
|
* * Table-Level: The end date (Effective To) must be on or after the start date (Effective From) if an end date is specified.
|
|
12614
13078
|
* * Table-Level: If both a minimum and maximum quantity are specified, the maximum quantity must be greater than or equal to the minimum quantity to ensure a valid range.
|
|
12615
13079
|
* * Table-Level: If the pricing model is set to 'Package', a package quantity greater than zero must be specified.
|
|
12616
|
-
* * Table-Level: Either a Product or a Product Category must be specified, but not both. This ensures the pricing rule
|
|
13080
|
+
* * Table-Level: Either a Product or a Product Category must be specified, but not both. This ensures that the pricing rule is targeted correctly to only one entity type.
|
|
12617
13081
|
* * Table-Level: The maximum recurrence day of the month must be greater than or equal to the minimum recurrence day of the month when both are specified.
|
|
12618
13082
|
* @public
|
|
12619
13083
|
* @method
|
|
@@ -12621,7 +13085,7 @@ export declare class mjBizAppsOrdersProductPriceEntity extends BaseEntity<mjBizA
|
|
|
12621
13085
|
*/
|
|
12622
13086
|
Validate(): ValidationResult;
|
|
12623
13087
|
/**
|
|
12624
|
-
* The applicability details, if provided, must be a valid JSON
|
|
13088
|
+
* The applicability details, if provided, must be a valid JSON formatted string to ensure structured data integrity.
|
|
12625
13089
|
* @param result - the ValidationResult object to add any errors or warnings to
|
|
12626
13090
|
* @public
|
|
12627
13091
|
* @method
|
|
@@ -12649,7 +13113,7 @@ export declare class mjBizAppsOrdersProductPriceEntity extends BaseEntity<mjBizA
|
|
|
12649
13113
|
*/
|
|
12650
13114
|
ValidatePackageQuantityForPackagePricingModel(result: ValidationResult): void;
|
|
12651
13115
|
/**
|
|
12652
|
-
* Either a Product or a Product Category must be specified, but not both. This ensures the pricing rule
|
|
13116
|
+
* Either a Product or a Product Category must be specified, but not both. This ensures that the pricing rule is targeted correctly to only one entity type.
|
|
12653
13117
|
* @param result - the ValidationResult object to add any errors or warnings to
|
|
12654
13118
|
* @public
|
|
12655
13119
|
* @method
|
|
@@ -13152,7 +13616,8 @@ export declare class mjBizAppsOrdersProductEntity extends BaseEntity<mjBizAppsOr
|
|
|
13152
13616
|
Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
|
|
13153
13617
|
/**
|
|
13154
13618
|
* Validate() method override for MJ_BizApps_Orders: Products entity. This is an auto-generated method that invokes the generated validators for this entity for the following fields:
|
|
13155
|
-
* * MaxQuantityPerLine: The maximum quantity allowed per line must be
|
|
13619
|
+
* * MaxQuantityPerLine: The maximum quantity allowed per line must be at least 1, if a limit is specified.
|
|
13620
|
+
* * RenewalIncreasePercent: The renewal increase percentage must be between 0 and 100 percent, if specified.
|
|
13156
13621
|
* * Table-Level: The availability end date must be on or after the availability start date when both dates are provided.
|
|
13157
13622
|
* * Table-Level: A product cannot be its own successor. If a successor product is specified, it must be a different product to prevent circular references.
|
|
13158
13623
|
* @public
|
|
@@ -13161,13 +13626,20 @@ export declare class mjBizAppsOrdersProductEntity extends BaseEntity<mjBizAppsOr
|
|
|
13161
13626
|
*/
|
|
13162
13627
|
Validate(): ValidationResult;
|
|
13163
13628
|
/**
|
|
13164
|
-
* The maximum quantity allowed per line must be
|
|
13629
|
+
* The maximum quantity allowed per line must be at least 1, if a limit is specified.
|
|
13165
13630
|
* @param result - the ValidationResult object to add any errors or warnings to
|
|
13166
13631
|
* @public
|
|
13167
13632
|
* @method
|
|
13168
13633
|
*/
|
|
13169
13634
|
ValidateMaxQuantityPerLineMinimum(result: ValidationResult): void;
|
|
13170
13635
|
/**
|
|
13636
|
+
* The renewal increase percentage must be between 0 and 100 percent, if specified.
|
|
13637
|
+
* @param result - the ValidationResult object to add any errors or warnings to
|
|
13638
|
+
* @public
|
|
13639
|
+
* @method
|
|
13640
|
+
*/
|
|
13641
|
+
ValidateRenewalIncreasePercentRange(result: ValidationResult): void;
|
|
13642
|
+
/**
|
|
13171
13643
|
* The availability end date must be on or after the availability start date when both dates are provided.
|
|
13172
13644
|
* @param result - the ValidationResult object to add any errors or warnings to
|
|
13173
13645
|
* @public
|
|
@@ -13281,8 +13753,9 @@ export declare class mjBizAppsOrdersProductEntity extends BaseEntity<mjBizAppsOr
|
|
|
13281
13753
|
/**
|
|
13282
13754
|
* * Field Name: StandaloneSellingPrice
|
|
13283
13755
|
* * Display Name: Standalone Selling Price
|
|
13284
|
-
* *
|
|
13285
|
-
* *
|
|
13756
|
+
* *
|
|
13757
|
+
* * @deprecated This field is deprecated and will be removed in a future version. Using it will result in console warnings.SQL Data Type: decimal(19, 4)
|
|
13758
|
+
* * Description: DEPRECATED — do not use as a list price or quote. What someone pays is MJ_BizApps_Orders: Product Prices (Name, Amount, Applicability). Bundle SSP allocation already reads those rows. Column retained so historical SPs and existing data still validate; do not populate it for new products.
|
|
13286
13759
|
*/
|
|
13287
13760
|
get StandaloneSellingPrice(): number | null;
|
|
13288
13761
|
set StandaloneSellingPrice(value: number | null);
|
|
@@ -13386,6 +13859,23 @@ export declare class mjBizAppsOrdersProductEntity extends BaseEntity<mjBizAppsOr
|
|
|
13386
13859
|
get MaxQuantityPerLine(): number | null;
|
|
13387
13860
|
set MaxQuantityPerLine(value: number | null);
|
|
13388
13861
|
/**
|
|
13862
|
+
* * Field Name: SubscriptionFamilyID
|
|
13863
|
+
* * Display Name: Subscription Family ID
|
|
13864
|
+
* * SQL Data Type: uniqueidentifier
|
|
13865
|
+
* * Related Entity/Foreign Key: MJ_BizApps_Orders: Subscription Families (vwSubscriptionFamilies.ID)
|
|
13866
|
+
* * Description: The subscription family this product is a band of. At confirm, a line for this product is checked against the holder's subscriptions to the family's other products. NULL means the product has no other bands. Must belong to the product's company.
|
|
13867
|
+
*/
|
|
13868
|
+
get SubscriptionFamilyID(): string | null;
|
|
13869
|
+
set SubscriptionFamilyID(value: string | null);
|
|
13870
|
+
/**
|
|
13871
|
+
* * Field Name: RenewalIncreasePercent
|
|
13872
|
+
* * Display Name: Renewal Increase Percent
|
|
13873
|
+
* * SQL Data Type: decimal(7, 4)
|
|
13874
|
+
* * Description: Percent added to a subscription's price when it renews onto this product. Overrides the product's category and the company. NULL means inherit from the category and its ancestors, then the company's OrderCompanyPolicy. A subscription's own value overrides it.
|
|
13875
|
+
*/
|
|
13876
|
+
get RenewalIncreasePercent(): number | null;
|
|
13877
|
+
set RenewalIncreasePercent(value: number | null);
|
|
13878
|
+
/**
|
|
13389
13879
|
* * Field Name: ProductType
|
|
13390
13880
|
* * Display Name: Product Type Name
|
|
13391
13881
|
* * SQL Data Type: nvarchar(100)
|
|
@@ -13421,6 +13911,12 @@ export declare class mjBizAppsOrdersProductEntity extends BaseEntity<mjBizAppsOr
|
|
|
13421
13911
|
* * SQL Data Type: nvarchar(200)
|
|
13422
13912
|
*/
|
|
13423
13913
|
get SubscriptionType(): string | null;
|
|
13914
|
+
/**
|
|
13915
|
+
* * Field Name: SubscriptionFamily
|
|
13916
|
+
* * Display Name: Subscription Family
|
|
13917
|
+
* * SQL Data Type: nvarchar(200)
|
|
13918
|
+
*/
|
|
13919
|
+
get SubscriptionFamily(): string | null;
|
|
13424
13920
|
}
|
|
13425
13921
|
/**
|
|
13426
13922
|
* MJ_BizApps_Orders: Promotion Codes - strongly typed entity sub-class
|
|
@@ -13581,19 +14077,19 @@ export declare class mjBizAppsOrdersPromotionTargetEntity extends BaseEntity<mjB
|
|
|
13581
14077
|
Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
|
|
13582
14078
|
/**
|
|
13583
14079
|
* Validate() method override for MJ_BizApps_Orders: Promotion Targets entity. This is an auto-generated method that invokes the generated validators for this entity for the following fields:
|
|
13584
|
-
* * Table-Level: Either a Product or a Product Category must be specified, but not both. This ensures
|
|
14080
|
+
* * Table-Level: Either a Product or a Product Category must be specified, but not both. This ensures the promotion is targeted to exactly one scope.
|
|
13585
14081
|
* @public
|
|
13586
14082
|
* @method
|
|
13587
14083
|
* @override
|
|
13588
14084
|
*/
|
|
13589
14085
|
Validate(): ValidationResult;
|
|
13590
14086
|
/**
|
|
13591
|
-
* Either a Product or a Product Category must be specified, but not both. This ensures
|
|
14087
|
+
* Either a Product or a Product Category must be specified, but not both. This ensures the promotion is targeted to exactly one scope.
|
|
13592
14088
|
* @param result - the ValidationResult object to add any errors or warnings to
|
|
13593
14089
|
* @public
|
|
13594
14090
|
* @method
|
|
13595
14091
|
*/
|
|
13596
|
-
|
|
14092
|
+
ValidateProductOrCategoryExclusivity(result: ValidationResult): void;
|
|
13597
14093
|
/**
|
|
13598
14094
|
* * Field Name: ID
|
|
13599
14095
|
* * Display Name: ID
|
|
@@ -14154,14 +14650,31 @@ export declare class mjBizAppsOrdersSalesAuthorityEntity extends BaseEntity<mjBi
|
|
|
14154
14650
|
Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
|
|
14155
14651
|
/**
|
|
14156
14652
|
* Validate() method override for MJ_BizApps_Orders: Sales Authorities entity. This is an auto-generated method that invokes the generated validators for this entity for the following fields:
|
|
14653
|
+
* * MaxConcessionPctOfContract: The maximum concession percentage of a contract must be a value between 0 and 1 (inclusive), representing 0% to 100%.
|
|
14654
|
+
* * MaxConcessionValue: The maximum concession value must be greater than or equal to zero.
|
|
14157
14655
|
* * MaxDiscountPct: The maximum discount percentage, if specified, must be a value between 0 and 1 (inclusive) to represent a valid percentage range from 0% to 100%.
|
|
14158
14656
|
* * MaxOrderValue: The maximum order value must be greater than or equal to 0, if it is specified.
|
|
14657
|
+
* * MaxTermExtensionDays: The maximum term extension days must be a non-negative number (0 or greater).
|
|
14159
14658
|
* @public
|
|
14160
14659
|
* @method
|
|
14161
14660
|
* @override
|
|
14162
14661
|
*/
|
|
14163
14662
|
Validate(): ValidationResult;
|
|
14164
14663
|
/**
|
|
14664
|
+
* The maximum concession percentage of a contract must be a value between 0 and 1 (inclusive), representing 0% to 100%.
|
|
14665
|
+
* @param result - the ValidationResult object to add any errors or warnings to
|
|
14666
|
+
* @public
|
|
14667
|
+
* @method
|
|
14668
|
+
*/
|
|
14669
|
+
ValidateMaxConcessionPctOfContractRange(result: ValidationResult): void;
|
|
14670
|
+
/**
|
|
14671
|
+
* The maximum concession value must be greater than or equal to zero.
|
|
14672
|
+
* @param result - the ValidationResult object to add any errors or warnings to
|
|
14673
|
+
* @public
|
|
14674
|
+
* @method
|
|
14675
|
+
*/
|
|
14676
|
+
ValidateMaxConcessionValueGreaterThanOrEqualToZero(result: ValidationResult): void;
|
|
14677
|
+
/**
|
|
14165
14678
|
* The maximum discount percentage, if specified, must be a value between 0 and 1 (inclusive) to represent a valid percentage range from 0% to 100%.
|
|
14166
14679
|
* @param result - the ValidationResult object to add any errors or warnings to
|
|
14167
14680
|
* @public
|
|
@@ -14176,6 +14689,13 @@ export declare class mjBizAppsOrdersSalesAuthorityEntity extends BaseEntity<mjBi
|
|
|
14176
14689
|
*/
|
|
14177
14690
|
ValidateMaxOrderValueGreaterThanOrEqualToZero(result: ValidationResult): void;
|
|
14178
14691
|
/**
|
|
14692
|
+
* The maximum term extension days must be a non-negative number (0 or greater).
|
|
14693
|
+
* @param result - the ValidationResult object to add any errors or warnings to
|
|
14694
|
+
* @public
|
|
14695
|
+
* @method
|
|
14696
|
+
*/
|
|
14697
|
+
ValidateMaxTermExtensionDaysMinLimit(result: ValidationResult): void;
|
|
14698
|
+
/**
|
|
14179
14699
|
* * Field Name: ID
|
|
14180
14700
|
* * Display Name: ID
|
|
14181
14701
|
* * SQL Data Type: uniqueidentifier
|
|
@@ -14428,14 +14948,14 @@ export declare class mjBizAppsOrdersStoredValueAccountEntity extends BaseEntity<
|
|
|
14428
14948
|
Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
|
|
14429
14949
|
/**
|
|
14430
14950
|
* Validate() method override for MJ_BizApps_Orders: Stored Value Accounts entity. This is an auto-generated method that invokes the generated validators for this entity for the following fields:
|
|
14431
|
-
* * InitialAmount: The initial amount must be greater than zero to ensure
|
|
14951
|
+
* * InitialAmount: The initial amount must be greater than zero to ensure a valid positive starting balance.
|
|
14432
14952
|
* @public
|
|
14433
14953
|
* @method
|
|
14434
14954
|
* @override
|
|
14435
14955
|
*/
|
|
14436
14956
|
Validate(): ValidationResult;
|
|
14437
14957
|
/**
|
|
14438
|
-
* The initial amount must be greater than zero to ensure
|
|
14958
|
+
* The initial amount must be greater than zero to ensure a valid positive starting balance.
|
|
14439
14959
|
* @param result - the ValidationResult object to add any errors or warnings to
|
|
14440
14960
|
* @public
|
|
14441
14961
|
* @method
|
|
@@ -14590,14 +15110,14 @@ export declare class mjBizAppsOrdersStoredValueTransactionEntity extends BaseEnt
|
|
|
14590
15110
|
Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
|
|
14591
15111
|
/**
|
|
14592
15112
|
* Validate() method override for MJ_BizApps_Orders: Stored Value Transactions entity. This is an auto-generated method that invokes the generated validators for this entity for the following fields:
|
|
14593
|
-
* * Amount: The transaction amount cannot be zero. Every transaction must
|
|
15113
|
+
* * Amount: The transaction amount cannot be zero. Every transaction must represent a non-zero value to ensure financial integrity.
|
|
14594
15114
|
* @public
|
|
14595
15115
|
* @method
|
|
14596
15116
|
* @override
|
|
14597
15117
|
*/
|
|
14598
15118
|
Validate(): ValidationResult;
|
|
14599
15119
|
/**
|
|
14600
|
-
* The transaction amount cannot be zero. Every transaction must
|
|
15120
|
+
* The transaction amount cannot be zero. Every transaction must represent a non-zero value to ensure financial integrity.
|
|
14601
15121
|
* @param result - the ValidationResult object to add any errors or warnings to
|
|
14602
15122
|
* @public
|
|
14603
15123
|
* @method
|
|
@@ -14843,6 +15363,124 @@ export declare class mjBizAppsOrdersSubscriptionEventEntity extends BaseEntity<m
|
|
|
14843
15363
|
*/
|
|
14844
15364
|
get RelatedOrderHeader(): string | null;
|
|
14845
15365
|
}
|
|
15366
|
+
/**
|
|
15367
|
+
* MJ_BizApps_Orders: Subscription Families - strongly typed entity sub-class
|
|
15368
|
+
* * Schema: __mj_BizAppsOrders
|
|
15369
|
+
* * Base Table: SubscriptionFamily
|
|
15370
|
+
* * Base View: vwSubscriptionFamilies
|
|
15371
|
+
* * @description The products that are bands of one subscription offering (for example a standard and a premium tier), within one selling company. At confirm, a line for one band is checked against the holder's subscriptions to the family's other bands, and overlapping coverage is refused or allowed according to the subscription types' ConcurrencyMode.
|
|
15372
|
+
* * Primary Key: ID
|
|
15373
|
+
* @extends {BaseEntity}
|
|
15374
|
+
* @class
|
|
15375
|
+
* @public
|
|
15376
|
+
*/
|
|
15377
|
+
export declare class mjBizAppsOrdersSubscriptionFamilyEntity extends BaseEntity<mjBizAppsOrdersSubscriptionFamilyEntityType> {
|
|
15378
|
+
/**
|
|
15379
|
+
* Loads the MJ_BizApps_Orders: Subscription Families record from the database
|
|
15380
|
+
* @param ID: string - primary key value to load the MJ_BizApps_Orders: Subscription Families record.
|
|
15381
|
+
* @param EntityRelationshipsToLoad - (optional) the relationships to load
|
|
15382
|
+
* @returns {Promise<boolean>} - true if successful, false otherwise
|
|
15383
|
+
* @public
|
|
15384
|
+
* @async
|
|
15385
|
+
* @memberof mjBizAppsOrdersSubscriptionFamilyEntity
|
|
15386
|
+
* @method
|
|
15387
|
+
* @override
|
|
15388
|
+
*/
|
|
15389
|
+
Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
|
|
15390
|
+
/**
|
|
15391
|
+
* Validate() method override for MJ_BizApps_Orders: Subscription Families entity. This is an auto-generated method that invokes the generated validators for this entity for the following fields:
|
|
15392
|
+
* * Code: The Code field must contain a value and cannot be empty or consist only of spaces.
|
|
15393
|
+
* * Name: The Name field cannot be empty or consist only of whitespace characters. A valid, non-empty name is required for proper identification.
|
|
15394
|
+
* @public
|
|
15395
|
+
* @method
|
|
15396
|
+
* @override
|
|
15397
|
+
*/
|
|
15398
|
+
Validate(): ValidationResult;
|
|
15399
|
+
/**
|
|
15400
|
+
* The Code field must contain a value and cannot be empty or consist only of spaces.
|
|
15401
|
+
* @param result - the ValidationResult object to add any errors or warnings to
|
|
15402
|
+
* @public
|
|
15403
|
+
* @method
|
|
15404
|
+
*/
|
|
15405
|
+
ValidateCodeNotEmpty(result: ValidationResult): void;
|
|
15406
|
+
/**
|
|
15407
|
+
* The Name field cannot be empty or consist only of whitespace characters. A valid, non-empty name is required for proper identification.
|
|
15408
|
+
* @param result - the ValidationResult object to add any errors or warnings to
|
|
15409
|
+
* @public
|
|
15410
|
+
* @method
|
|
15411
|
+
*/
|
|
15412
|
+
ValidateNameNotEmpty(result: ValidationResult): void;
|
|
15413
|
+
/**
|
|
15414
|
+
* * Field Name: ID
|
|
15415
|
+
* * Display Name: ID
|
|
15416
|
+
* * SQL Data Type: uniqueidentifier
|
|
15417
|
+
* * Default Value: newsequentialid()
|
|
15418
|
+
*/
|
|
15419
|
+
get ID(): string;
|
|
15420
|
+
set ID(value: string);
|
|
15421
|
+
/**
|
|
15422
|
+
* * Field Name: CompanyID
|
|
15423
|
+
* * Display Name: Company ID
|
|
15424
|
+
* * SQL Data Type: uniqueidentifier
|
|
15425
|
+
* * Related Entity/Foreign Key: MJ: Companies (vwCompanies.ID)
|
|
15426
|
+
* * Description: The selling company that owns the family. Only that company's products can belong to it.
|
|
15427
|
+
*/
|
|
15428
|
+
get CompanyID(): string;
|
|
15429
|
+
set CompanyID(value: string);
|
|
15430
|
+
/**
|
|
15431
|
+
* * Field Name: Code
|
|
15432
|
+
* * Display Name: Code
|
|
15433
|
+
* * SQL Data Type: nvarchar(40)
|
|
15434
|
+
* * Description: Short code for the family, unique within its company.
|
|
15435
|
+
*/
|
|
15436
|
+
get Code(): string;
|
|
15437
|
+
set Code(value: string);
|
|
15438
|
+
/**
|
|
15439
|
+
* * Field Name: Name
|
|
15440
|
+
* * Display Name: Name
|
|
15441
|
+
* * SQL Data Type: nvarchar(200)
|
|
15442
|
+
* * Description: Display name of the offering the family's bands belong to.
|
|
15443
|
+
*/
|
|
15444
|
+
get Name(): string;
|
|
15445
|
+
set Name(value: string);
|
|
15446
|
+
/**
|
|
15447
|
+
* * Field Name: Description
|
|
15448
|
+
* * Display Name: Description
|
|
15449
|
+
* * SQL Data Type: nvarchar(MAX)
|
|
15450
|
+
* * Description: Optional notes on the offering and its bands.
|
|
15451
|
+
*/
|
|
15452
|
+
get Description(): string | null;
|
|
15453
|
+
set Description(value: string | null);
|
|
15454
|
+
/**
|
|
15455
|
+
* * Field Name: IsActive
|
|
15456
|
+
* * Display Name: Is Active
|
|
15457
|
+
* * SQL Data Type: bit
|
|
15458
|
+
* * Default Value: 1
|
|
15459
|
+
* * Description: False retires the family from new product assignments. Products already in it keep it, and the overlap check still applies to them.
|
|
15460
|
+
*/
|
|
15461
|
+
get IsActive(): boolean;
|
|
15462
|
+
set IsActive(value: boolean);
|
|
15463
|
+
/**
|
|
15464
|
+
* * Field Name: __mj_CreatedAt
|
|
15465
|
+
* * Display Name: Created At
|
|
15466
|
+
* * SQL Data Type: datetimeoffset
|
|
15467
|
+
* * Default Value: getutcdate()
|
|
15468
|
+
*/
|
|
15469
|
+
get __mj_CreatedAt(): Date;
|
|
15470
|
+
/**
|
|
15471
|
+
* * Field Name: __mj_UpdatedAt
|
|
15472
|
+
* * Display Name: Updated At
|
|
15473
|
+
* * SQL Data Type: datetimeoffset
|
|
15474
|
+
* * Default Value: getutcdate()
|
|
15475
|
+
*/
|
|
15476
|
+
get __mj_UpdatedAt(): Date;
|
|
15477
|
+
/**
|
|
15478
|
+
* * Field Name: Company
|
|
15479
|
+
* * Display Name: Company
|
|
15480
|
+
* * SQL Data Type: nvarchar(50)
|
|
15481
|
+
*/
|
|
15482
|
+
get Company(): string;
|
|
15483
|
+
}
|
|
14846
15484
|
/**
|
|
14847
15485
|
* MJ_BizApps_Orders: Subscription Sequences - strongly typed entity sub-class
|
|
14848
15486
|
* * Schema: __mj_BizAppsOrders
|
|
@@ -14947,7 +15585,7 @@ export declare class mjBizAppsOrdersSubscriptionTermEntity extends BaseEntity<mj
|
|
|
14947
15585
|
Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
|
|
14948
15586
|
/**
|
|
14949
15587
|
* Validate() method override for MJ_BizApps_Orders: Subscription Terms entity. This is an auto-generated method that invokes the generated validators for this entity for the following fields:
|
|
14950
|
-
* * TermNumber: The term number must be a positive
|
|
15588
|
+
* * TermNumber: The term number must be a positive value greater than zero.
|
|
14951
15589
|
* * Table-Level: The subscription term's end date must be on or after its start date to ensure a valid active period.
|
|
14952
15590
|
* * Table-Level: If an item is marked as prorated, a proration factor must be provided to ensure accurate financial calculations.
|
|
14953
15591
|
* @public
|
|
@@ -14956,7 +15594,7 @@ export declare class mjBizAppsOrdersSubscriptionTermEntity extends BaseEntity<mj
|
|
|
14956
15594
|
*/
|
|
14957
15595
|
Validate(): ValidationResult;
|
|
14958
15596
|
/**
|
|
14959
|
-
* The term number must be a positive
|
|
15597
|
+
* The term number must be a positive value greater than zero.
|
|
14960
15598
|
* @param result - the ValidationResult object to add any errors or warnings to
|
|
14961
15599
|
* @public
|
|
14962
15600
|
* @method
|
|
@@ -15489,8 +16127,9 @@ export declare class mjBizAppsOrdersSubscriptionEntity extends BaseEntity<mjBizA
|
|
|
15489
16127
|
Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
|
|
15490
16128
|
/**
|
|
15491
16129
|
* Validate() method override for MJ_BizApps_Orders: Subscriptions entity. This is an auto-generated method that invokes the generated validators for this entity for the following fields:
|
|
16130
|
+
* * RenewalIncreasePercent: The renewal increase percentage, if specified, must be a value between 0% and 100% to ensure valid pricing adjustments.
|
|
15492
16131
|
* * RenewalLeadDays: Renewal lead days must be a non-negative number (0 or greater) if specified.
|
|
15493
|
-
* * Table-Level: A subscription cannot
|
|
16132
|
+
* * Table-Level: A subscription cannot migrate from itself. The 'Migrates From Subscription' field must refer to a different subscription than the current one.
|
|
15494
16133
|
* * Table-Level: A subscription cannot migrate to itself. This prevents logical errors where a subscription's migration destination is set as its own record.
|
|
15495
16134
|
* @public
|
|
15496
16135
|
* @method
|
|
@@ -15498,6 +16137,13 @@ export declare class mjBizAppsOrdersSubscriptionEntity extends BaseEntity<mjBizA
|
|
|
15498
16137
|
*/
|
|
15499
16138
|
Validate(): ValidationResult;
|
|
15500
16139
|
/**
|
|
16140
|
+
* The renewal increase percentage, if specified, must be a value between 0% and 100% to ensure valid pricing adjustments.
|
|
16141
|
+
* @param result - the ValidationResult object to add any errors or warnings to
|
|
16142
|
+
* @public
|
|
16143
|
+
* @method
|
|
16144
|
+
*/
|
|
16145
|
+
ValidateRenewalIncreasePercentRange(result: ValidationResult): void;
|
|
16146
|
+
/**
|
|
15501
16147
|
* Renewal lead days must be a non-negative number (0 or greater) if specified.
|
|
15502
16148
|
* @param result - the ValidationResult object to add any errors or warnings to
|
|
15503
16149
|
* @public
|
|
@@ -15505,7 +16151,7 @@ export declare class mjBizAppsOrdersSubscriptionEntity extends BaseEntity<mjBizA
|
|
|
15505
16151
|
*/
|
|
15506
16152
|
ValidateRenewalLeadDaysGreaterThanOrEqualToZero(result: ValidationResult): void;
|
|
15507
16153
|
/**
|
|
15508
|
-
* A subscription cannot
|
|
16154
|
+
* A subscription cannot migrate from itself. The 'Migrates From Subscription' field must refer to a different subscription than the current one.
|
|
15509
16155
|
* @param result - the ValidationResult object to add any errors or warnings to
|
|
15510
16156
|
* @public
|
|
15511
16157
|
* @method
|
|
@@ -15705,6 +16351,23 @@ export declare class mjBizAppsOrdersSubscriptionEntity extends BaseEntity<mjBizA
|
|
|
15705
16351
|
get DefaultCustomerPaymentMethodID(): string | null;
|
|
15706
16352
|
set DefaultCustomerPaymentMethodID(value: string | null);
|
|
15707
16353
|
/**
|
|
16354
|
+
* * Field Name: RenewalIncreasePercent
|
|
16355
|
+
* * Display Name: Renewal Increase Percent
|
|
16356
|
+
* * SQL Data Type: decimal(7, 4)
|
|
16357
|
+
* * Description: Percent added to this subscription's price when it renews: the contract's negotiated annual increase. Overrides the product, its category and the company. NULL means inherit from the product, then its category and ancestors, then the company's OrderCompanyPolicy; NULL everywhere means no increase. Set 0 to renew with no increase where a default would apply.
|
|
16358
|
+
*/
|
|
16359
|
+
get RenewalIncreasePercent(): number | null;
|
|
16360
|
+
set RenewalIncreasePercent(value: number | null);
|
|
16361
|
+
/**
|
|
16362
|
+
* * Field Name: CarryDiscountOnRenewal
|
|
16363
|
+
* * Display Name: Carry Discount On Renewal
|
|
16364
|
+
* * SQL Data Type: bit
|
|
16365
|
+
* * Default Value: 0
|
|
16366
|
+
* * Description: Whether the discount on the term being renewed carries into the renewal. Off by default: a first-term discount lapses and the renewal starts from the undiscounted price. Set it for a discount agreed to continue, such as a multi-year concession.
|
|
16367
|
+
*/
|
|
16368
|
+
get CarryDiscountOnRenewal(): boolean;
|
|
16369
|
+
set CarryDiscountOnRenewal(value: boolean);
|
|
16370
|
+
/**
|
|
15708
16371
|
* * Field Name: Company
|
|
15709
16372
|
* * Display Name: Company Name
|
|
15710
16373
|
* * SQL Data Type: nvarchar(50)
|