spitfirepm 23.9700.12 → 23.9700.15

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 CHANGED
@@ -1,82 +1,84 @@
1
- # Client API for Spitfire Project Management
2
-
3
- Spitfire Project Management is a solution that helps construction and capital organizations manage projects, documents and SOP. The web application includes a REST API with dynamic Swagger documentation via NSwag (https://github.com/RicoSuter/NSwag). This package provides TypeScript and JavaScript clients and helpers for working with this API.
4
-
5
- ### Sample Usage - JavaScript
6
-
7
- ```
8
- // client-side-example.js
9
- ...
10
-
11
- if (typeof top.sfClient === "undefined") top.sfClient = new exports.sfRestClient();
12
-
13
-
14
- let userKey = top.sfClient.GetPageContextValue("UserKey")
15
- let api = new exports.ActionItemsClient(sfApplicationRootPath)
16
- let apiResult = api.getUserActionItemsAll(userKey)
17
- apiResult.then( (a) => {
18
- top.sfClient.BuildViewModel("ActionItems", top.sfClient._EmptyKey, a)
19
- .done(function (v) { console.log(v); });
20
- });
21
-
22
- ...
23
- ```
24
-
25
- ### Change Log
26
-
27
- ```
28
- 23.9700.12 - Additional VisitorSettings and XTS support
29
- 23.9700.11 - ContactClient Delete Photo
30
- 23.9700.10 - QueryCatalog and improve Attachment and Contact endpoints
31
- 23.9700.9 - QueryCatalog and improve Attachment and Contact endpoints
32
- 23.9700.8 - Improved ContactClient endpoints
33
- 23.9700.7 - GetDV method clarifications
34
- 23.9700.6 - Audit History Model enhanced
35
- 23.9700.5 - Lookup Editor Endpoints
36
- 23.9700.2 - ProcessDocumentType DataModel enriched
37
- 23.9700.1 - GatherDependsOnValues() improved
38
- 23.9600.18 - Project Program
39
- 23.9600.17 - Improves Analytics opt out
40
- 23.9600.15 - Improves ConfigController
41
- 23.9600.13 - ARR cleanup
42
- 23.9600.12 - ARR endpoints
43
- 23.9600.11 - Adds Admin and Manage Tool Data Models and Endpoints
44
- 23.9600.10 - Adds csi-maintenance
45
- 23.9600.9 - Adds BuildWCCInfoTableHTML
46
- 23.9600.8 - Project SOP links and Send Log Endpoint
47
- 23.9600.5 - SignalR monkey unload to pagehide
48
- 23.9600.3 - Adds PresetSearch ShowTree
49
- 23.9600.1 - Constructing a view model of 3000 records and many fields improved
50
- 23.9500.12 - DataModels are now interfaces instead of classes (increases ES2022 compatability)
51
- 23.9500.11 - Adds Preset Search FolderSource
52
- 23.9500.8 - Vite 8 compatibility
53
- 23.9500.7 - adds forDeviceType optional to GetProjectDocSummary endpoint
54
- 23.9500.6 - adds user notification signal
55
- 23.9500.5 - Adds Bulk PDF Summary endpoint
56
- 23.9500.4 - Adds Cancel and Send Task Results endpoints
57
- 23.9500.1 - Adds ZAP project endpoint
58
- 23.9400.9 - CheckPermit automatically re-loads permit map if an unknown permit is requested
59
- 23.9400.8 - Improves InvokeAction, adds fields to ProjectDocsOfType model
60
- 23.9400.5 - Adds ConfigClient.GetFlexKeyInfo
61
- 23.9400.3 - Avoid stacked "Connection Check" dialogs
62
- 23.9400.2 - FontAwesome 7
63
- 23.9400.1 - Adds status_dv and responsibleParty_dv to doc header model
64
- 23.9390.1 - Adds Probability to FileInformation model
65
- 23.9330.8 - Adds ConfigController, Stats endpoints, serverUnavailable event
66
- 23.9140.0 - Adds Create Project Endpoint
67
- 23.9080.3 - Diffgrams for Doc Items and Attachments; GatherDependsOnValues() supports #DocMasterDetail references
68
- 23.8940.3 - Adds SaveDocumentPatch to DocumentModel exposed from WX and exports sfProcessDTKMap
69
- 23.8882.1 - Adds endpoints to XTSClient
70
- 23.8860.1 - Improves EDB Export support
71
- 23.8825.5 - Adds Report Menu and Route action REST endpoints
72
- 23.8810.1 - Updates swagger for Flush session endpoint
73
- 23.8780.3 - TabStripDetails
74
- 23.8764.0 - Google Auth, Microsoft Entra and endpoints for federated identites
75
- 23.8699.7 - PopDoc supports HTML Element and sfRowKey
76
- 23.8592.1 - Updates swagger
77
- 23.8510.2 - First release for sfPMS v2023
78
- 1.40.206 - SignalR 2.4.3 and FontAwesome 6
79
- 1.40.205 - Improved RecentDocList management
80
- 1.40.208 - Improved poor Signal message and TableAndFieldInfo type
81
- ```
1
+ # Client API for Spitfire Project Management
2
+
3
+ Spitfire Project Management is a solution that helps construction and capital organizations manage projects, documents and SOP. The web application includes a REST API with dynamic Swagger documentation via NSwag (https://github.com/RicoSuter/NSwag). This package provides TypeScript and JavaScript clients and helpers for working with this API.
4
+
5
+ ### Sample Usage - JavaScript
6
+
7
+ ```
8
+ // client-side-example.js
9
+ ...
10
+
11
+ if (typeof top.sfClient === "undefined") top.sfClient = new exports.sfRestClient();
12
+
13
+
14
+ let userKey = top.sfClient.GetPageContextValue("UserKey")
15
+ let api = new exports.ActionItemsClient(sfApplicationRootPath)
16
+ let apiResult = api.getUserActionItemsAll(userKey)
17
+ apiResult.then( (a) => {
18
+ top.sfClient.BuildViewModel("ActionItems", top.sfClient._EmptyKey, a)
19
+ .done(function (v) { console.log(v); });
20
+ });
21
+
22
+ ...
23
+ ```
24
+
25
+ ### Change Log
26
+
27
+ ```
28
+ 23.9700.15 - Add Contact refined
29
+ 23.9700.14 - MakeAttachmentPDF endpoint
30
+ 23.9700.12 - Additional VisitorSettings and XTS support
31
+ 23.9700.11 - ContactClient Delete Photo
32
+ 23.9700.10 - QueryCatalog and improve Attachment and Contact endpoints
33
+ 23.9700.9 - QueryCatalog and improve Attachment and Contact endpoints
34
+ 23.9700.8 - Improved ContactClient endpoints
35
+ 23.9700.7 - GetDV method clarifications
36
+ 23.9700.6 - Audit History Model enhanced
37
+ 23.9700.5 - Lookup Editor Endpoints
38
+ 23.9700.2 - ProcessDocumentType DataModel enriched
39
+ 23.9700.1 - GatherDependsOnValues() improved
40
+ 23.9600.18 - Project Program
41
+ 23.9600.17 - Improves Analytics opt out
42
+ 23.9600.15 - Improves ConfigController
43
+ 23.9600.13 - ARR cleanup
44
+ 23.9600.12 - ARR endpoints
45
+ 23.9600.11 - Adds Admin and Manage Tool Data Models and Endpoints
46
+ 23.9600.10 - Adds csi-maintenance
47
+ 23.9600.9 - Adds BuildWCCInfoTableHTML
48
+ 23.9600.8 - Project SOP links and Send Log Endpoint
49
+ 23.9600.5 - SignalR monkey unload to pagehide
50
+ 23.9600.3 - Adds PresetSearch ShowTree
51
+ 23.9600.1 - Constructing a view model of 3000 records and many fields improved
52
+ 23.9500.12 - DataModels are now interfaces instead of classes (increases ES2022 compatability)
53
+ 23.9500.11 - Adds Preset Search FolderSource
54
+ 23.9500.8 - Vite 8 compatibility
55
+ 23.9500.7 - adds forDeviceType optional to GetProjectDocSummary endpoint
56
+ 23.9500.6 - adds user notification signal
57
+ 23.9500.5 - Adds Bulk PDF Summary endpoint
58
+ 23.9500.4 - Adds Cancel and Send Task Results endpoints
59
+ 23.9500.1 - Adds ZAP project endpoint
60
+ 23.9400.9 - CheckPermit automatically re-loads permit map if an unknown permit is requested
61
+ 23.9400.8 - Improves InvokeAction, adds fields to ProjectDocsOfType model
62
+ 23.9400.5 - Adds ConfigClient.GetFlexKeyInfo
63
+ 23.9400.3 - Avoid stacked "Connection Check" dialogs
64
+ 23.9400.2 - FontAwesome 7
65
+ 23.9400.1 - Adds status_dv and responsibleParty_dv to doc header model
66
+ 23.9390.1 - Adds Probability to FileInformation model
67
+ 23.9330.8 - Adds ConfigController, Stats endpoints, serverUnavailable event
68
+ 23.9140.0 - Adds Create Project Endpoint
69
+ 23.9080.3 - Diffgrams for Doc Items and Attachments; GatherDependsOnValues() supports #DocMasterDetail references
70
+ 23.8940.3 - Adds SaveDocumentPatch to DocumentModel exposed from WX and exports sfProcessDTKMap
71
+ 23.8882.1 - Adds endpoints to XTSClient
72
+ 23.8860.1 - Improves EDB Export support
73
+ 23.8825.5 - Adds Report Menu and Route action REST endpoints
74
+ 23.8810.1 - Updates swagger for Flush session endpoint
75
+ 23.8780.3 - TabStripDetails
76
+ 23.8764.0 - Google Auth, Microsoft Entra and endpoints for federated identites
77
+ 23.8699.7 - PopDoc supports HTML Element and sfRowKey
78
+ 23.8592.1 - Updates swagger
79
+ 23.8510.2 - First release for sfPMS v2023
80
+ 1.40.206 - SignalR 2.4.3 and FontAwesome 6
81
+ 1.40.205 - Improved RecentDocList management
82
+ 1.40.208 - Improved poor Signal message and TableAndFieldInfo type
83
+ ```
82
84
  Originally modified for typescript and linter requirements by Uladzislau Kumakou of XB Software
@@ -1632,8 +1632,9 @@ export declare class ContactClient extends APIClientBase {
1632
1632
  * @param newData Contact Data
1633
1633
  * @param project (optional) Optional Project Contact
1634
1634
  * @param isCompany (optional) Optional is Primary Company Contact
1635
+ * @param quickAdd (optional) Optional; false when the add is deliberate rather than on-the-fly, so the contact does not join the Quick Add role
1635
1636
  */
1636
- addContact(newData: Contact, project?: string | null | undefined, isCompany?: boolean | undefined): Promise<Contact | null>;
1637
+ addContact(newData: Contact, project?: string | null | undefined, isCompany?: boolean | undefined, quickAdd?: boolean | undefined): Promise<Contact | null>;
1637
1638
  private addContactWithCallbacks;
1638
1639
  private processAddContactWithCallbacks;
1639
1640
  protected processAddContact(xhr: any): Contact | null | null;
@@ -1929,6 +1930,15 @@ export declare class DocumentToolsClient extends APIClientBase {
1929
1930
  private moveAttachmentWithCallbacks;
1930
1931
  private processMoveAttachmentWithCallbacks;
1931
1932
  protected processMoveAttachment(xhr: any): boolean | null;
1933
+ /**
1934
+ * Converts a template-generated Word attachment on the specified document into a PDF attachment
1935
+ * @param id Document Key
1936
+ * @param fileKey file Key
1937
+ */
1938
+ makeAttachmentPDF(id: string, fileKey: string): Promise<DocAttachment | null>;
1939
+ private makeAttachmentPDFWithCallbacks;
1940
+ private processMakeAttachmentPDFWithCallbacks;
1941
+ protected processMakeAttachmentPDF(xhr: any): DocAttachment | null | null;
1932
1942
  /**
1933
1943
  * Inserts attendees on the specified document
1934
1944
  * @param id Document Key
@@ -2465,6 +2475,24 @@ export declare class DocumentToolsClient extends APIClientBase {
2465
2475
  private createNextRevisionWithCallbacks;
2466
2476
  private processCreateNextRevisionWithCallbacks;
2467
2477
  protected processCreateNextRevision(xhr: any): boolean | null;
2478
+ /**
2479
+ * Returns the route on the specified document
2480
+ * @param id Document Key
2481
+ */
2482
+ getDocRoute(id: string): Promise<DocRoute[] | null>;
2483
+ private getDocRouteWithCallbacks;
2484
+ private processGetDocRouteWithCallbacks;
2485
+ protected processGetDocRoute(xhr: any): DocRoute[] | null | null;
2486
+ /**
2487
+ * Deletes the route on the specified document
2488
+ * @param id Document Key
2489
+ * @param routeKeys Route Key(s)
2490
+ * @return Specified route not found
2491
+ */
2492
+ deleteDocRoute(id: string, routeKeys: string[]): Promise<string>;
2493
+ private deleteDocRouteWithCallbacks;
2494
+ private processDeleteDocRouteWithCallbacks;
2495
+ protected processDeleteDocRoute(xhr: any): string | null;
2468
2496
  /**
2469
2497
  * Updates a route entry on the specified document
2470
2498
  * @param id Document Key
@@ -2484,24 +2512,6 @@ export declare class DocumentToolsClient extends APIClientBase {
2484
2512
  private addDocRouteWithCallbacks;
2485
2513
  private processAddDocRouteWithCallbacks;
2486
2514
  protected processAddDocRoute(xhr: any): DocRoute | null | null;
2487
- /**
2488
- * Returns the route on the specified document
2489
- * @param id Document Key
2490
- */
2491
- getDocRoute(id: string): Promise<DocRoute[] | null>;
2492
- private getDocRouteWithCallbacks;
2493
- private processGetDocRouteWithCallbacks;
2494
- protected processGetDocRoute(xhr: any): DocRoute[] | null | null;
2495
- /**
2496
- * Deletes the route on the specified document
2497
- * @param id Document Key
2498
- * @param routeKeys Route Key(s)
2499
- * @return Specified route not found
2500
- */
2501
- deleteDocRoute(id: string, routeKeys: string[]): Promise<string>;
2502
- private deleteDocRouteWithCallbacks;
2503
- private processDeleteDocRouteWithCallbacks;
2504
- protected processDeleteDocRoute(xhr: any): string | null;
2505
2515
  /**
2506
2516
  * Updates the specified field on the specified route on the specified document. See also PatchDoc
2507
2517
  * @param id Document Key
@@ -3841,12 +3851,12 @@ export declare class XTSClient extends APIClientBase {
3841
3851
  private processXTSRestContractGetVendorsWithCallbacks;
3842
3852
  protected processXTSRestContractGetVendors(xhr: any): XTSRestContractOfXTSNoRowsAndInboundContactInfo | null | null;
3843
3853
  /**
3844
- * SendAP contract: Spitfire pushes an inboundProjectAP envelope, the peer answers with an inboundAPDoc header row
3854
+ * SendAP contract: Spitfire pushes outboundProjectAP rows, the peer answers with the sibling inboundAPDoc header row, now or later
3845
3855
  */
3846
- xTSRestContractSendAP(): Promise<XTSRestContractOfInboundProjectAPAndInboundAPDoc | null>;
3856
+ xTSRestContractSendAP(): Promise<XTSRestContractOfOutboundProjectAPAndInboundAPDoc | null>;
3847
3857
  private xTSRestContractSendAPWithCallbacks;
3848
3858
  private processXTSRestContractSendAPWithCallbacks;
3849
- protected processXTSRestContractSendAP(xhr: any): XTSRestContractOfInboundProjectAPAndInboundAPDoc | null | null;
3859
+ protected processXTSRestContractSendAP(xhr: any): XTSRestContractOfOutboundProjectAPAndInboundAPDoc | null | null;
3850
3860
  /**
3851
3861
  * Peer pushes rows for a staging table
3852
3862
  * @param table inboundAPDoc | inboundPMDoc | inboundContactInfo
@@ -6770,7 +6780,8 @@ SQL: money */
6770
6780
  /** not used
6771
6781
  SQL: varchar(10) */
6772
6782
  LineUOM?: string | undefined;
6773
- /** SQL: money */
6783
+ /** Line amount, net of retention when retention is separate
6784
+ SQL: money */
6774
6785
  LineAmount?: number | undefined;
6775
6786
  /** SQL: varchar(50) */
6776
6787
  LineAccount?: string | undefined;
@@ -6781,11 +6792,14 @@ SQL: varchar(10) */
6781
6792
  /** When this compliance item was created
6782
6793
  SQL: datetime2(7) */
6783
6794
  Created?: Date | undefined;
6784
- /** SQL: datetime2(7) */
6795
+ /** When Spitfire last changed the voucher
6796
+ SQL: datetime2(7) */
6785
6797
  LastChanged?: Date | undefined;
6786
- /** SQL: bigint */
6798
+ /** Spitfire row version of the voucher
6799
+ SQL: bigint */
6787
6800
  LastTS?: number | undefined;
6788
- /** SQL: date */
6801
+ /** Vendor invoice date
6802
+ SQL: date */
6789
6803
  InvoiceDate?: Date | undefined;
6790
6804
  /** SQL: varchar(50) */
6791
6805
  PMBatchRef?: string | undefined;
@@ -7000,9 +7014,11 @@ SQL: varchar(64) */
7000
7014
  /** When this compliance item was created
7001
7015
  SQL: datetime */
7002
7016
  Created?: Date | undefined;
7003
- /** SQL: datetime */
7017
+ /** When Spitfire last changed the voucher
7018
+ SQL: datetime */
7004
7019
  LastChanged?: Date | undefined;
7005
- /** SQL: bigint */
7020
+ /** Spitfire row version of the voucher
7021
+ SQL: bigint */
7006
7022
  LastTS?: number | undefined;
7007
7023
  [key: string]: any;
7008
7024
  }
@@ -7084,7 +7100,8 @@ SQL: varchar(50) */
7084
7100
  /** maps to xsfDocItemTask.Quantity
7085
7101
  SQL: money */
7086
7102
  LineQty?: number | undefined;
7087
- /** SQL: money */
7103
+ /** Line amount, net of retention when retention is separate
7104
+ SQL: money */
7088
7105
  LineAmount?: number | undefined;
7089
7106
  /** SQL: varchar(10) */
7090
7107
  LineSource?: string | undefined;
@@ -7098,143 +7115,6 @@ SQL: varchar(10) */
7098
7115
  /** When this compliance item was created
7099
7116
  SQL: datetime */
7100
7117
  Created?: Date | undefined;
7101
- /** SQL: datetime */
7102
- LastChanged?: Date | undefined;
7103
- /** SQL: bigint */
7104
- LastTS?: number | undefined;
7105
- [key: string]: any;
7106
- }
7107
- /** One line of a Spitfire AP voucher as pushed to the peer by SendAP; header fields repeat on every line. Produced by pxts_ProjectSendAP (or the site's configured payload proc), so a site may add columns. */
7108
- export interface InboundProjectAP {
7109
- /** Spitfire project id (not a peer project; available for a GL segment or attribute)
7110
- SQL: varchar(16) NOT NULL */
7111
- Project: string;
7112
- /** INV. A negative DocBal is a credit
7113
- SQL: varchar(3) NOT NULL */
7114
- DocType: string;
7115
- /** Unused (Dynamics SL heritage)
7116
- SQL: varchar(1) */
7117
- BatNbr?: string | undefined;
7118
- /** Spitfire voucher number once assigned; empty on first send
7119
- SQL: varchar(16) */
7120
- RefNbr?: string | undefined;
7121
- /** Shared vendor id: the alternate key, equal to the peer's supplier number
7122
- SQL: varchar(16) */
7123
- VendID?: string | undefined;
7124
- /** Spitfire subcontract number (PayItemNumber)
7125
- SQL: varchar(30) */
7126
- PONbr?: string | undefined;
7127
- /** Vendor's invoice reference; must be unique per vendor at the peer
7128
- SQL: varchar(30) NOT NULL */
7129
- InvoiceNumber: string;
7130
- /** Vendor invoice date
7131
- SQL: datetime NOT NULL */
7132
- InvoiceDate?: Date;
7133
- /** Header description
7134
- SQL: varchar(60) */
7135
- Title?: string | undefined;
7136
- /** Amount to voucher, net of retention when retention is a separate voucher; equals the sum of LineAmount
7137
- SQL: money */
7138
- DocBal?: number | undefined;
7139
- /** Same as DocBal on first send
7140
- SQL: money */
7141
- OrigAmt?: number | undefined;
7142
- /** YYYYMM requested accounting period
7143
- SQL: varchar(6) */
7144
- FiscalPeriod?: string | undefined;
7145
- /** Null lets the peer compute from terms; set explicitly for a manual-retention voucher
7146
- SQL: datetime */
7147
- InvoiceDue?: Date | undefined;
7148
- /** Present when retention is involved (end of project)
7149
- SQL: datetime */
7150
- RetentionDue?: Date | undefined;
7151
- /** On a credit, the peer invoice number the credit applies against
7152
- SQL: varchar(50) */
7153
- ApplyCreditTo?: string | undefined;
7154
- /** Spitfire commitment type code (FP, CP, PO, LB ...)
7155
- SQL: varchar(8) NOT NULL */
7156
- ContractType: string;
7157
- /** Always 0 (Dynamics SL heritage)
7158
- SQL: varchar(1) NOT NULL */
7159
- PC_Status: string;
7160
- /** X on send
7161
- SQL: varchar(1) NOT NULL */
7162
- Status: string;
7163
- /** Spitfire asks the peer to release / validate the invoice
7164
- SQL: bit NOT NULL */
7165
- Rlsed?: boolean;
7166
- /** Always 1 on send
7167
- SQL: bit NOT NULL */
7168
- OpenDoc?: boolean;
7169
- /** 1 on a manual retention voucher
7170
- SQL: bit NOT NULL */
7171
- Hold?: boolean;
7172
- /** 1 on a manual retention voucher
7173
- SQL: bit NOT NULL */
7174
- IsRetention?: boolean;
7175
- /** GL account as Spitfire knows it (from the account-category map)
7176
- SQL: varchar(10) */
7177
- glAcct?: string | undefined;
7178
- /** GL sub-account as Spitfire knows it
7179
- SQL: varchar(30) */
7180
- SubAcct?: string | undefined;
7181
- /** Seldom used (phase)
7182
- SQL: varchar(32) */
7183
- ProjectTask?: string | undefined;
7184
- /** Spitfire cost code
7185
- SQL: varchar(32) */
7186
- WBCODE?: string | undefined;
7187
- /** Spitfire cost type (LABOR, MAT, SUB, EQUIP ...): primary input to GL coding
7188
- SQL: varchar(16) */
7189
- AccountCategory?: string | undefined;
7190
- /** Voucher line / subcontract line number; the peer returns it so lines can be matched
7191
- SQL: varchar(16) */
7192
- ItemNumber?: string | undefined;
7193
- /** Line description
7194
- SQL: varchar(256) */
7195
- Description?: string | undefined;
7196
- /** Quantity
7197
- SQL: money NOT NULL */
7198
- QTY?: number;
7199
- /** Line amount, net of retention when retention is separate
7200
- SQL: money */
7201
- LineAmount?: number | undefined;
7202
- /** Retention held on this line
7203
- SQL: money */
7204
- LineRetention?: number | undefined;
7205
- /** Shared unit-of-measure code
7206
- SQL: varchar(10) */
7207
- UOM?: string | undefined;
7208
- /** Spitfire company division: natural candidate for the peer business unit
7209
- SQL: varchar(10) */
7210
- DivisionID?: string | undefined;
7211
- /** Peer project id from the key map when one exists
7212
- SQL: varchar(64) */
7213
- ProjectAlienKey?: string | undefined;
7214
- /** Peer project primary key from the key map when one exists
7215
- SQL: varchar(64) */
7216
- ProjectAlienPK?: string | undefined;
7217
- /** Peer cost-code id from the key map when one exists
7218
- SQL: varchar(64) */
7219
- WBSAlienKey?: string | undefined;
7220
- /** Peer cost-code primary key when one exists
7221
- SQL: varchar(64) */
7222
- WBSAlienPK?: string | undefined;
7223
- /** Peer account-category id when one exists
7224
- SQL: varchar(64) */
7225
- WAAlienKey?: string | undefined;
7226
- /** Peer account-category primary key when one exists
7227
- SQL: varchar(64) */
7228
- WAAlienPK?: string | undefined;
7229
- /** Peer vendor id from the key map
7230
- SQL: varchar(64) */
7231
- VendorAlienKey?: string | undefined;
7232
- /** Peer vendor primary key from the key map
7233
- SQL: varchar(64) */
7234
- VendorAlienPK?: string | undefined;
7235
- /** Peer id of the subcontract when known, else Project-Subcontract
7236
- SQL: varchar(64) */
7237
- SubcontractAlienPK?: string | undefined;
7238
7118
  /** When Spitfire last changed the voucher
7239
7119
  SQL: datetime */
7240
7120
  LastChanged?: Date | undefined;
@@ -7518,6 +7398,148 @@ export interface NameValueHeaderValue {
7518
7398
  export interface NameValueWithParametersHeaderValue extends NameValueHeaderValue {
7519
7399
  Parameters?: NameValueHeaderValue[] | undefined;
7520
7400
  }
7401
+ /** One line of a Spitfire AP voucher as pushed to the peer by SendAP; header fields repeat on every line. The Send pattern: Spitfire pushes Outbound* rows and expects the sibling Inbound* row (here InboundAPDoc) back, now or later. Produced by pxts_REST_SendAPPayload over pxts_ProjectSendAP, or the site's configured payload proc. */
7402
+ export interface OutboundProjectAP {
7403
+ /** Spitfire project id (not a peer project; available for a GL segment or attribute)
7404
+ SQL: varchar(16) NOT NULL */
7405
+ Project: string;
7406
+ /** INV. A negative DocBal is a credit
7407
+ SQL: varchar(3) NOT NULL */
7408
+ DocType: string;
7409
+ /** Unused (Dynamics SL heritage)
7410
+ SQL: varchar(1) */
7411
+ BatNbr?: string | undefined;
7412
+ /** Spitfire voucher number once assigned; empty on first send
7413
+ SQL: varchar(16) */
7414
+ RefNbr?: string | undefined;
7415
+ /** Shared vendor id: the alternate key, equal to the peer's supplier number
7416
+ SQL: varchar(16) */
7417
+ VendorID?: string | undefined;
7418
+ /** Spitfire subcontract number (PayItemNumber)
7419
+ SQL: varchar(30) */
7420
+ PONbr?: string | undefined;
7421
+ /** Vendor's invoice reference; must be unique per vendor at the peer
7422
+ SQL: varchar(30) NOT NULL */
7423
+ InvoiceNumber: string;
7424
+ /** Vendor invoice date
7425
+ SQL: datetime NOT NULL */
7426
+ InvoiceDate?: Date;
7427
+ /** Header description
7428
+ SQL: varchar(60) */
7429
+ Title?: string | undefined;
7430
+ /** Amount to voucher, net of retention when retention is a separate voucher; equals the sum of LineAmount
7431
+ SQL: money */
7432
+ DocBal?: number | undefined;
7433
+ /** Same as DocBal on first send
7434
+ SQL: money */
7435
+ OrigAmt?: number | undefined;
7436
+ /** YYYYMM requested accounting period
7437
+ SQL: varchar(6) */
7438
+ FiscalPeriod?: string | undefined;
7439
+ /** Null lets the peer compute from terms; set explicitly for a manual-retention voucher
7440
+ SQL: datetime */
7441
+ InvoiceDue?: Date | undefined;
7442
+ /** Present when retention is involved (end of project)
7443
+ SQL: datetime */
7444
+ RetentionDue?: Date | undefined;
7445
+ /** On a credit, the peer invoice number the credit applies against
7446
+ SQL: varchar(50) */
7447
+ ApplyCreditTo?: string | undefined;
7448
+ /** Spitfire commitment type code (FP, CP, PO, LB ...)
7449
+ SQL: varchar(8) NOT NULL */
7450
+ ContractType: string;
7451
+ /** Always 0 (Dynamics SL heritage)
7452
+ SQL: varchar(1) NOT NULL */
7453
+ PC_Status: string;
7454
+ /** X on send
7455
+ SQL: varchar(1) NOT NULL */
7456
+ Status: string;
7457
+ /** Spitfire asks the peer to release / validate the invoice
7458
+ SQL: bit NOT NULL */
7459
+ Released?: boolean;
7460
+ /** Always 1 on send
7461
+ SQL: bit NOT NULL */
7462
+ OpenDoc?: boolean;
7463
+ /** 1 on a manual retention voucher
7464
+ SQL: bit NOT NULL */
7465
+ Hold?: boolean;
7466
+ /** 1 on a manual retention voucher
7467
+ SQL: bit NOT NULL */
7468
+ IsRetention?: boolean;
7469
+ /** GL account as Spitfire knows it (from the account-category map)
7470
+ SQL: varchar(10) */
7471
+ glAcct?: string | undefined;
7472
+ /** GL sub-account as Spitfire knows it
7473
+ SQL: varchar(30) */
7474
+ SubAcct?: string | undefined;
7475
+ /** Seldom used (phase)
7476
+ SQL: varchar(32) */
7477
+ ProjectTask?: string | undefined;
7478
+ /** Spitfire cost code
7479
+ SQL: varchar(32) */
7480
+ WBCODE?: string | undefined;
7481
+ /** Spitfire cost type (LABOR, MAT, SUB, EQUIP ...): primary input to GL coding
7482
+ SQL: varchar(16) */
7483
+ AccountCategory?: string | undefined;
7484
+ /** Voucher line / subcontract line number; the peer returns it so lines can be matched
7485
+ SQL: varchar(16) */
7486
+ ItemNumber?: string | undefined;
7487
+ /** Line description
7488
+ SQL: varchar(256) */
7489
+ Description?: string | undefined;
7490
+ /** Quantity
7491
+ SQL: money NOT NULL */
7492
+ QTY?: number;
7493
+ /** Line amount, net of retention when retention is separate
7494
+ SQL: money */
7495
+ LineAmount?: number | undefined;
7496
+ /** Retention held on this line
7497
+ SQL: money */
7498
+ LineRetention?: number | undefined;
7499
+ /** Shared unit-of-measure code
7500
+ SQL: varchar(10) */
7501
+ UOM?: string | undefined;
7502
+ /** Spitfire company division: natural candidate for the peer business unit
7503
+ SQL: varchar(10) */
7504
+ DivisionID?: string | undefined;
7505
+ /** Spitfire correlation id for the voucher (the KMK). Keep it on your side; retries de-duplicate on the envelope ActionKey, this one follows the voucher for life
7506
+ SQL: uniqueidentifier NOT NULL */
7507
+ TDKeyMapKey?: string;
7508
+ /** Peer project id from the key map when one exists
7509
+ SQL: varchar(64) */
7510
+ ProjectAlienKey?: string | undefined;
7511
+ /** Peer project primary key from the key map when one exists
7512
+ SQL: varchar(64) */
7513
+ ProjectAlienPK?: string | undefined;
7514
+ /** Peer cost-code id from the key map when one exists
7515
+ SQL: varchar(64) */
7516
+ WBSAlienKey?: string | undefined;
7517
+ /** Peer cost-code primary key when one exists
7518
+ SQL: varchar(64) */
7519
+ WBSAlienPK?: string | undefined;
7520
+ /** Peer account-category id when one exists
7521
+ SQL: varchar(64) */
7522
+ WAAlienKey?: string | undefined;
7523
+ /** Peer account-category primary key when one exists
7524
+ SQL: varchar(64) */
7525
+ WAAlienPK?: string | undefined;
7526
+ /** Peer vendor id from the key map
7527
+ SQL: varchar(64) */
7528
+ VendorAlienKey?: string | undefined;
7529
+ /** Peer vendor primary key from the key map
7530
+ SQL: varchar(64) */
7531
+ VendorAlienPK?: string | undefined;
7532
+ /** Peer id of the subcontract when known, else Project-Subcontract
7533
+ SQL: varchar(64) */
7534
+ SubcontractAlienPK?: string | undefined;
7535
+ /** When Spitfire last changed the voucher
7536
+ SQL: datetime */
7537
+ LastChanged?: Date | undefined;
7538
+ /** Spitfire row version of the voucher
7539
+ SQL: bigint */
7540
+ LastTS?: number | undefined;
7541
+ [key: string]: any;
7542
+ }
7521
7543
  export interface PasswordConfiguredOptions {
7522
7544
  }
7523
7545
  /** Passes data to a simple API */
@@ -10185,11 +10207,11 @@ export interface XTSRestActionState {
10185
10207
  ETag?: string | undefined;
10186
10208
  }
10187
10209
  /** The typed push / callback pair for one action type, as served by GET api/xts/contract/{actionType}. */
10188
- export interface XTSRestContractOfInboundProjectAPAndInboundAPDoc {
10210
+ export interface XTSRestContractOfOutboundProjectAPAndInboundAPDoc {
10189
10211
  /** SendAP, GetAPV ... */
10190
10212
  ActionType?: string | undefined;
10191
10213
  /** What Spitfire pushes to {peerUrl}/{actionType}. */
10192
- Envelope?: XTSRestEnvelopeOfInboundProjectAP | undefined;
10214
+ Envelope?: XTSRestEnvelopeOfOutboundProjectAP | undefined;
10193
10215
  /** What the peer answers with, synchronously (200) or later at Envelope.ResultUrl. */
10194
10216
  Result?: XTSRestResultOfInboundAPDoc | undefined;
10195
10217
  /** Plain-language notes for the peer developer. */
@@ -10236,7 +10258,7 @@ export interface XTSRestDataReceipt {
10236
10258
  Received?: number;
10237
10259
  /** Rows inserted or updated in the staging table. */
10238
10260
  Stored?: number;
10239
- /** true when the table's import proc ran after the store (import=true). */
10261
+ /** true when the table's import proc ran after the store (runImport=true). */
10240
10262
  Imported?: boolean;
10241
10263
  /** What was done, in words. */
10242
10264
  Message?: string | undefined;
@@ -10295,16 +10317,16 @@ export interface XTSRestEnvelope extends XTSRestEnvelopeBase {
10295
10317
  }[] | undefined;
10296
10318
  }
10297
10319
  /** Typed envelope, for documentation and tests: the rows are the action's payload row type. */
10298
- export interface XTSRestEnvelopeOfInboundProjectAP extends XTSRestEnvelopeBase {
10320
+ export interface XTSRestEnvelopeOfOutboundProjectAP extends XTSRestEnvelopeBase {
10299
10321
  /** Payload rows (Sends). Empty for a Get. */
10300
- Rows?: InboundProjectAP[] | undefined;
10322
+ Rows?: OutboundProjectAP[] | undefined;
10301
10323
  }
10302
10324
  /** Typed envelope, for documentation and tests: the rows are the action's payload row type. */
10303
10325
  export interface XTSRestEnvelopeOfXTSNoRows extends XTSRestEnvelopeBase {
10304
10326
  /** Payload rows (Sends). Empty for a Get. */
10305
10327
  Rows?: XTSNoRows[] | undefined;
10306
10328
  }
10307
- /** Response to POST api/xts/action/{key}/result. */
10329
+ /** Response to POST api/xts/action/{key}/result (and what a synchronous 200 to a push is answered with). */
10308
10330
  export interface XTSRestReceipt {
10309
10331
  /** The action the result was posted for. */
10310
10332
  ActionKey?: string;