@simpleapps-com/augur-api 0.2.12 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/API-DISCOVERY.md +8 -8
- package/PERFORMANCE.md +7 -7
- package/QUICKSTART.md +4 -4
- package/README.md +84 -18
- package/dist/cjs/index.d.ts +1 -1
- package/dist/cjs/index.d.ts.map +1 -1
- package/dist/cjs/index.js +1 -1
- package/dist/cjs/index.js.map +1 -1
- package/dist/cjs/services/customers/client.d.ts +4 -4
- package/dist/cjs/services/customers/schemas/addresses.d.ts +10 -10
- package/dist/cjs/services/customers/schemas/contacts.d.ts +16 -16
- package/dist/cjs/services/items/client.d.ts +5191 -1327
- package/dist/cjs/services/items/client.d.ts.map +1 -1
- package/dist/cjs/services/items/client.js +2983 -334
- package/dist/cjs/services/items/client.js.map +1 -1
- package/dist/cjs/services/items/schemas/bins.d.ts +855 -0
- package/dist/cjs/services/items/schemas/bins.d.ts.map +1 -0
- package/dist/cjs/services/items/schemas/bins.js +85 -0
- package/dist/cjs/services/items/schemas/bins.js.map +1 -0
- package/dist/cjs/services/items/schemas/brandItems.d.ts +401 -0
- package/dist/cjs/services/items/schemas/brandItems.d.ts.map +1 -0
- package/dist/cjs/services/items/schemas/brandItems.js +48 -0
- package/dist/cjs/services/items/schemas/brandItems.js.map +1 -0
- package/dist/cjs/services/items/schemas/faq.d.ts +438 -0
- package/dist/cjs/services/items/schemas/faq.d.ts.map +1 -0
- package/dist/cjs/services/items/schemas/faq.js +57 -0
- package/dist/cjs/services/items/schemas/faq.js.map +1 -0
- package/dist/cjs/services/items/schemas/favorites.d.ts +315 -0
- package/dist/cjs/services/items/schemas/favorites.d.ts.map +1 -0
- package/dist/cjs/services/items/schemas/favorites.js +38 -0
- package/dist/cjs/services/items/schemas/favorites.js.map +1 -0
- package/dist/cjs/services/items/schemas/index.d.ts +8 -0
- package/dist/cjs/services/items/schemas/index.d.ts.map +1 -1
- package/dist/cjs/services/items/schemas/index.js +8 -0
- package/dist/cjs/services/items/schemas/index.js.map +1 -1
- package/dist/cjs/services/items/schemas/productLinks.d.ts +398 -0
- package/dist/cjs/services/items/schemas/productLinks.d.ts.map +1 -0
- package/dist/cjs/services/items/schemas/productLinks.js +47 -0
- package/dist/cjs/services/items/schemas/productLinks.js.map +1 -0
- package/dist/cjs/services/items/schemas/subparts.d.ts +461 -0
- package/dist/cjs/services/items/schemas/subparts.d.ts.map +1 -0
- package/dist/cjs/services/items/schemas/subparts.js +54 -0
- package/dist/cjs/services/items/schemas/subparts.js.map +1 -0
- package/dist/cjs/services/items/schemas/variants.d.ts +1255 -0
- package/dist/cjs/services/items/schemas/variants.d.ts.map +1 -0
- package/dist/cjs/services/items/schemas/variants.js +96 -0
- package/dist/cjs/services/items/schemas/variants.js.map +1 -0
- package/dist/cjs/services/items/schemas/wishlists.d.ts +1061 -0
- package/dist/cjs/services/items/schemas/wishlists.d.ts.map +1 -0
- package/dist/cjs/services/items/schemas/wishlists.js +81 -0
- package/dist/cjs/services/items/schemas/wishlists.js.map +1 -0
- package/dist/cjs/services/legacy/client.d.ts +15 -15
- package/dist/cjs/services/legacy/client.d.ts.map +1 -1
- package/dist/cjs/services/legacy/client.js +15 -15
- package/dist/cjs/services/legacy/client.js.map +1 -1
- package/dist/cjs/services/orders/client.d.ts +150 -98
- package/dist/cjs/services/orders/client.d.ts.map +1 -1
- package/dist/cjs/services/orders/client.js +61 -61
- package/dist/cjs/services/orders/client.js.map +1 -1
- package/dist/cjs/services/orders/schemas/purchase-orders.d.ts +603 -277
- package/dist/cjs/services/orders/schemas/purchase-orders.d.ts.map +1 -1
- package/dist/cjs/services/orders/schemas/purchase-orders.js +40 -20
- package/dist/cjs/services/orders/schemas/purchase-orders.js.map +1 -1
- package/dist/cjs/services/p21-pim/client.d.ts +2 -2
- package/dist/cjs/services/p21-pim/client.d.ts.map +1 -1
- package/dist/cjs/services/p21-pim/client.js +2 -2
- package/dist/cjs/services/p21-pim/client.js.map +1 -1
- package/dist/cjs/services/p21-sism/client.d.ts +3 -3
- package/dist/cjs/services/p21-sism/client.d.ts.map +1 -1
- package/dist/cjs/services/p21-sism/client.js +4 -4
- package/dist/cjs/services/p21-sism/client.js.map +1 -1
- package/dist/cjs/services/pricing/client.d.ts +69 -57
- package/dist/cjs/services/pricing/client.d.ts.map +1 -1
- package/dist/cjs/services/pricing/client.js +87 -75
- package/dist/cjs/services/pricing/client.js.map +1 -1
- package/dist/cjs/services/vmi/client.d.ts +17 -17
- package/dist/cjs/services/vmi/client.d.ts.map +1 -1
- package/dist/cjs/services/vmi/client.js +29 -29
- package/dist/cjs/services/vmi/client.js.map +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.d.ts.map +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/esm/index.js.map +1 -1
- package/dist/esm/services/customers/client.d.ts +4 -4
- package/dist/esm/services/customers/schemas/addresses.d.ts +10 -10
- package/dist/esm/services/customers/schemas/contacts.d.ts +16 -16
- package/dist/esm/services/items/client.d.ts +5191 -1327
- package/dist/esm/services/items/client.d.ts.map +1 -1
- package/dist/esm/services/items/client.js +3001 -337
- package/dist/esm/services/items/client.js.map +1 -1
- package/dist/esm/services/items/schemas/bins.d.ts +855 -0
- package/dist/esm/services/items/schemas/bins.d.ts.map +1 -0
- package/dist/esm/services/items/schemas/bins.js +82 -0
- package/dist/esm/services/items/schemas/bins.js.map +1 -0
- package/dist/esm/services/items/schemas/brandItems.d.ts +401 -0
- package/dist/esm/services/items/schemas/brandItems.d.ts.map +1 -0
- package/dist/esm/services/items/schemas/brandItems.js +45 -0
- package/dist/esm/services/items/schemas/brandItems.js.map +1 -0
- package/dist/esm/services/items/schemas/faq.d.ts +438 -0
- package/dist/esm/services/items/schemas/faq.d.ts.map +1 -0
- package/dist/esm/services/items/schemas/faq.js +54 -0
- package/dist/esm/services/items/schemas/faq.js.map +1 -0
- package/dist/esm/services/items/schemas/favorites.d.ts +315 -0
- package/dist/esm/services/items/schemas/favorites.d.ts.map +1 -0
- package/dist/esm/services/items/schemas/favorites.js +35 -0
- package/dist/esm/services/items/schemas/favorites.js.map +1 -0
- package/dist/esm/services/items/schemas/index.d.ts +8 -0
- package/dist/esm/services/items/schemas/index.d.ts.map +1 -1
- package/dist/esm/services/items/schemas/index.js +8 -0
- package/dist/esm/services/items/schemas/index.js.map +1 -1
- package/dist/esm/services/items/schemas/productLinks.d.ts +398 -0
- package/dist/esm/services/items/schemas/productLinks.d.ts.map +1 -0
- package/dist/esm/services/items/schemas/productLinks.js +44 -0
- package/dist/esm/services/items/schemas/productLinks.js.map +1 -0
- package/dist/esm/services/items/schemas/subparts.d.ts +461 -0
- package/dist/esm/services/items/schemas/subparts.d.ts.map +1 -0
- package/dist/esm/services/items/schemas/subparts.js +51 -0
- package/dist/esm/services/items/schemas/subparts.js.map +1 -0
- package/dist/esm/services/items/schemas/variants.d.ts +1255 -0
- package/dist/esm/services/items/schemas/variants.d.ts.map +1 -0
- package/dist/esm/services/items/schemas/variants.js +93 -0
- package/dist/esm/services/items/schemas/variants.js.map +1 -0
- package/dist/esm/services/items/schemas/wishlists.d.ts +1061 -0
- package/dist/esm/services/items/schemas/wishlists.d.ts.map +1 -0
- package/dist/esm/services/items/schemas/wishlists.js +78 -0
- package/dist/esm/services/items/schemas/wishlists.js.map +1 -0
- package/dist/esm/services/legacy/client.d.ts +15 -15
- package/dist/esm/services/legacy/client.d.ts.map +1 -1
- package/dist/esm/services/legacy/client.js +15 -15
- package/dist/esm/services/legacy/client.js.map +1 -1
- package/dist/esm/services/orders/client.d.ts +150 -98
- package/dist/esm/services/orders/client.d.ts.map +1 -1
- package/dist/esm/services/orders/client.js +61 -61
- package/dist/esm/services/orders/client.js.map +1 -1
- package/dist/esm/services/orders/schemas/purchase-orders.d.ts +603 -277
- package/dist/esm/services/orders/schemas/purchase-orders.d.ts.map +1 -1
- package/dist/esm/services/orders/schemas/purchase-orders.js +40 -20
- package/dist/esm/services/orders/schemas/purchase-orders.js.map +1 -1
- package/dist/esm/services/p21-pim/client.d.ts +2 -2
- package/dist/esm/services/p21-pim/client.d.ts.map +1 -1
- package/dist/esm/services/p21-pim/client.js +2 -2
- package/dist/esm/services/p21-pim/client.js.map +1 -1
- package/dist/esm/services/p21-sism/client.d.ts +3 -3
- package/dist/esm/services/p21-sism/client.d.ts.map +1 -1
- package/dist/esm/services/p21-sism/client.js +4 -4
- package/dist/esm/services/p21-sism/client.js.map +1 -1
- package/dist/esm/services/pricing/client.d.ts +69 -57
- package/dist/esm/services/pricing/client.d.ts.map +1 -1
- package/dist/esm/services/pricing/client.js +87 -75
- package/dist/esm/services/pricing/client.js.map +1 -1
- package/dist/esm/services/vmi/client.d.ts +17 -17
- package/dist/esm/services/vmi/client.d.ts.map +1 -1
- package/dist/esm/services/vmi/client.js +29 -29
- package/dist/esm/services/vmi/client.js.map +1 -1
- package/dist/types/index.d.ts +1 -1
- package/dist/types/index.d.ts.map +1 -1
- package/dist/types/services/customers/client.d.ts +4 -4
- package/dist/types/services/customers/schemas/addresses.d.ts +10 -10
- package/dist/types/services/customers/schemas/contacts.d.ts +16 -16
- package/dist/types/services/items/client.d.ts +5191 -1327
- package/dist/types/services/items/client.d.ts.map +1 -1
- package/dist/types/services/items/schemas/bins.d.ts +855 -0
- package/dist/types/services/items/schemas/bins.d.ts.map +1 -0
- package/dist/types/services/items/schemas/brandItems.d.ts +401 -0
- package/dist/types/services/items/schemas/brandItems.d.ts.map +1 -0
- package/dist/types/services/items/schemas/faq.d.ts +438 -0
- package/dist/types/services/items/schemas/faq.d.ts.map +1 -0
- package/dist/types/services/items/schemas/favorites.d.ts +315 -0
- package/dist/types/services/items/schemas/favorites.d.ts.map +1 -0
- package/dist/types/services/items/schemas/index.d.ts +8 -0
- package/dist/types/services/items/schemas/index.d.ts.map +1 -1
- package/dist/types/services/items/schemas/productLinks.d.ts +398 -0
- package/dist/types/services/items/schemas/productLinks.d.ts.map +1 -0
- package/dist/types/services/items/schemas/subparts.d.ts +461 -0
- package/dist/types/services/items/schemas/subparts.d.ts.map +1 -0
- package/dist/types/services/items/schemas/variants.d.ts +1255 -0
- package/dist/types/services/items/schemas/variants.d.ts.map +1 -0
- package/dist/types/services/items/schemas/wishlists.d.ts +1061 -0
- package/dist/types/services/items/schemas/wishlists.d.ts.map +1 -0
- package/dist/types/services/legacy/client.d.ts +15 -15
- package/dist/types/services/legacy/client.d.ts.map +1 -1
- package/dist/types/services/orders/client.d.ts +150 -98
- package/dist/types/services/orders/client.d.ts.map +1 -1
- package/dist/types/services/orders/schemas/purchase-orders.d.ts +603 -277
- package/dist/types/services/orders/schemas/purchase-orders.d.ts.map +1 -1
- package/dist/types/services/p21-pim/client.d.ts +2 -2
- package/dist/types/services/p21-pim/client.d.ts.map +1 -1
- package/dist/types/services/p21-sism/client.d.ts +3 -3
- package/dist/types/services/p21-sism/client.d.ts.map +1 -1
- package/dist/types/services/pricing/client.d.ts +69 -57
- package/dist/types/services/pricing/client.d.ts.map +1 -1
- package/dist/types/services/vmi/client.d.ts +17 -17
- package/dist/types/services/vmi/client.d.ts.map +1 -1
- package/package.json +1 -1
|
@@ -22,19 +22,19 @@ import { type OrderDocumentParams, type OrderLookupParams, type PurchaseOrderLis
|
|
|
22
22
|
* const api = new AugurAPI({ bearerToken: 'token', siteId: 'site' });
|
|
23
23
|
*
|
|
24
24
|
* // Standard methods (full BaseResponse)
|
|
25
|
-
* const ordersResponse = await api.orders.
|
|
25
|
+
* const ordersResponse = await api.orders.oeHdr.lookup({ limit: 10, q: '12345' });
|
|
26
26
|
* console.log(`Found ${ordersResponse.total} orders`);
|
|
27
27
|
*
|
|
28
28
|
* // Data methods (data only)
|
|
29
|
-
* const orders = await api.orders.
|
|
29
|
+
* const orders = await api.orders.oeHdr.lookupData({ limit: 10, q: '12345' });
|
|
30
30
|
* orders.forEach(order => console.log(order.orderNo, order.customerName));
|
|
31
31
|
*
|
|
32
32
|
* // Get order document with validation
|
|
33
|
-
* const orderDoc = await api.orders.
|
|
33
|
+
* const orderDoc = await api.orders.oeHdr.getDocument(12345678, { postalCode: '12345' });
|
|
34
34
|
*
|
|
35
35
|
* // Purchase order workflow
|
|
36
|
-
* const pos = await api.orders.
|
|
37
|
-
* const poDoc = await api.orders.
|
|
36
|
+
* const pos = await api.orders.poHdr.listData({ complete: 'N', limit: 20 });
|
|
37
|
+
* const poDoc = await api.orders.poHdr.getDocument(pos[0].poNo);
|
|
38
38
|
* ```
|
|
39
39
|
*/
|
|
40
40
|
export declare class OrdersClient extends BaseServiceClient {
|
|
@@ -48,22 +48,22 @@ export declare class OrdersClient extends BaseServiceClient {
|
|
|
48
48
|
* Order Management Operations (oe-hdr endpoints)
|
|
49
49
|
* @description Core order management functionality for searching, tracking, and retrieving sales orders
|
|
50
50
|
*/
|
|
51
|
-
|
|
51
|
+
oeHdr: {
|
|
52
52
|
/**
|
|
53
53
|
* Search and list order headers with flexible filtering options
|
|
54
54
|
* @description Returns paginated order headers with comprehensive filtering by customer, date, status, sales rep, and search terms. Supports edge caching for improved performance.
|
|
55
55
|
*
|
|
56
|
-
* @fullPath api.orders.
|
|
56
|
+
* @fullPath api.orders.oeHdr.lookup
|
|
57
57
|
* @service orders
|
|
58
58
|
* @domain order-management
|
|
59
59
|
* @dataMethod lookupData - returns only the order headers array without metadata
|
|
60
60
|
* @discoverable true
|
|
61
61
|
* @searchTerms ["order lookup", "search orders", "order list", "find orders", "order search", "sales orders"]
|
|
62
|
-
* @relatedEndpoints ["api.orders.
|
|
62
|
+
* @relatedEndpoints ["api.orders.oeHdr.getDocument", "api.customers.customer.list", "api.orders.oeHdrSalesrep.getOrders"]
|
|
63
63
|
* @commonPatterns ["Search orders by customer", "Find orders by order number", "List incomplete orders", "Filter by date range"]
|
|
64
64
|
* @workflow ["order-discovery", "order-status-tracking", "customer-order-history"]
|
|
65
65
|
* @prerequisites ["Valid authentication token", "Order access permissions"]
|
|
66
|
-
* @nextSteps ["api.orders.
|
|
66
|
+
* @nextSteps ["api.orders.oeHdr.getDocument for full details", "api.customers.customer.get for customer info"]
|
|
67
67
|
* @businessRules ["Returns only orders accessible to current user/sales rep", "Completed orders may have restricted access", "Search supports partial matches"]
|
|
68
68
|
* @functionalArea "order-and-fulfillment-management"
|
|
69
69
|
* @caching "Supports edgeCache parameter (1-8 hours) for frequently accessed order lists"
|
|
@@ -83,7 +83,7 @@ export declare class OrdersClient extends BaseServiceClient {
|
|
|
83
83
|
* @example
|
|
84
84
|
* ```typescript
|
|
85
85
|
* // Search orders with full response metadata
|
|
86
|
-
* const response = await api.orders.
|
|
86
|
+
* const response = await api.orders.oeHdr.lookup({
|
|
87
87
|
* q: '12345',
|
|
88
88
|
* completed: 'N',
|
|
89
89
|
* limit: 10
|
|
@@ -91,13 +91,13 @@ export declare class OrdersClient extends BaseServiceClient {
|
|
|
91
91
|
* console.log(`Found ${response.total} orders`);
|
|
92
92
|
*
|
|
93
93
|
* // Get just the order data
|
|
94
|
-
* const orders = await api.orders.
|
|
94
|
+
* const orders = await api.orders.oeHdr.lookupData({
|
|
95
95
|
* salesrepId: 'REP001',
|
|
96
96
|
* limit: 50
|
|
97
97
|
* });
|
|
98
98
|
*
|
|
99
99
|
* // Filter by completion status with caching
|
|
100
|
-
* const incompleteOrders = await api.orders.
|
|
100
|
+
* const incompleteOrders = await api.orders.oeHdr.lookup({
|
|
101
101
|
* completed: 'N',
|
|
102
102
|
* edgeCache: 2, // Cache for 2 hours
|
|
103
103
|
* orderBy: 'orderDate DESC'
|
|
@@ -158,13 +158,13 @@ export declare class OrdersClient extends BaseServiceClient {
|
|
|
158
158
|
* Retrieve complete order document with all related information
|
|
159
159
|
* @description Returns comprehensive order details including customer info, shipping address, line items, and totals. Includes optional postal code validation for security.
|
|
160
160
|
*
|
|
161
|
-
* @fullPath api.orders.
|
|
161
|
+
* @fullPath api.orders.oeHdr.getDocument
|
|
162
162
|
* @service orders
|
|
163
163
|
* @domain order-management
|
|
164
164
|
* @dataMethod getDocumentData - returns only the order document without metadata
|
|
165
165
|
* @discoverable true
|
|
166
166
|
* @searchTerms ["order document", "order details", "full order", "order with lines", "complete order"]
|
|
167
|
-
* @relatedEndpoints ["api.orders.
|
|
167
|
+
* @relatedEndpoints ["api.orders.oeHdr.lookup", "api.customers.customer.get", "api.items.products.get"]
|
|
168
168
|
* @commonPatterns ["Get order details", "View complete order", "Order with line items", "Full order document"]
|
|
169
169
|
* @workflow ["order-review", "order-fulfillment", "customer-service"]
|
|
170
170
|
* @prerequisites ["Valid order number", "Order access permissions", "Optional postal code for validation"]
|
|
@@ -181,19 +181,19 @@ export declare class OrdersClient extends BaseServiceClient {
|
|
|
181
181
|
* @example
|
|
182
182
|
* ```typescript
|
|
183
183
|
* // Get order document with validation
|
|
184
|
-
* const response = await api.orders.
|
|
184
|
+
* const response = await api.orders.oeHdr.getDocument(12345678, {
|
|
185
185
|
* postalCode: '12345'
|
|
186
186
|
* });
|
|
187
187
|
* console.log(`Order ${response.data.orderNo} for ${response.data.customerName}`);
|
|
188
188
|
*
|
|
189
189
|
* // Get just the document data
|
|
190
|
-
* const order = await api.orders.
|
|
190
|
+
* const order = await api.orders.oeHdr.getDocumentData(12345678);
|
|
191
191
|
* order.lines.forEach(line => {
|
|
192
192
|
* console.log(`${line.itemId}: ${line.qtyOrdered} @ $${line.unitPrice}`);
|
|
193
193
|
* });
|
|
194
194
|
*
|
|
195
195
|
* // Without postal code validation
|
|
196
|
-
* const orderDoc = await api.orders.
|
|
196
|
+
* const orderDoc = await api.orders.oeHdr.getDocument(12345678);
|
|
197
197
|
* ```
|
|
198
198
|
*/
|
|
199
199
|
getDocument: (orderNo: number, params?: OrderDocumentParams) => Promise<{
|
|
@@ -272,22 +272,22 @@ export declare class OrdersClient extends BaseServiceClient {
|
|
|
272
272
|
* Sales Representative Order Operations
|
|
273
273
|
* @description Order management functionality specific to sales representatives including territory-based order access and rep-specific reporting
|
|
274
274
|
*/
|
|
275
|
-
|
|
275
|
+
oeHdrSalesrep: {
|
|
276
276
|
/**
|
|
277
277
|
* Get order list for a specific sales representative
|
|
278
278
|
* @description Returns all orders associated with a specific sales representative, filtered by territory and permissions. Essential for sales performance tracking and customer relationship management.
|
|
279
279
|
*
|
|
280
|
-
* @fullPath api.orders.
|
|
280
|
+
* @fullPath api.orders.oeHdrSalesrep.getOrders
|
|
281
281
|
* @service orders
|
|
282
282
|
* @domain sales-management
|
|
283
283
|
* @dataMethod getOrdersData - returns only the orders array without metadata
|
|
284
284
|
* @discoverable true
|
|
285
285
|
* @searchTerms ["sales rep orders", "representative orders", "territory orders", "sales orders by rep", "rep performance"]
|
|
286
|
-
* @relatedEndpoints ["api.orders.
|
|
286
|
+
* @relatedEndpoints ["api.orders.oeHdrSalesrep.getOrderDocument", "api.orders.oeHdr.lookup", "api.customers.customer.list"]
|
|
287
287
|
* @commonPatterns ["Sales rep performance", "Territory management", "Rep order history", "Sales tracking"]
|
|
288
288
|
* @workflow ["sales-performance-tracking", "territory-management", "commission-calculation"]
|
|
289
289
|
* @prerequisites ["Valid sales representative ID", "Sales rep access permissions"]
|
|
290
|
-
* @nextSteps ["api.orders.
|
|
290
|
+
* @nextSteps ["api.orders.oeHdrSalesrep.getOrderDocument for details", "Calculate commission totals", "Territory analysis"]
|
|
291
291
|
* @businessRules ["Returns only orders within rep's territory", "Respects sales hierarchy permissions", "May include completed and pending orders"]
|
|
292
292
|
* @functionalArea "sales-and-territory-management"
|
|
293
293
|
* @performance "Territory-filtered results - typically smaller datasets than global order lists"
|
|
@@ -298,11 +298,11 @@ export declare class OrdersClient extends BaseServiceClient {
|
|
|
298
298
|
* @example
|
|
299
299
|
* ```typescript
|
|
300
300
|
* // Get all orders for a sales rep
|
|
301
|
-
* const response = await api.orders.
|
|
301
|
+
* const response = await api.orders.oeHdrSalesrep.getOrders(12345);
|
|
302
302
|
* console.log(`Rep has ${response.data.length} orders`);
|
|
303
303
|
*
|
|
304
304
|
* // Get just the orders data
|
|
305
|
-
* const repOrders = await api.orders.
|
|
305
|
+
* const repOrders = await api.orders.oeHdrSalesrep.getOrdersData(12345);
|
|
306
306
|
* const totalValue = repOrders.reduce((sum, order) => sum + order.orderTotal, 0);
|
|
307
307
|
* ```
|
|
308
308
|
*/
|
|
@@ -346,13 +346,13 @@ export declare class OrdersClient extends BaseServiceClient {
|
|
|
346
346
|
* Get specific order document for a sales representative
|
|
347
347
|
* @description Returns complete order document with sales rep context, including commission details and territory-specific information. Validates that the order belongs to the specified sales representative.
|
|
348
348
|
*
|
|
349
|
-
* @fullPath api.orders.
|
|
349
|
+
* @fullPath api.orders.oeHdrSalesrep.getOrderDocument
|
|
350
350
|
* @service orders
|
|
351
351
|
* @domain sales-management
|
|
352
352
|
* @dataMethod getOrderDocumentData - returns only the order document without metadata
|
|
353
353
|
* @discoverable true
|
|
354
354
|
* @searchTerms ["sales rep order document", "rep order details", "territory order document", "rep order with lines"]
|
|
355
|
-
* @relatedEndpoints ["api.orders.
|
|
355
|
+
* @relatedEndpoints ["api.orders.oeHdrSalesrep.getOrders", "api.orders.oeHdr.getDocument", "api.customers.customer.get"]
|
|
356
356
|
* @commonPatterns ["Rep order details", "Commission calculation", "Territory order review", "Sales order analysis"]
|
|
357
357
|
* @workflow ["sales-order-review", "commission-processing", "territory-analysis"]
|
|
358
358
|
* @prerequisites ["Valid sales rep ID", "Valid order number", "Order must belong to specified rep"]
|
|
@@ -368,11 +368,11 @@ export declare class OrdersClient extends BaseServiceClient {
|
|
|
368
368
|
* @example
|
|
369
369
|
* ```typescript
|
|
370
370
|
* // Get order document for specific sales rep
|
|
371
|
-
* const response = await api.orders.
|
|
371
|
+
* const response = await api.orders.oeHdrSalesrep.getOrderDocument(12345, 987654);
|
|
372
372
|
* console.log(`Order ${response.data.orderNo} - Commission: $${response.data.commissionAmount}`);
|
|
373
373
|
*
|
|
374
374
|
* // Get just the document data
|
|
375
|
-
* const repOrder = await api.orders.
|
|
375
|
+
* const repOrder = await api.orders.oeHdrSalesrep.getOrderDocumentData(12345, 987654);
|
|
376
376
|
* console.log(`Territory: ${repOrder.territoryCode}`);
|
|
377
377
|
* ```
|
|
378
378
|
*/
|
|
@@ -422,22 +422,22 @@ export declare class OrdersClient extends BaseServiceClient {
|
|
|
422
422
|
* Purchase Order Operations
|
|
423
423
|
* @description Comprehensive purchase order management including creation, tracking, receiving, and document generation for procurement workflows
|
|
424
424
|
*/
|
|
425
|
-
|
|
425
|
+
poHdr: {
|
|
426
426
|
/**
|
|
427
427
|
* List purchase orders with filtering and pagination
|
|
428
428
|
* @description Returns paginated purchase orders with comprehensive filtering by status, vendor, date ranges, and completion status. Essential for procurement management and receiving workflows.
|
|
429
429
|
*
|
|
430
|
-
* @fullPath api.orders.
|
|
430
|
+
* @fullPath api.orders.poHdr.list
|
|
431
431
|
* @service orders
|
|
432
432
|
* @domain procurement-management
|
|
433
433
|
* @dataMethod listData - returns only the purchase orders array without metadata
|
|
434
434
|
* @discoverable true
|
|
435
435
|
* @searchTerms ["purchase orders", "PO list", "procurement", "vendor orders", "purchase order management", "receiving"]
|
|
436
|
-
* @relatedEndpoints ["api.orders.
|
|
436
|
+
* @relatedEndpoints ["api.orders.poHdr.get", "api.orders.poHdr.getDocument", "api.orders.poHdr.scan", "api.nexus.receiving.list"]
|
|
437
437
|
* @commonPatterns ["List open POs", "Find POs by vendor", "Track receiving status", "Procurement dashboard"]
|
|
438
438
|
* @workflow ["procurement-workflow", "purchase-order-lifecycle", "receiving-management"]
|
|
439
439
|
* @prerequisites ["Valid authentication", "Purchase order access permissions"]
|
|
440
|
-
* @nextSteps ["api.orders.
|
|
440
|
+
* @nextSteps ["api.orders.poHdr.get for details", "api.nexus.receiving.create for receiving", "Update PO status"]
|
|
441
441
|
* @businessRules ["Filters by completion status", "Supports vendor and date filtering", "Pagination required for large datasets"]
|
|
442
442
|
* @functionalArea "procurement-and-purchasing"
|
|
443
443
|
* @performance "Use filtering to reduce result sets. Consider pagination for better performance."
|
|
@@ -454,14 +454,14 @@ export declare class OrdersClient extends BaseServiceClient {
|
|
|
454
454
|
* @example
|
|
455
455
|
* ```typescript
|
|
456
456
|
* // List incomplete purchase orders
|
|
457
|
-
* const response = await api.orders.
|
|
457
|
+
* const response = await api.orders.poHdr.list({
|
|
458
458
|
* complete: 'N',
|
|
459
459
|
* limit: 50
|
|
460
460
|
* });
|
|
461
461
|
* console.log(`${response.total} open purchase orders`);
|
|
462
462
|
*
|
|
463
463
|
* // Get just the PO data
|
|
464
|
-
* const openPOs = await api.orders.
|
|
464
|
+
* const openPOs = await api.orders.poHdr.listData({
|
|
465
465
|
* complete: 'N',
|
|
466
466
|
* vendorId: 'VENDOR001'
|
|
467
467
|
* });
|
|
@@ -480,11 +480,22 @@ export declare class OrdersClient extends BaseServiceClient {
|
|
|
480
480
|
data: {
|
|
481
481
|
poNo: number;
|
|
482
482
|
complete: string;
|
|
483
|
-
|
|
484
|
-
|
|
485
|
-
|
|
486
|
-
poDate: string;
|
|
483
|
+
vendorId: number;
|
|
484
|
+
vendorName: string | null;
|
|
485
|
+
lines?: unknown[] | undefined;
|
|
487
486
|
locationId?: number | undefined;
|
|
487
|
+
orderDate?: unknown;
|
|
488
|
+
ship2Name?: string | null | undefined;
|
|
489
|
+
ship2Add1?: string | null | undefined;
|
|
490
|
+
ship2Add2?: string | null | undefined;
|
|
491
|
+
totalAmount?: number | undefined;
|
|
492
|
+
poHdrUid?: number | undefined;
|
|
493
|
+
supplierId?: number | undefined;
|
|
494
|
+
supplierName?: string | null | undefined;
|
|
495
|
+
divisionId?: number | undefined;
|
|
496
|
+
poDate?: string | undefined;
|
|
497
|
+
companyNo?: string | undefined;
|
|
498
|
+
packingSlipNumber?: unknown;
|
|
488
499
|
expedite?: string | undefined;
|
|
489
500
|
ackFlag?: string | undefined;
|
|
490
501
|
}[];
|
|
@@ -505,11 +516,22 @@ export declare class OrdersClient extends BaseServiceClient {
|
|
|
505
516
|
listData: (params?: PurchaseOrderListParams) => Promise<{
|
|
506
517
|
poNo: number;
|
|
507
518
|
complete: string;
|
|
508
|
-
|
|
509
|
-
|
|
510
|
-
|
|
511
|
-
poDate: string;
|
|
519
|
+
vendorId: number;
|
|
520
|
+
vendorName: string | null;
|
|
521
|
+
lines?: unknown[] | undefined;
|
|
512
522
|
locationId?: number | undefined;
|
|
523
|
+
orderDate?: unknown;
|
|
524
|
+
ship2Name?: string | null | undefined;
|
|
525
|
+
ship2Add1?: string | null | undefined;
|
|
526
|
+
ship2Add2?: string | null | undefined;
|
|
527
|
+
totalAmount?: number | undefined;
|
|
528
|
+
poHdrUid?: number | undefined;
|
|
529
|
+
supplierId?: number | undefined;
|
|
530
|
+
supplierName?: string | null | undefined;
|
|
531
|
+
divisionId?: number | undefined;
|
|
532
|
+
poDate?: string | undefined;
|
|
533
|
+
companyNo?: string | undefined;
|
|
534
|
+
packingSlipNumber?: unknown;
|
|
513
535
|
expedite?: string | undefined;
|
|
514
536
|
ackFlag?: string | undefined;
|
|
515
537
|
}[]>;
|
|
@@ -517,17 +539,17 @@ export declare class OrdersClient extends BaseServiceClient {
|
|
|
517
539
|
* Get detailed purchase order information
|
|
518
540
|
* @description Returns comprehensive purchase order details including header information, vendor details, status, and summary totals. Used for PO management and tracking.
|
|
519
541
|
*
|
|
520
|
-
* @fullPath api.orders.
|
|
542
|
+
* @fullPath api.orders.poHdr.get
|
|
521
543
|
* @service orders
|
|
522
544
|
* @domain procurement-management
|
|
523
545
|
* @dataMethod getData - returns only the purchase order detail without metadata
|
|
524
546
|
* @discoverable true
|
|
525
547
|
* @searchTerms ["purchase order details", "PO details", "purchase order info", "PO header"]
|
|
526
|
-
* @relatedEndpoints ["api.orders.
|
|
548
|
+
* @relatedEndpoints ["api.orders.poHdr.list", "api.orders.poHdr.getDocument", "api.nexus.receiving.list"]
|
|
527
549
|
* @commonPatterns ["Get PO details", "View purchase order", "PO status check", "Vendor order info"]
|
|
528
550
|
* @workflow ["purchase-order-review", "receiving-preparation", "vendor-management"]
|
|
529
551
|
* @prerequisites ["Valid purchase order number", "PO access permissions"]
|
|
530
|
-
* @nextSteps ["api.orders.
|
|
552
|
+
* @nextSteps ["api.orders.poHdr.getDocument for full details", "Create receiving record", "Update PO status"]
|
|
531
553
|
* @businessRules ["Returns header-level information only", "Access controlled by permissions", "Status reflects current receiving state"]
|
|
532
554
|
* @functionalArea "procurement-and-purchasing"
|
|
533
555
|
* @performance "Single PO retrieval - efficient for header information"
|
|
@@ -538,35 +560,42 @@ export declare class OrdersClient extends BaseServiceClient {
|
|
|
538
560
|
* @example
|
|
539
561
|
* ```typescript
|
|
540
562
|
* // Get PO details
|
|
541
|
-
* const response = await api.orders.
|
|
563
|
+
* const response = await api.orders.poHdr.get(12345);
|
|
542
564
|
* console.log(`PO ${response.data.poNo} - Status: ${response.data.status}`);
|
|
543
565
|
*
|
|
544
566
|
* // Get just the PO data
|
|
545
|
-
* const poDetail = await api.orders.
|
|
567
|
+
* const poDetail = await api.orders.poHdr.getData(12345);
|
|
546
568
|
* ```
|
|
547
569
|
*/
|
|
548
570
|
get: (id: string | number, params?: import("../../core/base-client").CacheParams | undefined) => Promise<{
|
|
549
571
|
params: Record<string, unknown> | unknown[];
|
|
550
572
|
data: {
|
|
551
573
|
lines: {
|
|
552
|
-
description: string;
|
|
553
574
|
lineNo: number;
|
|
554
575
|
invMastUid: number;
|
|
555
|
-
unitOfMeasure: string;
|
|
556
576
|
itemId: string;
|
|
557
577
|
qtyOrdered: number;
|
|
558
578
|
qtyReceived: number;
|
|
559
|
-
|
|
560
|
-
|
|
579
|
+
description?: string | undefined;
|
|
580
|
+
unitOfMeasure?: string | undefined;
|
|
581
|
+
itemDesc?: string | undefined;
|
|
582
|
+
serialized?: string | undefined;
|
|
583
|
+
primaryBin?: string | undefined;
|
|
584
|
+
unitCost?: number | undefined;
|
|
585
|
+
qtyOutstanding?: number | undefined;
|
|
586
|
+
extendedCost?: number | undefined;
|
|
587
|
+
trackBins?: string | undefined;
|
|
588
|
+
lotAssignmentRequired?: string | undefined;
|
|
561
589
|
}[];
|
|
562
590
|
poNo: number;
|
|
563
591
|
complete: string;
|
|
564
|
-
|
|
565
|
-
|
|
566
|
-
vendorName: string;
|
|
567
|
-
poDate: string;
|
|
592
|
+
vendorId: number;
|
|
593
|
+
vendorName: string | null;
|
|
568
594
|
approved?: string | undefined;
|
|
595
|
+
orderDate?: unknown;
|
|
569
596
|
requestedDate?: string | undefined;
|
|
597
|
+
totalAmount?: number | undefined;
|
|
598
|
+
poDate?: string | undefined;
|
|
570
599
|
expedite?: string | undefined;
|
|
571
600
|
ackFlag?: string | undefined;
|
|
572
601
|
currencyId?: string | undefined;
|
|
@@ -588,24 +617,31 @@ export declare class OrdersClient extends BaseServiceClient {
|
|
|
588
617
|
*/
|
|
589
618
|
getData: (id: number) => Promise<{
|
|
590
619
|
lines: {
|
|
591
|
-
description: string;
|
|
592
620
|
lineNo: number;
|
|
593
621
|
invMastUid: number;
|
|
594
|
-
unitOfMeasure: string;
|
|
595
622
|
itemId: string;
|
|
596
623
|
qtyOrdered: number;
|
|
597
624
|
qtyReceived: number;
|
|
598
|
-
|
|
599
|
-
|
|
625
|
+
description?: string | undefined;
|
|
626
|
+
unitOfMeasure?: string | undefined;
|
|
627
|
+
itemDesc?: string | undefined;
|
|
628
|
+
serialized?: string | undefined;
|
|
629
|
+
primaryBin?: string | undefined;
|
|
630
|
+
unitCost?: number | undefined;
|
|
631
|
+
qtyOutstanding?: number | undefined;
|
|
632
|
+
extendedCost?: number | undefined;
|
|
633
|
+
trackBins?: string | undefined;
|
|
634
|
+
lotAssignmentRequired?: string | undefined;
|
|
600
635
|
}[];
|
|
601
636
|
poNo: number;
|
|
602
637
|
complete: string;
|
|
603
|
-
|
|
604
|
-
|
|
605
|
-
vendorName: string;
|
|
606
|
-
poDate: string;
|
|
638
|
+
vendorId: number;
|
|
639
|
+
vendorName: string | null;
|
|
607
640
|
approved?: string | undefined;
|
|
641
|
+
orderDate?: unknown;
|
|
608
642
|
requestedDate?: string | undefined;
|
|
643
|
+
totalAmount?: number | undefined;
|
|
644
|
+
poDate?: string | undefined;
|
|
609
645
|
expedite?: string | undefined;
|
|
610
646
|
ackFlag?: string | undefined;
|
|
611
647
|
currencyId?: string | undefined;
|
|
@@ -615,13 +651,13 @@ export declare class OrdersClient extends BaseServiceClient {
|
|
|
615
651
|
* Get complete purchase order document with all related information
|
|
616
652
|
* @description Returns comprehensive purchase order document including header, line items, vendor information, shipping details, and totals. Complete document for receiving and fulfillment processes.
|
|
617
653
|
*
|
|
618
|
-
* @fullPath api.orders.
|
|
654
|
+
* @fullPath api.orders.poHdr.getDocument
|
|
619
655
|
* @service orders
|
|
620
656
|
* @domain procurement-management
|
|
621
657
|
* @dataMethod getDocumentData - returns only the purchase order document without metadata
|
|
622
658
|
* @discoverable true
|
|
623
659
|
* @searchTerms ["purchase order document", "complete PO", "PO with lines", "full purchase order", "PO document"]
|
|
624
|
-
* @relatedEndpoints ["api.orders.
|
|
660
|
+
* @relatedEndpoints ["api.orders.poHdr.get", "api.orders.poHdr.list", "api.nexus.receiving.create"]
|
|
625
661
|
* @commonPatterns ["Complete PO details", "PO for receiving", "Full purchase order", "PO with line items"]
|
|
626
662
|
* @workflow ["purchase-order-fulfillment", "receiving-workflow", "vendor-management"]
|
|
627
663
|
* @prerequisites ["Valid purchase order number", "Document access permissions"]
|
|
@@ -636,11 +672,11 @@ export declare class OrdersClient extends BaseServiceClient {
|
|
|
636
672
|
* @example
|
|
637
673
|
* ```typescript
|
|
638
674
|
* // Get complete PO document
|
|
639
|
-
* const response = await api.orders.
|
|
675
|
+
* const response = await api.orders.poHdr.getDocument(12345);
|
|
640
676
|
* console.log(`PO ${response.data.poNo} has ${response.data.lines.length} line items`);
|
|
641
677
|
*
|
|
642
678
|
* // Get just the document data
|
|
643
|
-
* const poDoc = await api.orders.
|
|
679
|
+
* const poDoc = await api.orders.poHdr.getDocumentData(12345);
|
|
644
680
|
* poDoc.lines.forEach(line => {
|
|
645
681
|
* console.log(`${line.itemId}: ${line.qtyOrdered} (${line.qtyReceived} received)`);
|
|
646
682
|
* });
|
|
@@ -650,23 +686,30 @@ export declare class OrdersClient extends BaseServiceClient {
|
|
|
650
686
|
params: Record<string, unknown> | unknown[];
|
|
651
687
|
data: {
|
|
652
688
|
lines: {
|
|
653
|
-
description: string;
|
|
654
689
|
lineNo: number;
|
|
655
690
|
invMastUid: number;
|
|
656
|
-
unitOfMeasure: string;
|
|
657
691
|
itemId: string;
|
|
658
692
|
qtyOrdered: number;
|
|
659
693
|
qtyReceived: number;
|
|
660
|
-
|
|
661
|
-
|
|
694
|
+
description?: string | undefined;
|
|
695
|
+
unitOfMeasure?: string | undefined;
|
|
696
|
+
itemDesc?: string | undefined;
|
|
697
|
+
serialized?: string | undefined;
|
|
698
|
+
primaryBin?: string | undefined;
|
|
699
|
+
unitCost?: number | undefined;
|
|
700
|
+
qtyOutstanding?: number | undefined;
|
|
701
|
+
extendedCost?: number | undefined;
|
|
702
|
+
trackBins?: string | undefined;
|
|
703
|
+
lotAssignmentRequired?: string | undefined;
|
|
662
704
|
}[];
|
|
663
705
|
poNo: number;
|
|
664
|
-
|
|
665
|
-
|
|
666
|
-
vendorName: string;
|
|
667
|
-
poDate: string;
|
|
706
|
+
vendorId: number;
|
|
707
|
+
vendorName: string | null;
|
|
668
708
|
receipts?: unknown[] | undefined;
|
|
709
|
+
orderDate?: unknown;
|
|
710
|
+
totalAmount?: number | undefined;
|
|
669
711
|
invoices?: unknown[] | undefined;
|
|
712
|
+
poDate?: string | undefined;
|
|
670
713
|
vendorAddress?: {
|
|
671
714
|
state?: string | undefined;
|
|
672
715
|
city?: string | undefined;
|
|
@@ -692,23 +735,30 @@ export declare class OrdersClient extends BaseServiceClient {
|
|
|
692
735
|
*/
|
|
693
736
|
getDocumentData: (poNo: number) => Promise<{
|
|
694
737
|
lines: {
|
|
695
|
-
description: string;
|
|
696
738
|
lineNo: number;
|
|
697
739
|
invMastUid: number;
|
|
698
|
-
unitOfMeasure: string;
|
|
699
740
|
itemId: string;
|
|
700
741
|
qtyOrdered: number;
|
|
701
742
|
qtyReceived: number;
|
|
702
|
-
|
|
703
|
-
|
|
743
|
+
description?: string | undefined;
|
|
744
|
+
unitOfMeasure?: string | undefined;
|
|
745
|
+
itemDesc?: string | undefined;
|
|
746
|
+
serialized?: string | undefined;
|
|
747
|
+
primaryBin?: string | undefined;
|
|
748
|
+
unitCost?: number | undefined;
|
|
749
|
+
qtyOutstanding?: number | undefined;
|
|
750
|
+
extendedCost?: number | undefined;
|
|
751
|
+
trackBins?: string | undefined;
|
|
752
|
+
lotAssignmentRequired?: string | undefined;
|
|
704
753
|
}[];
|
|
705
754
|
poNo: number;
|
|
706
|
-
|
|
707
|
-
|
|
708
|
-
vendorName: string;
|
|
709
|
-
poDate: string;
|
|
755
|
+
vendorId: number;
|
|
756
|
+
vendorName: string | null;
|
|
710
757
|
receipts?: unknown[] | undefined;
|
|
758
|
+
orderDate?: unknown;
|
|
759
|
+
totalAmount?: number | undefined;
|
|
711
760
|
invoices?: unknown[] | undefined;
|
|
761
|
+
poDate?: string | undefined;
|
|
712
762
|
vendorAddress?: {
|
|
713
763
|
state?: string | undefined;
|
|
714
764
|
city?: string | undefined;
|
|
@@ -722,13 +772,13 @@ export declare class OrdersClient extends BaseServiceClient {
|
|
|
722
772
|
* Scan for similar purchase orders based on provided criteria
|
|
723
773
|
* @description Intelligent purchase order discovery that finds similar POs based on items, vendors, or other criteria. Useful for reordering, vendor analysis, and procurement optimization.
|
|
724
774
|
*
|
|
725
|
-
* @fullPath api.orders.
|
|
775
|
+
* @fullPath api.orders.poHdr.scan
|
|
726
776
|
* @service orders
|
|
727
777
|
* @domain procurement-management
|
|
728
778
|
* @dataMethod scanData - returns only the scan results without metadata
|
|
729
779
|
* @discoverable true
|
|
730
780
|
* @searchTerms ["PO scan", "similar purchase orders", "find similar POs", "PO search", "procurement patterns"]
|
|
731
|
-
* @relatedEndpoints ["api.orders.
|
|
781
|
+
* @relatedEndpoints ["api.orders.poHdr.list", "api.orders.poHdr.getDocument", "api.items.products.list"]
|
|
732
782
|
* @commonPatterns ["Find similar orders", "Reorder analysis", "Vendor pattern analysis", "Procurement optimization"]
|
|
733
783
|
* @workflow ["procurement-optimization", "reorder-analysis", "vendor-comparison"]
|
|
734
784
|
* @prerequisites ["Scan criteria parameters", "PO access permissions"]
|
|
@@ -748,13 +798,13 @@ export declare class OrdersClient extends BaseServiceClient {
|
|
|
748
798
|
* @example
|
|
749
799
|
* ```typescript
|
|
750
800
|
* // Scan for similar POs by items
|
|
751
|
-
* const response = await api.orders.
|
|
801
|
+
* const response = await api.orders.poHdr.scan({
|
|
752
802
|
* itemIds: ['ITEM001', 'ITEM002'],
|
|
753
803
|
* similarityThreshold: 70
|
|
754
804
|
* });
|
|
755
805
|
*
|
|
756
806
|
* // Get just the scan results
|
|
757
|
-
* const similarPOs = await api.orders.
|
|
807
|
+
* const similarPOs = await api.orders.poHdr.scanData({
|
|
758
808
|
* vendorId: 'VENDOR001',
|
|
759
809
|
* dateFrom: '2024-01-01'
|
|
760
810
|
* });
|
|
@@ -763,7 +813,7 @@ export declare class OrdersClient extends BaseServiceClient {
|
|
|
763
813
|
scan: (data: {
|
|
764
814
|
locationId?: number | undefined;
|
|
765
815
|
complete?: string | undefined;
|
|
766
|
-
vendorId?:
|
|
816
|
+
vendorId?: number | undefined;
|
|
767
817
|
dateRange?: {
|
|
768
818
|
startDate?: string | undefined;
|
|
769
819
|
endDate?: string | undefined;
|
|
@@ -776,10 +826,11 @@ export declare class OrdersClient extends BaseServiceClient {
|
|
|
776
826
|
data: {
|
|
777
827
|
similarity: number;
|
|
778
828
|
poNo: number;
|
|
779
|
-
|
|
780
|
-
vendorId: string;
|
|
781
|
-
poDate: string;
|
|
829
|
+
vendorId: number;
|
|
782
830
|
matchedCriteria: string[];
|
|
831
|
+
orderDate?: unknown;
|
|
832
|
+
totalAmount?: number | undefined;
|
|
833
|
+
poDate?: string | undefined;
|
|
783
834
|
}[];
|
|
784
835
|
options: Record<string, unknown> | unknown[];
|
|
785
836
|
status: number;
|
|
@@ -798,28 +849,29 @@ export declare class OrdersClient extends BaseServiceClient {
|
|
|
798
849
|
scanData: (params?: PurchaseOrderScanParams) => Promise<{
|
|
799
850
|
similarity: number;
|
|
800
851
|
poNo: number;
|
|
801
|
-
|
|
802
|
-
vendorId: string;
|
|
803
|
-
poDate: string;
|
|
852
|
+
vendorId: number;
|
|
804
853
|
matchedCriteria: string[];
|
|
854
|
+
orderDate?: unknown;
|
|
855
|
+
totalAmount?: number | undefined;
|
|
856
|
+
poDate?: string | undefined;
|
|
805
857
|
}[]>;
|
|
806
858
|
};
|
|
807
859
|
/**
|
|
808
860
|
* Invoice Management Operations
|
|
809
861
|
* @description Invoice processing and document management with Prophet 21 integration for billing and accounting workflows
|
|
810
862
|
*/
|
|
811
|
-
|
|
863
|
+
invoiceHdr: {
|
|
812
864
|
/**
|
|
813
865
|
* Reprint an existing invoice through Prophet 21 integration
|
|
814
866
|
* @description Generates a reprint of an existing invoice through Prophet 21 system integration. Returns invoice document data and reprint status for billing and customer service workflows.
|
|
815
867
|
*
|
|
816
|
-
* @fullPath api.orders.
|
|
868
|
+
* @fullPath api.orders.invoiceHdr.reprint
|
|
817
869
|
* @service orders
|
|
818
870
|
* @domain invoice-management
|
|
819
871
|
* @dataMethod reprintData - returns only the reprint result without metadata
|
|
820
872
|
* @discoverable true
|
|
821
873
|
* @searchTerms ["invoice reprint", "reprint invoice", "invoice copy", "duplicate invoice", "invoice document"]
|
|
822
|
-
* @relatedEndpoints ["api.orders.
|
|
874
|
+
* @relatedEndpoints ["api.orders.oeHdr.getDocument", "api.customers.customer.get", "api.p21-core.company.get"]
|
|
823
875
|
* @commonPatterns ["Reprint invoice", "Customer invoice copy", "Billing document", "Invoice duplicate"]
|
|
824
876
|
* @workflow ["invoice-management", "customer-service", "billing-workflow"]
|
|
825
877
|
* @prerequisites ["Valid invoice number", "Invoice exists in Prophet 21", "Reprint permissions"]
|
|
@@ -834,11 +886,11 @@ export declare class OrdersClient extends BaseServiceClient {
|
|
|
834
886
|
* @example
|
|
835
887
|
* ```typescript
|
|
836
888
|
* // Reprint an invoice
|
|
837
|
-
* const response = await api.orders.
|
|
889
|
+
* const response = await api.orders.invoiceHdr.reprint('INV-12345');
|
|
838
890
|
* console.log(`Invoice reprint status: ${response.data.status}`);
|
|
839
891
|
*
|
|
840
892
|
* // Get just the reprint data
|
|
841
|
-
* const reprintResult = await api.orders.
|
|
893
|
+
* const reprintResult = await api.orders.invoiceHdr.reprintData('INV-12345');
|
|
842
894
|
* if (reprintResult.success) {
|
|
843
895
|
* console.log(`Reprint generated: ${reprintResult.documentUrl}`);
|
|
844
896
|
* }
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../../src/services/orders/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAC/C,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EAeL,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,KAAK,uBAAuB,EAC5B,KAAK,uBAAuB,EAC7B,MAAM,WAAW,CAAC;AAEnB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,qBAAa,YAAa,SAAQ,iBAAiB;IACjD;;;;OAIG;gBACS,IAAI,EAAE,UAAU,EAAE,OAAO,GAAE,MAAuC;IAI9E;;;OAGG;IACH,
|
|
1
|
+
{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../../src/services/orders/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAC/C,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EAeL,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,KAAK,uBAAuB,EAC5B,KAAK,uBAAuB,EAC7B,MAAM,WAAW,CAAC;AAEnB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,qBAAa,YAAa,SAAQ,iBAAiB;IACjD;;;;OAIG;gBACS,IAAI,EAAE,UAAU,EAAE,OAAO,GAAE,MAAuC;IAI9E;;;OAGG;IACH,KAAK;QACH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAsDG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAOH;;;;;;WAMG;8BACyB,iBAAiB;;;;;;;;;;;QAK7C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAyCG;+BAC0B,MAAM,WAAW,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAYjE;;;;;;;WAOG;mCAC8B,MAAM,WAAW,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;MAIrE;IAEF;;;OAGG;IACH,aAAa;QACX;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAgCG;gCAC2B,MAAM;;;;;;;;;;;;;;;;;;;QAWpC;;;;;;WAMG;oCAC+B,MAAM;;;;;;;;;;QAKxC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAiCG;uCACkC,MAAM,WAAW,MAAM;;;;;;;;;;;;;;;;;;;;;QAW5D;;;;;;;WAOG;2CACsC,MAAM,WAAW,MAAM;;;;;;;;;;;;MAIhE;IAEF;;;OAGG;IACH,KAAK;QACH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WA2CG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAOH;;;;;;WAMG;4BACuB,uBAAuB;;;;;;;;;;;;;;;;;;;;;;QAKjD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WA+BG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAGH;;;;;;WAMG;sBACiB,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAK1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAkCG;4BACuB,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAWhC;;;;;;WAMG;gCAC2B,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAKpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAyCG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAOH;;;;;;WAMG;4BACuB,uBAAuB;;;;;;;;;MAIjD;IAEF;;;OAGG;IACH,UAAU;QACR;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAkCG;6BACwB,MAAM;;;;;;;;;;;;;;;;;;;QAWjC;;;;;;WAMG;iCAC4B,MAAM;;;;;;;;;;MAIrC;IAEF;;;;;;;;;;;;;;;OAeG;IACH,cAAc;;;;;;;;;;;;OAA2D;IAEzE;;;;;;;;;;;;OAYG;IACH,kBAAkB;;;OAGhB;CACH"}
|