spitfirepm 23.9700.12 → 23.9700.14
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 +82 -81
- package/dist/SwaggerClients.d.ts +192 -171
- package/dist/SwaggerClients.js +168 -85
- package/dist/SwaggerClients.js.map +1 -1
- package/dist/version.js +1 -1
- package/package.json +40 -40
package/README.md
CHANGED
|
@@ -1,82 +1,83 @@
|
|
|
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.
|
|
29
|
-
23.9700.
|
|
30
|
-
23.9700.
|
|
31
|
-
23.9700.
|
|
32
|
-
23.9700.
|
|
33
|
-
23.9700.
|
|
34
|
-
23.9700.
|
|
35
|
-
23.9700.
|
|
36
|
-
23.9700.
|
|
37
|
-
23.9700.
|
|
38
|
-
23.
|
|
39
|
-
23.9600.
|
|
40
|
-
23.9600.
|
|
41
|
-
23.9600.
|
|
42
|
-
23.9600.
|
|
43
|
-
23.9600.
|
|
44
|
-
23.9600.
|
|
45
|
-
23.9600.
|
|
46
|
-
23.9600.
|
|
47
|
-
23.9600.
|
|
48
|
-
23.9600.
|
|
49
|
-
23.9600.
|
|
50
|
-
23.
|
|
51
|
-
23.9500.
|
|
52
|
-
23.9500.
|
|
53
|
-
23.9500.
|
|
54
|
-
23.9500.
|
|
55
|
-
23.9500.
|
|
56
|
-
23.9500.
|
|
57
|
-
23.9500.
|
|
58
|
-
23.
|
|
59
|
-
23.9400.
|
|
60
|
-
23.9400.
|
|
61
|
-
23.9400.
|
|
62
|
-
23.9400.
|
|
63
|
-
23.9400.
|
|
64
|
-
23.
|
|
65
|
-
23.
|
|
66
|
-
23.
|
|
67
|
-
23.
|
|
68
|
-
23.
|
|
69
|
-
23.
|
|
70
|
-
23.
|
|
71
|
-
23.
|
|
72
|
-
23.
|
|
73
|
-
23.
|
|
74
|
-
23.
|
|
75
|
-
23.
|
|
76
|
-
23.
|
|
77
|
-
23.
|
|
78
|
-
|
|
79
|
-
1.40.
|
|
80
|
-
1.40.
|
|
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.14 - c endpoint
|
|
29
|
+
23.9700.12 - Additional VisitorSettings and XTS support
|
|
30
|
+
23.9700.11 - ContactClient Delete Photo
|
|
31
|
+
23.9700.10 - QueryCatalog and improve Attachment and Contact endpoints
|
|
32
|
+
23.9700.9 - QueryCatalog and improve Attachment and Contact endpoints
|
|
33
|
+
23.9700.8 - Improved ContactClient endpoints
|
|
34
|
+
23.9700.7 - GetDV method clarifications
|
|
35
|
+
23.9700.6 - Audit History Model enhanced
|
|
36
|
+
23.9700.5 - Lookup Editor Endpoints
|
|
37
|
+
23.9700.2 - ProcessDocumentType DataModel enriched
|
|
38
|
+
23.9700.1 - GatherDependsOnValues() improved
|
|
39
|
+
23.9600.18 - Project Program
|
|
40
|
+
23.9600.17 - Improves Analytics opt out
|
|
41
|
+
23.9600.15 - Improves ConfigController
|
|
42
|
+
23.9600.13 - ARR cleanup
|
|
43
|
+
23.9600.12 - ARR endpoints
|
|
44
|
+
23.9600.11 - Adds Admin and Manage Tool Data Models and Endpoints
|
|
45
|
+
23.9600.10 - Adds csi-maintenance
|
|
46
|
+
23.9600.9 - Adds BuildWCCInfoTableHTML
|
|
47
|
+
23.9600.8 - Project SOP links and Send Log Endpoint
|
|
48
|
+
23.9600.5 - SignalR monkey unload to pagehide
|
|
49
|
+
23.9600.3 - Adds PresetSearch ShowTree
|
|
50
|
+
23.9600.1 - Constructing a view model of 3000 records and many fields improved
|
|
51
|
+
23.9500.12 - DataModels are now interfaces instead of classes (increases ES2022 compatability)
|
|
52
|
+
23.9500.11 - Adds Preset Search FolderSource
|
|
53
|
+
23.9500.8 - Vite 8 compatibility
|
|
54
|
+
23.9500.7 - adds forDeviceType optional to GetProjectDocSummary endpoint
|
|
55
|
+
23.9500.6 - adds user notification signal
|
|
56
|
+
23.9500.5 - Adds Bulk PDF Summary endpoint
|
|
57
|
+
23.9500.4 - Adds Cancel and Send Task Results endpoints
|
|
58
|
+
23.9500.1 - Adds ZAP project endpoint
|
|
59
|
+
23.9400.9 - CheckPermit automatically re-loads permit map if an unknown permit is requested
|
|
60
|
+
23.9400.8 - Improves InvokeAction, adds fields to ProjectDocsOfType model
|
|
61
|
+
23.9400.5 - Adds ConfigClient.GetFlexKeyInfo
|
|
62
|
+
23.9400.3 - Avoid stacked "Connection Check" dialogs
|
|
63
|
+
23.9400.2 - FontAwesome 7
|
|
64
|
+
23.9400.1 - Adds status_dv and responsibleParty_dv to doc header model
|
|
65
|
+
23.9390.1 - Adds Probability to FileInformation model
|
|
66
|
+
23.9330.8 - Adds ConfigController, Stats endpoints, serverUnavailable event
|
|
67
|
+
23.9140.0 - Adds Create Project Endpoint
|
|
68
|
+
23.9080.3 - Diffgrams for Doc Items and Attachments; GatherDependsOnValues() supports #DocMasterDetail references
|
|
69
|
+
23.8940.3 - Adds SaveDocumentPatch to DocumentModel exposed from WX and exports sfProcessDTKMap
|
|
70
|
+
23.8882.1 - Adds endpoints to XTSClient
|
|
71
|
+
23.8860.1 - Improves EDB Export support
|
|
72
|
+
23.8825.5 - Adds Report Menu and Route action REST endpoints
|
|
73
|
+
23.8810.1 - Updates swagger for Flush session endpoint
|
|
74
|
+
23.8780.3 - TabStripDetails
|
|
75
|
+
23.8764.0 - Google Auth, Microsoft Entra and endpoints for federated identites
|
|
76
|
+
23.8699.7 - PopDoc supports HTML Element and sfRowKey
|
|
77
|
+
23.8592.1 - Updates swagger
|
|
78
|
+
23.8510.2 - First release for sfPMS v2023
|
|
79
|
+
1.40.206 - SignalR 2.4.3 and FontAwesome 6
|
|
80
|
+
1.40.205 - Improved RecentDocList management
|
|
81
|
+
1.40.208 - Improved poor Signal message and TableAndFieldInfo type
|
|
82
|
+
```
|
|
82
83
|
Originally modified for typescript and linter requirements by Uladzislau Kumakou of XB Software
|
package/dist/SwaggerClients.d.ts
CHANGED
|
@@ -1929,6 +1929,15 @@ export declare class DocumentToolsClient extends APIClientBase {
|
|
|
1929
1929
|
private moveAttachmentWithCallbacks;
|
|
1930
1930
|
private processMoveAttachmentWithCallbacks;
|
|
1931
1931
|
protected processMoveAttachment(xhr: any): boolean | null;
|
|
1932
|
+
/**
|
|
1933
|
+
* Converts a template-generated Word attachment on the specified document into a PDF attachment
|
|
1934
|
+
* @param id Document Key
|
|
1935
|
+
* @param fileKey file Key
|
|
1936
|
+
*/
|
|
1937
|
+
makeAttachmentPDF(id: string, fileKey: string): Promise<DocAttachment | null>;
|
|
1938
|
+
private makeAttachmentPDFWithCallbacks;
|
|
1939
|
+
private processMakeAttachmentPDFWithCallbacks;
|
|
1940
|
+
protected processMakeAttachmentPDF(xhr: any): DocAttachment | null | null;
|
|
1932
1941
|
/**
|
|
1933
1942
|
* Inserts attendees on the specified document
|
|
1934
1943
|
* @param id Document Key
|
|
@@ -2465,6 +2474,24 @@ export declare class DocumentToolsClient extends APIClientBase {
|
|
|
2465
2474
|
private createNextRevisionWithCallbacks;
|
|
2466
2475
|
private processCreateNextRevisionWithCallbacks;
|
|
2467
2476
|
protected processCreateNextRevision(xhr: any): boolean | null;
|
|
2477
|
+
/**
|
|
2478
|
+
* Returns the route on the specified document
|
|
2479
|
+
* @param id Document Key
|
|
2480
|
+
*/
|
|
2481
|
+
getDocRoute(id: string): Promise<DocRoute[] | null>;
|
|
2482
|
+
private getDocRouteWithCallbacks;
|
|
2483
|
+
private processGetDocRouteWithCallbacks;
|
|
2484
|
+
protected processGetDocRoute(xhr: any): DocRoute[] | null | null;
|
|
2485
|
+
/**
|
|
2486
|
+
* Deletes the route on the specified document
|
|
2487
|
+
* @param id Document Key
|
|
2488
|
+
* @param routeKeys Route Key(s)
|
|
2489
|
+
* @return Specified route not found
|
|
2490
|
+
*/
|
|
2491
|
+
deleteDocRoute(id: string, routeKeys: string[]): Promise<string>;
|
|
2492
|
+
private deleteDocRouteWithCallbacks;
|
|
2493
|
+
private processDeleteDocRouteWithCallbacks;
|
|
2494
|
+
protected processDeleteDocRoute(xhr: any): string | null;
|
|
2468
2495
|
/**
|
|
2469
2496
|
* Updates a route entry on the specified document
|
|
2470
2497
|
* @param id Document Key
|
|
@@ -2484,24 +2511,6 @@ export declare class DocumentToolsClient extends APIClientBase {
|
|
|
2484
2511
|
private addDocRouteWithCallbacks;
|
|
2485
2512
|
private processAddDocRouteWithCallbacks;
|
|
2486
2513
|
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
2514
|
/**
|
|
2506
2515
|
* Updates the specified field on the specified route on the specified document. See also PatchDoc
|
|
2507
2516
|
* @param id Document Key
|
|
@@ -3841,12 +3850,12 @@ export declare class XTSClient extends APIClientBase {
|
|
|
3841
3850
|
private processXTSRestContractGetVendorsWithCallbacks;
|
|
3842
3851
|
protected processXTSRestContractGetVendors(xhr: any): XTSRestContractOfXTSNoRowsAndInboundContactInfo | null | null;
|
|
3843
3852
|
/**
|
|
3844
|
-
* SendAP contract: Spitfire pushes
|
|
3853
|
+
* SendAP contract: Spitfire pushes outboundProjectAP rows, the peer answers with the sibling inboundAPDoc header row, now or later
|
|
3845
3854
|
*/
|
|
3846
|
-
xTSRestContractSendAP(): Promise<
|
|
3855
|
+
xTSRestContractSendAP(): Promise<XTSRestContractOfOutboundProjectAPAndInboundAPDoc | null>;
|
|
3847
3856
|
private xTSRestContractSendAPWithCallbacks;
|
|
3848
3857
|
private processXTSRestContractSendAPWithCallbacks;
|
|
3849
|
-
protected processXTSRestContractSendAP(xhr: any):
|
|
3858
|
+
protected processXTSRestContractSendAP(xhr: any): XTSRestContractOfOutboundProjectAPAndInboundAPDoc | null | null;
|
|
3850
3859
|
/**
|
|
3851
3860
|
* Peer pushes rows for a staging table
|
|
3852
3861
|
* @param table inboundAPDoc | inboundPMDoc | inboundContactInfo
|
|
@@ -6770,7 +6779,8 @@ SQL: money */
|
|
|
6770
6779
|
/** not used
|
|
6771
6780
|
SQL: varchar(10) */
|
|
6772
6781
|
LineUOM?: string | undefined;
|
|
6773
|
-
/**
|
|
6782
|
+
/** Line amount, net of retention when retention is separate
|
|
6783
|
+
SQL: money */
|
|
6774
6784
|
LineAmount?: number | undefined;
|
|
6775
6785
|
/** SQL: varchar(50) */
|
|
6776
6786
|
LineAccount?: string | undefined;
|
|
@@ -6781,11 +6791,14 @@ SQL: varchar(10) */
|
|
|
6781
6791
|
/** When this compliance item was created
|
|
6782
6792
|
SQL: datetime2(7) */
|
|
6783
6793
|
Created?: Date | undefined;
|
|
6784
|
-
/**
|
|
6794
|
+
/** When Spitfire last changed the voucher
|
|
6795
|
+
SQL: datetime2(7) */
|
|
6785
6796
|
LastChanged?: Date | undefined;
|
|
6786
|
-
/**
|
|
6797
|
+
/** Spitfire row version of the voucher
|
|
6798
|
+
SQL: bigint */
|
|
6787
6799
|
LastTS?: number | undefined;
|
|
6788
|
-
/**
|
|
6800
|
+
/** Vendor invoice date
|
|
6801
|
+
SQL: date */
|
|
6789
6802
|
InvoiceDate?: Date | undefined;
|
|
6790
6803
|
/** SQL: varchar(50) */
|
|
6791
6804
|
PMBatchRef?: string | undefined;
|
|
@@ -7000,9 +7013,11 @@ SQL: varchar(64) */
|
|
|
7000
7013
|
/** When this compliance item was created
|
|
7001
7014
|
SQL: datetime */
|
|
7002
7015
|
Created?: Date | undefined;
|
|
7003
|
-
/**
|
|
7016
|
+
/** When Spitfire last changed the voucher
|
|
7017
|
+
SQL: datetime */
|
|
7004
7018
|
LastChanged?: Date | undefined;
|
|
7005
|
-
/**
|
|
7019
|
+
/** Spitfire row version of the voucher
|
|
7020
|
+
SQL: bigint */
|
|
7006
7021
|
LastTS?: number | undefined;
|
|
7007
7022
|
[key: string]: any;
|
|
7008
7023
|
}
|
|
@@ -7084,7 +7099,8 @@ SQL: varchar(50) */
|
|
|
7084
7099
|
/** maps to xsfDocItemTask.Quantity
|
|
7085
7100
|
SQL: money */
|
|
7086
7101
|
LineQty?: number | undefined;
|
|
7087
|
-
/**
|
|
7102
|
+
/** Line amount, net of retention when retention is separate
|
|
7103
|
+
SQL: money */
|
|
7088
7104
|
LineAmount?: number | undefined;
|
|
7089
7105
|
/** SQL: varchar(10) */
|
|
7090
7106
|
LineSource?: string | undefined;
|
|
@@ -7098,143 +7114,6 @@ SQL: varchar(10) */
|
|
|
7098
7114
|
/** When this compliance item was created
|
|
7099
7115
|
SQL: datetime */
|
|
7100
7116
|
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
7117
|
/** When Spitfire last changed the voucher
|
|
7239
7118
|
SQL: datetime */
|
|
7240
7119
|
LastChanged?: Date | undefined;
|
|
@@ -7518,6 +7397,148 @@ export interface NameValueHeaderValue {
|
|
|
7518
7397
|
export interface NameValueWithParametersHeaderValue extends NameValueHeaderValue {
|
|
7519
7398
|
Parameters?: NameValueHeaderValue[] | undefined;
|
|
7520
7399
|
}
|
|
7400
|
+
/** 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. */
|
|
7401
|
+
export interface OutboundProjectAP {
|
|
7402
|
+
/** Spitfire project id (not a peer project; available for a GL segment or attribute)
|
|
7403
|
+
SQL: varchar(16) NOT NULL */
|
|
7404
|
+
Project: string;
|
|
7405
|
+
/** INV. A negative DocBal is a credit
|
|
7406
|
+
SQL: varchar(3) NOT NULL */
|
|
7407
|
+
DocType: string;
|
|
7408
|
+
/** Unused (Dynamics SL heritage)
|
|
7409
|
+
SQL: varchar(1) */
|
|
7410
|
+
BatNbr?: string | undefined;
|
|
7411
|
+
/** Spitfire voucher number once assigned; empty on first send
|
|
7412
|
+
SQL: varchar(16) */
|
|
7413
|
+
RefNbr?: string | undefined;
|
|
7414
|
+
/** Shared vendor id: the alternate key, equal to the peer's supplier number
|
|
7415
|
+
SQL: varchar(16) */
|
|
7416
|
+
VendorID?: string | undefined;
|
|
7417
|
+
/** Spitfire subcontract number (PayItemNumber)
|
|
7418
|
+
SQL: varchar(30) */
|
|
7419
|
+
PONbr?: string | undefined;
|
|
7420
|
+
/** Vendor's invoice reference; must be unique per vendor at the peer
|
|
7421
|
+
SQL: varchar(30) NOT NULL */
|
|
7422
|
+
InvoiceNumber: string;
|
|
7423
|
+
/** Vendor invoice date
|
|
7424
|
+
SQL: datetime NOT NULL */
|
|
7425
|
+
InvoiceDate?: Date;
|
|
7426
|
+
/** Header description
|
|
7427
|
+
SQL: varchar(60) */
|
|
7428
|
+
Title?: string | undefined;
|
|
7429
|
+
/** Amount to voucher, net of retention when retention is a separate voucher; equals the sum of LineAmount
|
|
7430
|
+
SQL: money */
|
|
7431
|
+
DocBal?: number | undefined;
|
|
7432
|
+
/** Same as DocBal on first send
|
|
7433
|
+
SQL: money */
|
|
7434
|
+
OrigAmt?: number | undefined;
|
|
7435
|
+
/** YYYYMM requested accounting period
|
|
7436
|
+
SQL: varchar(6) */
|
|
7437
|
+
FiscalPeriod?: string | undefined;
|
|
7438
|
+
/** Null lets the peer compute from terms; set explicitly for a manual-retention voucher
|
|
7439
|
+
SQL: datetime */
|
|
7440
|
+
InvoiceDue?: Date | undefined;
|
|
7441
|
+
/** Present when retention is involved (end of project)
|
|
7442
|
+
SQL: datetime */
|
|
7443
|
+
RetentionDue?: Date | undefined;
|
|
7444
|
+
/** On a credit, the peer invoice number the credit applies against
|
|
7445
|
+
SQL: varchar(50) */
|
|
7446
|
+
ApplyCreditTo?: string | undefined;
|
|
7447
|
+
/** Spitfire commitment type code (FP, CP, PO, LB ...)
|
|
7448
|
+
SQL: varchar(8) NOT NULL */
|
|
7449
|
+
ContractType: string;
|
|
7450
|
+
/** Always 0 (Dynamics SL heritage)
|
|
7451
|
+
SQL: varchar(1) NOT NULL */
|
|
7452
|
+
PC_Status: string;
|
|
7453
|
+
/** X on send
|
|
7454
|
+
SQL: varchar(1) NOT NULL */
|
|
7455
|
+
Status: string;
|
|
7456
|
+
/** Spitfire asks the peer to release / validate the invoice
|
|
7457
|
+
SQL: bit NOT NULL */
|
|
7458
|
+
Released?: boolean;
|
|
7459
|
+
/** Always 1 on send
|
|
7460
|
+
SQL: bit NOT NULL */
|
|
7461
|
+
OpenDoc?: boolean;
|
|
7462
|
+
/** 1 on a manual retention voucher
|
|
7463
|
+
SQL: bit NOT NULL */
|
|
7464
|
+
Hold?: boolean;
|
|
7465
|
+
/** 1 on a manual retention voucher
|
|
7466
|
+
SQL: bit NOT NULL */
|
|
7467
|
+
IsRetention?: boolean;
|
|
7468
|
+
/** GL account as Spitfire knows it (from the account-category map)
|
|
7469
|
+
SQL: varchar(10) */
|
|
7470
|
+
glAcct?: string | undefined;
|
|
7471
|
+
/** GL sub-account as Spitfire knows it
|
|
7472
|
+
SQL: varchar(30) */
|
|
7473
|
+
SubAcct?: string | undefined;
|
|
7474
|
+
/** Seldom used (phase)
|
|
7475
|
+
SQL: varchar(32) */
|
|
7476
|
+
ProjectTask?: string | undefined;
|
|
7477
|
+
/** Spitfire cost code
|
|
7478
|
+
SQL: varchar(32) */
|
|
7479
|
+
WBCODE?: string | undefined;
|
|
7480
|
+
/** Spitfire cost type (LABOR, MAT, SUB, EQUIP ...): primary input to GL coding
|
|
7481
|
+
SQL: varchar(16) */
|
|
7482
|
+
AccountCategory?: string | undefined;
|
|
7483
|
+
/** Voucher line / subcontract line number; the peer returns it so lines can be matched
|
|
7484
|
+
SQL: varchar(16) */
|
|
7485
|
+
ItemNumber?: string | undefined;
|
|
7486
|
+
/** Line description
|
|
7487
|
+
SQL: varchar(256) */
|
|
7488
|
+
Description?: string | undefined;
|
|
7489
|
+
/** Quantity
|
|
7490
|
+
SQL: money NOT NULL */
|
|
7491
|
+
QTY?: number;
|
|
7492
|
+
/** Line amount, net of retention when retention is separate
|
|
7493
|
+
SQL: money */
|
|
7494
|
+
LineAmount?: number | undefined;
|
|
7495
|
+
/** Retention held on this line
|
|
7496
|
+
SQL: money */
|
|
7497
|
+
LineRetention?: number | undefined;
|
|
7498
|
+
/** Shared unit-of-measure code
|
|
7499
|
+
SQL: varchar(10) */
|
|
7500
|
+
UOM?: string | undefined;
|
|
7501
|
+
/** Spitfire company division: natural candidate for the peer business unit
|
|
7502
|
+
SQL: varchar(10) */
|
|
7503
|
+
DivisionID?: string | undefined;
|
|
7504
|
+
/** 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
|
|
7505
|
+
SQL: uniqueidentifier NOT NULL */
|
|
7506
|
+
TDKeyMapKey?: string;
|
|
7507
|
+
/** Peer project id from the key map when one exists
|
|
7508
|
+
SQL: varchar(64) */
|
|
7509
|
+
ProjectAlienKey?: string | undefined;
|
|
7510
|
+
/** Peer project primary key from the key map when one exists
|
|
7511
|
+
SQL: varchar(64) */
|
|
7512
|
+
ProjectAlienPK?: string | undefined;
|
|
7513
|
+
/** Peer cost-code id from the key map when one exists
|
|
7514
|
+
SQL: varchar(64) */
|
|
7515
|
+
WBSAlienKey?: string | undefined;
|
|
7516
|
+
/** Peer cost-code primary key when one exists
|
|
7517
|
+
SQL: varchar(64) */
|
|
7518
|
+
WBSAlienPK?: string | undefined;
|
|
7519
|
+
/** Peer account-category id when one exists
|
|
7520
|
+
SQL: varchar(64) */
|
|
7521
|
+
WAAlienKey?: string | undefined;
|
|
7522
|
+
/** Peer account-category primary key when one exists
|
|
7523
|
+
SQL: varchar(64) */
|
|
7524
|
+
WAAlienPK?: string | undefined;
|
|
7525
|
+
/** Peer vendor id from the key map
|
|
7526
|
+
SQL: varchar(64) */
|
|
7527
|
+
VendorAlienKey?: string | undefined;
|
|
7528
|
+
/** Peer vendor primary key from the key map
|
|
7529
|
+
SQL: varchar(64) */
|
|
7530
|
+
VendorAlienPK?: string | undefined;
|
|
7531
|
+
/** Peer id of the subcontract when known, else Project-Subcontract
|
|
7532
|
+
SQL: varchar(64) */
|
|
7533
|
+
SubcontractAlienPK?: string | undefined;
|
|
7534
|
+
/** When Spitfire last changed the voucher
|
|
7535
|
+
SQL: datetime */
|
|
7536
|
+
LastChanged?: Date | undefined;
|
|
7537
|
+
/** Spitfire row version of the voucher
|
|
7538
|
+
SQL: bigint */
|
|
7539
|
+
LastTS?: number | undefined;
|
|
7540
|
+
[key: string]: any;
|
|
7541
|
+
}
|
|
7521
7542
|
export interface PasswordConfiguredOptions {
|
|
7522
7543
|
}
|
|
7523
7544
|
/** Passes data to a simple API */
|
|
@@ -10185,11 +10206,11 @@ export interface XTSRestActionState {
|
|
|
10185
10206
|
ETag?: string | undefined;
|
|
10186
10207
|
}
|
|
10187
10208
|
/** The typed push / callback pair for one action type, as served by GET api/xts/contract/{actionType}. */
|
|
10188
|
-
export interface
|
|
10209
|
+
export interface XTSRestContractOfOutboundProjectAPAndInboundAPDoc {
|
|
10189
10210
|
/** SendAP, GetAPV ... */
|
|
10190
10211
|
ActionType?: string | undefined;
|
|
10191
10212
|
/** What Spitfire pushes to {peerUrl}/{actionType}. */
|
|
10192
|
-
Envelope?:
|
|
10213
|
+
Envelope?: XTSRestEnvelopeOfOutboundProjectAP | undefined;
|
|
10193
10214
|
/** What the peer answers with, synchronously (200) or later at Envelope.ResultUrl. */
|
|
10194
10215
|
Result?: XTSRestResultOfInboundAPDoc | undefined;
|
|
10195
10216
|
/** Plain-language notes for the peer developer. */
|
|
@@ -10236,7 +10257,7 @@ export interface XTSRestDataReceipt {
|
|
|
10236
10257
|
Received?: number;
|
|
10237
10258
|
/** Rows inserted or updated in the staging table. */
|
|
10238
10259
|
Stored?: number;
|
|
10239
|
-
/** true when the table's import proc ran after the store (
|
|
10260
|
+
/** true when the table's import proc ran after the store (runImport=true). */
|
|
10240
10261
|
Imported?: boolean;
|
|
10241
10262
|
/** What was done, in words. */
|
|
10242
10263
|
Message?: string | undefined;
|
|
@@ -10295,16 +10316,16 @@ export interface XTSRestEnvelope extends XTSRestEnvelopeBase {
|
|
|
10295
10316
|
}[] | undefined;
|
|
10296
10317
|
}
|
|
10297
10318
|
/** Typed envelope, for documentation and tests: the rows are the action's payload row type. */
|
|
10298
|
-
export interface
|
|
10319
|
+
export interface XTSRestEnvelopeOfOutboundProjectAP extends XTSRestEnvelopeBase {
|
|
10299
10320
|
/** Payload rows (Sends). Empty for a Get. */
|
|
10300
|
-
Rows?:
|
|
10321
|
+
Rows?: OutboundProjectAP[] | undefined;
|
|
10301
10322
|
}
|
|
10302
10323
|
/** Typed envelope, for documentation and tests: the rows are the action's payload row type. */
|
|
10303
10324
|
export interface XTSRestEnvelopeOfXTSNoRows extends XTSRestEnvelopeBase {
|
|
10304
10325
|
/** Payload rows (Sends). Empty for a Get. */
|
|
10305
10326
|
Rows?: XTSNoRows[] | undefined;
|
|
10306
10327
|
}
|
|
10307
|
-
/** Response to POST api/xts/action/{key}/result. */
|
|
10328
|
+
/** Response to POST api/xts/action/{key}/result (and what a synchronous 200 to a push is answered with). */
|
|
10308
10329
|
export interface XTSRestReceipt {
|
|
10309
10330
|
/** The action the result was posted for. */
|
|
10310
10331
|
ActionKey?: string;
|