@workbuddy/cli-vnext 1.0.5 → 1.0.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.js +1152 -8
- package/package.json +1 -1
package/dist/index.js
CHANGED
|
@@ -6255,7 +6255,7 @@ var operations = [
|
|
|
6255
6255
|
description: "Retrieve all active statuses for a given entity type. Supported entities: customer, contractor, supplier",
|
|
6256
6256
|
method: "GET",
|
|
6257
6257
|
path: "/settings/entity-statuses/{entity}",
|
|
6258
|
-
commandPath: ["settings", "entity-statuses", "get"],
|
|
6258
|
+
commandPath: ["settings", "reference", "data", "entity-statuses", "get"],
|
|
6259
6259
|
options: [
|
|
6260
6260
|
{
|
|
6261
6261
|
name: "entity",
|
|
@@ -6281,7 +6281,7 @@ var operations = [
|
|
|
6281
6281
|
description: "Retrieve all possible job statuses. These are system-defined status values that represent the aggregated state of a job based on its stages.",
|
|
6282
6282
|
method: "GET",
|
|
6283
6283
|
path: "/settings/job-statuses",
|
|
6284
|
-
commandPath: ["settings", "job-statuses", "list"],
|
|
6284
|
+
commandPath: ["settings", "reference", "data", "job-statuses", "list"],
|
|
6285
6285
|
options: [],
|
|
6286
6286
|
hasRequestBody: false,
|
|
6287
6287
|
responseFields: [
|
|
@@ -6297,7 +6297,7 @@ var operations = [
|
|
|
6297
6297
|
description: "Retrieve all active job types configured for the tenant. Job types categorize jobs by the type of work being performed (e.g., Maintenance, Installation, Repair).",
|
|
6298
6298
|
method: "GET",
|
|
6299
6299
|
path: "/settings/job-types",
|
|
6300
|
-
commandPath: ["settings", "job-types", "list"],
|
|
6300
|
+
commandPath: ["settings", "reference", "data", "job-types", "list"],
|
|
6301
6301
|
options: [],
|
|
6302
6302
|
hasRequestBody: false,
|
|
6303
6303
|
responseFields: [
|
|
@@ -6313,7 +6313,7 @@ var operations = [
|
|
|
6313
6313
|
description: "Retrieve all active priority levels configured for the tenant. Priorities indicate the urgency of jobs (e.g., Critical, High, Medium, Low).",
|
|
6314
6314
|
method: "GET",
|
|
6315
6315
|
path: "/settings/priorities",
|
|
6316
|
-
commandPath: ["settings", "priorities", "list"],
|
|
6316
|
+
commandPath: ["settings", "reference", "data", "priorities", "list"],
|
|
6317
6317
|
options: [],
|
|
6318
6318
|
hasRequestBody: false,
|
|
6319
6319
|
responseFields: [
|
|
@@ -6329,7 +6329,7 @@ var operations = [
|
|
|
6329
6329
|
description: "Retrieve all stage statuses configured for the tenant. Stage statuses represent the workflow states a stage (work order) can transition through (e.g., New, Dispatched, En Route, On Site, Completed, Finalised).",
|
|
6330
6330
|
method: "GET",
|
|
6331
6331
|
path: "/settings/stage-statuses",
|
|
6332
|
-
commandPath: ["settings", "stage-statuses", "list"],
|
|
6332
|
+
commandPath: ["settings", "reference", "data", "stage-statuses", "list"],
|
|
6333
6333
|
options: [],
|
|
6334
6334
|
hasRequestBody: false,
|
|
6335
6335
|
responseFields: [
|
|
@@ -6345,7 +6345,7 @@ var operations = [
|
|
|
6345
6345
|
description: "Retrieve all active tags (labels) configured. Use the optional `type` query parameter to filter by label type. Defaults to `job` if not specified. Supported types: job, scheduling, quote, customer, user, overheads, form, finance, system, work-order-system, account, contact, zone, work-categories, lead-source, lead, opportunity, opportunity-lost, project, project-type, payment-type, file, asset, item-location, task, phase, site, service-type, subscriptions, agreement, work, integration-types, flag-category.",
|
|
6346
6346
|
method: "GET",
|
|
6347
6347
|
path: "/settings/tags",
|
|
6348
|
-
commandPath: ["settings", "tags", "list"],
|
|
6348
|
+
commandPath: ["settings", "reference", "data", "tags", "list"],
|
|
6349
6349
|
options: [],
|
|
6350
6350
|
hasRequestBody: false,
|
|
6351
6351
|
responseFields: [
|
|
@@ -6361,7 +6361,7 @@ var operations = [
|
|
|
6361
6361
|
description: "Retrieve all active zones configured for the tenant. Zones represent geographic regions used for job assignment, routing, and resource allocation.",
|
|
6362
6362
|
method: "GET",
|
|
6363
6363
|
path: "/settings/zones",
|
|
6364
|
-
commandPath: ["settings", "zones", "list"],
|
|
6364
|
+
commandPath: ["settings", "reference", "data", "zones", "list"],
|
|
6365
6365
|
options: [],
|
|
6366
6366
|
hasRequestBody: false,
|
|
6367
6367
|
responseFields: [
|
|
@@ -6377,7 +6377,7 @@ var operations = [
|
|
|
6377
6377
|
description: "Retrieve all active work types configured for the tenant (e.g., Labour, Travel, Administration) for time tracking and billing purposes.",
|
|
6378
6378
|
method: "GET",
|
|
6379
6379
|
path: "/settings/work-types",
|
|
6380
|
-
commandPath: ["settings", "work-types", "list"],
|
|
6380
|
+
commandPath: ["settings", "reference", "data", "work-types", "list"],
|
|
6381
6381
|
options: [],
|
|
6382
6382
|
hasRequestBody: false,
|
|
6383
6383
|
responseFields: [
|
|
@@ -6441,6 +6441,1150 @@ var operations = [
|
|
|
6441
6441
|
}
|
|
6442
6442
|
]
|
|
6443
6443
|
},
|
|
6444
|
+
{
|
|
6445
|
+
operationId: "PublicApiItemController_list",
|
|
6446
|
+
displayName: "List items",
|
|
6447
|
+
description: "Retrieve paginated editable settings items.",
|
|
6448
|
+
method: "GET",
|
|
6449
|
+
path: "/settings/items",
|
|
6450
|
+
commandPath: ["settings", "items", "list"],
|
|
6451
|
+
options: [],
|
|
6452
|
+
hasRequestBody: false,
|
|
6453
|
+
responseFields: [
|
|
6454
|
+
{
|
|
6455
|
+
name: "items",
|
|
6456
|
+
type: "array"
|
|
6457
|
+
},
|
|
6458
|
+
{
|
|
6459
|
+
name: "pagination",
|
|
6460
|
+
type: "object"
|
|
6461
|
+
}
|
|
6462
|
+
]
|
|
6463
|
+
},
|
|
6464
|
+
{
|
|
6465
|
+
operationId: "PublicApiItemController_create",
|
|
6466
|
+
displayName: "Create item",
|
|
6467
|
+
description: "Create a settings item. This endpoint does not upsert.",
|
|
6468
|
+
method: "POST",
|
|
6469
|
+
path: "/settings/items",
|
|
6470
|
+
commandPath: ["settings", "items", "create"],
|
|
6471
|
+
options: [
|
|
6472
|
+
{
|
|
6473
|
+
name: "type",
|
|
6474
|
+
cliName: "type",
|
|
6475
|
+
optionKey: "type",
|
|
6476
|
+
source: "body",
|
|
6477
|
+
type: "string",
|
|
6478
|
+
required: true,
|
|
6479
|
+
description: "",
|
|
6480
|
+
enumValues: ["SERVICE", "INVENTORY", "NON-INVENTORY", "LABOUR", "INCENTIVE"]
|
|
6481
|
+
},
|
|
6482
|
+
{
|
|
6483
|
+
name: "name",
|
|
6484
|
+
cliName: "name",
|
|
6485
|
+
optionKey: "name",
|
|
6486
|
+
source: "body",
|
|
6487
|
+
type: "string",
|
|
6488
|
+
required: true,
|
|
6489
|
+
description: "Display name"
|
|
6490
|
+
},
|
|
6491
|
+
{
|
|
6492
|
+
name: "baseUomId",
|
|
6493
|
+
cliName: "base-uom-id",
|
|
6494
|
+
optionKey: "baseUomId",
|
|
6495
|
+
source: "body",
|
|
6496
|
+
type: "string",
|
|
6497
|
+
required: false,
|
|
6498
|
+
description: "base uom ID"
|
|
6499
|
+
},
|
|
6500
|
+
{
|
|
6501
|
+
name: "baseUomName",
|
|
6502
|
+
cliName: "base-uom-name",
|
|
6503
|
+
optionKey: "baseUomName",
|
|
6504
|
+
source: "body",
|
|
6505
|
+
type: "string",
|
|
6506
|
+
required: false,
|
|
6507
|
+
description: ""
|
|
6508
|
+
},
|
|
6509
|
+
{
|
|
6510
|
+
name: "description",
|
|
6511
|
+
cliName: "description",
|
|
6512
|
+
optionKey: "description",
|
|
6513
|
+
source: "body",
|
|
6514
|
+
type: "string",
|
|
6515
|
+
required: true,
|
|
6516
|
+
description: "Detailed description"
|
|
6517
|
+
},
|
|
6518
|
+
{
|
|
6519
|
+
name: "category",
|
|
6520
|
+
cliName: "category",
|
|
6521
|
+
optionKey: "category",
|
|
6522
|
+
source: "body",
|
|
6523
|
+
type: "object",
|
|
6524
|
+
required: true,
|
|
6525
|
+
description: ""
|
|
6526
|
+
},
|
|
6527
|
+
{
|
|
6528
|
+
name: "active",
|
|
6529
|
+
cliName: "active",
|
|
6530
|
+
optionKey: "active",
|
|
6531
|
+
source: "body",
|
|
6532
|
+
type: "boolean",
|
|
6533
|
+
required: false,
|
|
6534
|
+
description: "Whether the entity is active"
|
|
6535
|
+
},
|
|
6536
|
+
{
|
|
6537
|
+
name: "integrationId",
|
|
6538
|
+
cliName: "integration-id",
|
|
6539
|
+
optionKey: "integrationId",
|
|
6540
|
+
source: "body",
|
|
6541
|
+
type: "string",
|
|
6542
|
+
required: false,
|
|
6543
|
+
description: "integration ID"
|
|
6544
|
+
},
|
|
6545
|
+
{
|
|
6546
|
+
name: "canOverrideDesc",
|
|
6547
|
+
cliName: "can-override-desc",
|
|
6548
|
+
optionKey: "canOverrideDesc",
|
|
6549
|
+
source: "body",
|
|
6550
|
+
type: "boolean",
|
|
6551
|
+
required: false,
|
|
6552
|
+
description: ""
|
|
6553
|
+
},
|
|
6554
|
+
{
|
|
6555
|
+
name: "longDescription",
|
|
6556
|
+
cliName: "long-description",
|
|
6557
|
+
optionKey: "longDescription",
|
|
6558
|
+
source: "body",
|
|
6559
|
+
type: "string",
|
|
6560
|
+
required: false,
|
|
6561
|
+
description: ""
|
|
6562
|
+
},
|
|
6563
|
+
{
|
|
6564
|
+
name: "manufacturer",
|
|
6565
|
+
cliName: "manufacturer",
|
|
6566
|
+
optionKey: "manufacturer",
|
|
6567
|
+
source: "body",
|
|
6568
|
+
type: "string",
|
|
6569
|
+
required: false,
|
|
6570
|
+
description: ""
|
|
6571
|
+
},
|
|
6572
|
+
{
|
|
6573
|
+
name: "retailPrice",
|
|
6574
|
+
cliName: "retail-price",
|
|
6575
|
+
optionKey: "retailPrice",
|
|
6576
|
+
source: "body",
|
|
6577
|
+
type: "number",
|
|
6578
|
+
required: false,
|
|
6579
|
+
description: ""
|
|
6580
|
+
},
|
|
6581
|
+
{
|
|
6582
|
+
name: "tradePrice",
|
|
6583
|
+
cliName: "trade-price",
|
|
6584
|
+
optionKey: "tradePrice",
|
|
6585
|
+
source: "body",
|
|
6586
|
+
type: "number",
|
|
6587
|
+
required: false,
|
|
6588
|
+
description: ""
|
|
6589
|
+
},
|
|
6590
|
+
{
|
|
6591
|
+
name: "standardCost",
|
|
6592
|
+
cliName: "standard-cost",
|
|
6593
|
+
optionKey: "standardCost",
|
|
6594
|
+
source: "body",
|
|
6595
|
+
type: "number",
|
|
6596
|
+
required: false,
|
|
6597
|
+
description: ""
|
|
6598
|
+
},
|
|
6599
|
+
{
|
|
6600
|
+
name: "economicOrderQty",
|
|
6601
|
+
cliName: "economic-order-qty",
|
|
6602
|
+
optionKey: "economicOrderQty",
|
|
6603
|
+
source: "body",
|
|
6604
|
+
type: "number",
|
|
6605
|
+
required: false,
|
|
6606
|
+
description: ""
|
|
6607
|
+
},
|
|
6608
|
+
{
|
|
6609
|
+
name: "safetyStockQty",
|
|
6610
|
+
cliName: "safety-stock-qty",
|
|
6611
|
+
optionKey: "safetyStockQty",
|
|
6612
|
+
source: "body",
|
|
6613
|
+
type: "number",
|
|
6614
|
+
required: false,
|
|
6615
|
+
description: ""
|
|
6616
|
+
},
|
|
6617
|
+
{
|
|
6618
|
+
name: "leadTimeDays",
|
|
6619
|
+
cliName: "lead-time-days",
|
|
6620
|
+
optionKey: "leadTimeDays",
|
|
6621
|
+
source: "body",
|
|
6622
|
+
type: "number",
|
|
6623
|
+
required: false,
|
|
6624
|
+
description: ""
|
|
6625
|
+
},
|
|
6626
|
+
{
|
|
6627
|
+
name: "upc",
|
|
6628
|
+
cliName: "upc",
|
|
6629
|
+
optionKey: "upc",
|
|
6630
|
+
source: "body",
|
|
6631
|
+
type: "string",
|
|
6632
|
+
required: false,
|
|
6633
|
+
description: ""
|
|
6634
|
+
},
|
|
6635
|
+
{
|
|
6636
|
+
name: "itemSold",
|
|
6637
|
+
cliName: "item-sold",
|
|
6638
|
+
optionKey: "itemSold",
|
|
6639
|
+
source: "body",
|
|
6640
|
+
type: "boolean",
|
|
6641
|
+
required: false,
|
|
6642
|
+
description: ""
|
|
6643
|
+
},
|
|
6644
|
+
{
|
|
6645
|
+
name: "saleGlCode",
|
|
6646
|
+
cliName: "sale-gl-code",
|
|
6647
|
+
optionKey: "saleGlCode",
|
|
6648
|
+
source: "body",
|
|
6649
|
+
type: "string",
|
|
6650
|
+
required: false,
|
|
6651
|
+
description: ""
|
|
6652
|
+
},
|
|
6653
|
+
{
|
|
6654
|
+
name: "saleTaxRateId",
|
|
6655
|
+
cliName: "sale-tax-rate-id",
|
|
6656
|
+
optionKey: "saleTaxRateId",
|
|
6657
|
+
source: "body",
|
|
6658
|
+
type: "string",
|
|
6659
|
+
required: false,
|
|
6660
|
+
description: "sale tax rate ID"
|
|
6661
|
+
},
|
|
6662
|
+
{
|
|
6663
|
+
name: "saleTaxRateName",
|
|
6664
|
+
cliName: "sale-tax-rate-name",
|
|
6665
|
+
optionKey: "saleTaxRateName",
|
|
6666
|
+
source: "body",
|
|
6667
|
+
type: "string",
|
|
6668
|
+
required: false,
|
|
6669
|
+
description: ""
|
|
6670
|
+
},
|
|
6671
|
+
{
|
|
6672
|
+
name: "itemPurchased",
|
|
6673
|
+
cliName: "item-purchased",
|
|
6674
|
+
optionKey: "itemPurchased",
|
|
6675
|
+
source: "body",
|
|
6676
|
+
type: "boolean",
|
|
6677
|
+
required: false,
|
|
6678
|
+
description: ""
|
|
6679
|
+
},
|
|
6680
|
+
{
|
|
6681
|
+
name: "purchaseGlCode",
|
|
6682
|
+
cliName: "purchase-gl-code",
|
|
6683
|
+
optionKey: "purchaseGlCode",
|
|
6684
|
+
source: "body",
|
|
6685
|
+
type: "string",
|
|
6686
|
+
required: false,
|
|
6687
|
+
description: ""
|
|
6688
|
+
},
|
|
6689
|
+
{
|
|
6690
|
+
name: "purchaseTaxRateId",
|
|
6691
|
+
cliName: "purchase-tax-rate-id",
|
|
6692
|
+
optionKey: "purchaseTaxRateId",
|
|
6693
|
+
source: "body",
|
|
6694
|
+
type: "string",
|
|
6695
|
+
required: false,
|
|
6696
|
+
description: "purchase tax rate ID"
|
|
6697
|
+
},
|
|
6698
|
+
{
|
|
6699
|
+
name: "purchaseTaxRateName",
|
|
6700
|
+
cliName: "purchase-tax-rate-name",
|
|
6701
|
+
optionKey: "purchaseTaxRateName",
|
|
6702
|
+
source: "body",
|
|
6703
|
+
type: "string",
|
|
6704
|
+
required: false,
|
|
6705
|
+
description: ""
|
|
6706
|
+
},
|
|
6707
|
+
{
|
|
6708
|
+
name: "codeInvoicingStatus",
|
|
6709
|
+
cliName: "code-invoicing-status",
|
|
6710
|
+
optionKey: "codeInvoicingStatus",
|
|
6711
|
+
source: "body",
|
|
6712
|
+
type: "string",
|
|
6713
|
+
required: false,
|
|
6714
|
+
description: "",
|
|
6715
|
+
enumValues: ["Billable", "No Charge", "Not Billable"]
|
|
6716
|
+
},
|
|
6717
|
+
{
|
|
6718
|
+
name: "suppliedBySubcontractor",
|
|
6719
|
+
cliName: "supplied-by-subcontractor",
|
|
6720
|
+
optionKey: "suppliedBySubcontractor",
|
|
6721
|
+
source: "body",
|
|
6722
|
+
type: "boolean",
|
|
6723
|
+
required: false,
|
|
6724
|
+
description: ""
|
|
6725
|
+
},
|
|
6726
|
+
{
|
|
6727
|
+
name: "autoCreateTask",
|
|
6728
|
+
cliName: "auto-create-task",
|
|
6729
|
+
optionKey: "autoCreateTask",
|
|
6730
|
+
source: "body",
|
|
6731
|
+
type: "boolean",
|
|
6732
|
+
required: false,
|
|
6733
|
+
description: ""
|
|
6734
|
+
},
|
|
6735
|
+
{
|
|
6736
|
+
name: "customFields",
|
|
6737
|
+
cliName: "custom-fields",
|
|
6738
|
+
optionKey: "customFields",
|
|
6739
|
+
source: "body",
|
|
6740
|
+
type: "string",
|
|
6741
|
+
required: false,
|
|
6742
|
+
description: "Custom fields as key-value pairs — validated against tenant field definitions"
|
|
6743
|
+
},
|
|
6744
|
+
{
|
|
6745
|
+
name: "trackingCategory1",
|
|
6746
|
+
cliName: "tracking-category1",
|
|
6747
|
+
optionKey: "trackingCategory1",
|
|
6748
|
+
source: "body",
|
|
6749
|
+
type: "string",
|
|
6750
|
+
required: false,
|
|
6751
|
+
description: ""
|
|
6752
|
+
},
|
|
6753
|
+
{
|
|
6754
|
+
name: "trackingCategory2",
|
|
6755
|
+
cliName: "tracking-category2",
|
|
6756
|
+
optionKey: "trackingCategory2",
|
|
6757
|
+
source: "body",
|
|
6758
|
+
type: "string",
|
|
6759
|
+
required: false,
|
|
6760
|
+
description: ""
|
|
6761
|
+
},
|
|
6762
|
+
{
|
|
6763
|
+
name: "uoms",
|
|
6764
|
+
cliName: "uoms",
|
|
6765
|
+
optionKey: "uoms",
|
|
6766
|
+
source: "body",
|
|
6767
|
+
type: "array",
|
|
6768
|
+
required: false,
|
|
6769
|
+
description: ""
|
|
6770
|
+
},
|
|
6771
|
+
{
|
|
6772
|
+
name: "raw-body",
|
|
6773
|
+
cliName: "raw-body",
|
|
6774
|
+
optionKey: "rawBody",
|
|
6775
|
+
source: "body",
|
|
6776
|
+
type: "object",
|
|
6777
|
+
required: false,
|
|
6778
|
+
description: "Raw request body JSON (overrides individual fields)"
|
|
6779
|
+
}
|
|
6780
|
+
],
|
|
6781
|
+
hasRequestBody: true,
|
|
6782
|
+
responseFields: [
|
|
6783
|
+
{
|
|
6784
|
+
name: "item",
|
|
6785
|
+
type: "object"
|
|
6786
|
+
}
|
|
6787
|
+
]
|
|
6788
|
+
},
|
|
6789
|
+
{
|
|
6790
|
+
operationId: "PublicApiItemController_upsert",
|
|
6791
|
+
displayName: "Upsert item",
|
|
6792
|
+
description: "Create or partially update a settings item using integrationId when supplied, otherwise name. Create still requires mandatory item fields.",
|
|
6793
|
+
method: "PUT",
|
|
6794
|
+
path: "/settings/items",
|
|
6795
|
+
commandPath: ["settings", "items", "upsert"],
|
|
6796
|
+
options: [
|
|
6797
|
+
{
|
|
6798
|
+
name: "type",
|
|
6799
|
+
cliName: "type",
|
|
6800
|
+
optionKey: "type",
|
|
6801
|
+
source: "body",
|
|
6802
|
+
type: "string",
|
|
6803
|
+
required: false,
|
|
6804
|
+
description: "",
|
|
6805
|
+
enumValues: ["SERVICE", "INVENTORY", "NON-INVENTORY", "LABOUR", "INCENTIVE"]
|
|
6806
|
+
},
|
|
6807
|
+
{
|
|
6808
|
+
name: "name",
|
|
6809
|
+
cliName: "name",
|
|
6810
|
+
optionKey: "name",
|
|
6811
|
+
source: "body",
|
|
6812
|
+
type: "string",
|
|
6813
|
+
required: true,
|
|
6814
|
+
description: "Display name"
|
|
6815
|
+
},
|
|
6816
|
+
{
|
|
6817
|
+
name: "baseUomId",
|
|
6818
|
+
cliName: "base-uom-id",
|
|
6819
|
+
optionKey: "baseUomId",
|
|
6820
|
+
source: "body",
|
|
6821
|
+
type: "string",
|
|
6822
|
+
required: false,
|
|
6823
|
+
description: "base uom ID"
|
|
6824
|
+
},
|
|
6825
|
+
{
|
|
6826
|
+
name: "baseUomName",
|
|
6827
|
+
cliName: "base-uom-name",
|
|
6828
|
+
optionKey: "baseUomName",
|
|
6829
|
+
source: "body",
|
|
6830
|
+
type: "string",
|
|
6831
|
+
required: false,
|
|
6832
|
+
description: ""
|
|
6833
|
+
},
|
|
6834
|
+
{
|
|
6835
|
+
name: "description",
|
|
6836
|
+
cliName: "description",
|
|
6837
|
+
optionKey: "description",
|
|
6838
|
+
source: "body",
|
|
6839
|
+
type: "string",
|
|
6840
|
+
required: false,
|
|
6841
|
+
description: "Detailed description"
|
|
6842
|
+
},
|
|
6843
|
+
{
|
|
6844
|
+
name: "category",
|
|
6845
|
+
cliName: "category",
|
|
6846
|
+
optionKey: "category",
|
|
6847
|
+
source: "body",
|
|
6848
|
+
type: "object",
|
|
6849
|
+
required: false,
|
|
6850
|
+
description: ""
|
|
6851
|
+
},
|
|
6852
|
+
{
|
|
6853
|
+
name: "active",
|
|
6854
|
+
cliName: "active",
|
|
6855
|
+
optionKey: "active",
|
|
6856
|
+
source: "body",
|
|
6857
|
+
type: "boolean",
|
|
6858
|
+
required: false,
|
|
6859
|
+
description: "Whether the entity is active"
|
|
6860
|
+
},
|
|
6861
|
+
{
|
|
6862
|
+
name: "integrationId",
|
|
6863
|
+
cliName: "integration-id",
|
|
6864
|
+
optionKey: "integrationId",
|
|
6865
|
+
source: "body",
|
|
6866
|
+
type: "string",
|
|
6867
|
+
required: false,
|
|
6868
|
+
description: "integration ID"
|
|
6869
|
+
},
|
|
6870
|
+
{
|
|
6871
|
+
name: "canOverrideDesc",
|
|
6872
|
+
cliName: "can-override-desc",
|
|
6873
|
+
optionKey: "canOverrideDesc",
|
|
6874
|
+
source: "body",
|
|
6875
|
+
type: "boolean",
|
|
6876
|
+
required: false,
|
|
6877
|
+
description: ""
|
|
6878
|
+
},
|
|
6879
|
+
{
|
|
6880
|
+
name: "longDescription",
|
|
6881
|
+
cliName: "long-description",
|
|
6882
|
+
optionKey: "longDescription",
|
|
6883
|
+
source: "body",
|
|
6884
|
+
type: "string",
|
|
6885
|
+
required: false,
|
|
6886
|
+
description: ""
|
|
6887
|
+
},
|
|
6888
|
+
{
|
|
6889
|
+
name: "manufacturer",
|
|
6890
|
+
cliName: "manufacturer",
|
|
6891
|
+
optionKey: "manufacturer",
|
|
6892
|
+
source: "body",
|
|
6893
|
+
type: "string",
|
|
6894
|
+
required: false,
|
|
6895
|
+
description: ""
|
|
6896
|
+
},
|
|
6897
|
+
{
|
|
6898
|
+
name: "retailPrice",
|
|
6899
|
+
cliName: "retail-price",
|
|
6900
|
+
optionKey: "retailPrice",
|
|
6901
|
+
source: "body",
|
|
6902
|
+
type: "number",
|
|
6903
|
+
required: false,
|
|
6904
|
+
description: ""
|
|
6905
|
+
},
|
|
6906
|
+
{
|
|
6907
|
+
name: "tradePrice",
|
|
6908
|
+
cliName: "trade-price",
|
|
6909
|
+
optionKey: "tradePrice",
|
|
6910
|
+
source: "body",
|
|
6911
|
+
type: "number",
|
|
6912
|
+
required: false,
|
|
6913
|
+
description: ""
|
|
6914
|
+
},
|
|
6915
|
+
{
|
|
6916
|
+
name: "standardCost",
|
|
6917
|
+
cliName: "standard-cost",
|
|
6918
|
+
optionKey: "standardCost",
|
|
6919
|
+
source: "body",
|
|
6920
|
+
type: "number",
|
|
6921
|
+
required: false,
|
|
6922
|
+
description: ""
|
|
6923
|
+
},
|
|
6924
|
+
{
|
|
6925
|
+
name: "economicOrderQty",
|
|
6926
|
+
cliName: "economic-order-qty",
|
|
6927
|
+
optionKey: "economicOrderQty",
|
|
6928
|
+
source: "body",
|
|
6929
|
+
type: "number",
|
|
6930
|
+
required: false,
|
|
6931
|
+
description: ""
|
|
6932
|
+
},
|
|
6933
|
+
{
|
|
6934
|
+
name: "safetyStockQty",
|
|
6935
|
+
cliName: "safety-stock-qty",
|
|
6936
|
+
optionKey: "safetyStockQty",
|
|
6937
|
+
source: "body",
|
|
6938
|
+
type: "number",
|
|
6939
|
+
required: false,
|
|
6940
|
+
description: ""
|
|
6941
|
+
},
|
|
6942
|
+
{
|
|
6943
|
+
name: "leadTimeDays",
|
|
6944
|
+
cliName: "lead-time-days",
|
|
6945
|
+
optionKey: "leadTimeDays",
|
|
6946
|
+
source: "body",
|
|
6947
|
+
type: "number",
|
|
6948
|
+
required: false,
|
|
6949
|
+
description: ""
|
|
6950
|
+
},
|
|
6951
|
+
{
|
|
6952
|
+
name: "upc",
|
|
6953
|
+
cliName: "upc",
|
|
6954
|
+
optionKey: "upc",
|
|
6955
|
+
source: "body",
|
|
6956
|
+
type: "string",
|
|
6957
|
+
required: false,
|
|
6958
|
+
description: ""
|
|
6959
|
+
},
|
|
6960
|
+
{
|
|
6961
|
+
name: "itemSold",
|
|
6962
|
+
cliName: "item-sold",
|
|
6963
|
+
optionKey: "itemSold",
|
|
6964
|
+
source: "body",
|
|
6965
|
+
type: "boolean",
|
|
6966
|
+
required: false,
|
|
6967
|
+
description: ""
|
|
6968
|
+
},
|
|
6969
|
+
{
|
|
6970
|
+
name: "saleGlCode",
|
|
6971
|
+
cliName: "sale-gl-code",
|
|
6972
|
+
optionKey: "saleGlCode",
|
|
6973
|
+
source: "body",
|
|
6974
|
+
type: "string",
|
|
6975
|
+
required: false,
|
|
6976
|
+
description: ""
|
|
6977
|
+
},
|
|
6978
|
+
{
|
|
6979
|
+
name: "saleTaxRateId",
|
|
6980
|
+
cliName: "sale-tax-rate-id",
|
|
6981
|
+
optionKey: "saleTaxRateId",
|
|
6982
|
+
source: "body",
|
|
6983
|
+
type: "string",
|
|
6984
|
+
required: false,
|
|
6985
|
+
description: "sale tax rate ID"
|
|
6986
|
+
},
|
|
6987
|
+
{
|
|
6988
|
+
name: "saleTaxRateName",
|
|
6989
|
+
cliName: "sale-tax-rate-name",
|
|
6990
|
+
optionKey: "saleTaxRateName",
|
|
6991
|
+
source: "body",
|
|
6992
|
+
type: "string",
|
|
6993
|
+
required: false,
|
|
6994
|
+
description: ""
|
|
6995
|
+
},
|
|
6996
|
+
{
|
|
6997
|
+
name: "itemPurchased",
|
|
6998
|
+
cliName: "item-purchased",
|
|
6999
|
+
optionKey: "itemPurchased",
|
|
7000
|
+
source: "body",
|
|
7001
|
+
type: "boolean",
|
|
7002
|
+
required: false,
|
|
7003
|
+
description: ""
|
|
7004
|
+
},
|
|
7005
|
+
{
|
|
7006
|
+
name: "purchaseGlCode",
|
|
7007
|
+
cliName: "purchase-gl-code",
|
|
7008
|
+
optionKey: "purchaseGlCode",
|
|
7009
|
+
source: "body",
|
|
7010
|
+
type: "string",
|
|
7011
|
+
required: false,
|
|
7012
|
+
description: ""
|
|
7013
|
+
},
|
|
7014
|
+
{
|
|
7015
|
+
name: "purchaseTaxRateId",
|
|
7016
|
+
cliName: "purchase-tax-rate-id",
|
|
7017
|
+
optionKey: "purchaseTaxRateId",
|
|
7018
|
+
source: "body",
|
|
7019
|
+
type: "string",
|
|
7020
|
+
required: false,
|
|
7021
|
+
description: "purchase tax rate ID"
|
|
7022
|
+
},
|
|
7023
|
+
{
|
|
7024
|
+
name: "purchaseTaxRateName",
|
|
7025
|
+
cliName: "purchase-tax-rate-name",
|
|
7026
|
+
optionKey: "purchaseTaxRateName",
|
|
7027
|
+
source: "body",
|
|
7028
|
+
type: "string",
|
|
7029
|
+
required: false,
|
|
7030
|
+
description: ""
|
|
7031
|
+
},
|
|
7032
|
+
{
|
|
7033
|
+
name: "codeInvoicingStatus",
|
|
7034
|
+
cliName: "code-invoicing-status",
|
|
7035
|
+
optionKey: "codeInvoicingStatus",
|
|
7036
|
+
source: "body",
|
|
7037
|
+
type: "string",
|
|
7038
|
+
required: false,
|
|
7039
|
+
description: "",
|
|
7040
|
+
enumValues: ["Billable", "No Charge", "Not Billable"]
|
|
7041
|
+
},
|
|
7042
|
+
{
|
|
7043
|
+
name: "suppliedBySubcontractor",
|
|
7044
|
+
cliName: "supplied-by-subcontractor",
|
|
7045
|
+
optionKey: "suppliedBySubcontractor",
|
|
7046
|
+
source: "body",
|
|
7047
|
+
type: "boolean",
|
|
7048
|
+
required: false,
|
|
7049
|
+
description: ""
|
|
7050
|
+
},
|
|
7051
|
+
{
|
|
7052
|
+
name: "autoCreateTask",
|
|
7053
|
+
cliName: "auto-create-task",
|
|
7054
|
+
optionKey: "autoCreateTask",
|
|
7055
|
+
source: "body",
|
|
7056
|
+
type: "boolean",
|
|
7057
|
+
required: false,
|
|
7058
|
+
description: ""
|
|
7059
|
+
},
|
|
7060
|
+
{
|
|
7061
|
+
name: "customFields",
|
|
7062
|
+
cliName: "custom-fields",
|
|
7063
|
+
optionKey: "customFields",
|
|
7064
|
+
source: "body",
|
|
7065
|
+
type: "string",
|
|
7066
|
+
required: false,
|
|
7067
|
+
description: "Custom fields as key-value pairs — validated against tenant field definitions"
|
|
7068
|
+
},
|
|
7069
|
+
{
|
|
7070
|
+
name: "trackingCategory1",
|
|
7071
|
+
cliName: "tracking-category1",
|
|
7072
|
+
optionKey: "trackingCategory1",
|
|
7073
|
+
source: "body",
|
|
7074
|
+
type: "string",
|
|
7075
|
+
required: false,
|
|
7076
|
+
description: ""
|
|
7077
|
+
},
|
|
7078
|
+
{
|
|
7079
|
+
name: "trackingCategory2",
|
|
7080
|
+
cliName: "tracking-category2",
|
|
7081
|
+
optionKey: "trackingCategory2",
|
|
7082
|
+
source: "body",
|
|
7083
|
+
type: "string",
|
|
7084
|
+
required: false,
|
|
7085
|
+
description: ""
|
|
7086
|
+
},
|
|
7087
|
+
{
|
|
7088
|
+
name: "uoms",
|
|
7089
|
+
cliName: "uoms",
|
|
7090
|
+
optionKey: "uoms",
|
|
7091
|
+
source: "body",
|
|
7092
|
+
type: "array",
|
|
7093
|
+
required: false,
|
|
7094
|
+
description: ""
|
|
7095
|
+
},
|
|
7096
|
+
{
|
|
7097
|
+
name: "raw-body",
|
|
7098
|
+
cliName: "raw-body",
|
|
7099
|
+
optionKey: "rawBody",
|
|
7100
|
+
source: "body",
|
|
7101
|
+
type: "object",
|
|
7102
|
+
required: false,
|
|
7103
|
+
description: "Raw request body JSON (overrides individual fields)"
|
|
7104
|
+
}
|
|
7105
|
+
],
|
|
7106
|
+
hasRequestBody: true,
|
|
7107
|
+
responseFields: [
|
|
7108
|
+
{
|
|
7109
|
+
name: "item",
|
|
7110
|
+
type: "object"
|
|
7111
|
+
}
|
|
7112
|
+
]
|
|
7113
|
+
},
|
|
7114
|
+
{
|
|
7115
|
+
operationId: "PublicApiItemController_getById",
|
|
7116
|
+
displayName: "Get item",
|
|
7117
|
+
description: "Retrieve a settings item by ID.",
|
|
7118
|
+
method: "GET",
|
|
7119
|
+
path: "/settings/items/{id}",
|
|
7120
|
+
commandPath: ["settings", "items", "get"],
|
|
7121
|
+
options: [
|
|
7122
|
+
{
|
|
7123
|
+
name: "id",
|
|
7124
|
+
cliName: "id",
|
|
7125
|
+
optionKey: "id",
|
|
7126
|
+
source: "path",
|
|
7127
|
+
type: "string",
|
|
7128
|
+
required: true,
|
|
7129
|
+
description: "Entity ID"
|
|
7130
|
+
}
|
|
7131
|
+
],
|
|
7132
|
+
hasRequestBody: false,
|
|
7133
|
+
responseFields: [
|
|
7134
|
+
{
|
|
7135
|
+
name: "item",
|
|
7136
|
+
type: "object"
|
|
7137
|
+
}
|
|
7138
|
+
]
|
|
7139
|
+
},
|
|
7140
|
+
{
|
|
7141
|
+
operationId: "PublicApiItemController_update",
|
|
7142
|
+
displayName: "Update item",
|
|
7143
|
+
description: "Update a settings item by ID.",
|
|
7144
|
+
method: "PATCH",
|
|
7145
|
+
path: "/settings/items/{id}",
|
|
7146
|
+
commandPath: ["settings", "items", "update"],
|
|
7147
|
+
options: [
|
|
7148
|
+
{
|
|
7149
|
+
name: "id",
|
|
7150
|
+
cliName: "id",
|
|
7151
|
+
optionKey: "id",
|
|
7152
|
+
source: "path",
|
|
7153
|
+
type: "string",
|
|
7154
|
+
required: true,
|
|
7155
|
+
description: "Entity ID"
|
|
7156
|
+
},
|
|
7157
|
+
{
|
|
7158
|
+
name: "type",
|
|
7159
|
+
cliName: "type",
|
|
7160
|
+
optionKey: "type",
|
|
7161
|
+
source: "body",
|
|
7162
|
+
type: "string",
|
|
7163
|
+
required: false,
|
|
7164
|
+
description: "",
|
|
7165
|
+
enumValues: ["SERVICE", "INVENTORY", "NON-INVENTORY", "LABOUR", "INCENTIVE"]
|
|
7166
|
+
},
|
|
7167
|
+
{
|
|
7168
|
+
name: "name",
|
|
7169
|
+
cliName: "name",
|
|
7170
|
+
optionKey: "name",
|
|
7171
|
+
source: "body",
|
|
7172
|
+
type: "string",
|
|
7173
|
+
required: false,
|
|
7174
|
+
description: "Display name"
|
|
7175
|
+
},
|
|
7176
|
+
{
|
|
7177
|
+
name: "baseUomId",
|
|
7178
|
+
cliName: "base-uom-id",
|
|
7179
|
+
optionKey: "baseUomId",
|
|
7180
|
+
source: "body",
|
|
7181
|
+
type: "string",
|
|
7182
|
+
required: false,
|
|
7183
|
+
description: "base uom ID"
|
|
7184
|
+
},
|
|
7185
|
+
{
|
|
7186
|
+
name: "baseUomName",
|
|
7187
|
+
cliName: "base-uom-name",
|
|
7188
|
+
optionKey: "baseUomName",
|
|
7189
|
+
source: "body",
|
|
7190
|
+
type: "string",
|
|
7191
|
+
required: false,
|
|
7192
|
+
description: ""
|
|
7193
|
+
},
|
|
7194
|
+
{
|
|
7195
|
+
name: "description",
|
|
7196
|
+
cliName: "description",
|
|
7197
|
+
optionKey: "description",
|
|
7198
|
+
source: "body",
|
|
7199
|
+
type: "string",
|
|
7200
|
+
required: false,
|
|
7201
|
+
description: "Detailed description"
|
|
7202
|
+
},
|
|
7203
|
+
{
|
|
7204
|
+
name: "category",
|
|
7205
|
+
cliName: "category",
|
|
7206
|
+
optionKey: "category",
|
|
7207
|
+
source: "body",
|
|
7208
|
+
type: "object",
|
|
7209
|
+
required: false,
|
|
7210
|
+
description: ""
|
|
7211
|
+
},
|
|
7212
|
+
{
|
|
7213
|
+
name: "active",
|
|
7214
|
+
cliName: "active",
|
|
7215
|
+
optionKey: "active",
|
|
7216
|
+
source: "body",
|
|
7217
|
+
type: "boolean",
|
|
7218
|
+
required: false,
|
|
7219
|
+
description: "Whether the entity is active"
|
|
7220
|
+
},
|
|
7221
|
+
{
|
|
7222
|
+
name: "integrationId",
|
|
7223
|
+
cliName: "integration-id",
|
|
7224
|
+
optionKey: "integrationId",
|
|
7225
|
+
source: "body",
|
|
7226
|
+
type: "string",
|
|
7227
|
+
required: false,
|
|
7228
|
+
description: "integration ID"
|
|
7229
|
+
},
|
|
7230
|
+
{
|
|
7231
|
+
name: "canOverrideDesc",
|
|
7232
|
+
cliName: "can-override-desc",
|
|
7233
|
+
optionKey: "canOverrideDesc",
|
|
7234
|
+
source: "body",
|
|
7235
|
+
type: "boolean",
|
|
7236
|
+
required: false,
|
|
7237
|
+
description: ""
|
|
7238
|
+
},
|
|
7239
|
+
{
|
|
7240
|
+
name: "longDescription",
|
|
7241
|
+
cliName: "long-description",
|
|
7242
|
+
optionKey: "longDescription",
|
|
7243
|
+
source: "body",
|
|
7244
|
+
type: "string",
|
|
7245
|
+
required: false,
|
|
7246
|
+
description: ""
|
|
7247
|
+
},
|
|
7248
|
+
{
|
|
7249
|
+
name: "manufacturer",
|
|
7250
|
+
cliName: "manufacturer",
|
|
7251
|
+
optionKey: "manufacturer",
|
|
7252
|
+
source: "body",
|
|
7253
|
+
type: "string",
|
|
7254
|
+
required: false,
|
|
7255
|
+
description: ""
|
|
7256
|
+
},
|
|
7257
|
+
{
|
|
7258
|
+
name: "retailPrice",
|
|
7259
|
+
cliName: "retail-price",
|
|
7260
|
+
optionKey: "retailPrice",
|
|
7261
|
+
source: "body",
|
|
7262
|
+
type: "number",
|
|
7263
|
+
required: false,
|
|
7264
|
+
description: ""
|
|
7265
|
+
},
|
|
7266
|
+
{
|
|
7267
|
+
name: "tradePrice",
|
|
7268
|
+
cliName: "trade-price",
|
|
7269
|
+
optionKey: "tradePrice",
|
|
7270
|
+
source: "body",
|
|
7271
|
+
type: "number",
|
|
7272
|
+
required: false,
|
|
7273
|
+
description: ""
|
|
7274
|
+
},
|
|
7275
|
+
{
|
|
7276
|
+
name: "standardCost",
|
|
7277
|
+
cliName: "standard-cost",
|
|
7278
|
+
optionKey: "standardCost",
|
|
7279
|
+
source: "body",
|
|
7280
|
+
type: "number",
|
|
7281
|
+
required: false,
|
|
7282
|
+
description: ""
|
|
7283
|
+
},
|
|
7284
|
+
{
|
|
7285
|
+
name: "economicOrderQty",
|
|
7286
|
+
cliName: "economic-order-qty",
|
|
7287
|
+
optionKey: "economicOrderQty",
|
|
7288
|
+
source: "body",
|
|
7289
|
+
type: "number",
|
|
7290
|
+
required: false,
|
|
7291
|
+
description: ""
|
|
7292
|
+
},
|
|
7293
|
+
{
|
|
7294
|
+
name: "safetyStockQty",
|
|
7295
|
+
cliName: "safety-stock-qty",
|
|
7296
|
+
optionKey: "safetyStockQty",
|
|
7297
|
+
source: "body",
|
|
7298
|
+
type: "number",
|
|
7299
|
+
required: false,
|
|
7300
|
+
description: ""
|
|
7301
|
+
},
|
|
7302
|
+
{
|
|
7303
|
+
name: "leadTimeDays",
|
|
7304
|
+
cliName: "lead-time-days",
|
|
7305
|
+
optionKey: "leadTimeDays",
|
|
7306
|
+
source: "body",
|
|
7307
|
+
type: "number",
|
|
7308
|
+
required: false,
|
|
7309
|
+
description: ""
|
|
7310
|
+
},
|
|
7311
|
+
{
|
|
7312
|
+
name: "upc",
|
|
7313
|
+
cliName: "upc",
|
|
7314
|
+
optionKey: "upc",
|
|
7315
|
+
source: "body",
|
|
7316
|
+
type: "string",
|
|
7317
|
+
required: false,
|
|
7318
|
+
description: ""
|
|
7319
|
+
},
|
|
7320
|
+
{
|
|
7321
|
+
name: "itemSold",
|
|
7322
|
+
cliName: "item-sold",
|
|
7323
|
+
optionKey: "itemSold",
|
|
7324
|
+
source: "body",
|
|
7325
|
+
type: "boolean",
|
|
7326
|
+
required: false,
|
|
7327
|
+
description: ""
|
|
7328
|
+
},
|
|
7329
|
+
{
|
|
7330
|
+
name: "saleGlCode",
|
|
7331
|
+
cliName: "sale-gl-code",
|
|
7332
|
+
optionKey: "saleGlCode",
|
|
7333
|
+
source: "body",
|
|
7334
|
+
type: "string",
|
|
7335
|
+
required: false,
|
|
7336
|
+
description: ""
|
|
7337
|
+
},
|
|
7338
|
+
{
|
|
7339
|
+
name: "saleTaxRateId",
|
|
7340
|
+
cliName: "sale-tax-rate-id",
|
|
7341
|
+
optionKey: "saleTaxRateId",
|
|
7342
|
+
source: "body",
|
|
7343
|
+
type: "string",
|
|
7344
|
+
required: false,
|
|
7345
|
+
description: "sale tax rate ID"
|
|
7346
|
+
},
|
|
7347
|
+
{
|
|
7348
|
+
name: "saleTaxRateName",
|
|
7349
|
+
cliName: "sale-tax-rate-name",
|
|
7350
|
+
optionKey: "saleTaxRateName",
|
|
7351
|
+
source: "body",
|
|
7352
|
+
type: "string",
|
|
7353
|
+
required: false,
|
|
7354
|
+
description: ""
|
|
7355
|
+
},
|
|
7356
|
+
{
|
|
7357
|
+
name: "itemPurchased",
|
|
7358
|
+
cliName: "item-purchased",
|
|
7359
|
+
optionKey: "itemPurchased",
|
|
7360
|
+
source: "body",
|
|
7361
|
+
type: "boolean",
|
|
7362
|
+
required: false,
|
|
7363
|
+
description: ""
|
|
7364
|
+
},
|
|
7365
|
+
{
|
|
7366
|
+
name: "purchaseGlCode",
|
|
7367
|
+
cliName: "purchase-gl-code",
|
|
7368
|
+
optionKey: "purchaseGlCode",
|
|
7369
|
+
source: "body",
|
|
7370
|
+
type: "string",
|
|
7371
|
+
required: false,
|
|
7372
|
+
description: ""
|
|
7373
|
+
},
|
|
7374
|
+
{
|
|
7375
|
+
name: "purchaseTaxRateId",
|
|
7376
|
+
cliName: "purchase-tax-rate-id",
|
|
7377
|
+
optionKey: "purchaseTaxRateId",
|
|
7378
|
+
source: "body",
|
|
7379
|
+
type: "string",
|
|
7380
|
+
required: false,
|
|
7381
|
+
description: "purchase tax rate ID"
|
|
7382
|
+
},
|
|
7383
|
+
{
|
|
7384
|
+
name: "purchaseTaxRateName",
|
|
7385
|
+
cliName: "purchase-tax-rate-name",
|
|
7386
|
+
optionKey: "purchaseTaxRateName",
|
|
7387
|
+
source: "body",
|
|
7388
|
+
type: "string",
|
|
7389
|
+
required: false,
|
|
7390
|
+
description: ""
|
|
7391
|
+
},
|
|
7392
|
+
{
|
|
7393
|
+
name: "codeInvoicingStatus",
|
|
7394
|
+
cliName: "code-invoicing-status",
|
|
7395
|
+
optionKey: "codeInvoicingStatus",
|
|
7396
|
+
source: "body",
|
|
7397
|
+
type: "string",
|
|
7398
|
+
required: false,
|
|
7399
|
+
description: "",
|
|
7400
|
+
enumValues: ["Billable", "No Charge", "Not Billable"]
|
|
7401
|
+
},
|
|
7402
|
+
{
|
|
7403
|
+
name: "suppliedBySubcontractor",
|
|
7404
|
+
cliName: "supplied-by-subcontractor",
|
|
7405
|
+
optionKey: "suppliedBySubcontractor",
|
|
7406
|
+
source: "body",
|
|
7407
|
+
type: "boolean",
|
|
7408
|
+
required: false,
|
|
7409
|
+
description: ""
|
|
7410
|
+
},
|
|
7411
|
+
{
|
|
7412
|
+
name: "autoCreateTask",
|
|
7413
|
+
cliName: "auto-create-task",
|
|
7414
|
+
optionKey: "autoCreateTask",
|
|
7415
|
+
source: "body",
|
|
7416
|
+
type: "boolean",
|
|
7417
|
+
required: false,
|
|
7418
|
+
description: ""
|
|
7419
|
+
},
|
|
7420
|
+
{
|
|
7421
|
+
name: "customFields",
|
|
7422
|
+
cliName: "custom-fields",
|
|
7423
|
+
optionKey: "customFields",
|
|
7424
|
+
source: "body",
|
|
7425
|
+
type: "string",
|
|
7426
|
+
required: false,
|
|
7427
|
+
description: "Custom fields as key-value pairs — validated against tenant field definitions"
|
|
7428
|
+
},
|
|
7429
|
+
{
|
|
7430
|
+
name: "trackingCategory1",
|
|
7431
|
+
cliName: "tracking-category1",
|
|
7432
|
+
optionKey: "trackingCategory1",
|
|
7433
|
+
source: "body",
|
|
7434
|
+
type: "string",
|
|
7435
|
+
required: false,
|
|
7436
|
+
description: ""
|
|
7437
|
+
},
|
|
7438
|
+
{
|
|
7439
|
+
name: "trackingCategory2",
|
|
7440
|
+
cliName: "tracking-category2",
|
|
7441
|
+
optionKey: "trackingCategory2",
|
|
7442
|
+
source: "body",
|
|
7443
|
+
type: "string",
|
|
7444
|
+
required: false,
|
|
7445
|
+
description: ""
|
|
7446
|
+
},
|
|
7447
|
+
{
|
|
7448
|
+
name: "uoms",
|
|
7449
|
+
cliName: "uoms",
|
|
7450
|
+
optionKey: "uoms",
|
|
7451
|
+
source: "body",
|
|
7452
|
+
type: "array",
|
|
7453
|
+
required: false,
|
|
7454
|
+
description: ""
|
|
7455
|
+
},
|
|
7456
|
+
{
|
|
7457
|
+
name: "raw-body",
|
|
7458
|
+
cliName: "raw-body",
|
|
7459
|
+
optionKey: "rawBody",
|
|
7460
|
+
source: "body",
|
|
7461
|
+
type: "object",
|
|
7462
|
+
required: false,
|
|
7463
|
+
description: "Raw request body JSON (overrides individual fields)"
|
|
7464
|
+
}
|
|
7465
|
+
],
|
|
7466
|
+
hasRequestBody: true,
|
|
7467
|
+
responseFields: [
|
|
7468
|
+
{
|
|
7469
|
+
name: "item",
|
|
7470
|
+
type: "object"
|
|
7471
|
+
}
|
|
7472
|
+
]
|
|
7473
|
+
},
|
|
7474
|
+
{
|
|
7475
|
+
operationId: "PublicApiItemController_delete",
|
|
7476
|
+
displayName: "Delete item",
|
|
7477
|
+
description: "Deactivate a settings item by ID.",
|
|
7478
|
+
method: "DELETE",
|
|
7479
|
+
path: "/settings/items/{id}",
|
|
7480
|
+
commandPath: ["settings", "items", "delete"],
|
|
7481
|
+
options: [
|
|
7482
|
+
{
|
|
7483
|
+
name: "id",
|
|
7484
|
+
cliName: "id",
|
|
7485
|
+
optionKey: "id",
|
|
7486
|
+
source: "path",
|
|
7487
|
+
type: "string",
|
|
7488
|
+
required: true,
|
|
7489
|
+
description: "Entity ID"
|
|
7490
|
+
}
|
|
7491
|
+
],
|
|
7492
|
+
hasRequestBody: false
|
|
7493
|
+
},
|
|
7494
|
+
{
|
|
7495
|
+
operationId: "PublicApiItemCategoryController_list",
|
|
7496
|
+
displayName: "List item categories",
|
|
7497
|
+
description: "Retrieve active item categories and sub-categories.",
|
|
7498
|
+
method: "GET",
|
|
7499
|
+
path: "/settings/item-categories",
|
|
7500
|
+
commandPath: ["settings", "items", "item-categories", "list"],
|
|
7501
|
+
options: [],
|
|
7502
|
+
hasRequestBody: false,
|
|
7503
|
+
responseFields: [
|
|
7504
|
+
{
|
|
7505
|
+
name: "items",
|
|
7506
|
+
type: "array"
|
|
7507
|
+
}
|
|
7508
|
+
]
|
|
7509
|
+
},
|
|
7510
|
+
{
|
|
7511
|
+
operationId: "PublicApiItemCategoryController_upsert",
|
|
7512
|
+
displayName: "Upsert item category",
|
|
7513
|
+
description: "Create a category/sub-category pair if it does not already exist.",
|
|
7514
|
+
method: "POST",
|
|
7515
|
+
path: "/settings/item-categories/upsert",
|
|
7516
|
+
commandPath: ["settings", "items", "item-categories", "upsert"],
|
|
7517
|
+
options: [
|
|
7518
|
+
{
|
|
7519
|
+
name: "categoryId",
|
|
7520
|
+
cliName: "category-id",
|
|
7521
|
+
optionKey: "categoryId",
|
|
7522
|
+
source: "body",
|
|
7523
|
+
type: "string",
|
|
7524
|
+
required: false,
|
|
7525
|
+
description: "category ID"
|
|
7526
|
+
},
|
|
7527
|
+
{
|
|
7528
|
+
name: "categoryName",
|
|
7529
|
+
cliName: "category-name",
|
|
7530
|
+
optionKey: "categoryName",
|
|
7531
|
+
source: "body",
|
|
7532
|
+
type: "string",
|
|
7533
|
+
required: false,
|
|
7534
|
+
description: ""
|
|
7535
|
+
},
|
|
7536
|
+
{
|
|
7537
|
+
name: "subCategoryId",
|
|
7538
|
+
cliName: "sub-category-id",
|
|
7539
|
+
optionKey: "subCategoryId",
|
|
7540
|
+
source: "body",
|
|
7541
|
+
type: "string",
|
|
7542
|
+
required: false,
|
|
7543
|
+
description: "sub category ID"
|
|
7544
|
+
},
|
|
7545
|
+
{
|
|
7546
|
+
name: "subCategoryName",
|
|
7547
|
+
cliName: "sub-category-name",
|
|
7548
|
+
optionKey: "subCategoryName",
|
|
7549
|
+
source: "body",
|
|
7550
|
+
type: "string",
|
|
7551
|
+
required: false,
|
|
7552
|
+
description: ""
|
|
7553
|
+
},
|
|
7554
|
+
{
|
|
7555
|
+
name: "raw-body",
|
|
7556
|
+
cliName: "raw-body",
|
|
7557
|
+
optionKey: "rawBody",
|
|
7558
|
+
source: "body",
|
|
7559
|
+
type: "object",
|
|
7560
|
+
required: false,
|
|
7561
|
+
description: "Raw request body JSON (overrides individual fields)"
|
|
7562
|
+
}
|
|
7563
|
+
],
|
|
7564
|
+
hasRequestBody: true,
|
|
7565
|
+
responseFields: [
|
|
7566
|
+
{
|
|
7567
|
+
name: "category",
|
|
7568
|
+
type: "object"
|
|
7569
|
+
}
|
|
7570
|
+
]
|
|
7571
|
+
},
|
|
7572
|
+
{
|
|
7573
|
+
operationId: "PublicApiUoMController_list",
|
|
7574
|
+
displayName: "List UOMs",
|
|
7575
|
+
description: "Retrieve active units of measure for item create/update.",
|
|
7576
|
+
method: "GET",
|
|
7577
|
+
path: "/settings/uoms",
|
|
7578
|
+
commandPath: ["settings", "items", "uoms", "list"],
|
|
7579
|
+
options: [],
|
|
7580
|
+
hasRequestBody: false,
|
|
7581
|
+
responseFields: [
|
|
7582
|
+
{
|
|
7583
|
+
name: "items",
|
|
7584
|
+
type: "array"
|
|
7585
|
+
}
|
|
7586
|
+
]
|
|
7587
|
+
},
|
|
6444
7588
|
{
|
|
6445
7589
|
operationId: "PublicAttachmentController_createUploadSession",
|
|
6446
7590
|
displayName: "Create upload session",
|