@d19n/youfibre-odin-sdk 2.0.326 → 2.0.328
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/README.md +1 -1
- package/dist/actions-v2/CreateCollectionAmcoWorkOrderDto.d.ts +8 -1
- package/dist/actions-v2/CreateCollectionAmcoWorkOrderFromOrderDto.d.ts +8 -1
- package/dist/actions-v2/CreateDispatchAmcoWorkOrderDto.d.ts +8 -1
- package/dist/actions-v2/CreateDispatchAmcoWorkOrderFromOrderDto.d.ts +8 -1
- package/dist/actions-v2/CreateReplacementAmcoWorkOrderDto.d.ts +8 -1
- package/dist/actions-v2/CreateReplacementAmcoWorkOrderFromOrderDto.d.ts +8 -1
- package/dist/entities-v2/Invoice.d.ts +323 -0
- package/dist/entities-v2/Invoice.js +9 -1
- package/dist/entities-v2/WorkOrder.d.ts +226 -1
- package/dist/entities-v2/WorkOrder.js +22 -4
- package/dist/records-v2/InvoiceRecord.d.ts +19 -3
- package/dist/records-v2/InvoiceRecord.js +17 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -162,7 +162,7 @@ This SDK includes **187** entities across **12** modules.
|
|
|
162
162
|
| **BillingRequest** | BillingRequest Entity Definition | MANDATE, PAYMENT |
|
|
163
163
|
| **Commission** | Commission Entity Definition | DEFAULT |
|
|
164
164
|
| **CreditNote** | CreditNote Entity Definition | DEFAULT |
|
|
165
|
-
| **Invoice** | Invoice Entity Definition | ETF |
|
|
165
|
+
| **Invoice** | Invoice Entity Definition | EQUIPMENT, ETF |
|
|
166
166
|
| **InvoiceItem** | InvoiceItem Entity Definition | DEFAULT |
|
|
167
167
|
| **Payment** | Payment Entity Definition | DEFAULT |
|
|
168
168
|
| **PaymentMethod** | PaymentMethod Entity Definition | DEFAULT |
|
|
@@ -23,7 +23,7 @@ export interface CreateCollectionAmcoWorkOrderMessage extends OdinRecordCreatedE
|
|
|
23
23
|
* Properties for CreateCollectionAmcoWorkOrder action
|
|
24
24
|
*
|
|
25
25
|
* @property Required fields: 0
|
|
26
|
-
* @property Optional fields:
|
|
26
|
+
* @property Optional fields: 19
|
|
27
27
|
*/
|
|
28
28
|
export interface CreateCollectionAmcoWorkOrderProperties {
|
|
29
29
|
/**
|
|
@@ -84,6 +84,13 @@ export interface CreateCollectionAmcoWorkOrderProperties {
|
|
|
84
84
|
* @type {DATE}
|
|
85
85
|
*/
|
|
86
86
|
ExpectedReturnDate?: string | null;
|
|
87
|
+
/**
|
|
88
|
+
* Source
|
|
89
|
+
*
|
|
90
|
+
* Which customer-facing front end raised this work order. Set by the customer portal API from its `source` query parameter (PORTAPP-3258). Null on staff-created and system-created work orders.
|
|
91
|
+
* @type {ENUM}
|
|
92
|
+
*/
|
|
93
|
+
Source?: string | null;
|
|
87
94
|
/**
|
|
88
95
|
* UseAlternativeAddress
|
|
89
96
|
*
|
|
@@ -15,7 +15,7 @@ import { OdinRecord, OdinRecordCreateDto, OdinRecordUpdateDto, OdinRecordUpdated
|
|
|
15
15
|
* Properties for CreateCollectionAmcoWorkOrder action
|
|
16
16
|
*
|
|
17
17
|
* @property Required fields: 0
|
|
18
|
-
* @property Optional fields:
|
|
18
|
+
* @property Optional fields: 19
|
|
19
19
|
*/
|
|
20
20
|
export interface CreateCollectionAmcoWorkOrderProperties {
|
|
21
21
|
/**
|
|
@@ -76,6 +76,13 @@ export interface CreateCollectionAmcoWorkOrderProperties {
|
|
|
76
76
|
* @type {DATE}
|
|
77
77
|
*/
|
|
78
78
|
ExpectedReturnDate?: string | null;
|
|
79
|
+
/**
|
|
80
|
+
* Source
|
|
81
|
+
*
|
|
82
|
+
* Which customer-facing front end raised this work order. Set by the customer portal API from its `source` query parameter (PORTAPP-3258). Null on staff-created and system-created work orders.
|
|
83
|
+
* @type {ENUM}
|
|
84
|
+
*/
|
|
85
|
+
Source?: string | null;
|
|
79
86
|
/**
|
|
80
87
|
* UseAlternativeAddress
|
|
81
88
|
*
|
|
@@ -23,7 +23,7 @@ export interface CreateDispatchAmcoWorkOrderMessage extends OdinRecordCreatedEve
|
|
|
23
23
|
* Properties for CreateDispatchAmcoWorkOrder action
|
|
24
24
|
*
|
|
25
25
|
* @property Required fields: 1
|
|
26
|
-
* @property Optional fields:
|
|
26
|
+
* @property Optional fields: 23
|
|
27
27
|
*/
|
|
28
28
|
export interface CreateDispatchAmcoWorkOrderProperties {
|
|
29
29
|
/**
|
|
@@ -77,6 +77,13 @@ export interface CreateDispatchAmcoWorkOrderProperties {
|
|
|
77
77
|
* @hidden This field is not visible in the UI
|
|
78
78
|
*/
|
|
79
79
|
AddressId?: string | null;
|
|
80
|
+
/**
|
|
81
|
+
* Source
|
|
82
|
+
*
|
|
83
|
+
* Which customer-facing front end raised this work order. Set by the customer portal API from its `source` query parameter (PORTAPP-3258). Null on staff-created and system-created work orders.
|
|
84
|
+
* @type {ENUM}
|
|
85
|
+
*/
|
|
86
|
+
Source?: string | null;
|
|
80
87
|
/**
|
|
81
88
|
* DispatchedMeshProductCount
|
|
82
89
|
*
|
|
@@ -15,7 +15,7 @@ import { OdinRecord, OdinRecordCreateDto, OdinRecordUpdateDto, OdinRecordUpdated
|
|
|
15
15
|
* Properties for CreateDispatchAmcoWorkOrder action
|
|
16
16
|
*
|
|
17
17
|
* @property Required fields: 1
|
|
18
|
-
* @property Optional fields:
|
|
18
|
+
* @property Optional fields: 23
|
|
19
19
|
*/
|
|
20
20
|
export interface CreateDispatchAmcoWorkOrderProperties {
|
|
21
21
|
/**
|
|
@@ -69,6 +69,13 @@ export interface CreateDispatchAmcoWorkOrderProperties {
|
|
|
69
69
|
* @hidden This field is not visible in the UI
|
|
70
70
|
*/
|
|
71
71
|
AddressId?: string | null;
|
|
72
|
+
/**
|
|
73
|
+
* Source
|
|
74
|
+
*
|
|
75
|
+
* Which customer-facing front end raised this work order. Set by the customer portal API from its `source` query parameter (PORTAPP-3258). Null on staff-created and system-created work orders.
|
|
76
|
+
* @type {ENUM}
|
|
77
|
+
*/
|
|
78
|
+
Source?: string | null;
|
|
72
79
|
/**
|
|
73
80
|
* DispatchedMeshProductCount
|
|
74
81
|
*
|
|
@@ -23,7 +23,7 @@ export interface CreateReplacementAmcoWorkOrderMessage extends OdinRecordCreated
|
|
|
23
23
|
* Properties for CreateReplacementAmcoWorkOrder action
|
|
24
24
|
*
|
|
25
25
|
* @property Required fields: 0
|
|
26
|
-
* @property Optional fields:
|
|
26
|
+
* @property Optional fields: 27
|
|
27
27
|
*/
|
|
28
28
|
export interface CreateReplacementAmcoWorkOrderProperties {
|
|
29
29
|
/**
|
|
@@ -122,6 +122,13 @@ export interface CreateReplacementAmcoWorkOrderProperties {
|
|
|
122
122
|
* @type {LOOKUP}
|
|
123
123
|
*/
|
|
124
124
|
DispatchedMiscProduct2?: string | null;
|
|
125
|
+
/**
|
|
126
|
+
* Replaced Device Ids
|
|
127
|
+
*
|
|
128
|
+
* JSON list of the CustomerDeviceRouter / CustomerDevice record ids the agent ticked when creating a replacement. The Delivered mint supersedes exactly these and links them to the work order for collection (PORTAPP-3260).
|
|
129
|
+
* @type {JSON}
|
|
130
|
+
*/
|
|
131
|
+
ReplacedDeviceIds?: string | null;
|
|
125
132
|
/**
|
|
126
133
|
* OtherProductRequired
|
|
127
134
|
*
|
|
@@ -15,7 +15,7 @@ import { OdinRecord, OdinRecordCreateDto, OdinRecordUpdateDto, OdinRecordUpdated
|
|
|
15
15
|
* Properties for CreateReplacementAmcoWorkOrder action
|
|
16
16
|
*
|
|
17
17
|
* @property Required fields: 0
|
|
18
|
-
* @property Optional fields:
|
|
18
|
+
* @property Optional fields: 27
|
|
19
19
|
*/
|
|
20
20
|
export interface CreateReplacementAmcoWorkOrderProperties {
|
|
21
21
|
/**
|
|
@@ -114,6 +114,13 @@ export interface CreateReplacementAmcoWorkOrderProperties {
|
|
|
114
114
|
* @type {LOOKUP}
|
|
115
115
|
*/
|
|
116
116
|
DispatchedMiscProduct2?: string | null;
|
|
117
|
+
/**
|
|
118
|
+
* Replaced Device Ids
|
|
119
|
+
*
|
|
120
|
+
* JSON list of the CustomerDeviceRouter / CustomerDevice record ids the agent ticked when creating a replacement. The Delivered mint supersedes exactly these and links them to the work order for collection (PORTAPP-3260).
|
|
121
|
+
* @type {JSON}
|
|
122
|
+
*/
|
|
123
|
+
ReplacedDeviceIds?: string | null;
|
|
117
124
|
/**
|
|
118
125
|
* OtherProductRequired
|
|
119
126
|
*
|
|
@@ -35,6 +35,8 @@ import { PaymentProperties } from './Payment';
|
|
|
35
35
|
export declare enum InvoiceEntityTypes {
|
|
36
36
|
/** This is the default record type */
|
|
37
37
|
DEFAULT = "DEFAULT",
|
|
38
|
+
/** A charge for equipment a customer never returned, raised from a COLLECTION_AMCO at Non Returned. Its total equals the WorkOrder.EquipmentCharge the customer was quoted. Separate from DEFAULT so equipment recovery can be reported apart. */
|
|
39
|
+
EQUIPMENT = "EQUIPMENT",
|
|
38
40
|
/** Early Termination Fee Invoices */
|
|
39
41
|
ETF = "ETF"
|
|
40
42
|
}
|
|
@@ -626,6 +628,321 @@ export interface InvoiceProperties {
|
|
|
626
628
|
*/
|
|
627
629
|
ExternalReference: string;
|
|
628
630
|
}
|
|
631
|
+
/**
|
|
632
|
+
* Properties for EQUIPMENT Invoice records
|
|
633
|
+
*
|
|
634
|
+
* @see BillingModule:Invoice
|
|
635
|
+
*/
|
|
636
|
+
export interface EquipmentInvoiceProperties {
|
|
637
|
+
/** Data field for Invoice records. Used by Finance team.
|
|
638
|
+
*
|
|
639
|
+
* @type {TEXT}
|
|
640
|
+
* @default 0
|
|
641
|
+
* @hidden This field is hidden in the UI
|
|
642
|
+
*/
|
|
643
|
+
VatNumber: string;
|
|
644
|
+
/** unit cost for the product derived from product components UnitCost (Finance - Invoice)
|
|
645
|
+
*
|
|
646
|
+
* @type {PERCENT}
|
|
647
|
+
* @default 0
|
|
648
|
+
* @hidden This field is hidden in the UI
|
|
649
|
+
*/
|
|
650
|
+
TaxRate: number;
|
|
651
|
+
/** Billing terms i.e NET 15,30 (Finance - Invoice)
|
|
652
|
+
*
|
|
653
|
+
* @type {ENUM}
|
|
654
|
+
* @default NET_0
|
|
655
|
+
* @enum {InvoiceBillingTerms}
|
|
656
|
+
* @hidden This field is hidden in the UI
|
|
657
|
+
*/
|
|
658
|
+
BillingTerms: InvoiceBillingTerms;
|
|
659
|
+
/** Billing start date (Finance - Invoice)
|
|
660
|
+
*
|
|
661
|
+
* @type {DATE}
|
|
662
|
+
* @format DD/MM/YYYY
|
|
663
|
+
* @hidden This field is hidden in the UI
|
|
664
|
+
*/
|
|
665
|
+
BillingStartDate: string;
|
|
666
|
+
/** the type of discount (Finance - Invoice)
|
|
667
|
+
*
|
|
668
|
+
* @type {ENUM}
|
|
669
|
+
* @default AMOUNT
|
|
670
|
+
* @enum {InvoiceDiscountType}
|
|
671
|
+
* @hidden This field is hidden in the UI
|
|
672
|
+
*/
|
|
673
|
+
DiscountType: InvoiceDiscountType;
|
|
674
|
+
/** total due including taxes and discounts (Finance - Invoice)
|
|
675
|
+
*
|
|
676
|
+
* @type {CURRENCY}
|
|
677
|
+
* @default 0
|
|
678
|
+
* @hidden This field is hidden in the UI
|
|
679
|
+
*/
|
|
680
|
+
TotalDue: string;
|
|
681
|
+
/** Billing period start date (Finance - Invoice)
|
|
682
|
+
*
|
|
683
|
+
* @type {DATE}
|
|
684
|
+
* @format DD/MM/YYYY
|
|
685
|
+
* @hidden This field is hidden in the UI
|
|
686
|
+
*/
|
|
687
|
+
BillingPeriodStart: string;
|
|
688
|
+
/** trial length for the discount (Finance - Invoice)
|
|
689
|
+
*
|
|
690
|
+
* @type {NUMBER}
|
|
691
|
+
* @hidden This field is hidden in the UI
|
|
692
|
+
*/
|
|
693
|
+
TrialLength: number;
|
|
694
|
+
/** length for the items discount duration (Finance - Invoice)
|
|
695
|
+
*
|
|
696
|
+
* @type {NUMBER}
|
|
697
|
+
* @default 0
|
|
698
|
+
* @hidden This field is hidden in the UI
|
|
699
|
+
*/
|
|
700
|
+
DiscountLength: number;
|
|
701
|
+
/** the date the payment was sent to the bank (Finance - Invoice)
|
|
702
|
+
*
|
|
703
|
+
* @type {DATE}
|
|
704
|
+
* @format DD/MM/YYYY
|
|
705
|
+
* @hidden This field is hidden in the UI
|
|
706
|
+
*/
|
|
707
|
+
SettledDate: string;
|
|
708
|
+
/** the date the dunning period started (Finance - Invoice)
|
|
709
|
+
*
|
|
710
|
+
* @type {DATE}
|
|
711
|
+
* @hidden This field is hidden in the UI
|
|
712
|
+
*/
|
|
713
|
+
DunningStartDate: string;
|
|
714
|
+
/** the date the dunning processes was triggered (Finance - Invoice)
|
|
715
|
+
*
|
|
716
|
+
* @type {DATE}
|
|
717
|
+
* @format DD/MM/YYYY
|
|
718
|
+
* @hidden This field is hidden in the UI
|
|
719
|
+
*/
|
|
720
|
+
DunningProcessedAt: string;
|
|
721
|
+
/** will attempt payment retries if failed (Finance - Invoice)
|
|
722
|
+
*
|
|
723
|
+
* @type {BOOLEAN}
|
|
724
|
+
* @default true
|
|
725
|
+
* @tracked Changes to this field are tracked in audit history
|
|
726
|
+
*/
|
|
727
|
+
WillAttemptRetry: boolean;
|
|
728
|
+
/** total discounts (Finance - Invoice)
|
|
729
|
+
*
|
|
730
|
+
* @type {CURRENCY}
|
|
731
|
+
* @default 0
|
|
732
|
+
* @hidden This field is hidden in the UI
|
|
733
|
+
*/
|
|
734
|
+
TotalDiscounts: string;
|
|
735
|
+
/** the date the order is delivered (Finance - Invoice)
|
|
736
|
+
*
|
|
737
|
+
* @type {DATE}
|
|
738
|
+
* @format DD/MM/YYYY
|
|
739
|
+
* @hidden This field is hidden in the UI
|
|
740
|
+
*/
|
|
741
|
+
DeliveryDate: string;
|
|
742
|
+
/** the date the order is issued (Finance - Invoice)
|
|
743
|
+
*
|
|
744
|
+
* @type {DATE}
|
|
745
|
+
* @format DD/MM/YYYY
|
|
746
|
+
* @hidden This field is hidden in the UI
|
|
747
|
+
*/
|
|
748
|
+
IssuedDate: string;
|
|
749
|
+
/** total taxes (Finance - Invoice)
|
|
750
|
+
*
|
|
751
|
+
* @type {CURRENCY}
|
|
752
|
+
* @default 0
|
|
753
|
+
* @hidden This field is hidden in the UI
|
|
754
|
+
*/
|
|
755
|
+
TotalTaxAmount: string;
|
|
756
|
+
/** invoice name (Finance - Invoice)
|
|
757
|
+
*
|
|
758
|
+
* @type {TEXT}
|
|
759
|
+
* @hidden This field is hidden in the UI
|
|
760
|
+
*/
|
|
761
|
+
Name: string;
|
|
762
|
+
/** timestamp indicating when the DunningStatus changed (Finance - Invoice)
|
|
763
|
+
*
|
|
764
|
+
* @type {DATE}
|
|
765
|
+
* @hidden This field is hidden in the UI
|
|
766
|
+
*/
|
|
767
|
+
DunningStatusUpdatedAt: string;
|
|
768
|
+
/** trial unit for the discount (Finance - Invoice)
|
|
769
|
+
*
|
|
770
|
+
* @type {ENUM}
|
|
771
|
+
* @default MONTHS
|
|
772
|
+
* @enum {InvoiceTrialUnit}
|
|
773
|
+
* @hidden This field is hidden in the UI
|
|
774
|
+
*/
|
|
775
|
+
TrialUnit: InvoiceTrialUnit;
|
|
776
|
+
/** the number of days the invoice is past due (Finance - Invoice)
|
|
777
|
+
*
|
|
778
|
+
* @type {NUMBER}
|
|
779
|
+
* @default
|
|
780
|
+
* @hidden This field is hidden in the UI
|
|
781
|
+
*/
|
|
782
|
+
PastDueDays: number;
|
|
783
|
+
/** the date the mandate status was last updated (Finance - Invoice)
|
|
784
|
+
*
|
|
785
|
+
* @type {DATE}
|
|
786
|
+
* @format DD/MM/YYYY
|
|
787
|
+
* @hidden This field is hidden in the UI
|
|
788
|
+
*/
|
|
789
|
+
MandateStatusUpdatedAt: string;
|
|
790
|
+
/** The user that processed the dunning for the invoice (Finance - Invoice)
|
|
791
|
+
*
|
|
792
|
+
* @type {TEXT}
|
|
793
|
+
* @hidden This field is hidden in the UI
|
|
794
|
+
*/
|
|
795
|
+
DunningProcessedBy: string;
|
|
796
|
+
/** the status of dunning (Finance - Invoice)
|
|
797
|
+
*
|
|
798
|
+
* @type {ENUM}
|
|
799
|
+
* @default NONE
|
|
800
|
+
* @enum {InvoiceDunningStatus}
|
|
801
|
+
* @hidden This field is hidden in the UI
|
|
802
|
+
*/
|
|
803
|
+
DunningStatus: InvoiceDunningStatus;
|
|
804
|
+
/** Currency code (Finance - Invoice)
|
|
805
|
+
*
|
|
806
|
+
* @type {ENUM}
|
|
807
|
+
* @default GBP
|
|
808
|
+
* @enum {InvoiceCurrencyCode}
|
|
809
|
+
* @hidden This field is hidden in the UI
|
|
810
|
+
*/
|
|
811
|
+
CurrencyCode: InvoiceCurrencyCode;
|
|
812
|
+
/** the value to discount (Finance - Invoice)
|
|
813
|
+
*
|
|
814
|
+
* @type {CURRENCY}
|
|
815
|
+
* @default 0
|
|
816
|
+
* @hidden This field is hidden in the UI
|
|
817
|
+
*/
|
|
818
|
+
DiscountValue: string;
|
|
819
|
+
/** invoice due date (Finance - Invoice)
|
|
820
|
+
*
|
|
821
|
+
* @type {DATE}
|
|
822
|
+
* @format DD/MM/YYYY
|
|
823
|
+
* @placeholder due date
|
|
824
|
+
* @hidden This field is hidden in the UI
|
|
825
|
+
*/
|
|
826
|
+
DueDate: string;
|
|
827
|
+
/** Billing period end date (Finance - Invoice)
|
|
828
|
+
*
|
|
829
|
+
* @type {DATE}
|
|
830
|
+
* @format DD/MM/YYYY
|
|
831
|
+
* @hidden This field is hidden in the UI
|
|
832
|
+
*/
|
|
833
|
+
BillingPeriodEnd: string;
|
|
834
|
+
/** discount duration unit (Finance - Invoice)
|
|
835
|
+
*
|
|
836
|
+
* @type {ENUM}
|
|
837
|
+
* @default MONTHS
|
|
838
|
+
* @enum {InvoiceDiscountUnit}
|
|
839
|
+
* @hidden This field is hidden in the UI
|
|
840
|
+
*/
|
|
841
|
+
DiscountUnit: InvoiceDiscountUnit;
|
|
842
|
+
/** Used to identify what billing period this invoice includes (Finance - Invoice)
|
|
843
|
+
*
|
|
844
|
+
* @type {ENUM}
|
|
845
|
+
* @default
|
|
846
|
+
* @enum {InvoiceBillingPeriodType}
|
|
847
|
+
*/
|
|
848
|
+
BillingPeriodType: InvoiceBillingPeriodType;
|
|
849
|
+
/** timestamp indicating when the final dunning reminder was sent for invoices where the payment collection won't be retried (Finance - Invoice)
|
|
850
|
+
*
|
|
851
|
+
* @type {DATE}
|
|
852
|
+
*/
|
|
853
|
+
FinalDunningReminder: string;
|
|
854
|
+
/** balance left to be paid (Finance - Invoice)
|
|
855
|
+
*
|
|
856
|
+
* @type {CURRENCY}
|
|
857
|
+
* @default 0
|
|
858
|
+
* @placeholder 0
|
|
859
|
+
* @hidden This field is hidden in the UI
|
|
860
|
+
*/
|
|
861
|
+
Balance: string;
|
|
862
|
+
/** true if the customer has an active mandate (Finance - Invoice)
|
|
863
|
+
*
|
|
864
|
+
* @type {BOOLEAN}
|
|
865
|
+
* @hidden This field is hidden in the UI
|
|
866
|
+
*/
|
|
867
|
+
ActiveMandate: boolean;
|
|
868
|
+
/** The invoice category (Finance - Invoice)
|
|
869
|
+
*
|
|
870
|
+
* @type {TEXT}
|
|
871
|
+
*/
|
|
872
|
+
Category: string;
|
|
873
|
+
/** Indicates how this invoice was generated. ORDER: invoice created from a single order. ACCOUNT: invoice consolidates multiple orders from the same account. Used for filtering and reporting. (Finance - Invoice)
|
|
874
|
+
*
|
|
875
|
+
* @type {ENUM}
|
|
876
|
+
* @default ORDER
|
|
877
|
+
* @enum {InvoiceBillingMode}
|
|
878
|
+
*/
|
|
879
|
+
BillingMode: InvoiceBillingMode;
|
|
880
|
+
/** JSON array of order IDs included in this invoice. Only populated for account-based invoices (BillingMode=ACCOUNT). Example: ["uuid-1","uuid-2"]. Used to track which orders contributed to a consolidated invoice. (Finance - Invoice)
|
|
881
|
+
*
|
|
882
|
+
* @type {JSON}
|
|
883
|
+
*/
|
|
884
|
+
OrderRefs: string;
|
|
885
|
+
/** order reference (Finance - Invoice)
|
|
886
|
+
*
|
|
887
|
+
* @type {TEXT}
|
|
888
|
+
* @hidden This field is hidden in the UI
|
|
889
|
+
*/
|
|
890
|
+
OrderRef: string;
|
|
891
|
+
/** JSON array of sub-account IDs (Finance - Invoice)
|
|
892
|
+
*
|
|
893
|
+
* @type {JSON}
|
|
894
|
+
*/
|
|
895
|
+
SubAccountRefs: string;
|
|
896
|
+
/** status of the invoice (Finance - Invoice)
|
|
897
|
+
*
|
|
898
|
+
* @type {ENUM}
|
|
899
|
+
* @default DRAFT
|
|
900
|
+
* @placeholder status
|
|
901
|
+
* @enum {InvoiceStatus}
|
|
902
|
+
*/
|
|
903
|
+
Status: InvoiceStatus;
|
|
904
|
+
/** timestamp indicating when the first dunning reminder was sent after a payment collection failed on the mandate (Finance - Invoice)
|
|
905
|
+
*
|
|
906
|
+
* @type {DATE}
|
|
907
|
+
*/
|
|
908
|
+
InitialDunningReminder: string;
|
|
909
|
+
/** total price including taxes and discounts (Finance - Invoice)
|
|
910
|
+
*
|
|
911
|
+
* @type {NUMBER}
|
|
912
|
+
* @hidden This field is hidden in the UI
|
|
913
|
+
*/
|
|
914
|
+
TotalPrice: number;
|
|
915
|
+
/** total taxes (Finance - Invoice)
|
|
916
|
+
*
|
|
917
|
+
* @type {NUMBER}
|
|
918
|
+
* @hidden This field is hidden in the UI
|
|
919
|
+
*/
|
|
920
|
+
TotalTaxD: number;
|
|
921
|
+
/** invoice is locked from being modified (Finance - Invoice)
|
|
922
|
+
*
|
|
923
|
+
* @type {BOOLEAN}
|
|
924
|
+
* @default false
|
|
925
|
+
* @hidden This field is hidden in the UI
|
|
926
|
+
*/
|
|
927
|
+
IsLocked: boolean;
|
|
928
|
+
/** subtotal of the prices no taxes (Finance - Invoice)
|
|
929
|
+
*
|
|
930
|
+
* @type {CURRENCY}
|
|
931
|
+
* @default 0
|
|
932
|
+
*/
|
|
933
|
+
Subtotal: string;
|
|
934
|
+
/** total amount due (Finance - Invoice)
|
|
935
|
+
*
|
|
936
|
+
* @type {NUMBER}
|
|
937
|
+
* @hidden This field is hidden in the UI
|
|
938
|
+
*/
|
|
939
|
+
AmountDueD: number;
|
|
940
|
+
/** ExternalReference
|
|
941
|
+
*
|
|
942
|
+
* @type {TEXT}
|
|
943
|
+
*/
|
|
944
|
+
ExternalReference: string;
|
|
945
|
+
}
|
|
629
946
|
/**
|
|
630
947
|
* Properties for ETF Invoice records
|
|
631
948
|
*
|
|
@@ -1011,6 +1328,12 @@ export declare const ROUTING_KEY_INVOICE_DEFAULT_CREATED = "BillingModule.Invoic
|
|
|
1011
1328
|
export declare const ROUTING_KEY_INVOICE_DEFAULT_UPDATED = "BillingModule.Invoice.DEFAULT.SubDbRecordUpdated";
|
|
1012
1329
|
/** This is the default record type deleted */
|
|
1013
1330
|
export declare const ROUTING_KEY_INVOICE_DEFAULT_DELETED = "BillingModule.Invoice.DEFAULT.SubDbRecordDeleted";
|
|
1331
|
+
/** A charge for equipment a customer never returned, raised from a COLLECTION_AMCO at Non Returned. Its total equals the WorkOrder.EquipmentCharge the customer was quoted. Separate from DEFAULT so equipment recovery can be reported apart. created */
|
|
1332
|
+
export declare const ROUTING_KEY_INVOICE_EQUIPMENT_CREATED = "BillingModule.Invoice.EQUIPMENT.SubDbRecordCreated";
|
|
1333
|
+
/** A charge for equipment a customer never returned, raised from a COLLECTION_AMCO at Non Returned. Its total equals the WorkOrder.EquipmentCharge the customer was quoted. Separate from DEFAULT so equipment recovery can be reported apart. updated */
|
|
1334
|
+
export declare const ROUTING_KEY_INVOICE_EQUIPMENT_UPDATED = "BillingModule.Invoice.EQUIPMENT.SubDbRecordUpdated";
|
|
1335
|
+
/** A charge for equipment a customer never returned, raised from a COLLECTION_AMCO at Non Returned. Its total equals the WorkOrder.EquipmentCharge the customer was quoted. Separate from DEFAULT so equipment recovery can be reported apart. deleted */
|
|
1336
|
+
export declare const ROUTING_KEY_INVOICE_EQUIPMENT_DELETED = "BillingModule.Invoice.EQUIPMENT.SubDbRecordDeleted";
|
|
1014
1337
|
/** Early Termination Fee Invoices created */
|
|
1015
1338
|
export declare const ROUTING_KEY_INVOICE_ETF_CREATED = "BillingModule.Invoice.ETF.SubDbRecordCreated";
|
|
1016
1339
|
/** Early Termination Fee Invoices updated */
|
|
@@ -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_INVOICE_CREDIT_NOTE_DELETED = exports.ROUTING_KEY_LINK_INVOICE_CREDIT_NOTE_CREATED = exports.ROUTING_KEY_LINK_INVOICE_SMS_MESSAGE_DELETED = exports.ROUTING_KEY_LINK_INVOICE_SMS_MESSAGE_CREATED = exports.ROUTING_KEY_LINK_INVOICE_INVOICE_ITEM_DELETED = exports.ROUTING_KEY_LINK_INVOICE_INVOICE_ITEM_CREATED = exports.ROUTING_KEY_LINK_INVOICE_DISCOUNT_DELETED = exports.ROUTING_KEY_LINK_INVOICE_DISCOUNT_CREATED = exports.ROUTING_KEY_LINK_INVOICE_TRANSACTION_DELETED = exports.ROUTING_KEY_LINK_INVOICE_TRANSACTION_CREATED = exports.ROUTING_KEY_LINK_INVOICE_ADDRESS_DELETED = exports.ROUTING_KEY_LINK_INVOICE_ADDRESS_CREATED = exports.ROUTING_KEY_LINK_INVOICE_CONTACT_DELETED = exports.ROUTING_KEY_LINK_INVOICE_CONTACT_CREATED = exports.ROUTING_KEY_LINK_INVOICE_BILLING_ADJUSTMENT_DELETED = exports.ROUTING_KEY_LINK_INVOICE_BILLING_ADJUSTMENT_CREATED = exports.ROUTING_KEY_LINK_INVOICE_NOTE_DELETED = exports.ROUTING_KEY_LINK_INVOICE_NOTE_CREATED = exports.ROUTING_KEY_LINK_INVOICE_FILE_DELETED = exports.ROUTING_KEY_LINK_INVOICE_FILE_CREATED = exports.ROUTING_KEY_INVOICE_ETF_DELETED = exports.ROUTING_KEY_INVOICE_ETF_UPDATED = exports.ROUTING_KEY_INVOICE_ETF_CREATED = exports.ROUTING_KEY_INVOICE_DEFAULT_DELETED = exports.ROUTING_KEY_INVOICE_DEFAULT_UPDATED = exports.ROUTING_KEY_INVOICE_DEFAULT_CREATED = exports.ROUTING_KEY_INVOICE_DELETED = exports.ROUTING_KEY_INVOICE_UPDATED = exports.ROUTING_KEY_INVOICE_CREATED = exports.Invoice = exports.InvoicePropertyKeys = exports.InvoiceStatus = exports.InvoiceBillingMode = exports.InvoiceBillingPeriodType = exports.InvoiceDiscountUnit = exports.InvoiceCurrencyCode = exports.InvoiceDunningStatus = exports.InvoiceTrialUnit = exports.InvoiceDiscountType = exports.InvoiceBillingTerms = exports.InvoiceEntityTypes = void 0;
|
|
15
|
+
exports.ROUTING_KEY_LINK_INVOICE_CREDIT_NOTE_DELETED = exports.ROUTING_KEY_LINK_INVOICE_CREDIT_NOTE_CREATED = exports.ROUTING_KEY_LINK_INVOICE_SMS_MESSAGE_DELETED = exports.ROUTING_KEY_LINK_INVOICE_SMS_MESSAGE_CREATED = exports.ROUTING_KEY_LINK_INVOICE_INVOICE_ITEM_DELETED = exports.ROUTING_KEY_LINK_INVOICE_INVOICE_ITEM_CREATED = exports.ROUTING_KEY_LINK_INVOICE_DISCOUNT_DELETED = exports.ROUTING_KEY_LINK_INVOICE_DISCOUNT_CREATED = exports.ROUTING_KEY_LINK_INVOICE_TRANSACTION_DELETED = exports.ROUTING_KEY_LINK_INVOICE_TRANSACTION_CREATED = exports.ROUTING_KEY_LINK_INVOICE_ADDRESS_DELETED = exports.ROUTING_KEY_LINK_INVOICE_ADDRESS_CREATED = exports.ROUTING_KEY_LINK_INVOICE_CONTACT_DELETED = exports.ROUTING_KEY_LINK_INVOICE_CONTACT_CREATED = exports.ROUTING_KEY_LINK_INVOICE_BILLING_ADJUSTMENT_DELETED = exports.ROUTING_KEY_LINK_INVOICE_BILLING_ADJUSTMENT_CREATED = exports.ROUTING_KEY_LINK_INVOICE_NOTE_DELETED = exports.ROUTING_KEY_LINK_INVOICE_NOTE_CREATED = exports.ROUTING_KEY_LINK_INVOICE_FILE_DELETED = exports.ROUTING_KEY_LINK_INVOICE_FILE_CREATED = exports.ROUTING_KEY_INVOICE_ETF_DELETED = exports.ROUTING_KEY_INVOICE_ETF_UPDATED = exports.ROUTING_KEY_INVOICE_ETF_CREATED = exports.ROUTING_KEY_INVOICE_EQUIPMENT_DELETED = exports.ROUTING_KEY_INVOICE_EQUIPMENT_UPDATED = exports.ROUTING_KEY_INVOICE_EQUIPMENT_CREATED = exports.ROUTING_KEY_INVOICE_DEFAULT_DELETED = exports.ROUTING_KEY_INVOICE_DEFAULT_UPDATED = exports.ROUTING_KEY_INVOICE_DEFAULT_CREATED = exports.ROUTING_KEY_INVOICE_DELETED = exports.ROUTING_KEY_INVOICE_UPDATED = exports.ROUTING_KEY_INVOICE_CREATED = exports.Invoice = exports.InvoicePropertyKeys = exports.InvoiceStatus = exports.InvoiceBillingMode = exports.InvoiceBillingPeriodType = exports.InvoiceDiscountUnit = exports.InvoiceCurrencyCode = exports.InvoiceDunningStatus = exports.InvoiceTrialUnit = exports.InvoiceDiscountType = exports.InvoiceBillingTerms = exports.InvoiceEntityTypes = void 0;
|
|
16
16
|
const core_1 = require("@d19n/odin-types/dist/core");
|
|
17
17
|
/**
|
|
18
18
|
* Available types for Invoice records
|
|
@@ -21,6 +21,8 @@ var InvoiceEntityTypes;
|
|
|
21
21
|
(function (InvoiceEntityTypes) {
|
|
22
22
|
/** This is the default record type */
|
|
23
23
|
InvoiceEntityTypes["DEFAULT"] = "DEFAULT";
|
|
24
|
+
/** A charge for equipment a customer never returned, raised from a COLLECTION_AMCO at Non Returned. Its total equals the WorkOrder.EquipmentCharge the customer was quoted. Separate from DEFAULT so equipment recovery can be reported apart. */
|
|
25
|
+
InvoiceEntityTypes["EQUIPMENT"] = "EQUIPMENT";
|
|
24
26
|
/** Early Termination Fee Invoices */
|
|
25
27
|
InvoiceEntityTypes["ETF"] = "ETF";
|
|
26
28
|
})(InvoiceEntityTypes = exports.InvoiceEntityTypes || (exports.InvoiceEntityTypes = {}));
|
|
@@ -341,6 +343,12 @@ exports.ROUTING_KEY_INVOICE_DEFAULT_CREATED = 'BillingModule.Invoice.DEFAULT.Sub
|
|
|
341
343
|
exports.ROUTING_KEY_INVOICE_DEFAULT_UPDATED = 'BillingModule.Invoice.DEFAULT.SubDbRecordUpdated';
|
|
342
344
|
/** This is the default record type deleted */
|
|
343
345
|
exports.ROUTING_KEY_INVOICE_DEFAULT_DELETED = 'BillingModule.Invoice.DEFAULT.SubDbRecordDeleted';
|
|
346
|
+
/** A charge for equipment a customer never returned, raised from a COLLECTION_AMCO at Non Returned. Its total equals the WorkOrder.EquipmentCharge the customer was quoted. Separate from DEFAULT so equipment recovery can be reported apart. created */
|
|
347
|
+
exports.ROUTING_KEY_INVOICE_EQUIPMENT_CREATED = 'BillingModule.Invoice.EQUIPMENT.SubDbRecordCreated';
|
|
348
|
+
/** A charge for equipment a customer never returned, raised from a COLLECTION_AMCO at Non Returned. Its total equals the WorkOrder.EquipmentCharge the customer was quoted. Separate from DEFAULT so equipment recovery can be reported apart. updated */
|
|
349
|
+
exports.ROUTING_KEY_INVOICE_EQUIPMENT_UPDATED = 'BillingModule.Invoice.EQUIPMENT.SubDbRecordUpdated';
|
|
350
|
+
/** A charge for equipment a customer never returned, raised from a COLLECTION_AMCO at Non Returned. Its total equals the WorkOrder.EquipmentCharge the customer was quoted. Separate from DEFAULT so equipment recovery can be reported apart. deleted */
|
|
351
|
+
exports.ROUTING_KEY_INVOICE_EQUIPMENT_DELETED = 'BillingModule.Invoice.EQUIPMENT.SubDbRecordDeleted';
|
|
344
352
|
/** Early Termination Fee Invoices created */
|
|
345
353
|
exports.ROUTING_KEY_INVOICE_ETF_CREATED = 'BillingModule.Invoice.ETF.SubDbRecordCreated';
|
|
346
354
|
/** Early Termination Fee Invoices updated */
|
|
@@ -1392,6 +1392,19 @@ export declare enum WorkOrderPreventableWorkOrder {
|
|
|
1392
1392
|
NO = "NO",
|
|
1393
1393
|
YES = "YES"
|
|
1394
1394
|
}
|
|
1395
|
+
/**
|
|
1396
|
+
* Valid values for WorkOrder.Source
|
|
1397
|
+
*
|
|
1398
|
+
* Which customer-facing front end raised this work order. Set by the customer portal API from its `source` query parameter (PORTAPP-3258). Null on staff-created and system-created work orders.
|
|
1399
|
+
*
|
|
1400
|
+
* @remarks Available options:
|
|
1401
|
+
* - `CUSTOMER_APP` - Customer App
|
|
1402
|
+
* - `CUSTOMER_PORTAL` - Customer Portal
|
|
1403
|
+
*/
|
|
1404
|
+
export declare enum WorkOrderSource {
|
|
1405
|
+
CUSTOMER_APP = "CUSTOMER_APP",
|
|
1406
|
+
CUSTOMER_PORTAL = "CUSTOMER_PORTAL"
|
|
1407
|
+
}
|
|
1395
1408
|
/**
|
|
1396
1409
|
* Property keys for WorkOrder
|
|
1397
1410
|
* Use these constants instead of string literals for type safety
|
|
@@ -1668,7 +1681,11 @@ export declare enum WorkOrderPropertyKeys {
|
|
|
1668
1681
|
/** PreventableWorkOrder */
|
|
1669
1682
|
PreventableWorkOrder = "PreventableWorkOrder",
|
|
1670
1683
|
/** The device counts behind EquipmentCharge, by kind, fixed at the same moment: {"ROUTER":1,"MESH":3}. Exists so the charge can be invoiced as one line per fee product with a quantity, rather than as a single unexplained total — £250 does not say whether that is a router and three nodes or two routers and a node. Kinds rather than fee products, because what the customer holds is the durable fact and which SKU prices it is an invoicing decision. Snapshotted for the same reason as the total: the figure is quoted in the 3PL-C1 booking confirmation and charged from the 3PL-C7 notice months later, so recomputing it at invoice time would bill something other than what was quoted. Absent on collections raised before PORTAPP-3026, including those the PORTAPP-3096 backfill gives a total to. */
|
|
1671
|
-
EquipmentChargeBreakdown = "EquipmentChargeBreakdown"
|
|
1684
|
+
EquipmentChargeBreakdown = "EquipmentChargeBreakdown",
|
|
1685
|
+
/** JSON list of the CustomerDeviceRouter / CustomerDevice record ids the agent ticked when creating a replacement. The Delivered mint supersedes exactly these and links them to the work order for collection (PORTAPP-3260). */
|
|
1686
|
+
ReplacedDeviceIds = "ReplacedDeviceIds",
|
|
1687
|
+
/** Which customer-facing front end raised this work order. Set by the customer portal API from its `source` query parameter (PORTAPP-3258). Null on staff-created and system-created work orders. */
|
|
1688
|
+
Source = "Source"
|
|
1672
1689
|
}
|
|
1673
1690
|
/**
|
|
1674
1691
|
* Properties for WorkOrder records
|
|
@@ -2468,6 +2485,19 @@ export interface WorkOrderProperties {
|
|
|
2468
2485
|
* @default
|
|
2469
2486
|
*/
|
|
2470
2487
|
EquipmentChargeBreakdown: string;
|
|
2488
|
+
/** JSON list of the CustomerDeviceRouter / CustomerDevice record ids the agent ticked when creating a replacement. The Delivered mint supersedes exactly these and links them to the work order for collection (PORTAPP-3260).
|
|
2489
|
+
*
|
|
2490
|
+
* @type {JSON}
|
|
2491
|
+
* @default
|
|
2492
|
+
*/
|
|
2493
|
+
ReplacedDeviceIds: string;
|
|
2494
|
+
/** Which customer-facing front end raised this work order. Set by the customer portal API from its `source` query parameter (PORTAPP-3258). Null on staff-created and system-created work orders.
|
|
2495
|
+
*
|
|
2496
|
+
* @type {ENUM}
|
|
2497
|
+
* @default
|
|
2498
|
+
* @enum {WorkOrderSource}
|
|
2499
|
+
*/
|
|
2500
|
+
Source: WorkOrderSource;
|
|
2471
2501
|
}
|
|
2472
2502
|
/**
|
|
2473
2503
|
* Properties for COLLECTION WorkOrder records
|
|
@@ -3267,6 +3297,19 @@ export interface CollectionWorkOrderProperties {
|
|
|
3267
3297
|
* @default
|
|
3268
3298
|
*/
|
|
3269
3299
|
EquipmentChargeBreakdown: string;
|
|
3300
|
+
/** JSON list of the CustomerDeviceRouter / CustomerDevice record ids the agent ticked when creating a replacement. The Delivered mint supersedes exactly these and links them to the work order for collection (PORTAPP-3260).
|
|
3301
|
+
*
|
|
3302
|
+
* @type {JSON}
|
|
3303
|
+
* @default
|
|
3304
|
+
*/
|
|
3305
|
+
ReplacedDeviceIds: string;
|
|
3306
|
+
/** Which customer-facing front end raised this work order. Set by the customer portal API from its `source` query parameter (PORTAPP-3258). Null on staff-created and system-created work orders.
|
|
3307
|
+
*
|
|
3308
|
+
* @type {ENUM}
|
|
3309
|
+
* @default
|
|
3310
|
+
* @enum {WorkOrderSource}
|
|
3311
|
+
*/
|
|
3312
|
+
Source: WorkOrderSource;
|
|
3270
3313
|
}
|
|
3271
3314
|
/**
|
|
3272
3315
|
* Properties for COLLECTION_AMCO WorkOrder records
|
|
@@ -4066,6 +4109,19 @@ export interface CollectionAmcoWorkOrderProperties {
|
|
|
4066
4109
|
* @default
|
|
4067
4110
|
*/
|
|
4068
4111
|
EquipmentChargeBreakdown: string;
|
|
4112
|
+
/** JSON list of the CustomerDeviceRouter / CustomerDevice record ids the agent ticked when creating a replacement. The Delivered mint supersedes exactly these and links them to the work order for collection (PORTAPP-3260).
|
|
4113
|
+
*
|
|
4114
|
+
* @type {JSON}
|
|
4115
|
+
* @default
|
|
4116
|
+
*/
|
|
4117
|
+
ReplacedDeviceIds: string;
|
|
4118
|
+
/** Which customer-facing front end raised this work order. Set by the customer portal API from its `source` query parameter (PORTAPP-3258). Null on staff-created and system-created work orders.
|
|
4119
|
+
*
|
|
4120
|
+
* @type {ENUM}
|
|
4121
|
+
* @default
|
|
4122
|
+
* @enum {WorkOrderSource}
|
|
4123
|
+
*/
|
|
4124
|
+
Source: WorkOrderSource;
|
|
4069
4125
|
}
|
|
4070
4126
|
/**
|
|
4071
4127
|
* Properties for DISPATCH_AMCO WorkOrder records
|
|
@@ -4865,6 +4921,19 @@ export interface DispatchAmcoWorkOrderProperties {
|
|
|
4865
4921
|
* @default
|
|
4866
4922
|
*/
|
|
4867
4923
|
EquipmentChargeBreakdown: string;
|
|
4924
|
+
/** JSON list of the CustomerDeviceRouter / CustomerDevice record ids the agent ticked when creating a replacement. The Delivered mint supersedes exactly these and links them to the work order for collection (PORTAPP-3260).
|
|
4925
|
+
*
|
|
4926
|
+
* @type {JSON}
|
|
4927
|
+
* @default
|
|
4928
|
+
*/
|
|
4929
|
+
ReplacedDeviceIds: string;
|
|
4930
|
+
/** Which customer-facing front end raised this work order. Set by the customer portal API from its `source` query parameter (PORTAPP-3258). Null on staff-created and system-created work orders.
|
|
4931
|
+
*
|
|
4932
|
+
* @type {ENUM}
|
|
4933
|
+
* @default
|
|
4934
|
+
* @enum {WorkOrderSource}
|
|
4935
|
+
*/
|
|
4936
|
+
Source: WorkOrderSource;
|
|
4868
4937
|
}
|
|
4869
4938
|
/**
|
|
4870
4939
|
* Properties for FINANCE WorkOrder records
|
|
@@ -5664,6 +5733,19 @@ export interface FinanceWorkOrderProperties {
|
|
|
5664
5733
|
* @default
|
|
5665
5734
|
*/
|
|
5666
5735
|
EquipmentChargeBreakdown: string;
|
|
5736
|
+
/** JSON list of the CustomerDeviceRouter / CustomerDevice record ids the agent ticked when creating a replacement. The Delivered mint supersedes exactly these and links them to the work order for collection (PORTAPP-3260).
|
|
5737
|
+
*
|
|
5738
|
+
* @type {JSON}
|
|
5739
|
+
* @default
|
|
5740
|
+
*/
|
|
5741
|
+
ReplacedDeviceIds: string;
|
|
5742
|
+
/** Which customer-facing front end raised this work order. Set by the customer portal API from its `source` query parameter (PORTAPP-3258). Null on staff-created and system-created work orders.
|
|
5743
|
+
*
|
|
5744
|
+
* @type {ENUM}
|
|
5745
|
+
* @default
|
|
5746
|
+
* @enum {WorkOrderSource}
|
|
5747
|
+
*/
|
|
5748
|
+
Source: WorkOrderSource;
|
|
5667
5749
|
}
|
|
5668
5750
|
/**
|
|
5669
5751
|
* Properties for INSPECTION WorkOrder records
|
|
@@ -6463,6 +6545,19 @@ export interface InspectionWorkOrderProperties {
|
|
|
6463
6545
|
* @default
|
|
6464
6546
|
*/
|
|
6465
6547
|
EquipmentChargeBreakdown: string;
|
|
6548
|
+
/** JSON list of the CustomerDeviceRouter / CustomerDevice record ids the agent ticked when creating a replacement. The Delivered mint supersedes exactly these and links them to the work order for collection (PORTAPP-3260).
|
|
6549
|
+
*
|
|
6550
|
+
* @type {JSON}
|
|
6551
|
+
* @default
|
|
6552
|
+
*/
|
|
6553
|
+
ReplacedDeviceIds: string;
|
|
6554
|
+
/** Which customer-facing front end raised this work order. Set by the customer portal API from its `source` query parameter (PORTAPP-3258). Null on staff-created and system-created work orders.
|
|
6555
|
+
*
|
|
6556
|
+
* @type {ENUM}
|
|
6557
|
+
* @default
|
|
6558
|
+
* @enum {WorkOrderSource}
|
|
6559
|
+
*/
|
|
6560
|
+
Source: WorkOrderSource;
|
|
6466
6561
|
}
|
|
6467
6562
|
/**
|
|
6468
6563
|
* Properties for INSTALL WorkOrder records
|
|
@@ -7262,6 +7357,19 @@ export interface InstallWorkOrderProperties {
|
|
|
7262
7357
|
* @default
|
|
7263
7358
|
*/
|
|
7264
7359
|
EquipmentChargeBreakdown: string;
|
|
7360
|
+
/** JSON list of the CustomerDeviceRouter / CustomerDevice record ids the agent ticked when creating a replacement. The Delivered mint supersedes exactly these and links them to the work order for collection (PORTAPP-3260).
|
|
7361
|
+
*
|
|
7362
|
+
* @type {JSON}
|
|
7363
|
+
* @default
|
|
7364
|
+
*/
|
|
7365
|
+
ReplacedDeviceIds: string;
|
|
7366
|
+
/** Which customer-facing front end raised this work order. Set by the customer portal API from its `source` query parameter (PORTAPP-3258). Null on staff-created and system-created work orders.
|
|
7367
|
+
*
|
|
7368
|
+
* @type {ENUM}
|
|
7369
|
+
* @default
|
|
7370
|
+
* @enum {WorkOrderSource}
|
|
7371
|
+
*/
|
|
7372
|
+
Source: WorkOrderSource;
|
|
7265
7373
|
}
|
|
7266
7374
|
/**
|
|
7267
7375
|
* Properties for INSTALL_BUSINESS WorkOrder records
|
|
@@ -8061,6 +8169,19 @@ export interface InstallBusinessWorkOrderProperties {
|
|
|
8061
8169
|
* @default
|
|
8062
8170
|
*/
|
|
8063
8171
|
EquipmentChargeBreakdown: string;
|
|
8172
|
+
/** JSON list of the CustomerDeviceRouter / CustomerDevice record ids the agent ticked when creating a replacement. The Delivered mint supersedes exactly these and links them to the work order for collection (PORTAPP-3260).
|
|
8173
|
+
*
|
|
8174
|
+
* @type {JSON}
|
|
8175
|
+
* @default
|
|
8176
|
+
*/
|
|
8177
|
+
ReplacedDeviceIds: string;
|
|
8178
|
+
/** Which customer-facing front end raised this work order. Set by the customer portal API from its `source` query parameter (PORTAPP-3258). Null on staff-created and system-created work orders.
|
|
8179
|
+
*
|
|
8180
|
+
* @type {ENUM}
|
|
8181
|
+
* @default
|
|
8182
|
+
* @enum {WorkOrderSource}
|
|
8183
|
+
*/
|
|
8184
|
+
Source: WorkOrderSource;
|
|
8064
8185
|
}
|
|
8065
8186
|
/**
|
|
8066
8187
|
* Properties for INSTALL_SERVICE WorkOrder records
|
|
@@ -8860,6 +8981,19 @@ export interface InstallServiceWorkOrderProperties {
|
|
|
8860
8981
|
* @default
|
|
8861
8982
|
*/
|
|
8862
8983
|
EquipmentChargeBreakdown: string;
|
|
8984
|
+
/** JSON list of the CustomerDeviceRouter / CustomerDevice record ids the agent ticked when creating a replacement. The Delivered mint supersedes exactly these and links them to the work order for collection (PORTAPP-3260).
|
|
8985
|
+
*
|
|
8986
|
+
* @type {JSON}
|
|
8987
|
+
* @default
|
|
8988
|
+
*/
|
|
8989
|
+
ReplacedDeviceIds: string;
|
|
8990
|
+
/** Which customer-facing front end raised this work order. Set by the customer portal API from its `source` query parameter (PORTAPP-3258). Null on staff-created and system-created work orders.
|
|
8991
|
+
*
|
|
8992
|
+
* @type {ENUM}
|
|
8993
|
+
* @default
|
|
8994
|
+
* @enum {WorkOrderSource}
|
|
8995
|
+
*/
|
|
8996
|
+
Source: WorkOrderSource;
|
|
8863
8997
|
}
|
|
8864
8998
|
/**
|
|
8865
8999
|
* Properties for NETWORK_ADJUSTMENT WorkOrder records
|
|
@@ -9659,6 +9793,19 @@ export interface NetworkAdjustmentWorkOrderProperties {
|
|
|
9659
9793
|
* @default
|
|
9660
9794
|
*/
|
|
9661
9795
|
EquipmentChargeBreakdown: string;
|
|
9796
|
+
/** JSON list of the CustomerDeviceRouter / CustomerDevice record ids the agent ticked when creating a replacement. The Delivered mint supersedes exactly these and links them to the work order for collection (PORTAPP-3260).
|
|
9797
|
+
*
|
|
9798
|
+
* @type {JSON}
|
|
9799
|
+
* @default
|
|
9800
|
+
*/
|
|
9801
|
+
ReplacedDeviceIds: string;
|
|
9802
|
+
/** Which customer-facing front end raised this work order. Set by the customer portal API from its `source` query parameter (PORTAPP-3258). Null on staff-created and system-created work orders.
|
|
9803
|
+
*
|
|
9804
|
+
* @type {ENUM}
|
|
9805
|
+
* @default
|
|
9806
|
+
* @enum {WorkOrderSource}
|
|
9807
|
+
*/
|
|
9808
|
+
Source: WorkOrderSource;
|
|
9662
9809
|
}
|
|
9663
9810
|
/**
|
|
9664
9811
|
* Properties for PLANNING WorkOrder records
|
|
@@ -10458,6 +10605,19 @@ export interface PlanningWorkOrderProperties {
|
|
|
10458
10605
|
* @default
|
|
10459
10606
|
*/
|
|
10460
10607
|
EquipmentChargeBreakdown: string;
|
|
10608
|
+
/** JSON list of the CustomerDeviceRouter / CustomerDevice record ids the agent ticked when creating a replacement. The Delivered mint supersedes exactly these and links them to the work order for collection (PORTAPP-3260).
|
|
10609
|
+
*
|
|
10610
|
+
* @type {JSON}
|
|
10611
|
+
* @default
|
|
10612
|
+
*/
|
|
10613
|
+
ReplacedDeviceIds: string;
|
|
10614
|
+
/** Which customer-facing front end raised this work order. Set by the customer portal API from its `source` query parameter (PORTAPP-3258). Null on staff-created and system-created work orders.
|
|
10615
|
+
*
|
|
10616
|
+
* @type {ENUM}
|
|
10617
|
+
* @default
|
|
10618
|
+
* @enum {WorkOrderSource}
|
|
10619
|
+
*/
|
|
10620
|
+
Source: WorkOrderSource;
|
|
10461
10621
|
}
|
|
10462
10622
|
/**
|
|
10463
10623
|
* Properties for PRE_PULL WorkOrder records
|
|
@@ -11257,6 +11417,19 @@ export interface PrePullWorkOrderProperties {
|
|
|
11257
11417
|
* @default
|
|
11258
11418
|
*/
|
|
11259
11419
|
EquipmentChargeBreakdown: string;
|
|
11420
|
+
/** JSON list of the CustomerDeviceRouter / CustomerDevice record ids the agent ticked when creating a replacement. The Delivered mint supersedes exactly these and links them to the work order for collection (PORTAPP-3260).
|
|
11421
|
+
*
|
|
11422
|
+
* @type {JSON}
|
|
11423
|
+
* @default
|
|
11424
|
+
*/
|
|
11425
|
+
ReplacedDeviceIds: string;
|
|
11426
|
+
/** Which customer-facing front end raised this work order. Set by the customer portal API from its `source` query parameter (PORTAPP-3258). Null on staff-created and system-created work orders.
|
|
11427
|
+
*
|
|
11428
|
+
* @type {ENUM}
|
|
11429
|
+
* @default
|
|
11430
|
+
* @enum {WorkOrderSource}
|
|
11431
|
+
*/
|
|
11432
|
+
Source: WorkOrderSource;
|
|
11260
11433
|
}
|
|
11261
11434
|
/**
|
|
11262
11435
|
* Properties for REMEDIATION WorkOrder records
|
|
@@ -12056,6 +12229,19 @@ export interface RemediationWorkOrderProperties {
|
|
|
12056
12229
|
* @default
|
|
12057
12230
|
*/
|
|
12058
12231
|
EquipmentChargeBreakdown: string;
|
|
12232
|
+
/** JSON list of the CustomerDeviceRouter / CustomerDevice record ids the agent ticked when creating a replacement. The Delivered mint supersedes exactly these and links them to the work order for collection (PORTAPP-3260).
|
|
12233
|
+
*
|
|
12234
|
+
* @type {JSON}
|
|
12235
|
+
* @default
|
|
12236
|
+
*/
|
|
12237
|
+
ReplacedDeviceIds: string;
|
|
12238
|
+
/** Which customer-facing front end raised this work order. Set by the customer portal API from its `source` query parameter (PORTAPP-3258). Null on staff-created and system-created work orders.
|
|
12239
|
+
*
|
|
12240
|
+
* @type {ENUM}
|
|
12241
|
+
* @default
|
|
12242
|
+
* @enum {WorkOrderSource}
|
|
12243
|
+
*/
|
|
12244
|
+
Source: WorkOrderSource;
|
|
12059
12245
|
}
|
|
12060
12246
|
/**
|
|
12061
12247
|
* Properties for REPLACEMENT_AMCO WorkOrder records
|
|
@@ -12855,6 +13041,19 @@ export interface ReplacementAmcoWorkOrderProperties {
|
|
|
12855
13041
|
* @default
|
|
12856
13042
|
*/
|
|
12857
13043
|
EquipmentChargeBreakdown: string;
|
|
13044
|
+
/** JSON list of the CustomerDeviceRouter / CustomerDevice record ids the agent ticked when creating a replacement. The Delivered mint supersedes exactly these and links them to the work order for collection (PORTAPP-3260).
|
|
13045
|
+
*
|
|
13046
|
+
* @type {JSON}
|
|
13047
|
+
* @default
|
|
13048
|
+
*/
|
|
13049
|
+
ReplacedDeviceIds: string;
|
|
13050
|
+
/** Which customer-facing front end raised this work order. Set by the customer portal API from its `source` query parameter (PORTAPP-3258). Null on staff-created and system-created work orders.
|
|
13051
|
+
*
|
|
13052
|
+
* @type {ENUM}
|
|
13053
|
+
* @default
|
|
13054
|
+
* @enum {WorkOrderSource}
|
|
13055
|
+
*/
|
|
13056
|
+
Source: WorkOrderSource;
|
|
12858
13057
|
}
|
|
12859
13058
|
/**
|
|
12860
13059
|
* Properties for SERVICE WorkOrder records
|
|
@@ -13654,6 +13853,19 @@ export interface ServiceWorkOrderProperties {
|
|
|
13654
13853
|
* @default
|
|
13655
13854
|
*/
|
|
13656
13855
|
EquipmentChargeBreakdown: string;
|
|
13856
|
+
/** JSON list of the CustomerDeviceRouter / CustomerDevice record ids the agent ticked when creating a replacement. The Delivered mint supersedes exactly these and links them to the work order for collection (PORTAPP-3260).
|
|
13857
|
+
*
|
|
13858
|
+
* @type {JSON}
|
|
13859
|
+
* @default
|
|
13860
|
+
*/
|
|
13861
|
+
ReplacedDeviceIds: string;
|
|
13862
|
+
/** Which customer-facing front end raised this work order. Set by the customer portal API from its `source` query parameter (PORTAPP-3258). Null on staff-created and system-created work orders.
|
|
13863
|
+
*
|
|
13864
|
+
* @type {ENUM}
|
|
13865
|
+
* @default
|
|
13866
|
+
* @enum {WorkOrderSource}
|
|
13867
|
+
*/
|
|
13868
|
+
Source: WorkOrderSource;
|
|
13657
13869
|
}
|
|
13658
13870
|
/**
|
|
13659
13871
|
* Properties for WAYLEAVE WorkOrder records
|
|
@@ -14453,6 +14665,19 @@ export interface WayleaveWorkOrderProperties {
|
|
|
14453
14665
|
* @default
|
|
14454
14666
|
*/
|
|
14455
14667
|
EquipmentChargeBreakdown: string;
|
|
14668
|
+
/** JSON list of the CustomerDeviceRouter / CustomerDevice record ids the agent ticked when creating a replacement. The Delivered mint supersedes exactly these and links them to the work order for collection (PORTAPP-3260).
|
|
14669
|
+
*
|
|
14670
|
+
* @type {JSON}
|
|
14671
|
+
* @default
|
|
14672
|
+
*/
|
|
14673
|
+
ReplacedDeviceIds: string;
|
|
14674
|
+
/** Which customer-facing front end raised this work order. Set by the customer portal API from its `source` query parameter (PORTAPP-3258). Null on staff-created and system-created work orders.
|
|
14675
|
+
*
|
|
14676
|
+
* @type {ENUM}
|
|
14677
|
+
* @default
|
|
14678
|
+
* @enum {WorkOrderSource}
|
|
14679
|
+
*/
|
|
14680
|
+
Source: WorkOrderSource;
|
|
14456
14681
|
}
|
|
14457
14682
|
/**
|
|
14458
14683
|
* WorkOrder entity from FieldServiceModule
|
|
@@ -13,10 +13,10 @@
|
|
|
13
13
|
*/
|
|
14
14
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
15
15
|
exports.WorkOrderSLARagStatus = exports.WorkOrderNextAction = exports.WorkOrderCategory = exports.WorkOrderStatus = exports.WorkOrderOutcomeOfServiceVisit = exports.WorkOrderCpe2 = exports.WorkOrderLengthOfInsideOutCableUsed = exports.WorkOrderLengthOfDropCableUsed = exports.WorkOrderProvider = exports.WorkOrderCpe3 = exports.WorkOrderShippingMethod = exports.WorkOrderReturnedStatus = exports.WorkOrderCustomerCallOutcome = exports.WorkOrderState = exports.WorkOrderConfirmationStatus = exports.WorkOrderTypeOfCtuUsed = exports.WorkOrderSubType = exports.WorkOrderContractorComments = exports.WorkOrderServiceCallReason = exports.WorkOrderCpe4 = exports.WorkOrderServiceAppointmentTime = exports.WayleaveWorkOrderStageKeys = exports.WayleaveWorkOrderStageNames = exports.ServiceWorkOrderStageKeys = exports.ServiceWorkOrderStageNames = exports.ReplacementAmcoWorkOrderStageKeys = exports.ReplacementAmcoWorkOrderStageNames = exports.RemediationWorkOrderStageKeys = exports.RemediationWorkOrderStageNames = exports.PrePullWorkOrderStageKeys = exports.PrePullWorkOrderStageNames = exports.PlanningWorkOrderStageKeys = exports.PlanningWorkOrderStageNames = exports.NetworkAdjustmentWorkOrderStageKeys = exports.NetworkAdjustmentWorkOrderStageNames = exports.InstallBusinessWorkOrderStageKeys = exports.InstallBusinessWorkOrderStageNames = exports.InstallWorkOrderStageKeys = exports.InstallWorkOrderStageNames = exports.InspectionWorkOrderStageKeys = exports.InspectionWorkOrderStageNames = exports.FinanceWorkOrderStageKeys = exports.FinanceWorkOrderStageNames = exports.DispatchAmcoWorkOrderStageKeys = exports.DispatchAmcoWorkOrderStageNames = exports.CollectionAmcoWorkOrderStageKeys = exports.CollectionAmcoWorkOrderStageNames = exports.CollectionWorkOrderStageKeys = exports.CollectionWorkOrderStageNames = exports.WorkOrderEntityTypes = void 0;
|
|
16
|
-
exports.
|
|
17
|
-
exports.
|
|
18
|
-
exports.
|
|
19
|
-
exports.ROUTING_KEY_LINK_WORK_ORDER_CUSTOMER_DEVICE_DELETED = exports.ROUTING_KEY_LINK_WORK_ORDER_CUSTOMER_DEVICE_CREATED = exports.ROUTING_KEY_LINK_WORK_ORDER_CUSTOMER_DEVICE_ROUTER_DELETED = exports.ROUTING_KEY_LINK_WORK_ORDER_CUSTOMER_DEVICE_ROUTER_CREATED = exports.ROUTING_KEY_LINK_WORK_ORDER_YF_FIELD_VISIT_OUTCOME_FORM_DELETED = exports.ROUTING_KEY_LINK_WORK_ORDER_YF_FIELD_VISIT_OUTCOME_FORM_CREATED = exports.ROUTING_KEY_LINK_WORK_ORDER_YF_WIFI_SURVEY_DELETED = exports.ROUTING_KEY_LINK_WORK_ORDER_YF_WIFI_SURVEY_CREATED = exports.ROUTING_KEY_LINK_WORK_ORDER_SITE_SPECIFIC_RISK_ASSESSMENT_OUTCOME_FORM_DELETED = exports.ROUTING_KEY_LINK_WORK_ORDER_SITE_SPECIFIC_RISK_ASSESSMENT_OUTCOME_FORM_CREATED = exports.ROUTING_KEY_LINK_WORK_ORDER_WAYLEAVE_AUDIT_DELETED = exports.ROUTING_KEY_LINK_WORK_ORDER_WAYLEAVE_AUDIT_CREATED = exports.ROUTING_KEY_LINK_WORK_ORDER_SERVICE_APPOINTMENT_DELETED = exports.ROUTING_KEY_LINK_WORK_ORDER_SERVICE_APPOINTMENT_CREATED = void 0;
|
|
16
|
+
exports.ROUTING_KEY_WORK_ORDER_REPLACEMENT_AMCO_UPDATED = exports.ROUTING_KEY_WORK_ORDER_REPLACEMENT_AMCO_CREATED = exports.ROUTING_KEY_WORK_ORDER_REMEDIATION_DELETED = exports.ROUTING_KEY_WORK_ORDER_REMEDIATION_UPDATED = exports.ROUTING_KEY_WORK_ORDER_REMEDIATION_CREATED = exports.ROUTING_KEY_WORK_ORDER_PRE_PULL_DELETED = exports.ROUTING_KEY_WORK_ORDER_PRE_PULL_UPDATED = exports.ROUTING_KEY_WORK_ORDER_PRE_PULL_CREATED = exports.ROUTING_KEY_WORK_ORDER_PLANNING_DELETED = exports.ROUTING_KEY_WORK_ORDER_PLANNING_UPDATED = exports.ROUTING_KEY_WORK_ORDER_PLANNING_CREATED = exports.ROUTING_KEY_WORK_ORDER_NETWORK_ADJUSTMENT_DELETED = exports.ROUTING_KEY_WORK_ORDER_NETWORK_ADJUSTMENT_UPDATED = exports.ROUTING_KEY_WORK_ORDER_NETWORK_ADJUSTMENT_CREATED = exports.ROUTING_KEY_WORK_ORDER_INSTALL_SERVICE_DELETED = exports.ROUTING_KEY_WORK_ORDER_INSTALL_SERVICE_UPDATED = exports.ROUTING_KEY_WORK_ORDER_INSTALL_SERVICE_CREATED = exports.ROUTING_KEY_WORK_ORDER_INSTALL_BUSINESS_DELETED = exports.ROUTING_KEY_WORK_ORDER_INSTALL_BUSINESS_UPDATED = exports.ROUTING_KEY_WORK_ORDER_INSTALL_BUSINESS_CREATED = exports.ROUTING_KEY_WORK_ORDER_INSTALL_DELETED = exports.ROUTING_KEY_WORK_ORDER_INSTALL_UPDATED = exports.ROUTING_KEY_WORK_ORDER_INSTALL_CREATED = exports.ROUTING_KEY_WORK_ORDER_INSPECTION_DELETED = exports.ROUTING_KEY_WORK_ORDER_INSPECTION_UPDATED = exports.ROUTING_KEY_WORK_ORDER_INSPECTION_CREATED = exports.ROUTING_KEY_WORK_ORDER_FINANCE_DELETED = exports.ROUTING_KEY_WORK_ORDER_FINANCE_UPDATED = exports.ROUTING_KEY_WORK_ORDER_FINANCE_CREATED = exports.ROUTING_KEY_WORK_ORDER_DISPATCH_AMCO_DELETED = exports.ROUTING_KEY_WORK_ORDER_DISPATCH_AMCO_UPDATED = exports.ROUTING_KEY_WORK_ORDER_DISPATCH_AMCO_CREATED = exports.ROUTING_KEY_WORK_ORDER_COLLECTION_AMCO_DELETED = exports.ROUTING_KEY_WORK_ORDER_COLLECTION_AMCO_UPDATED = exports.ROUTING_KEY_WORK_ORDER_COLLECTION_AMCO_CREATED = exports.ROUTING_KEY_WORK_ORDER_COLLECTION_DELETED = exports.ROUTING_KEY_WORK_ORDER_COLLECTION_UPDATED = exports.ROUTING_KEY_WORK_ORDER_COLLECTION_CREATED = exports.ROUTING_KEY_WORK_ORDER_DELETED = exports.ROUTING_KEY_WORK_ORDER_UPDATED = exports.ROUTING_KEY_WORK_ORDER_CREATED = exports.WorkOrder = exports.WorkOrderPropertyKeys = exports.WorkOrderSource = exports.WorkOrderPreventableWorkOrder = exports.WorkOrderReplacementReason = exports.WorkOrderDispatchReason = exports.WorkOrderReTriggerReason = exports.WorkOrderCpe5 = exports.WorkOrderCpe1 = void 0;
|
|
17
|
+
exports.ROUTING_KEY_LINK_WORK_ORDER_ALTERNATIVE_ADDRESS_CREATED = exports.ROUTING_KEY_LINK_WORK_ORDER_UG_RETRO_AUDIT_DELETED = exports.ROUTING_KEY_LINK_WORK_ORDER_UG_RETRO_AUDIT_CREATED = exports.ROUTING_KEY_LINK_WORK_ORDER_UG_AUDIT_OF_INSTALLATION_DELETED = exports.ROUTING_KEY_LINK_WORK_ORDER_UG_AUDIT_OF_INSTALLATION_CREATED = exports.ROUTING_KEY_LINK_WORK_ORDER_YF_VAN_AUDIT_DELETED = exports.ROUTING_KEY_LINK_WORK_ORDER_YF_VAN_AUDIT_CREATED = exports.ROUTING_KEY_LINK_WORK_ORDER_OH_RETRO_AUDIT_DELETED = exports.ROUTING_KEY_LINK_WORK_ORDER_OH_RETRO_AUDIT_CREATED = exports.ROUTING_KEY_LINK_WORK_ORDER_YF_TOOL_AUDIT_DELETED = exports.ROUTING_KEY_LINK_WORK_ORDER_YF_TOOL_AUDIT_CREATED = exports.ROUTING_KEY_LINK_WORK_ORDER_NETOMNIA_INSTALL_VERIFICATION_DELETED = exports.ROUTING_KEY_LINK_WORK_ORDER_NETOMNIA_INSTALL_VERIFICATION_CREATED = exports.ROUTING_KEY_LINK_WORK_ORDER_EMAIL_DELETED = exports.ROUTING_KEY_LINK_WORK_ORDER_EMAIL_CREATED = exports.ROUTING_KEY_LINK_WORK_ORDER_CONTACT_DELETED = exports.ROUTING_KEY_LINK_WORK_ORDER_CONTACT_CREATED = exports.ROUTING_KEY_LINK_WORK_ORDER_YF_FIELD_SERVICE_VISIT_DELETED = exports.ROUTING_KEY_LINK_WORK_ORDER_YF_FIELD_SERVICE_VISIT_CREATED = exports.ROUTING_KEY_LINK_WORK_ORDER_OH_EXTERNAL_AUDIT_DELETED = exports.ROUTING_KEY_LINK_WORK_ORDER_OH_EXTERNAL_AUDIT_CREATED = exports.ROUTING_KEY_LINK_WORK_ORDER_TEAM_DELETED = exports.ROUTING_KEY_LINK_WORK_ORDER_TEAM_CREATED = exports.ROUTING_KEY_LINK_WORK_ORDER_REMEDIATION_OUTCOME_FORM_DELETED = exports.ROUTING_KEY_LINK_WORK_ORDER_REMEDIATION_OUTCOME_FORM_CREATED = exports.ROUTING_KEY_LINK_WORK_ORDER_LEAD_DELETED = exports.ROUTING_KEY_LINK_WORK_ORDER_LEAD_CREATED = exports.ROUTING_KEY_LINK_WORK_ORDER_NOTE_DELETED = exports.ROUTING_KEY_LINK_WORK_ORDER_NOTE_CREATED = exports.ROUTING_KEY_LINK_WORK_ORDER_FILE_DELETED = exports.ROUTING_KEY_LINK_WORK_ORDER_FILE_CREATED = exports.ROUTING_KEY_LINK_WORK_ORDER_ACTIVITY_LOG_DELETED = exports.ROUTING_KEY_LINK_WORK_ORDER_ACTIVITY_LOG_CREATED = exports.ROUTING_KEY_LINK_WORK_ORDER_NETOMNIA_FTTH2_STAGE_INSTALL_AUDIT_DELETED = exports.ROUTING_KEY_LINK_WORK_ORDER_NETOMNIA_FTTH2_STAGE_INSTALL_AUDIT_CREATED = exports.ROUTING_KEY_LINK_WORK_ORDER_BLOCKAGE_A55_DELETED = exports.ROUTING_KEY_LINK_WORK_ORDER_BLOCKAGE_A55_CREATED = exports.ROUTING_KEY_LINK_WORK_ORDER_OVERLAY_REAL_A55_DELETED = exports.ROUTING_KEY_LINK_WORK_ORDER_OVERLAY_REAL_A55_CREATED = exports.ROUTING_KEY_LINK_WORK_ORDER_NETOMNIA_FTTH1_STAGE_INSTALL_AUDIT_DELETED = exports.ROUTING_KEY_LINK_WORK_ORDER_NETOMNIA_FTTH1_STAGE_INSTALL_AUDIT_CREATED = exports.ROUTING_KEY_LINK_WORK_ORDER_SERVICE_VISIT_AUDIT_DELETED = exports.ROUTING_KEY_LINK_WORK_ORDER_SERVICE_VISIT_AUDIT_CREATED = exports.ROUTING_KEY_WORK_ORDER_WAYLEAVE_DELETED = exports.ROUTING_KEY_WORK_ORDER_WAYLEAVE_UPDATED = exports.ROUTING_KEY_WORK_ORDER_WAYLEAVE_CREATED = exports.ROUTING_KEY_WORK_ORDER_SERVICE_DELETED = exports.ROUTING_KEY_WORK_ORDER_SERVICE_UPDATED = exports.ROUTING_KEY_WORK_ORDER_SERVICE_CREATED = exports.ROUTING_KEY_WORK_ORDER_REPLACEMENT_AMCO_DELETED = void 0;
|
|
18
|
+
exports.ROUTING_KEY_LINK_WORK_ORDER_YF_STOCK_COUNT_CREATED = exports.ROUTING_KEY_LINK_WORK_ORDER_OH_IN_PROGRESS_AUDIT_DELETED = exports.ROUTING_KEY_LINK_WORK_ORDER_OH_IN_PROGRESS_AUDIT_CREATED = exports.ROUTING_KEY_LINK_WORK_ORDER_OH_AUDIT_OF_INSTALLATION_DELETED = exports.ROUTING_KEY_LINK_WORK_ORDER_OH_AUDIT_OF_INSTALLATION_CREATED = exports.ROUTING_KEY_LINK_WORK_ORDER_OH_INSTALLATION_AUDIT_DELETED = exports.ROUTING_KEY_LINK_WORK_ORDER_OH_INSTALLATION_AUDIT_CREATED = exports.ROUTING_KEY_LINK_WORK_ORDER_FIELD_SERVICE_PRODUCT_ROUTER_DELETED = exports.ROUTING_KEY_LINK_WORK_ORDER_FIELD_SERVICE_PRODUCT_ROUTER_CREATED = exports.ROUTING_KEY_LINK_WORK_ORDER_UG_IN_PROGRESS_AUDIT_DELETED = exports.ROUTING_KEY_LINK_WORK_ORDER_UG_IN_PROGRESS_AUDIT_CREATED = exports.ROUTING_KEY_LINK_WORK_ORDER_WORK_ORDER_DELETED = exports.ROUTING_KEY_LINK_WORK_ORDER_WORK_ORDER_CREATED = exports.ROUTING_KEY_LINK_WORK_ORDER_BLOCKAGE_REPORT_A55_DELETED = exports.ROUTING_KEY_LINK_WORK_ORDER_BLOCKAGE_REPORT_A55_CREATED = exports.ROUTING_KEY_LINK_WORK_ORDER_PERMISSION_TO_FAIL_DELETED = exports.ROUTING_KEY_LINK_WORK_ORDER_PERMISSION_TO_FAIL_CREATED = exports.ROUTING_KEY_LINK_WORK_ORDER_ENGINEER_DELETED = exports.ROUTING_KEY_LINK_WORK_ORDER_ENGINEER_CREATED = exports.ROUTING_KEY_LINK_WORK_ORDER_REMEDIATION_REQUIRED_REASON_DELETED = exports.ROUTING_KEY_LINK_WORK_ORDER_REMEDIATION_REQUIRED_REASON_CREATED = exports.ROUTING_KEY_LINK_WORK_ORDER_SERVICE_APPOINTMENT_CONFIG_DELETED = exports.ROUTING_KEY_LINK_WORK_ORDER_SERVICE_APPOINTMENT_CONFIG_CREATED = exports.ROUTING_KEY_LINK_WORK_ORDER_UG_INSTALLATION_AUDIT_DELETED = exports.ROUTING_KEY_LINK_WORK_ORDER_UG_INSTALLATION_AUDIT_CREATED = exports.ROUTING_KEY_LINK_WORK_ORDER_SWEEPER_MAINTENANCE_AUDIT_DELETED = exports.ROUTING_KEY_LINK_WORK_ORDER_SWEEPER_MAINTENANCE_AUDIT_CREATED = exports.ROUTING_KEY_LINK_WORK_ORDER_CUSTOMER_DEVICE_ONT_REMOVAL_DELETED = exports.ROUTING_KEY_LINK_WORK_ORDER_CUSTOMER_DEVICE_ONT_REMOVAL_CREATED = exports.ROUTING_KEY_LINK_WORK_ORDER_INTERNAL_INSTALL_AUDIT_DELETED = exports.ROUTING_KEY_LINK_WORK_ORDER_INTERNAL_INSTALL_AUDIT_CREATED = exports.ROUTING_KEY_LINK_WORK_ORDER_SMS_MESSAGE_DELETED = exports.ROUTING_KEY_LINK_WORK_ORDER_SMS_MESSAGE_CREATED = exports.ROUTING_KEY_LINK_WORK_ORDER_CHANGE_REASON_DELETED = exports.ROUTING_KEY_LINK_WORK_ORDER_CHANGE_REASON_CREATED = exports.ROUTING_KEY_LINK_WORK_ORDER_ORDER_ITEM_DELETED = exports.ROUTING_KEY_LINK_WORK_ORDER_ORDER_ITEM_CREATED = exports.ROUTING_KEY_LINK_WORK_ORDER_FIELD_SERVICE_DISPATCHED_PRODUCT_DELETED = exports.ROUTING_KEY_LINK_WORK_ORDER_FIELD_SERVICE_DISPATCHED_PRODUCT_CREATED = exports.ROUTING_KEY_LINK_WORK_ORDER_NETOMNIA_FTTH_SERVICE_VISIT_SHEET_DELETED = exports.ROUTING_KEY_LINK_WORK_ORDER_NETOMNIA_FTTH_SERVICE_VISIT_SHEET_CREATED = exports.ROUTING_KEY_LINK_WORK_ORDER_UG_EXTERNAL_AUDIT_DELETED = exports.ROUTING_KEY_LINK_WORK_ORDER_UG_EXTERNAL_AUDIT_CREATED = exports.ROUTING_KEY_LINK_WORK_ORDER_NOINSTALL3_AUDIT_OF_INSTALLATION_SHEET_DELETED = exports.ROUTING_KEY_LINK_WORK_ORDER_NOINSTALL3_AUDIT_OF_INSTALLATION_SHEET_CREATED = exports.ROUTING_KEY_LINK_WORK_ORDER_ACTIVITY_DELETED = exports.ROUTING_KEY_LINK_WORK_ORDER_ACTIVITY_CREATED = exports.ROUTING_KEY_LINK_WORK_ORDER_INVOICE_DELETED = exports.ROUTING_KEY_LINK_WORK_ORDER_INVOICE_CREATED = exports.ROUTING_KEY_LINK_WORK_ORDER_ALTERNATIVE_ADDRESS_DELETED = void 0;
|
|
19
|
+
exports.ROUTING_KEY_LINK_WORK_ORDER_CUSTOMER_DEVICE_DELETED = exports.ROUTING_KEY_LINK_WORK_ORDER_CUSTOMER_DEVICE_CREATED = exports.ROUTING_KEY_LINK_WORK_ORDER_CUSTOMER_DEVICE_ROUTER_DELETED = exports.ROUTING_KEY_LINK_WORK_ORDER_CUSTOMER_DEVICE_ROUTER_CREATED = exports.ROUTING_KEY_LINK_WORK_ORDER_YF_FIELD_VISIT_OUTCOME_FORM_DELETED = exports.ROUTING_KEY_LINK_WORK_ORDER_YF_FIELD_VISIT_OUTCOME_FORM_CREATED = exports.ROUTING_KEY_LINK_WORK_ORDER_YF_WIFI_SURVEY_DELETED = exports.ROUTING_KEY_LINK_WORK_ORDER_YF_WIFI_SURVEY_CREATED = exports.ROUTING_KEY_LINK_WORK_ORDER_SITE_SPECIFIC_RISK_ASSESSMENT_OUTCOME_FORM_DELETED = exports.ROUTING_KEY_LINK_WORK_ORDER_SITE_SPECIFIC_RISK_ASSESSMENT_OUTCOME_FORM_CREATED = exports.ROUTING_KEY_LINK_WORK_ORDER_WAYLEAVE_AUDIT_DELETED = exports.ROUTING_KEY_LINK_WORK_ORDER_WAYLEAVE_AUDIT_CREATED = exports.ROUTING_KEY_LINK_WORK_ORDER_SERVICE_APPOINTMENT_DELETED = exports.ROUTING_KEY_LINK_WORK_ORDER_SERVICE_APPOINTMENT_CREATED = exports.ROUTING_KEY_LINK_WORK_ORDER_YF_STOCK_COUNT_DELETED = void 0;
|
|
20
20
|
const core_1 = require("@d19n/odin-types/dist/core");
|
|
21
21
|
/**
|
|
22
22
|
* Available types for WorkOrder records
|
|
@@ -1392,6 +1392,20 @@ var WorkOrderPreventableWorkOrder;
|
|
|
1392
1392
|
WorkOrderPreventableWorkOrder["NO"] = "NO";
|
|
1393
1393
|
WorkOrderPreventableWorkOrder["YES"] = "YES";
|
|
1394
1394
|
})(WorkOrderPreventableWorkOrder = exports.WorkOrderPreventableWorkOrder || (exports.WorkOrderPreventableWorkOrder = {}));
|
|
1395
|
+
/**
|
|
1396
|
+
* Valid values for WorkOrder.Source
|
|
1397
|
+
*
|
|
1398
|
+
* Which customer-facing front end raised this work order. Set by the customer portal API from its `source` query parameter (PORTAPP-3258). Null on staff-created and system-created work orders.
|
|
1399
|
+
*
|
|
1400
|
+
* @remarks Available options:
|
|
1401
|
+
* - `CUSTOMER_APP` - Customer App
|
|
1402
|
+
* - `CUSTOMER_PORTAL` - Customer Portal
|
|
1403
|
+
*/
|
|
1404
|
+
var WorkOrderSource;
|
|
1405
|
+
(function (WorkOrderSource) {
|
|
1406
|
+
WorkOrderSource["CUSTOMER_APP"] = "CUSTOMER_APP";
|
|
1407
|
+
WorkOrderSource["CUSTOMER_PORTAL"] = "CUSTOMER_PORTAL";
|
|
1408
|
+
})(WorkOrderSource = exports.WorkOrderSource || (exports.WorkOrderSource = {}));
|
|
1395
1409
|
/**
|
|
1396
1410
|
* Property keys for WorkOrder
|
|
1397
1411
|
* Use these constants instead of string literals for type safety
|
|
@@ -1670,6 +1684,10 @@ var WorkOrderPropertyKeys;
|
|
|
1670
1684
|
WorkOrderPropertyKeys["PreventableWorkOrder"] = "PreventableWorkOrder";
|
|
1671
1685
|
/** The device counts behind EquipmentCharge, by kind, fixed at the same moment: {"ROUTER":1,"MESH":3}. Exists so the charge can be invoiced as one line per fee product with a quantity, rather than as a single unexplained total — £250 does not say whether that is a router and three nodes or two routers and a node. Kinds rather than fee products, because what the customer holds is the durable fact and which SKU prices it is an invoicing decision. Snapshotted for the same reason as the total: the figure is quoted in the 3PL-C1 booking confirmation and charged from the 3PL-C7 notice months later, so recomputing it at invoice time would bill something other than what was quoted. Absent on collections raised before PORTAPP-3026, including those the PORTAPP-3096 backfill gives a total to. */
|
|
1672
1686
|
WorkOrderPropertyKeys["EquipmentChargeBreakdown"] = "EquipmentChargeBreakdown";
|
|
1687
|
+
/** JSON list of the CustomerDeviceRouter / CustomerDevice record ids the agent ticked when creating a replacement. The Delivered mint supersedes exactly these and links them to the work order for collection (PORTAPP-3260). */
|
|
1688
|
+
WorkOrderPropertyKeys["ReplacedDeviceIds"] = "ReplacedDeviceIds";
|
|
1689
|
+
/** Which customer-facing front end raised this work order. Set by the customer portal API from its `source` query parameter (PORTAPP-3258). Null on staff-created and system-created work orders. */
|
|
1690
|
+
WorkOrderPropertyKeys["Source"] = "Source";
|
|
1673
1691
|
})(WorkOrderPropertyKeys = exports.WorkOrderPropertyKeys || (exports.WorkOrderPropertyKeys = {}));
|
|
1674
1692
|
/**
|
|
1675
1693
|
* WorkOrder entity from FieldServiceModule
|
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
* await record.createInvoice({ ... }).execute();
|
|
14
14
|
* ```
|
|
15
15
|
*
|
|
16
|
-
* Entity Types: DEFAULT, ETF
|
|
16
|
+
* Entity Types: DEFAULT, EQUIPMENT, ETF
|
|
17
17
|
*
|
|
18
18
|
* AUTO-GENERATED - DO NOT EDIT DIRECTLY
|
|
19
19
|
*/
|
|
@@ -22,7 +22,7 @@ import { PipelineStageEntity } from '@d19n/odin-types/dist/core';
|
|
|
22
22
|
import { IDbRecordCreateUpdateRes } from '@d19n/odin-types/dist/core/interfaces/v1.db.interfaces';
|
|
23
23
|
import { IOdinProvider } from '@d19n/odin-sdk-generator/dist/odin-sdk-types';
|
|
24
24
|
import { RecordLinkManager } from '@d19n/odin-sdk-generator/dist/record-link-manager';
|
|
25
|
-
import { InvoiceProperties, EtfInvoiceProperties } from '../entities-v2/Invoice';
|
|
25
|
+
import { InvoiceProperties, EquipmentInvoiceProperties, EtfInvoiceProperties } from '../entities-v2/Invoice';
|
|
26
26
|
import { InvoiceCreateProperties } from '../actions-v2/InvoiceCreateDto';
|
|
27
27
|
import { InvoiceUpdateProperties } from '../actions-v2/InvoiceUpdateDto';
|
|
28
28
|
import { SetInvoiceDunningBrqRequestProperties } from '../actions-v2/SetInvoiceDunningBrqRequestDto';
|
|
@@ -51,7 +51,7 @@ import { OneTouchSwitchRecord } from './OneTouchSwitchRecord';
|
|
|
51
51
|
import { CreditNoteRecord } from './CreditNoteRecord';
|
|
52
52
|
import { PaymentRecord } from './PaymentRecord';
|
|
53
53
|
/** Valid entity types for Invoice */
|
|
54
|
-
export declare type InvoiceType = 'DEFAULT' | 'ETF';
|
|
54
|
+
export declare type InvoiceType = 'DEFAULT' | 'EQUIPMENT' | 'ETF';
|
|
55
55
|
/**
|
|
56
56
|
* Builder for action execution with dryRun support
|
|
57
57
|
*
|
|
@@ -176,6 +176,22 @@ export declare class InvoiceRecord<TProps = InvoiceProperties> {
|
|
|
176
176
|
* @remarks This is the default record type
|
|
177
177
|
*/
|
|
178
178
|
isDefault(): this is InvoiceRecord<InvoiceProperties>;
|
|
179
|
+
/**
|
|
180
|
+
* Type guard: check if this record is of type EQUIPMENT
|
|
181
|
+
*
|
|
182
|
+
* When this returns true, TypeScript automatically narrows the type,
|
|
183
|
+
* giving you access to EQUIPMENT-specific properties.
|
|
184
|
+
*
|
|
185
|
+
* @example
|
|
186
|
+
* ```typescript
|
|
187
|
+
* if (record.isEquipment()) {
|
|
188
|
+
* // TypeScript knows record.properties is EquipmentInvoiceProperties
|
|
189
|
+
* console.log(record.properties.SomeTypeSpecificField);
|
|
190
|
+
* }
|
|
191
|
+
* ```
|
|
192
|
+
* @remarks A charge for equipment a customer never returned, raised from a COLLECTION_AMCO at Non Returned. Its total equals the WorkOrder.EquipmentCharge the customer was quoted. Separate from DEFAULT so equipment recovery can be reported apart.
|
|
193
|
+
*/
|
|
194
|
+
isEquipment(): this is InvoiceRecord<EquipmentInvoiceProperties>;
|
|
179
195
|
/**
|
|
180
196
|
* Type guard: check if this record is of type ETF
|
|
181
197
|
*
|
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
* await record.createInvoice({ ... }).execute();
|
|
15
15
|
* ```
|
|
16
16
|
*
|
|
17
|
-
* Entity Types: DEFAULT, ETF
|
|
17
|
+
* Entity Types: DEFAULT, EQUIPMENT, ETF
|
|
18
18
|
*
|
|
19
19
|
* AUTO-GENERATED - DO NOT EDIT DIRECTLY
|
|
20
20
|
*/
|
|
@@ -181,6 +181,22 @@ class InvoiceRecord {
|
|
|
181
181
|
* @remarks This is the default record type
|
|
182
182
|
*/
|
|
183
183
|
isDefault() { var _a; return ((_a = this._record) === null || _a === void 0 ? void 0 : _a.type) === 'DEFAULT'; }
|
|
184
|
+
/**
|
|
185
|
+
* Type guard: check if this record is of type EQUIPMENT
|
|
186
|
+
*
|
|
187
|
+
* When this returns true, TypeScript automatically narrows the type,
|
|
188
|
+
* giving you access to EQUIPMENT-specific properties.
|
|
189
|
+
*
|
|
190
|
+
* @example
|
|
191
|
+
* ```typescript
|
|
192
|
+
* if (record.isEquipment()) {
|
|
193
|
+
* // TypeScript knows record.properties is EquipmentInvoiceProperties
|
|
194
|
+
* console.log(record.properties.SomeTypeSpecificField);
|
|
195
|
+
* }
|
|
196
|
+
* ```
|
|
197
|
+
* @remarks A charge for equipment a customer never returned, raised from a COLLECTION_AMCO at Non Returned. Its total equals the WorkOrder.EquipmentCharge the customer was quoted. Separate from DEFAULT so equipment recovery can be reported apart.
|
|
198
|
+
*/
|
|
199
|
+
isEquipment() { var _a; return ((_a = this._record) === null || _a === void 0 ? void 0 : _a.type) === 'EQUIPMENT'; }
|
|
184
200
|
/**
|
|
185
201
|
* Type guard: check if this record is of type ETF
|
|
186
202
|
*
|