@d19n/youfibre-odin-sdk 1.0.239 → 1.0.241
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/actions-v2/CreatePaymentMethodRefundDto.d.ts +15 -1
- package/dist/entities-v2/BillingAdjustment.d.ts +72 -72
- package/dist/entities-v2/BillingAdjustment.js +45 -45
- package/package.json +1 -1
- package/src/actions-v2/CreatePaymentMethodRefundDto.ts +15 -1
- package/src/entities-v2/BillingAdjustment.ts +71 -71
|
@@ -14,7 +14,7 @@ import { OdinRecordCreateDto, OdinRecordCreatedEvent } from '@d19n/odin-types/di
|
|
|
14
14
|
* Properties for CreatePaymentMethodRefund action
|
|
15
15
|
*
|
|
16
16
|
* @property Required fields: 2
|
|
17
|
-
* @property Optional fields:
|
|
17
|
+
* @property Optional fields: 2
|
|
18
18
|
*/
|
|
19
19
|
export interface CreatePaymentMethodRefundProperties {
|
|
20
20
|
/**
|
|
@@ -33,6 +33,20 @@ export interface CreatePaymentMethodRefundProperties {
|
|
|
33
33
|
* @required
|
|
34
34
|
*/
|
|
35
35
|
Description: string;
|
|
36
|
+
/**
|
|
37
|
+
* AuthorizedBy
|
|
38
|
+
*
|
|
39
|
+
* Authorized By (Finance - PaymentMethodRefund)
|
|
40
|
+
* @type {TEXT}
|
|
41
|
+
*/
|
|
42
|
+
AuthorizedBy?: string;
|
|
43
|
+
/**
|
|
44
|
+
* OrderRef
|
|
45
|
+
*
|
|
46
|
+
* Reference identifier for PaymentMethodRefund relationships. Used for data integrity.
|
|
47
|
+
* @type {LOOKUP}
|
|
48
|
+
*/
|
|
49
|
+
OrderRef?: string;
|
|
36
50
|
}
|
|
37
51
|
/**
|
|
38
52
|
* CreatePaymentMethodRefund
|
|
@@ -22,6 +22,32 @@ export declare enum BillingAdjustmentEntityTypes {
|
|
|
22
22
|
/** Default record type */
|
|
23
23
|
DEFAULT = "DEFAULT"
|
|
24
24
|
}
|
|
25
|
+
/**
|
|
26
|
+
* Valid values for BillingAdjustment.DiscountType
|
|
27
|
+
*
|
|
28
|
+
* the type of discount (Sales - BillingAdjustment)
|
|
29
|
+
*
|
|
30
|
+
* @remarks Available options:
|
|
31
|
+
* - `AMOUNT` - Amount
|
|
32
|
+
* - `PERCENT` - Percent
|
|
33
|
+
*/
|
|
34
|
+
export declare enum BillingAdjustmentDiscountType {
|
|
35
|
+
AMOUNT = "AMOUNT",
|
|
36
|
+
PERCENT = "PERCENT"
|
|
37
|
+
}
|
|
38
|
+
/**
|
|
39
|
+
* Valid values for BillingAdjustment.ProrationType
|
|
40
|
+
*
|
|
41
|
+
* proration type charge or credit (Sales - BillingAdjustment)
|
|
42
|
+
*
|
|
43
|
+
* @remarks Available options:
|
|
44
|
+
* - `CHARGE` - Charge
|
|
45
|
+
* - `CREDIT` - Credit
|
|
46
|
+
*/
|
|
47
|
+
export declare enum BillingAdjustmentProrationType {
|
|
48
|
+
CHARGE = "CHARGE",
|
|
49
|
+
CREDIT = "CREDIT"
|
|
50
|
+
}
|
|
25
51
|
/**
|
|
26
52
|
* Valid values for BillingAdjustment.Reason
|
|
27
53
|
*
|
|
@@ -57,65 +83,39 @@ export declare enum BillingAdjustmentReason {
|
|
|
57
83
|
SALES_MISSELLING_ADJUSTMENT = "SALES_MISSELLING_ADJUSTMENT",
|
|
58
84
|
OUTAGE_COMPENSATION = "OUTAGE_COMPENSATION"
|
|
59
85
|
}
|
|
60
|
-
/**
|
|
61
|
-
* Valid values for BillingAdjustment.DiscountType
|
|
62
|
-
*
|
|
63
|
-
* the type of discount (Sales - BillingAdjustment)
|
|
64
|
-
*
|
|
65
|
-
* @remarks Available options:
|
|
66
|
-
* - `AMOUNT` - Amount
|
|
67
|
-
* - `PERCENT` - Percent
|
|
68
|
-
*/
|
|
69
|
-
export declare enum BillingAdjustmentDiscountType {
|
|
70
|
-
AMOUNT = "AMOUNT",
|
|
71
|
-
PERCENT = "PERCENT"
|
|
72
|
-
}
|
|
73
|
-
/**
|
|
74
|
-
* Valid values for BillingAdjustment.ProrationType
|
|
75
|
-
*
|
|
76
|
-
* proration type charge or credit (Sales - BillingAdjustment)
|
|
77
|
-
*
|
|
78
|
-
* @remarks Available options:
|
|
79
|
-
* - `CHARGE` - Charge
|
|
80
|
-
* - `CREDIT` - Credit
|
|
81
|
-
*/
|
|
82
|
-
export declare enum BillingAdjustmentProrationType {
|
|
83
|
-
CHARGE = "CHARGE",
|
|
84
|
-
CREDIT = "CREDIT"
|
|
85
|
-
}
|
|
86
86
|
/**
|
|
87
87
|
* Property keys for BillingAdjustment
|
|
88
88
|
* Use these constants instead of string literals for type safety
|
|
89
89
|
*/
|
|
90
90
|
export declare enum BillingAdjustmentPropertyKeys {
|
|
91
|
-
/**
|
|
92
|
-
|
|
93
|
-
/** The number of future invoices that should be free of charge (Sales - BillingAdjustment) */
|
|
94
|
-
FreePeriodLength = "FreePeriodLength",
|
|
95
|
-
/** the billing adjustment reason (Sales - BillingAdjustment) */
|
|
96
|
-
Reason = "Reason",
|
|
97
|
-
/** the value of the discount to be applied (Sales - BillingAdjustment) */
|
|
98
|
-
DiscountValue = "DiscountValue",
|
|
91
|
+
/** Describe why this billing adjustment being applied (Sales - BillingAdjustment) */
|
|
92
|
+
Description = "Description",
|
|
99
93
|
/** the length of the discount (Sales - BillingAdjustment) */
|
|
100
94
|
DiscountLength = "DiscountLength",
|
|
101
95
|
/** the type of discount (Sales - BillingAdjustment) */
|
|
102
96
|
DiscountType = "DiscountType",
|
|
97
|
+
/** the value of the discount to be applied (Sales - BillingAdjustment) */
|
|
98
|
+
DiscountValue = "DiscountValue",
|
|
99
|
+
/** The number of future invoices that should be free of charge (Sales - BillingAdjustment) */
|
|
100
|
+
FreePeriodLength = "FreePeriodLength",
|
|
103
101
|
/** end of first full cycle (Invoice.BillingPeriodEnd!) (Sales - BillingAdjustment) */
|
|
104
102
|
InCycleBillingPeriodEnd = "InCycleBillingPeriodEnd",
|
|
105
|
-
/** day after prev invoice ended (Sales - BillingAdjustment) */
|
|
106
|
-
ProrationBillingPeriodStart = "ProrationBillingPeriodStart",
|
|
107
|
-
/** day before new billing day (Sales - BillingAdjustment) */
|
|
108
|
-
ProrationBillingPeriodEnd = "ProrationBillingPeriodEnd",
|
|
109
103
|
/** the new billing billing period start (Sales - BillingAdjustment) */
|
|
110
104
|
InCycleBillingPeriodStart = "InCycleBillingPeriodStart",
|
|
111
|
-
/** proration type charge or credit (Sales - BillingAdjustment) */
|
|
112
|
-
ProrationType = "ProrationType",
|
|
113
105
|
/** The number of days being prorated (Sales - BillingAdjustment) */
|
|
114
106
|
ProrationBillableDays = "ProrationBillableDays",
|
|
115
|
-
/**
|
|
116
|
-
|
|
107
|
+
/** day before new billing day (Sales - BillingAdjustment) */
|
|
108
|
+
ProrationBillingPeriodEnd = "ProrationBillingPeriodEnd",
|
|
109
|
+
/** day after prev invoice ended (Sales - BillingAdjustment) */
|
|
110
|
+
ProrationBillingPeriodStart = "ProrationBillingPeriodStart",
|
|
111
|
+
/** proration type charge or credit (Sales - BillingAdjustment) */
|
|
112
|
+
ProrationType = "ProrationType",
|
|
113
|
+
/** the billing adjustment reason (Sales - BillingAdjustment) */
|
|
114
|
+
Reason = "Reason",
|
|
117
115
|
/** Source of payment date update (Sales - BillingAdjustment) */
|
|
118
|
-
Source = "Source"
|
|
116
|
+
Source = "Source",
|
|
117
|
+
/** Billing Adjustment Title (Sales - BillingAdjustment) */
|
|
118
|
+
Title = "Title"
|
|
119
119
|
}
|
|
120
120
|
/**
|
|
121
121
|
* Properties for BillingAdjustment records
|
|
@@ -123,80 +123,80 @@ export declare enum BillingAdjustmentPropertyKeys {
|
|
|
123
123
|
* @see OrderModule:BillingAdjustment
|
|
124
124
|
*/
|
|
125
125
|
export interface BillingAdjustmentProperties {
|
|
126
|
-
/**
|
|
126
|
+
/** Describe why this billing adjustment being applied (Sales - BillingAdjustment)
|
|
127
127
|
*
|
|
128
|
-
* @type {
|
|
128
|
+
* @type {TEXT_LONG}
|
|
129
129
|
*/
|
|
130
|
-
|
|
131
|
-
/**
|
|
130
|
+
Description?: string;
|
|
131
|
+
/** the length of the discount (Sales - BillingAdjustment)
|
|
132
132
|
*
|
|
133
133
|
* @type {NUMBER}
|
|
134
|
-
* @hidden This field is hidden in the UI
|
|
135
134
|
*/
|
|
136
|
-
|
|
137
|
-
/** the
|
|
135
|
+
DiscountLength?: number;
|
|
136
|
+
/** the type of discount (Sales - BillingAdjustment)
|
|
138
137
|
*
|
|
139
138
|
* @type {ENUM}
|
|
140
|
-
* @enum {
|
|
139
|
+
* @enum {BillingAdjustmentDiscountType}
|
|
141
140
|
*/
|
|
142
|
-
|
|
141
|
+
DiscountType?: BillingAdjustmentDiscountType;
|
|
143
142
|
/** the value of the discount to be applied (Sales - BillingAdjustment)
|
|
144
143
|
*
|
|
145
144
|
* @type {NUMERIC}
|
|
146
145
|
*/
|
|
147
146
|
DiscountValue?: number;
|
|
148
|
-
/**
|
|
147
|
+
/** The number of future invoices that should be free of charge (Sales - BillingAdjustment)
|
|
149
148
|
*
|
|
150
149
|
* @type {NUMBER}
|
|
150
|
+
* @hidden This field is hidden in the UI
|
|
151
151
|
*/
|
|
152
|
-
|
|
153
|
-
/** the type of discount (Sales - BillingAdjustment)
|
|
154
|
-
*
|
|
155
|
-
* @type {ENUM}
|
|
156
|
-
* @enum {BillingAdjustmentDiscountType}
|
|
157
|
-
*/
|
|
158
|
-
DiscountType?: BillingAdjustmentDiscountType;
|
|
152
|
+
FreePeriodLength?: number;
|
|
159
153
|
/** end of first full cycle (Invoice.BillingPeriodEnd!) (Sales - BillingAdjustment)
|
|
160
154
|
*
|
|
161
155
|
* @type {DATE}
|
|
162
156
|
*/
|
|
163
157
|
InCycleBillingPeriodEnd?: string;
|
|
164
|
-
/**
|
|
158
|
+
/** the new billing billing period start (Sales - BillingAdjustment)
|
|
165
159
|
*
|
|
166
160
|
* @type {DATE}
|
|
167
161
|
*/
|
|
168
|
-
|
|
162
|
+
InCycleBillingPeriodStart?: string;
|
|
163
|
+
/** The number of days being prorated (Sales - BillingAdjustment)
|
|
164
|
+
*
|
|
165
|
+
* @type {NUMBER}
|
|
166
|
+
*/
|
|
167
|
+
ProrationBillableDays?: number;
|
|
169
168
|
/** day before new billing day (Sales - BillingAdjustment)
|
|
170
169
|
*
|
|
171
170
|
* @type {DATE}
|
|
172
171
|
*/
|
|
173
172
|
ProrationBillingPeriodEnd?: string;
|
|
174
|
-
/**
|
|
173
|
+
/** day after prev invoice ended (Sales - BillingAdjustment)
|
|
175
174
|
*
|
|
176
175
|
* @type {DATE}
|
|
177
176
|
*/
|
|
178
|
-
|
|
177
|
+
ProrationBillingPeriodStart?: string;
|
|
179
178
|
/** proration type charge or credit (Sales - BillingAdjustment)
|
|
180
179
|
*
|
|
181
180
|
* @type {ENUM}
|
|
182
181
|
* @enum {BillingAdjustmentProrationType}
|
|
183
182
|
*/
|
|
184
183
|
ProrationType?: BillingAdjustmentProrationType;
|
|
185
|
-
/**
|
|
186
|
-
*
|
|
187
|
-
* @type {NUMBER}
|
|
188
|
-
*/
|
|
189
|
-
ProrationBillableDays?: number;
|
|
190
|
-
/** Describe why this billing adjustment being applied (Sales - BillingAdjustment)
|
|
184
|
+
/** the billing adjustment reason (Sales - BillingAdjustment)
|
|
191
185
|
*
|
|
192
|
-
* @type {
|
|
186
|
+
* @type {ENUM}
|
|
187
|
+
* @enum {BillingAdjustmentReason}
|
|
193
188
|
*/
|
|
194
|
-
|
|
189
|
+
Reason?: BillingAdjustmentReason;
|
|
195
190
|
/** Source of payment date update (Sales - BillingAdjustment)
|
|
196
191
|
*
|
|
197
192
|
* @type {TEXT}
|
|
198
193
|
*/
|
|
199
194
|
Source?: string;
|
|
195
|
+
/** Billing Adjustment Title (Sales - BillingAdjustment)
|
|
196
|
+
*
|
|
197
|
+
* @type {TEXT}
|
|
198
|
+
*/
|
|
199
|
+
Title?: string;
|
|
200
200
|
}
|
|
201
201
|
/**
|
|
202
202
|
* BillingAdjustment entity from OrderModule
|
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
* Generated from Odin schema definition
|
|
13
13
|
*/
|
|
14
14
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
15
|
-
exports.ROUTING_KEY_LINK_BILLING_ADJUSTMENT_FILE_DELETED = exports.ROUTING_KEY_LINK_BILLING_ADJUSTMENT_FILE_CREATED = exports.ROUTING_KEY_LINK_BILLING_ADJUSTMENT_NOTE_DELETED = exports.ROUTING_KEY_LINK_BILLING_ADJUSTMENT_NOTE_CREATED = exports.ROUTING_KEY_BILLING_ADJUSTMENT_DELETED = exports.ROUTING_KEY_BILLING_ADJUSTMENT_UPDATED = exports.ROUTING_KEY_BILLING_ADJUSTMENT_CREATED = exports.BillingAdjustment = exports.BillingAdjustmentPropertyKeys = exports.
|
|
15
|
+
exports.ROUTING_KEY_LINK_BILLING_ADJUSTMENT_FILE_DELETED = exports.ROUTING_KEY_LINK_BILLING_ADJUSTMENT_FILE_CREATED = exports.ROUTING_KEY_LINK_BILLING_ADJUSTMENT_NOTE_DELETED = exports.ROUTING_KEY_LINK_BILLING_ADJUSTMENT_NOTE_CREATED = exports.ROUTING_KEY_BILLING_ADJUSTMENT_DELETED = exports.ROUTING_KEY_BILLING_ADJUSTMENT_UPDATED = exports.ROUTING_KEY_BILLING_ADJUSTMENT_CREATED = exports.BillingAdjustment = exports.BillingAdjustmentPropertyKeys = exports.BillingAdjustmentReason = exports.BillingAdjustmentProrationType = exports.BillingAdjustmentDiscountType = exports.BillingAdjustmentEntityTypes = void 0;
|
|
16
16
|
const core_1 = require("@d19n/odin-types/dist/core");
|
|
17
17
|
/**
|
|
18
18
|
* Available types for BillingAdjustment records
|
|
@@ -22,6 +22,34 @@ var BillingAdjustmentEntityTypes;
|
|
|
22
22
|
/** Default record type */
|
|
23
23
|
BillingAdjustmentEntityTypes["DEFAULT"] = "DEFAULT";
|
|
24
24
|
})(BillingAdjustmentEntityTypes = exports.BillingAdjustmentEntityTypes || (exports.BillingAdjustmentEntityTypes = {}));
|
|
25
|
+
/**
|
|
26
|
+
* Valid values for BillingAdjustment.DiscountType
|
|
27
|
+
*
|
|
28
|
+
* the type of discount (Sales - BillingAdjustment)
|
|
29
|
+
*
|
|
30
|
+
* @remarks Available options:
|
|
31
|
+
* - `AMOUNT` - Amount
|
|
32
|
+
* - `PERCENT` - Percent
|
|
33
|
+
*/
|
|
34
|
+
var BillingAdjustmentDiscountType;
|
|
35
|
+
(function (BillingAdjustmentDiscountType) {
|
|
36
|
+
BillingAdjustmentDiscountType["AMOUNT"] = "AMOUNT";
|
|
37
|
+
BillingAdjustmentDiscountType["PERCENT"] = "PERCENT";
|
|
38
|
+
})(BillingAdjustmentDiscountType = exports.BillingAdjustmentDiscountType || (exports.BillingAdjustmentDiscountType = {}));
|
|
39
|
+
/**
|
|
40
|
+
* Valid values for BillingAdjustment.ProrationType
|
|
41
|
+
*
|
|
42
|
+
* proration type charge or credit (Sales - BillingAdjustment)
|
|
43
|
+
*
|
|
44
|
+
* @remarks Available options:
|
|
45
|
+
* - `CHARGE` - Charge
|
|
46
|
+
* - `CREDIT` - Credit
|
|
47
|
+
*/
|
|
48
|
+
var BillingAdjustmentProrationType;
|
|
49
|
+
(function (BillingAdjustmentProrationType) {
|
|
50
|
+
BillingAdjustmentProrationType["CHARGE"] = "CHARGE";
|
|
51
|
+
BillingAdjustmentProrationType["CREDIT"] = "CREDIT";
|
|
52
|
+
})(BillingAdjustmentProrationType = exports.BillingAdjustmentProrationType || (exports.BillingAdjustmentProrationType = {}));
|
|
25
53
|
/**
|
|
26
54
|
* Valid values for BillingAdjustment.Reason
|
|
27
55
|
*
|
|
@@ -58,68 +86,40 @@ var BillingAdjustmentReason;
|
|
|
58
86
|
BillingAdjustmentReason["SALES_MISSELLING_ADJUSTMENT"] = "SALES_MISSELLING_ADJUSTMENT";
|
|
59
87
|
BillingAdjustmentReason["OUTAGE_COMPENSATION"] = "OUTAGE_COMPENSATION";
|
|
60
88
|
})(BillingAdjustmentReason = exports.BillingAdjustmentReason || (exports.BillingAdjustmentReason = {}));
|
|
61
|
-
/**
|
|
62
|
-
* Valid values for BillingAdjustment.DiscountType
|
|
63
|
-
*
|
|
64
|
-
* the type of discount (Sales - BillingAdjustment)
|
|
65
|
-
*
|
|
66
|
-
* @remarks Available options:
|
|
67
|
-
* - `AMOUNT` - Amount
|
|
68
|
-
* - `PERCENT` - Percent
|
|
69
|
-
*/
|
|
70
|
-
var BillingAdjustmentDiscountType;
|
|
71
|
-
(function (BillingAdjustmentDiscountType) {
|
|
72
|
-
BillingAdjustmentDiscountType["AMOUNT"] = "AMOUNT";
|
|
73
|
-
BillingAdjustmentDiscountType["PERCENT"] = "PERCENT";
|
|
74
|
-
})(BillingAdjustmentDiscountType = exports.BillingAdjustmentDiscountType || (exports.BillingAdjustmentDiscountType = {}));
|
|
75
|
-
/**
|
|
76
|
-
* Valid values for BillingAdjustment.ProrationType
|
|
77
|
-
*
|
|
78
|
-
* proration type charge or credit (Sales - BillingAdjustment)
|
|
79
|
-
*
|
|
80
|
-
* @remarks Available options:
|
|
81
|
-
* - `CHARGE` - Charge
|
|
82
|
-
* - `CREDIT` - Credit
|
|
83
|
-
*/
|
|
84
|
-
var BillingAdjustmentProrationType;
|
|
85
|
-
(function (BillingAdjustmentProrationType) {
|
|
86
|
-
BillingAdjustmentProrationType["CHARGE"] = "CHARGE";
|
|
87
|
-
BillingAdjustmentProrationType["CREDIT"] = "CREDIT";
|
|
88
|
-
})(BillingAdjustmentProrationType = exports.BillingAdjustmentProrationType || (exports.BillingAdjustmentProrationType = {}));
|
|
89
89
|
/**
|
|
90
90
|
* Property keys for BillingAdjustment
|
|
91
91
|
* Use these constants instead of string literals for type safety
|
|
92
92
|
*/
|
|
93
93
|
var BillingAdjustmentPropertyKeys;
|
|
94
94
|
(function (BillingAdjustmentPropertyKeys) {
|
|
95
|
-
/**
|
|
96
|
-
BillingAdjustmentPropertyKeys["
|
|
97
|
-
/** The number of future invoices that should be free of charge (Sales - BillingAdjustment) */
|
|
98
|
-
BillingAdjustmentPropertyKeys["FreePeriodLength"] = "FreePeriodLength";
|
|
99
|
-
/** the billing adjustment reason (Sales - BillingAdjustment) */
|
|
100
|
-
BillingAdjustmentPropertyKeys["Reason"] = "Reason";
|
|
101
|
-
/** the value of the discount to be applied (Sales - BillingAdjustment) */
|
|
102
|
-
BillingAdjustmentPropertyKeys["DiscountValue"] = "DiscountValue";
|
|
95
|
+
/** Describe why this billing adjustment being applied (Sales - BillingAdjustment) */
|
|
96
|
+
BillingAdjustmentPropertyKeys["Description"] = "Description";
|
|
103
97
|
/** the length of the discount (Sales - BillingAdjustment) */
|
|
104
98
|
BillingAdjustmentPropertyKeys["DiscountLength"] = "DiscountLength";
|
|
105
99
|
/** the type of discount (Sales - BillingAdjustment) */
|
|
106
100
|
BillingAdjustmentPropertyKeys["DiscountType"] = "DiscountType";
|
|
101
|
+
/** the value of the discount to be applied (Sales - BillingAdjustment) */
|
|
102
|
+
BillingAdjustmentPropertyKeys["DiscountValue"] = "DiscountValue";
|
|
103
|
+
/** The number of future invoices that should be free of charge (Sales - BillingAdjustment) */
|
|
104
|
+
BillingAdjustmentPropertyKeys["FreePeriodLength"] = "FreePeriodLength";
|
|
107
105
|
/** end of first full cycle (Invoice.BillingPeriodEnd!) (Sales - BillingAdjustment) */
|
|
108
106
|
BillingAdjustmentPropertyKeys["InCycleBillingPeriodEnd"] = "InCycleBillingPeriodEnd";
|
|
109
|
-
/** day after prev invoice ended (Sales - BillingAdjustment) */
|
|
110
|
-
BillingAdjustmentPropertyKeys["ProrationBillingPeriodStart"] = "ProrationBillingPeriodStart";
|
|
111
|
-
/** day before new billing day (Sales - BillingAdjustment) */
|
|
112
|
-
BillingAdjustmentPropertyKeys["ProrationBillingPeriodEnd"] = "ProrationBillingPeriodEnd";
|
|
113
107
|
/** the new billing billing period start (Sales - BillingAdjustment) */
|
|
114
108
|
BillingAdjustmentPropertyKeys["InCycleBillingPeriodStart"] = "InCycleBillingPeriodStart";
|
|
115
|
-
/** proration type charge or credit (Sales - BillingAdjustment) */
|
|
116
|
-
BillingAdjustmentPropertyKeys["ProrationType"] = "ProrationType";
|
|
117
109
|
/** The number of days being prorated (Sales - BillingAdjustment) */
|
|
118
110
|
BillingAdjustmentPropertyKeys["ProrationBillableDays"] = "ProrationBillableDays";
|
|
119
|
-
/**
|
|
120
|
-
BillingAdjustmentPropertyKeys["
|
|
111
|
+
/** day before new billing day (Sales - BillingAdjustment) */
|
|
112
|
+
BillingAdjustmentPropertyKeys["ProrationBillingPeriodEnd"] = "ProrationBillingPeriodEnd";
|
|
113
|
+
/** day after prev invoice ended (Sales - BillingAdjustment) */
|
|
114
|
+
BillingAdjustmentPropertyKeys["ProrationBillingPeriodStart"] = "ProrationBillingPeriodStart";
|
|
115
|
+
/** proration type charge or credit (Sales - BillingAdjustment) */
|
|
116
|
+
BillingAdjustmentPropertyKeys["ProrationType"] = "ProrationType";
|
|
117
|
+
/** the billing adjustment reason (Sales - BillingAdjustment) */
|
|
118
|
+
BillingAdjustmentPropertyKeys["Reason"] = "Reason";
|
|
121
119
|
/** Source of payment date update (Sales - BillingAdjustment) */
|
|
122
120
|
BillingAdjustmentPropertyKeys["Source"] = "Source";
|
|
121
|
+
/** Billing Adjustment Title (Sales - BillingAdjustment) */
|
|
122
|
+
BillingAdjustmentPropertyKeys["Title"] = "Title";
|
|
123
123
|
})(BillingAdjustmentPropertyKeys = exports.BillingAdjustmentPropertyKeys || (exports.BillingAdjustmentPropertyKeys = {}));
|
|
124
124
|
/**
|
|
125
125
|
* BillingAdjustment entity from OrderModule
|
package/package.json
CHANGED
|
@@ -24,7 +24,7 @@ import {
|
|
|
24
24
|
* Properties for CreatePaymentMethodRefund action
|
|
25
25
|
*
|
|
26
26
|
* @property Required fields: 2
|
|
27
|
-
* @property Optional fields:
|
|
27
|
+
* @property Optional fields: 2
|
|
28
28
|
*/
|
|
29
29
|
export interface CreatePaymentMethodRefundProperties {
|
|
30
30
|
/**
|
|
@@ -43,6 +43,20 @@ export interface CreatePaymentMethodRefundProperties {
|
|
|
43
43
|
* @required
|
|
44
44
|
*/
|
|
45
45
|
Description: string;
|
|
46
|
+
/**
|
|
47
|
+
* AuthorizedBy
|
|
48
|
+
*
|
|
49
|
+
* Authorized By (Finance - PaymentMethodRefund)
|
|
50
|
+
* @type {TEXT}
|
|
51
|
+
*/
|
|
52
|
+
AuthorizedBy?: string;
|
|
53
|
+
/**
|
|
54
|
+
* OrderRef
|
|
55
|
+
*
|
|
56
|
+
* Reference identifier for PaymentMethodRefund relationships. Used for data integrity.
|
|
57
|
+
* @type {LOOKUP}
|
|
58
|
+
*/
|
|
59
|
+
OrderRef?: string;
|
|
46
60
|
}
|
|
47
61
|
|
|
48
62
|
/**
|
|
@@ -34,6 +34,32 @@ export enum BillingAdjustmentEntityTypes {
|
|
|
34
34
|
DEFAULT = 'DEFAULT',
|
|
35
35
|
}
|
|
36
36
|
|
|
37
|
+
/**
|
|
38
|
+
* Valid values for BillingAdjustment.DiscountType
|
|
39
|
+
*
|
|
40
|
+
* the type of discount (Sales - BillingAdjustment)
|
|
41
|
+
*
|
|
42
|
+
* @remarks Available options:
|
|
43
|
+
* - `AMOUNT` - Amount
|
|
44
|
+
* - `PERCENT` - Percent
|
|
45
|
+
*/
|
|
46
|
+
export enum BillingAdjustmentDiscountType {
|
|
47
|
+
AMOUNT = 'AMOUNT',
|
|
48
|
+
PERCENT = 'PERCENT',
|
|
49
|
+
}
|
|
50
|
+
/**
|
|
51
|
+
* Valid values for BillingAdjustment.ProrationType
|
|
52
|
+
*
|
|
53
|
+
* proration type charge or credit (Sales - BillingAdjustment)
|
|
54
|
+
*
|
|
55
|
+
* @remarks Available options:
|
|
56
|
+
* - `CHARGE` - Charge
|
|
57
|
+
* - `CREDIT` - Credit
|
|
58
|
+
*/
|
|
59
|
+
export enum BillingAdjustmentProrationType {
|
|
60
|
+
CHARGE = 'CHARGE',
|
|
61
|
+
CREDIT = 'CREDIT',
|
|
62
|
+
}
|
|
37
63
|
/**
|
|
38
64
|
* Valid values for BillingAdjustment.Reason
|
|
39
65
|
*
|
|
@@ -69,66 +95,40 @@ export enum BillingAdjustmentReason {
|
|
|
69
95
|
SALES_MISSELLING_ADJUSTMENT = 'SALES_MISSELLING_ADJUSTMENT',
|
|
70
96
|
OUTAGE_COMPENSATION = 'OUTAGE_COMPENSATION',
|
|
71
97
|
}
|
|
72
|
-
/**
|
|
73
|
-
* Valid values for BillingAdjustment.DiscountType
|
|
74
|
-
*
|
|
75
|
-
* the type of discount (Sales - BillingAdjustment)
|
|
76
|
-
*
|
|
77
|
-
* @remarks Available options:
|
|
78
|
-
* - `AMOUNT` - Amount
|
|
79
|
-
* - `PERCENT` - Percent
|
|
80
|
-
*/
|
|
81
|
-
export enum BillingAdjustmentDiscountType {
|
|
82
|
-
AMOUNT = 'AMOUNT',
|
|
83
|
-
PERCENT = 'PERCENT',
|
|
84
|
-
}
|
|
85
|
-
/**
|
|
86
|
-
* Valid values for BillingAdjustment.ProrationType
|
|
87
|
-
*
|
|
88
|
-
* proration type charge or credit (Sales - BillingAdjustment)
|
|
89
|
-
*
|
|
90
|
-
* @remarks Available options:
|
|
91
|
-
* - `CHARGE` - Charge
|
|
92
|
-
* - `CREDIT` - Credit
|
|
93
|
-
*/
|
|
94
|
-
export enum BillingAdjustmentProrationType {
|
|
95
|
-
CHARGE = 'CHARGE',
|
|
96
|
-
CREDIT = 'CREDIT',
|
|
97
|
-
}
|
|
98
98
|
|
|
99
99
|
/**
|
|
100
100
|
* Property keys for BillingAdjustment
|
|
101
101
|
* Use these constants instead of string literals for type safety
|
|
102
102
|
*/
|
|
103
103
|
export enum BillingAdjustmentPropertyKeys {
|
|
104
|
-
/**
|
|
105
|
-
|
|
106
|
-
/** The number of future invoices that should be free of charge (Sales - BillingAdjustment) */
|
|
107
|
-
FreePeriodLength = 'FreePeriodLength',
|
|
108
|
-
/** the billing adjustment reason (Sales - BillingAdjustment) */
|
|
109
|
-
Reason = 'Reason',
|
|
110
|
-
/** the value of the discount to be applied (Sales - BillingAdjustment) */
|
|
111
|
-
DiscountValue = 'DiscountValue',
|
|
104
|
+
/** Describe why this billing adjustment being applied (Sales - BillingAdjustment) */
|
|
105
|
+
Description = 'Description',
|
|
112
106
|
/** the length of the discount (Sales - BillingAdjustment) */
|
|
113
107
|
DiscountLength = 'DiscountLength',
|
|
114
108
|
/** the type of discount (Sales - BillingAdjustment) */
|
|
115
109
|
DiscountType = 'DiscountType',
|
|
110
|
+
/** the value of the discount to be applied (Sales - BillingAdjustment) */
|
|
111
|
+
DiscountValue = 'DiscountValue',
|
|
112
|
+
/** The number of future invoices that should be free of charge (Sales - BillingAdjustment) */
|
|
113
|
+
FreePeriodLength = 'FreePeriodLength',
|
|
116
114
|
/** end of first full cycle (Invoice.BillingPeriodEnd!) (Sales - BillingAdjustment) */
|
|
117
115
|
InCycleBillingPeriodEnd = 'InCycleBillingPeriodEnd',
|
|
118
|
-
/** day after prev invoice ended (Sales - BillingAdjustment) */
|
|
119
|
-
ProrationBillingPeriodStart = 'ProrationBillingPeriodStart',
|
|
120
|
-
/** day before new billing day (Sales - BillingAdjustment) */
|
|
121
|
-
ProrationBillingPeriodEnd = 'ProrationBillingPeriodEnd',
|
|
122
116
|
/** the new billing billing period start (Sales - BillingAdjustment) */
|
|
123
117
|
InCycleBillingPeriodStart = 'InCycleBillingPeriodStart',
|
|
124
|
-
/** proration type charge or credit (Sales - BillingAdjustment) */
|
|
125
|
-
ProrationType = 'ProrationType',
|
|
126
118
|
/** The number of days being prorated (Sales - BillingAdjustment) */
|
|
127
119
|
ProrationBillableDays = 'ProrationBillableDays',
|
|
128
|
-
/**
|
|
129
|
-
|
|
120
|
+
/** day before new billing day (Sales - BillingAdjustment) */
|
|
121
|
+
ProrationBillingPeriodEnd = 'ProrationBillingPeriodEnd',
|
|
122
|
+
/** day after prev invoice ended (Sales - BillingAdjustment) */
|
|
123
|
+
ProrationBillingPeriodStart = 'ProrationBillingPeriodStart',
|
|
124
|
+
/** proration type charge or credit (Sales - BillingAdjustment) */
|
|
125
|
+
ProrationType = 'ProrationType',
|
|
126
|
+
/** the billing adjustment reason (Sales - BillingAdjustment) */
|
|
127
|
+
Reason = 'Reason',
|
|
130
128
|
/** Source of payment date update (Sales - BillingAdjustment) */
|
|
131
129
|
Source = 'Source',
|
|
130
|
+
/** Billing Adjustment Title (Sales - BillingAdjustment) */
|
|
131
|
+
Title = 'Title',
|
|
132
132
|
}
|
|
133
133
|
|
|
134
134
|
/**
|
|
@@ -137,80 +137,80 @@ export enum BillingAdjustmentPropertyKeys {
|
|
|
137
137
|
* @see OrderModule:BillingAdjustment
|
|
138
138
|
*/
|
|
139
139
|
export interface BillingAdjustmentProperties {
|
|
140
|
-
/**
|
|
140
|
+
/** Describe why this billing adjustment being applied (Sales - BillingAdjustment)
|
|
141
141
|
*
|
|
142
|
-
* @type {
|
|
142
|
+
* @type {TEXT_LONG}
|
|
143
143
|
*/
|
|
144
|
-
|
|
145
|
-
/**
|
|
144
|
+
Description?: string;
|
|
145
|
+
/** the length of the discount (Sales - BillingAdjustment)
|
|
146
146
|
*
|
|
147
147
|
* @type {NUMBER}
|
|
148
|
-
* @hidden This field is hidden in the UI
|
|
149
148
|
*/
|
|
150
|
-
|
|
151
|
-
/** the
|
|
149
|
+
DiscountLength?: number;
|
|
150
|
+
/** the type of discount (Sales - BillingAdjustment)
|
|
152
151
|
*
|
|
153
152
|
* @type {ENUM}
|
|
154
|
-
* @enum {
|
|
153
|
+
* @enum {BillingAdjustmentDiscountType}
|
|
155
154
|
*/
|
|
156
|
-
|
|
155
|
+
DiscountType?: BillingAdjustmentDiscountType;
|
|
157
156
|
/** the value of the discount to be applied (Sales - BillingAdjustment)
|
|
158
157
|
*
|
|
159
158
|
* @type {NUMERIC}
|
|
160
159
|
*/
|
|
161
160
|
DiscountValue?: number;
|
|
162
|
-
/**
|
|
161
|
+
/** The number of future invoices that should be free of charge (Sales - BillingAdjustment)
|
|
163
162
|
*
|
|
164
163
|
* @type {NUMBER}
|
|
164
|
+
* @hidden This field is hidden in the UI
|
|
165
165
|
*/
|
|
166
|
-
|
|
167
|
-
/** the type of discount (Sales - BillingAdjustment)
|
|
168
|
-
*
|
|
169
|
-
* @type {ENUM}
|
|
170
|
-
* @enum {BillingAdjustmentDiscountType}
|
|
171
|
-
*/
|
|
172
|
-
DiscountType?: BillingAdjustmentDiscountType;
|
|
166
|
+
FreePeriodLength?: number;
|
|
173
167
|
/** end of first full cycle (Invoice.BillingPeriodEnd!) (Sales - BillingAdjustment)
|
|
174
168
|
*
|
|
175
169
|
* @type {DATE}
|
|
176
170
|
*/
|
|
177
171
|
InCycleBillingPeriodEnd?: string;
|
|
178
|
-
/**
|
|
172
|
+
/** the new billing billing period start (Sales - BillingAdjustment)
|
|
179
173
|
*
|
|
180
174
|
* @type {DATE}
|
|
181
175
|
*/
|
|
182
|
-
|
|
176
|
+
InCycleBillingPeriodStart?: string;
|
|
177
|
+
/** The number of days being prorated (Sales - BillingAdjustment)
|
|
178
|
+
*
|
|
179
|
+
* @type {NUMBER}
|
|
180
|
+
*/
|
|
181
|
+
ProrationBillableDays?: number;
|
|
183
182
|
/** day before new billing day (Sales - BillingAdjustment)
|
|
184
183
|
*
|
|
185
184
|
* @type {DATE}
|
|
186
185
|
*/
|
|
187
186
|
ProrationBillingPeriodEnd?: string;
|
|
188
|
-
/**
|
|
187
|
+
/** day after prev invoice ended (Sales - BillingAdjustment)
|
|
189
188
|
*
|
|
190
189
|
* @type {DATE}
|
|
191
190
|
*/
|
|
192
|
-
|
|
191
|
+
ProrationBillingPeriodStart?: string;
|
|
193
192
|
/** proration type charge or credit (Sales - BillingAdjustment)
|
|
194
193
|
*
|
|
195
194
|
* @type {ENUM}
|
|
196
195
|
* @enum {BillingAdjustmentProrationType}
|
|
197
196
|
*/
|
|
198
197
|
ProrationType?: BillingAdjustmentProrationType;
|
|
199
|
-
/**
|
|
200
|
-
*
|
|
201
|
-
* @type {NUMBER}
|
|
202
|
-
*/
|
|
203
|
-
ProrationBillableDays?: number;
|
|
204
|
-
/** Describe why this billing adjustment being applied (Sales - BillingAdjustment)
|
|
198
|
+
/** the billing adjustment reason (Sales - BillingAdjustment)
|
|
205
199
|
*
|
|
206
|
-
* @type {
|
|
200
|
+
* @type {ENUM}
|
|
201
|
+
* @enum {BillingAdjustmentReason}
|
|
207
202
|
*/
|
|
208
|
-
|
|
203
|
+
Reason?: BillingAdjustmentReason;
|
|
209
204
|
/** Source of payment date update (Sales - BillingAdjustment)
|
|
210
205
|
*
|
|
211
206
|
* @type {TEXT}
|
|
212
207
|
*/
|
|
213
208
|
Source?: string;
|
|
209
|
+
/** Billing Adjustment Title (Sales - BillingAdjustment)
|
|
210
|
+
*
|
|
211
|
+
* @type {TEXT}
|
|
212
|
+
*/
|
|
213
|
+
Title?: string;
|
|
214
214
|
}
|
|
215
215
|
|
|
216
216
|
/**
|