node-autotask 0.91.0 → 0.92.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/CHANGELOG.md +4 -0
- package/MCP_TOOL_CATALOG.json +152 -9
- package/README.md +1 -1
- package/capabilities.json +575 -28
- package/dist/capabilities-data.js +574 -27
- package/dist/capabilities.cjs +4 -4
- package/dist/capabilities.js +1 -1
- package/dist/{chunk-43ADHLZJ.js → chunk-2MC3LDZU.js} +3 -3
- package/dist/{chunk-YFC5VAKK.cjs → chunk-ATDGRAX2.cjs} +31 -30
- package/dist/{chunk-Y2KXGSWM.js → chunk-ELAU2MT5.js} +3 -2
- package/dist/{chunk-RXXITZH4.cjs → chunk-H24SV774.cjs} +377 -114
- package/dist/{chunk-5PUHGPKG.cjs → chunk-JPZ7M7QI.cjs} +200 -200
- package/dist/{chunk-2GP7W6QB.js → chunk-NQNAEA23.js} +372 -109
- package/dist/{chunk-KRYDLTY3.cjs → chunk-QXJQIZCT.cjs} +3 -3
- package/dist/{chunk-WAHRZDV4.js → chunk-XAOWO42G.js} +2 -2
- package/dist/{index-Dy92Xbpv.d.cts → index-B9y5IwT1.d.cts} +41 -1
- package/dist/{index-Dy92Xbpv.d.ts → index-B9y5IwT1.d.ts} +41 -1
- package/dist/{index-C3jXvpXZ.d.ts → index-U7Lepdm2.d.ts} +8 -5
- package/dist/{index-BfGOllfY.d.cts → index-lWek2NrV.d.cts} +8 -5
- package/dist/index.cjs +85 -85
- package/dist/index.d.cts +3 -3
- package/dist/index.d.ts +3 -3
- package/dist/index.js +5 -5
- package/dist/operations/index.cjs +51 -51
- package/dist/operations/index.d.cts +6 -4
- package/dist/operations/index.d.ts +6 -4
- package/dist/operations/index.js +2 -2
- package/dist/pool.cjs +12 -12
- package/dist/pool.d.cts +1 -1
- package/dist/pool.d.ts +1 -1
- package/dist/pool.js +4 -4
- package/dist/resources/index.cjs +27 -27
- package/dist/resources/index.d.cts +2 -2
- package/dist/resources/index.d.ts +2 -2
- package/dist/resources/index.js +3 -3
- package/dist/types/index.d.cts +1 -1
- package/dist/types/index.d.ts +1 -1
- package/docs/API.md +3 -2
- package/examples/mcp/manifest.ts +1 -1
- package/examples/mcp/tools-mode.ts +15 -6
- package/examples/mcp/tools-read.ts +8 -2
- package/package.json +1 -1
|
@@ -293,6 +293,40 @@ const CAPABILITY_DATA = {
|
|
|
293
293
|
"RESPONSE_TOO_LARGE",
|
|
294
294
|
"REDIRECT_BLOCKED"
|
|
295
295
|
],
|
|
296
|
+
[
|
|
297
|
+
"BAD_REQUEST",
|
|
298
|
+
"CONFIG_ERROR",
|
|
299
|
+
"NETWORK_ERROR",
|
|
300
|
+
"UNAUTHORIZED",
|
|
301
|
+
"RATE_LIMITED",
|
|
302
|
+
"VALIDATION_FAILED",
|
|
303
|
+
"CONFLICT",
|
|
304
|
+
"TIMEOUT",
|
|
305
|
+
"SERVER_ERROR",
|
|
306
|
+
"INVALID_RESPONSE",
|
|
307
|
+
"ABORTED",
|
|
308
|
+
"RESPONSE_TOO_LARGE",
|
|
309
|
+
"REDIRECT_BLOCKED",
|
|
310
|
+
"FORBIDDEN",
|
|
311
|
+
"NOT_FOUND",
|
|
312
|
+
"MAINTENANCE"
|
|
313
|
+
],
|
|
314
|
+
[
|
|
315
|
+
"BAD_REQUEST",
|
|
316
|
+
"CONFIG_ERROR",
|
|
317
|
+
"NETWORK_ERROR",
|
|
318
|
+
"UNAUTHORIZED",
|
|
319
|
+
"RATE_LIMITED",
|
|
320
|
+
"TIMEOUT",
|
|
321
|
+
"SERVER_ERROR",
|
|
322
|
+
"INVALID_RESPONSE",
|
|
323
|
+
"ABORTED",
|
|
324
|
+
"RESPONSE_TOO_LARGE",
|
|
325
|
+
"REDIRECT_BLOCKED",
|
|
326
|
+
"SCOPE_REQUIRED",
|
|
327
|
+
"FORBIDDEN",
|
|
328
|
+
"RESPONSE_REJECTED"
|
|
329
|
+
],
|
|
296
330
|
[
|
|
297
331
|
"BAD_REQUEST",
|
|
298
332
|
"CONFIG_ERROR",
|
|
@@ -492,8 +526,8 @@ const CAPABILITY_DATA = {
|
|
|
492
526
|
],
|
|
493
527
|
"groups": {
|
|
494
528
|
"B": {
|
|
495
|
-
"planHash": "
|
|
496
|
-
"builtAt": "2026-11-
|
|
529
|
+
"planHash": "21e75d0f8bf9986b21c6b7996dfb1fec78b3aaa9afa86f50f5351c54c733d4ac",
|
|
530
|
+
"builtAt": "2026-11-21T07:49:35.531Z",
|
|
497
531
|
"records": [
|
|
498
532
|
{
|
|
499
533
|
"id": "appointments.count",
|
|
@@ -47871,8 +47905,8 @@ const CAPABILITY_DATA = {
|
|
|
47871
47905
|
]
|
|
47872
47906
|
},
|
|
47873
47907
|
"A": {
|
|
47874
|
-
"planHash": "
|
|
47875
|
-
"builtAt": "2026-11-
|
|
47908
|
+
"planHash": "21e75d0f8bf9986b21c6b7996dfb1fec78b3aaa9afa86f50f5351c54c733d4ac",
|
|
47909
|
+
"builtAt": "2026-11-21T07:49:35.531Z",
|
|
47876
47910
|
"records": [
|
|
47877
47911
|
{
|
|
47878
47912
|
"id": "attachment_info.count",
|
|
@@ -73187,6 +73221,519 @@ const CAPABILITY_DATA = {
|
|
|
73187
73221
|
"compact": null,
|
|
73188
73222
|
"status": "tested"
|
|
73189
73223
|
},
|
|
73224
|
+
{
|
|
73225
|
+
"id": "inventory_items.count",
|
|
73226
|
+
"resource": "inventory_items",
|
|
73227
|
+
"udfCapable": false,
|
|
73228
|
+
"operation": "count",
|
|
73229
|
+
"kind": "primitive",
|
|
73230
|
+
"endpoint": "POST /V1.0/InventoryItems/query/count",
|
|
73231
|
+
"effect": "read",
|
|
73232
|
+
"flags": [],
|
|
73233
|
+
"dryRun": false,
|
|
73234
|
+
"envelope": "QueryCountResultModel",
|
|
73235
|
+
"inputSchema": {
|
|
73236
|
+
"params": {
|
|
73237
|
+
"type": "object",
|
|
73238
|
+
"required": false,
|
|
73239
|
+
"description": "The query params object (CLOSED — unknown keys are refused pre-request): { filter?: FilterCondition[], fieldCheck?: boolean } — filter is the only wire parameter (the count endpoint takes no MaxRecords/IncludeFields; fieldCheck is consumed by the invoke router — never sent to the vendor). Filter condition field names are name-checked pre-request the same way as the query bag: a refusal costs zero /query/count wire (the cold fieldCache may cost the one authority metadata GET first). fieldCheck: false disables the name check (a non-boolean is refused pre-request; the shape/grammar checks always run) — the opt-out works on the count verb too. InventoryItems has no record UDFs. UDF-marked filters are refused even with fieldCheck: false.",
|
|
73240
|
+
"properties": [
|
|
73241
|
+
{
|
|
73242
|
+
"name": "filter",
|
|
73243
|
+
"type": "FilterCondition[]",
|
|
73244
|
+
"optional": true
|
|
73245
|
+
},
|
|
73246
|
+
{
|
|
73247
|
+
"name": "fieldCheck",
|
|
73248
|
+
"type": "boolean",
|
|
73249
|
+
"optional": true
|
|
73250
|
+
}
|
|
73251
|
+
]
|
|
73252
|
+
}
|
|
73253
|
+
},
|
|
73254
|
+
"inputSchemaStrict": true,
|
|
73255
|
+
"outputSchema": {
|
|
73256
|
+
"type": "QueryCountResultModel",
|
|
73257
|
+
"drops": []
|
|
73258
|
+
},
|
|
73259
|
+
"examples": [
|
|
73260
|
+
"await invoke(client, 'inventory_items.count', [{ filter: [{ field: 'productID', op: 'eq', value: 7 }] }])"
|
|
73261
|
+
],
|
|
73262
|
+
"permissions": "unknown",
|
|
73263
|
+
"pagination": {
|
|
73264
|
+
"mode": "none"
|
|
73265
|
+
},
|
|
73266
|
+
"resolution": null,
|
|
73267
|
+
"retry": {
|
|
73268
|
+
"preset": "retry-ffb3a9cb"
|
|
73269
|
+
},
|
|
73270
|
+
"errors": {
|
|
73271
|
+
"set": 6
|
|
73272
|
+
},
|
|
73273
|
+
"metadata": {
|
|
73274
|
+
"purpose": "Count inventory item records matching a JSON filter.",
|
|
73275
|
+
"usage": "Unwraps queryCount; returns a plain number. Inventory permissions and module access govern visibility and writes. Empty results do not establish tenant-wide absence. Records bind a product and an inventory location.",
|
|
73276
|
+
"preferredWhen": null,
|
|
73277
|
+
"related": [
|
|
73278
|
+
"inventory_items.query"
|
|
73279
|
+
],
|
|
73280
|
+
"args": "args[0] is a params object (CLOSED — unknown keys are refused pre-request): { filter?: FilterCondition[], fieldCheck?: boolean } — filter is the only parameter sent to the vendor (the count endpoint takes no MaxRecords/IncludeFields; fieldCheck is consumed by the invoke router — never sent to the vendor). Filter condition field names are name-checked pre-request the same way as the query bag: a refusal costs zero /query/count wire (the cold fieldCache may cost the one authority metadata GET first). fieldCheck: false disables the name check (a non-boolean is refused pre-request; the shape/grammar checks always run) — the opt-out works on the count verb too. Filter grammar: 13 operators: eq, noteq, gt, gte, lt, lte, beginsWith, endsWith, contains, exist, notExist, in, notIn (in/notIn: array or '1,2,3') + and/or grouping (no not-group). Field names in vendor API casing — get them via operations.fieldCatalog. Caps: 500 OR-conditions / no UDFs / 8000 chars.",
|
|
73281
|
+
"untrustedFields": [
|
|
73282
|
+
"bin",
|
|
73283
|
+
"referenceNumber"
|
|
73284
|
+
]
|
|
73285
|
+
},
|
|
73286
|
+
"compact": null,
|
|
73287
|
+
"status": "tested"
|
|
73288
|
+
},
|
|
73289
|
+
{
|
|
73290
|
+
"id": "inventory_items.create",
|
|
73291
|
+
"resource": "inventory_items",
|
|
73292
|
+
"udfCapable": false,
|
|
73293
|
+
"operation": "create",
|
|
73294
|
+
"kind": "primitive",
|
|
73295
|
+
"endpoint": "POST /V1.0/InventoryItems",
|
|
73296
|
+
"effect": "write",
|
|
73297
|
+
"flags": [],
|
|
73298
|
+
"dryRun": true,
|
|
73299
|
+
"envelope": "OperationResultModel",
|
|
73300
|
+
"inputSchema": {
|
|
73301
|
+
"data": {
|
|
73302
|
+
"type": "object",
|
|
73303
|
+
"required": true,
|
|
73304
|
+
"description": "The record payload (vendor model fields)."
|
|
73305
|
+
}
|
|
73306
|
+
},
|
|
73307
|
+
"inputSchemaStrict": true,
|
|
73308
|
+
"outputSchema": {
|
|
73309
|
+
"type": "OperationResultModel",
|
|
73310
|
+
"drops": []
|
|
73311
|
+
},
|
|
73312
|
+
"examples": [
|
|
73313
|
+
"await client.inventoryItems.create({ productID: 3, inventoryLocationID: 7, quantityMinimum: 0, quantityMaximum: 10, quantityOnHand: 0 }, { dryRun: true })"
|
|
73314
|
+
],
|
|
73315
|
+
"permissions": "unknown",
|
|
73316
|
+
"pagination": {
|
|
73317
|
+
"mode": "none"
|
|
73318
|
+
},
|
|
73319
|
+
"resolution": null,
|
|
73320
|
+
"retry": {
|
|
73321
|
+
"preset": "retry-c5657094"
|
|
73322
|
+
},
|
|
73323
|
+
"errors": {
|
|
73324
|
+
"set": 17
|
|
73325
|
+
},
|
|
73326
|
+
"metadata": {
|
|
73327
|
+
"purpose": "Create a product-location inventory item.",
|
|
73328
|
+
"usage": "Inventory permissions and module access govern visibility and writes. Empty results do not establish tenant-wide absence. Records bind a product and an inventory location. Supply productID, inventoryLocationID, quantityMinimum, quantityMaximum and quantityOnHand. Product and location are verified before preview or apply. The location must be active and initial quantityOnHand must be nonnegative. Serialized products require zero on-hand. Autotask controls pair uniqueness and initializes read-only counters. No public DELETE exists. Preview first.",
|
|
73329
|
+
"preferredWhen": "Use for a new product-location pair after checking known inventory items.",
|
|
73330
|
+
"related": [
|
|
73331
|
+
"inventory_items.query",
|
|
73332
|
+
"inventory_locations.get",
|
|
73333
|
+
"products.get"
|
|
73334
|
+
],
|
|
73335
|
+
"deleteBoundary": {
|
|
73336
|
+
"resource": "inventory_items",
|
|
73337
|
+
"note": "The specification defines no public DELETE for InventoryItems. A created item cannot be removed through that API.",
|
|
73338
|
+
"proof": "spec-derived"
|
|
73339
|
+
},
|
|
73340
|
+
"untrustedFields": [
|
|
73341
|
+
"bin",
|
|
73342
|
+
"referenceNumber"
|
|
73343
|
+
],
|
|
73344
|
+
"accountWide": true,
|
|
73345
|
+
"createRequirements": {
|
|
73346
|
+
"requires": {
|
|
73347
|
+
"allOf": [
|
|
73348
|
+
"inventoryLocationID",
|
|
73349
|
+
"productID",
|
|
73350
|
+
"quantityMinimum",
|
|
73351
|
+
"quantityMaximum",
|
|
73352
|
+
"quantityOnHand"
|
|
73353
|
+
]
|
|
73354
|
+
}
|
|
73355
|
+
}
|
|
73356
|
+
},
|
|
73357
|
+
"compact": null,
|
|
73358
|
+
"status": "tested"
|
|
73359
|
+
},
|
|
73360
|
+
{
|
|
73361
|
+
"id": "inventory_items.get",
|
|
73362
|
+
"resource": "inventory_items",
|
|
73363
|
+
"udfCapable": false,
|
|
73364
|
+
"operation": "get",
|
|
73365
|
+
"kind": "primitive",
|
|
73366
|
+
"endpoint": "GET /V1.0/InventoryItems/{id}",
|
|
73367
|
+
"effect": "read",
|
|
73368
|
+
"flags": [],
|
|
73369
|
+
"dryRun": false,
|
|
73370
|
+
"envelope": "ItemQueryResultModel[InventoryItemModel,InventoryItem]",
|
|
73371
|
+
"inputSchema": {
|
|
73372
|
+
"id": {
|
|
73373
|
+
"type": "string | number",
|
|
73374
|
+
"required": true,
|
|
73375
|
+
"description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
|
|
73376
|
+
},
|
|
73377
|
+
"opts": {
|
|
73378
|
+
"type": "object",
|
|
73379
|
+
"required": false,
|
|
73380
|
+
"description": "The read options bag (CLOSED): { fresh?: boolean } — fresh: true bypasses the read-cache lookup and refreshes the entry with the live response. Omitted: the cached read (default unchanged). A positional fresh via invoke is REFUSED (typed error, zero wire — the fresh invoke option is the only spelling); the typed method get(id, { fresh: true }) is unchanged.",
|
|
73381
|
+
"properties": [
|
|
73382
|
+
{
|
|
73383
|
+
"name": "fresh",
|
|
73384
|
+
"type": "boolean",
|
|
73385
|
+
"optional": true
|
|
73386
|
+
}
|
|
73387
|
+
]
|
|
73388
|
+
}
|
|
73389
|
+
},
|
|
73390
|
+
"inputSchemaStrict": true,
|
|
73391
|
+
"outputSchema": {
|
|
73392
|
+
"type": "ItemQueryResultModel[InventoryItemModel,InventoryItem]",
|
|
73393
|
+
"drops": []
|
|
73394
|
+
},
|
|
73395
|
+
"examples": [
|
|
73396
|
+
"await client.inventoryItems.get(7)"
|
|
73397
|
+
],
|
|
73398
|
+
"permissions": "unknown",
|
|
73399
|
+
"pagination": {
|
|
73400
|
+
"mode": "none"
|
|
73401
|
+
},
|
|
73402
|
+
"resolution": null,
|
|
73403
|
+
"retry": {
|
|
73404
|
+
"preset": "retry-ffb3a9cb"
|
|
73405
|
+
},
|
|
73406
|
+
"errors": {
|
|
73407
|
+
"set": 3
|
|
73408
|
+
},
|
|
73409
|
+
"metadata": {
|
|
73410
|
+
"purpose": "Get one InventoryItem by id.",
|
|
73411
|
+
"usage": "item: null on the 200 body maps to NotFoundError (vendor not-found signal). Inventory permissions and module access govern visibility and writes. Empty results do not establish tenant-wide absence. Records bind a product and an inventory location.",
|
|
73412
|
+
"preferredWhen": "Preferred when the numeric id is already known.",
|
|
73413
|
+
"related": [
|
|
73414
|
+
"inventory_items.query"
|
|
73415
|
+
],
|
|
73416
|
+
"args": "args[0] is the record id (safe integer or decimal string; use the string form above Number.MAX_SAFE_INTEGER). Item GET returns the FULL vendor model — the vendor documents no field selection on single-record reads. For a slim record use an inventory_items.query with includeFields.",
|
|
73417
|
+
"untrustedFields": [
|
|
73418
|
+
"bin",
|
|
73419
|
+
"referenceNumber"
|
|
73420
|
+
]
|
|
73421
|
+
},
|
|
73422
|
+
"compact": null,
|
|
73423
|
+
"status": "tested"
|
|
73424
|
+
},
|
|
73425
|
+
{
|
|
73426
|
+
"id": "inventory_items.getEntityInfo",
|
|
73427
|
+
"resource": "inventory_items",
|
|
73428
|
+
"udfCapable": false,
|
|
73429
|
+
"operation": "getEntityInfo",
|
|
73430
|
+
"kind": "primitive",
|
|
73431
|
+
"endpoint": "GET /V1.0/InventoryItems/entityInformation",
|
|
73432
|
+
"effect": "read",
|
|
73433
|
+
"flags": [],
|
|
73434
|
+
"dryRun": false,
|
|
73435
|
+
"envelope": "EntityInformationResultModel",
|
|
73436
|
+
"inputSchema": {},
|
|
73437
|
+
"inputSchemaStrict": true,
|
|
73438
|
+
"outputSchema": {
|
|
73439
|
+
"type": "EntityInformationResultModel",
|
|
73440
|
+
"drops": []
|
|
73441
|
+
},
|
|
73442
|
+
"examples": [
|
|
73443
|
+
"await client.inventoryItems.getEntityInfo()"
|
|
73444
|
+
],
|
|
73445
|
+
"permissions": "unknown",
|
|
73446
|
+
"pagination": {
|
|
73447
|
+
"mode": "none"
|
|
73448
|
+
},
|
|
73449
|
+
"resolution": null,
|
|
73450
|
+
"retry": {
|
|
73451
|
+
"preset": "retry-ffb3a9cb"
|
|
73452
|
+
},
|
|
73453
|
+
"errors": {
|
|
73454
|
+
"set": 6
|
|
73455
|
+
},
|
|
73456
|
+
"metadata": {
|
|
73457
|
+
"purpose": "Get the InventoryItem capability metadata (canCreate/canUpdate/hasUserDefinedFields/...).",
|
|
73458
|
+
"usage": "Unwraps info{}; drives client-side capability checks.",
|
|
73459
|
+
"preferredWhen": null,
|
|
73460
|
+
"related": [
|
|
73461
|
+
"inventory_items.getFieldInfo"
|
|
73462
|
+
],
|
|
73463
|
+
"untrustedFields": [
|
|
73464
|
+
"bin",
|
|
73465
|
+
"referenceNumber"
|
|
73466
|
+
]
|
|
73467
|
+
},
|
|
73468
|
+
"compact": null,
|
|
73469
|
+
"status": "tested"
|
|
73470
|
+
},
|
|
73471
|
+
{
|
|
73472
|
+
"id": "inventory_items.getFieldInfo",
|
|
73473
|
+
"resource": "inventory_items",
|
|
73474
|
+
"udfCapable": false,
|
|
73475
|
+
"operation": "getFieldInfo",
|
|
73476
|
+
"kind": "primitive",
|
|
73477
|
+
"endpoint": "GET /V1.0/InventoryItems/entityInformation/fields",
|
|
73478
|
+
"effect": "read",
|
|
73479
|
+
"flags": [],
|
|
73480
|
+
"dryRun": false,
|
|
73481
|
+
"envelope": "FieldInformationResultModel",
|
|
73482
|
+
"inputSchema": {},
|
|
73483
|
+
"inputSchemaStrict": true,
|
|
73484
|
+
"outputSchema": {
|
|
73485
|
+
"type": "FieldInformationResultModel",
|
|
73486
|
+
"drops": []
|
|
73487
|
+
},
|
|
73488
|
+
"examples": [
|
|
73489
|
+
"await client.inventoryItems.getFieldInfo()"
|
|
73490
|
+
],
|
|
73491
|
+
"permissions": "unknown",
|
|
73492
|
+
"pagination": {
|
|
73493
|
+
"mode": "none"
|
|
73494
|
+
},
|
|
73495
|
+
"resolution": null,
|
|
73496
|
+
"retry": {
|
|
73497
|
+
"preset": "retry-ffb3a9cb"
|
|
73498
|
+
},
|
|
73499
|
+
"errors": {
|
|
73500
|
+
"set": 6
|
|
73501
|
+
},
|
|
73502
|
+
"metadata": {
|
|
73503
|
+
"purpose": "Get the InventoryItem field catalog (types, picklists, required, maxLength) — the full raw field dump (the largest read of the info trio; compact discovery: operations.fieldCatalog).",
|
|
73504
|
+
"usage": "Unwraps fields[]; full raw field dump — the largest read of the info trio (compact discovery: operations.fieldCatalog); the raw dump is also the basis for UDF handling.",
|
|
73505
|
+
"preferredWhen": null,
|
|
73506
|
+
"related": [
|
|
73507
|
+
"inventory_items.getEntityInfo",
|
|
73508
|
+
"inventory_items.getUdfInfo"
|
|
73509
|
+
],
|
|
73510
|
+
"untrustedFields": [
|
|
73511
|
+
"bin",
|
|
73512
|
+
"referenceNumber"
|
|
73513
|
+
]
|
|
73514
|
+
},
|
|
73515
|
+
"compact": null,
|
|
73516
|
+
"status": "tested"
|
|
73517
|
+
},
|
|
73518
|
+
{
|
|
73519
|
+
"id": "inventory_items.getUdfInfo",
|
|
73520
|
+
"resource": "inventory_items",
|
|
73521
|
+
"udfCapable": false,
|
|
73522
|
+
"operation": "getUdfInfo",
|
|
73523
|
+
"kind": "primitive",
|
|
73524
|
+
"endpoint": "GET /V1.0/InventoryItems/entityInformation/userDefinedFields",
|
|
73525
|
+
"effect": "read",
|
|
73526
|
+
"flags": [],
|
|
73527
|
+
"dryRun": false,
|
|
73528
|
+
"envelope": "UserDefinedFieldInformationResultModel",
|
|
73529
|
+
"inputSchema": {},
|
|
73530
|
+
"inputSchemaStrict": true,
|
|
73531
|
+
"outputSchema": {
|
|
73532
|
+
"type": "UserDefinedFieldInformationResultModel",
|
|
73533
|
+
"drops": []
|
|
73534
|
+
},
|
|
73535
|
+
"examples": [
|
|
73536
|
+
"await client.inventoryItems.getUdfInfo()"
|
|
73537
|
+
],
|
|
73538
|
+
"permissions": "unknown",
|
|
73539
|
+
"pagination": {
|
|
73540
|
+
"mode": "none"
|
|
73541
|
+
},
|
|
73542
|
+
"resolution": null,
|
|
73543
|
+
"retry": {
|
|
73544
|
+
"preset": "retry-ffb3a9cb"
|
|
73545
|
+
},
|
|
73546
|
+
"errors": {
|
|
73547
|
+
"set": 6
|
|
73548
|
+
},
|
|
73549
|
+
"metadata": {
|
|
73550
|
+
"purpose": "Get the InventoryItem user-defined-field catalog.",
|
|
73551
|
+
"usage": "Unwraps fields[]; only meaningful where the entity is UDF-capable. (entity is not UDF-capable; catalog is expected empty).",
|
|
73552
|
+
"preferredWhen": null,
|
|
73553
|
+
"related": [
|
|
73554
|
+
"inventory_items.getFieldInfo"
|
|
73555
|
+
],
|
|
73556
|
+
"untrustedFields": [
|
|
73557
|
+
"bin",
|
|
73558
|
+
"referenceNumber"
|
|
73559
|
+
]
|
|
73560
|
+
},
|
|
73561
|
+
"compact": null,
|
|
73562
|
+
"status": "tested"
|
|
73563
|
+
},
|
|
73564
|
+
{
|
|
73565
|
+
"id": "inventory_items.query",
|
|
73566
|
+
"resource": "inventory_items",
|
|
73567
|
+
"udfCapable": false,
|
|
73568
|
+
"operation": "query",
|
|
73569
|
+
"kind": "primitive",
|
|
73570
|
+
"endpoint": "GET|POST /V1.0/InventoryItems/query",
|
|
73571
|
+
"effect": "read",
|
|
73572
|
+
"flags": [],
|
|
73573
|
+
"dryRun": false,
|
|
73574
|
+
"envelope": "QueryActionResult[<Model>,<Entity>]",
|
|
73575
|
+
"inputSchema": {
|
|
73576
|
+
"params": {
|
|
73577
|
+
"type": "object",
|
|
73578
|
+
"required": false,
|
|
73579
|
+
"description": "The query params object (CLOSED — unknown keys are refused pre-request with a typed error naming the key + the valid keys): { filter?: FilterCondition[], limit?: number (total cap, default 500, max 2500 — NOT a page size), latest?: number (1-2500; the N highest-id rows — the vendor has no sort; count-probe + id-threshold semantics, see docs/API.md §4; the same-process latest-walk count probes are briefly cached per client — a 30 s TTL, cleared on a write through this client (a probe in flight across the write is discarded by the cache's invalidation epoch); the plain count op and aggregate stay fresh; limit and latest may coexist only when limit >= latest), noteChars?: number (integer >= 1; opt-in per-field char cap on the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose): each capped value = the first N chars + the explicit marker … [+N chars truncated] (N = chars removed), applied at result-build BEFORE the server-side untrusted wrapper; absent = the raw, untruncated result), includeFields?: string[], fieldCheck?: boolean (default true: every includeFields NAME and every filter condition FIELD NAME is checked pre-request against the live field set (the vendored spec when that read faults — the resource's plan-pinned live-only fields, metadata.liveOnlyFields, are exempt from the vendored refusal: the live entity carries them and the vendor model omits them (e.g. time_entries postedDate/postedOnTime) — a truly unknown name is still refused); a refusal costs zero QUERY wire — the query POST and the count probe that anchors latest are never issued, a COLD fieldCache performs one authority metadata GET first (zero on a warm one); false disables both name checks, never the shape/grammar checks; the count verb's bag is name-checked the same way and carries the same fieldCheck opt-out; a direct queryBounded/queryAll call is not checked (no bag contract there)), names?: boolean (absent = the client's labels option — OFF by default (the label pass costs a field-catalog read + a capped number of cold name reads per call (several ids of one table share one batched read); the MCP server (iit-mcp-autotask) enables the client labels option when it re-pins to this version (downstream)); true adds the row label siblings: picklist <field>Label (statusLabel), <fk>Name for companyID/contractID/ticketID/roleID/billingCodeID/productID/vendorID (a company)/configurationItemCategoryID/*ResourceID (contractIDName, productIDName, assignedResourceIDName) — null, never missing, when the field is keyed with a null value, a 0 id (except companyID/vendorID 0, which name the tenant owner's own company) or an unresolved value (a picklist 0 is labelled when the picklist defines it); a names summary appears only when something was left unlabelled (the uncached name-read cap, an id a batched name read did not return, or an unresolved picklist value); false = raw ids, ~30% smaller on a full tickets row), via?: \"post\" | \"get\" (vendor GET has a 2048-char cap), acknowledgeUnscoped?: boolean (query verb only; a walk expected to read over 500 rows with no id scope in the filter is guarded — one pre-flight <resource>.count, and a count over 500 refuses with the typed SCOPE_REQUIRED before the walk; true walks the unscoped set anyway; a count that fails or is blind lets the walk run and the result's scopeNote says so), walk?: object (walk.maxRows: positive integer — (D6): the walk's TOTAL row cap — serves at most maxRows rows in total; the page size stays min(500, limit), so one vendor page may fetch more rows than maxRows and the surplus is sliced off (fetched, not served); the result's truncated flag — false only when the cursor is exhausted, true iff more rows exist past the cap (so an exact-multiple count with a live next page reports true); not combinable with latest) }. Filter grammar: 13 operators (eq, noteq, gt, gte, lt, lte, beginsWith, endsWith, contains, exist, notExist, in, notIn; in/notIn: array or \"1,2,3\") + and/or grouping (no not-group); field names in vendor API casing (via operations.fieldCatalog); caps: 500 OR-conditions / no UDFs / 8000 chars. InventoryItems has no record UDFs. UDF-marked filters are refused even with fieldCheck: false.",
|
|
73580
|
+
"properties": [
|
|
73581
|
+
{
|
|
73582
|
+
"name": "filter",
|
|
73583
|
+
"type": "FilterCondition[]",
|
|
73584
|
+
"optional": true
|
|
73585
|
+
},
|
|
73586
|
+
{
|
|
73587
|
+
"name": "limit",
|
|
73588
|
+
"type": "number",
|
|
73589
|
+
"optional": true,
|
|
73590
|
+
"default": 500
|
|
73591
|
+
},
|
|
73592
|
+
{
|
|
73593
|
+
"name": "latest",
|
|
73594
|
+
"type": "number",
|
|
73595
|
+
"optional": true
|
|
73596
|
+
},
|
|
73597
|
+
{
|
|
73598
|
+
"name": "noteChars",
|
|
73599
|
+
"type": "number",
|
|
73600
|
+
"optional": true
|
|
73601
|
+
},
|
|
73602
|
+
{
|
|
73603
|
+
"name": "includeFields",
|
|
73604
|
+
"type": "string[]",
|
|
73605
|
+
"optional": true
|
|
73606
|
+
},
|
|
73607
|
+
{
|
|
73608
|
+
"name": "fieldCheck",
|
|
73609
|
+
"type": "boolean",
|
|
73610
|
+
"optional": true,
|
|
73611
|
+
"default": true
|
|
73612
|
+
},
|
|
73613
|
+
{
|
|
73614
|
+
"name": "names",
|
|
73615
|
+
"type": "boolean",
|
|
73616
|
+
"optional": true
|
|
73617
|
+
},
|
|
73618
|
+
{
|
|
73619
|
+
"name": "via",
|
|
73620
|
+
"type": "\"post\" | \"get\"",
|
|
73621
|
+
"optional": true
|
|
73622
|
+
},
|
|
73623
|
+
{
|
|
73624
|
+
"name": "acknowledgeUnscoped",
|
|
73625
|
+
"type": "boolean",
|
|
73626
|
+
"optional": true
|
|
73627
|
+
},
|
|
73628
|
+
{
|
|
73629
|
+
"name": "walk",
|
|
73630
|
+
"type": "object",
|
|
73631
|
+
"optional": true
|
|
73632
|
+
}
|
|
73633
|
+
]
|
|
73634
|
+
}
|
|
73635
|
+
},
|
|
73636
|
+
"inputSchemaStrict": true,
|
|
73637
|
+
"outputSchema": {
|
|
73638
|
+
"type": "QueryActionResult[<Model>,<Entity>]",
|
|
73639
|
+
"drops": []
|
|
73640
|
+
},
|
|
73641
|
+
"examples": [
|
|
73642
|
+
"await invoke(client, 'inventory_items.query', [{ filter: [{ field: 'productID', op: 'eq', value: 7 }], limit: 25 }])"
|
|
73643
|
+
],
|
|
73644
|
+
"permissions": "unknown",
|
|
73645
|
+
"pagination": {
|
|
73646
|
+
"mode": "cursor",
|
|
73647
|
+
"vendorDefault": 10,
|
|
73648
|
+
"vendorMax": 500,
|
|
73649
|
+
"pageGuard": 1000,
|
|
73650
|
+
"queryBounded": {
|
|
73651
|
+
"default": 500,
|
|
73652
|
+
"max": 2500
|
|
73653
|
+
}
|
|
73654
|
+
},
|
|
73655
|
+
"resolution": null,
|
|
73656
|
+
"retry": {
|
|
73657
|
+
"preset": "retry-ffb3a9cb"
|
|
73658
|
+
},
|
|
73659
|
+
"errors": {
|
|
73660
|
+
"set": 18
|
|
73661
|
+
},
|
|
73662
|
+
"metadata": {
|
|
73663
|
+
"purpose": "Query InventoryItem records with a JSON filter.",
|
|
73664
|
+
"usage": "Server-side pagination: one call walks the vendor cursor until the limit, end, or 1000-page guard. POST is the default and carries the same QueryModel on continuation. GET mode carries the original search JSON on each GET continuation. queryAll is the unbounded raw walk — only when you need the ENTIRE set and accept a large payload; default to the bounded query op. noteChars: N (integer >= 1) is an opt-in per-field char cap on the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose — the same set the server wraps): each capped value = the first N chars + the explicit marker … [+N chars truncated] (N = chars removed), applied at result-build BEFORE the server-side untrusted wrapper; absent = the raw, untruncated result (zero wire — response-side only). latest: N returns the N highest-id rows (id-descending): the vendor has no sort parameter — this is the only ordering channel, and a date window in `filter` narrows the cost; count-anchored — C ≤ 2500 → one count + a ≤6-page walk of the matching set, C > 2500 → count probes + an id-threshold window (≤64 probes; LATEST_THRESHOLD_UNRESOLVED on budget exhaustion), a blind count → a bounded walk with the blind-surface stamp (LATEST_WINDOW_INCOMPLETE on a truncated walk). Explicit walk.maxRows independently sets the TOTAL returned-row cap (including export-sized walks); the ordinary limit is still validated in 1..2500 and only bounds the internal page size for this form. hasMore and truncated remain true at the page guard or while a cursor or unserved fetched rows remain. Self-resource prefixes are accepted in filter fields and includeFields; dotted UDF names are always refused before metadata or vendor requests, never rewritten to another tenant UDF. Inventory permissions and module access govern visibility and writes. Empty results do not establish tenant-wide absence. Records bind a product and an inventory location. Continuation cursors stay on this collection. An empty page can still have a next cursor.",
|
|
73665
|
+
"preferredWhen": "Default for filtered reads (the bounded query op). queryAll is the unbounded raw walk — only when you need the ENTIRE set and accept a large payload; default to the bounded query op. Prefer an includeFields subset over the full model (field names via operations.fieldCatalog). latest: N is the latest-N rows (id-descending) when the newest rows are the goal (the vendor has no sort — count-anchored, docs/API.md §4). Prefer a hand-listed includeFields for common narrow reads (removed the closed fieldsPreset presets — the v1 billing_join field list for billing_items.query, if you need it, is: companyID, ticketID, projectID, timeEntryID, contractServiceID, contractID, billingCodeID, expenseItemID, itemDate, quantity, rate, extendedPrice, totalAmount, nonBillable); noteChars: N caps the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose) to N chars each with the explicit … [+N chars truncated] marker (opt-in; the raw result when absent).",
|
|
73666
|
+
"related": [
|
|
73667
|
+
"inventory_items.get"
|
|
73668
|
+
],
|
|
73669
|
+
"args": "args[0] is a params object: { filter?: FilterCondition[], limit?: total cap (default 500, max 2500; server-side pagination), latest?: number (1-2500 — the N highest-id rows; the vendor has no sort parameter, so this is a count-anchored mechanism — see docs/API.md §4; coexists with limit only when limit >= latest), noteChars?: number (integer >= 1 — opt-in per-field char cap on the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose): each capped value = the first N chars + the explicit marker … [+N chars truncated] (N = chars removed), applied at result-build BEFORE the server-side untrusted wrapper; absent = the raw, untruncated result) maxRecords?: page size — raw SDK `queryAll`/`query` walks only (this bounded query ignores it; the invoke bag refuses it — pass limit), includeFields?: string[], fieldCheck?: boolean (default true — the pre-request field-name check on includeFields names and filter condition fields; false disables it — consumed by the invoke router, never sent to the vendor), via?: \"post\" | \"get\" (the wire method; the vendor GET has a 2048-char cap), acknowledgeUnscoped?: boolean (query verb only; a walk expected over 500 rows with no id scope in the filter is guarded — one pre-flight <resource>.count, and a count over 500 refuses with the typed SCOPE_REQUIRED before the walk; true walks the unscoped set anyway; a count that fails or is blind lets the walk run and the result’s scopeNote says so), walk?: { maxRows: positive integer (D6: the walk’s TOTAL row cap — serves at most maxRows rows in total; the page size stays min(500, limit), so one vendor page may fetch more rows than maxRows and the surplus is sliced off (fetched, not served); the result’s truncated flag — false only when the cursor is exhausted, true iff more rows exist past the cap (so an exact-multiple count with a live next page reports true); not combinable with latest) } }. Filter grammar: 13 operators: eq, noteq, gt, gte, lt, lte, beginsWith, endsWith, contains, exist, notExist, in, notIn (in/notIn: array or '1,2,3') + and/or grouping (no not-group). Field names in vendor API casing — get them via operations.fieldCatalog. Caps: 500 OR-conditions / no UDFs / 8000 chars. By default the FULL vendor model is returned (all fields). To slim the payload for context savings pass includeFields with the exact vendor field names you need (discover them via operations.fieldCatalog); only those fields + id come back. The subset persists across the internal page walk.",
|
|
73670
|
+
"untrustedFields": [
|
|
73671
|
+
"bin",
|
|
73672
|
+
"referenceNumber"
|
|
73673
|
+
]
|
|
73674
|
+
},
|
|
73675
|
+
"compact": null,
|
|
73676
|
+
"status": "tested"
|
|
73677
|
+
},
|
|
73678
|
+
{
|
|
73679
|
+
"id": "inventory_items.update",
|
|
73680
|
+
"resource": "inventory_items",
|
|
73681
|
+
"udfCapable": false,
|
|
73682
|
+
"operation": "update",
|
|
73683
|
+
"kind": "primitive",
|
|
73684
|
+
"endpoint": "PATCH /V1.0/InventoryItems",
|
|
73685
|
+
"effect": "write",
|
|
73686
|
+
"flags": [],
|
|
73687
|
+
"dryRun": true,
|
|
73688
|
+
"envelope": "OperationResultModel",
|
|
73689
|
+
"inputSchema": {
|
|
73690
|
+
"id": {
|
|
73691
|
+
"type": "string | number",
|
|
73692
|
+
"required": true,
|
|
73693
|
+
"description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
|
|
73694
|
+
},
|
|
73695
|
+
"data": {
|
|
73696
|
+
"type": "object",
|
|
73697
|
+
"required": true,
|
|
73698
|
+
"description": "The record payload (vendor model fields)."
|
|
73699
|
+
}
|
|
73700
|
+
},
|
|
73701
|
+
"inputSchemaStrict": true,
|
|
73702
|
+
"outputSchema": {
|
|
73703
|
+
"type": "OperationResultModel",
|
|
73704
|
+
"drops": []
|
|
73705
|
+
},
|
|
73706
|
+
"examples": [
|
|
73707
|
+
"await client.inventoryItems.update(7, { bin: 'A1' }, { dryRun: true })"
|
|
73708
|
+
],
|
|
73709
|
+
"permissions": "unknown",
|
|
73710
|
+
"pagination": {
|
|
73711
|
+
"mode": "none"
|
|
73712
|
+
},
|
|
73713
|
+
"resolution": null,
|
|
73714
|
+
"retry": {
|
|
73715
|
+
"preset": "retry-c5657094"
|
|
73716
|
+
},
|
|
73717
|
+
"errors": {
|
|
73718
|
+
"set": 17
|
|
73719
|
+
},
|
|
73720
|
+
"metadata": {
|
|
73721
|
+
"purpose": "Update writable inventory item fields with collection PATCH.",
|
|
73722
|
+
"usage": "Inventory permissions and module access govern visibility and writes. Empty results do not establish tenant-wide absence. Records bind a product and an inventory location. The ID is supplied separately and travels in the PATCH body. Product and location are immutable. Min/max changes use fresh current bounds. On-hand changes require known picked and reserved counters and a fresh nonserialized product. A fresh preflight is not atomic and no timestamp is documented. No replacing PUT fallback or maintenance replay is issued.",
|
|
73723
|
+
"preferredWhen": "Use with a known item ID and only the writable fields that should change.",
|
|
73724
|
+
"related": [
|
|
73725
|
+
"inventory_items.get",
|
|
73726
|
+
"products.get"
|
|
73727
|
+
],
|
|
73728
|
+
"untrustedFields": [
|
|
73729
|
+
"bin",
|
|
73730
|
+
"referenceNumber"
|
|
73731
|
+
],
|
|
73732
|
+
"accountWide": true
|
|
73733
|
+
},
|
|
73734
|
+
"compact": null,
|
|
73735
|
+
"status": "tested"
|
|
73736
|
+
},
|
|
73190
73737
|
{
|
|
73191
73738
|
"id": "inventory_locations.count",
|
|
73192
73739
|
"resource": "inventory_locations",
|
|
@@ -73286,7 +73833,7 @@ const CAPABILITY_DATA = {
|
|
|
73286
73833
|
"preset": "retry-c5657094"
|
|
73287
73834
|
},
|
|
73288
73835
|
"errors": {
|
|
73289
|
-
"set":
|
|
73836
|
+
"set": 19
|
|
73290
73837
|
},
|
|
73291
73838
|
"metadata": {
|
|
73292
73839
|
"purpose": "Create an inventory location.",
|
|
@@ -73612,7 +74159,7 @@ const CAPABILITY_DATA = {
|
|
|
73612
74159
|
"preset": "retry-ffb3a9cb"
|
|
73613
74160
|
},
|
|
73614
74161
|
"errors": {
|
|
73615
|
-
"set":
|
|
74162
|
+
"set": 20
|
|
73616
74163
|
},
|
|
73617
74164
|
"metadata": {
|
|
73618
74165
|
"purpose": "Query InventoryLocation records with a JSON filter.",
|
|
@@ -73671,7 +74218,7 @@ const CAPABILITY_DATA = {
|
|
|
73671
74218
|
"preset": "retry-c5657094"
|
|
73672
74219
|
},
|
|
73673
74220
|
"errors": {
|
|
73674
|
-
"set":
|
|
74221
|
+
"set": 21
|
|
73675
74222
|
},
|
|
73676
74223
|
"metadata": {
|
|
73677
74224
|
"purpose": "Update an inventory location.",
|
|
@@ -82492,7 +83039,7 @@ const CAPABILITY_DATA = {
|
|
|
82492
83039
|
"preset": "retry-c5657094"
|
|
82493
83040
|
},
|
|
82494
83041
|
"errors": {
|
|
82495
|
-
"set":
|
|
83042
|
+
"set": 19
|
|
82496
83043
|
},
|
|
82497
83044
|
"metadata": {
|
|
82498
83045
|
"purpose": "Create an attachment under a task.",
|
|
@@ -82564,7 +83111,7 @@ const CAPABILITY_DATA = {
|
|
|
82564
83111
|
"preset": "retry-1849870d"
|
|
82565
83112
|
},
|
|
82566
83113
|
"errors": {
|
|
82567
|
-
"set":
|
|
83114
|
+
"set": 22
|
|
82568
83115
|
},
|
|
82569
83116
|
"metadata": {
|
|
82570
83117
|
"purpose": "Delete an attachment under a task.",
|
|
@@ -82835,7 +83382,7 @@ const CAPABILITY_DATA = {
|
|
|
82835
83382
|
"preset": "retry-ffb3a9cb"
|
|
82836
83383
|
},
|
|
82837
83384
|
"errors": {
|
|
82838
|
-
"set":
|
|
83385
|
+
"set": 20
|
|
82839
83386
|
},
|
|
82840
83387
|
"metadata": {
|
|
82841
83388
|
"purpose": "Query TaskAttachment records with a JSON filter.",
|
|
@@ -91603,7 +92150,7 @@ const CAPABILITY_DATA = {
|
|
|
91603
92150
|
"preset": "retry-6980a375"
|
|
91604
92151
|
},
|
|
91605
92152
|
"errors": {
|
|
91606
|
-
"set":
|
|
92153
|
+
"set": 23
|
|
91607
92154
|
},
|
|
91608
92155
|
"metadata": {
|
|
91609
92156
|
"purpose": "Move a ticket to a target status in ONE op — the node validates targetStatus against the tenant's LIVE status picklist (entity metadata; vendor rejection is the fallback when the metadata is unavailable) + the live-discovered per-status required-field map and fills the proven-safe defaults itself (the vendor 500s when a target status has unsatisfied field requirements; the MCP LLM has no way to know the map).",
|
|
@@ -92008,7 +92555,7 @@ const CAPABILITY_DATA = {
|
|
|
92008
92555
|
"preset": "retry-ffb3a9cb"
|
|
92009
92556
|
},
|
|
92010
92557
|
"errors": {
|
|
92011
|
-
"set":
|
|
92558
|
+
"set": 24
|
|
92012
92559
|
},
|
|
92013
92560
|
"metadata": {
|
|
92014
92561
|
"purpose": "List the tickets a resource is assigned to — as primary owner, as a secondary resource, or both — de-duplicated, with the four reconciling counts and an optional open-only filter that uses the tenant's own closed-status set.",
|
|
@@ -93198,7 +93745,7 @@ const CAPABILITY_DATA = {
|
|
|
93198
93745
|
"preset": "retry-ffb3a9cb"
|
|
93199
93746
|
},
|
|
93200
93747
|
"errors": {
|
|
93201
|
-
"set":
|
|
93748
|
+
"set": 25
|
|
93202
93749
|
},
|
|
93203
93750
|
"metadata": {
|
|
93204
93751
|
"purpose": "Report the ticket status picklist and the ids this SDK treats as CLOSED for the caller's tenant, with the provenance of that set (read from the tenant's picklist, or the documented assumed fallback).",
|
|
@@ -93557,8 +94104,8 @@ const CAPABILITY_DATA = {
|
|
|
93557
94104
|
]
|
|
93558
94105
|
},
|
|
93559
94106
|
"operations": {
|
|
93560
|
-
"planHash": "
|
|
93561
|
-
"builtAt": "2026-11-
|
|
94107
|
+
"planHash": "21e75d0f8bf9986b21c6b7996dfb1fec78b3aaa9afa86f50f5351c54c733d4ac",
|
|
94108
|
+
"builtAt": "2026-11-21T07:49:35.531Z",
|
|
93562
94109
|
"records": [
|
|
93563
94110
|
{
|
|
93564
94111
|
"id": "operations.aggregate",
|
|
@@ -93641,7 +94188,7 @@ const CAPABILITY_DATA = {
|
|
|
93641
94188
|
"preset": "retry-ffb3a9cb"
|
|
93642
94189
|
},
|
|
93643
94190
|
"errors": {
|
|
93644
|
-
"set":
|
|
94191
|
+
"set": 26
|
|
93645
94192
|
},
|
|
93646
94193
|
"metadata": {
|
|
93647
94194
|
"purpose": "Fold any query surface into groups/sums/totals in one bounded call — or count it with the vendor count endpoint when no folding is needed — with blind-surface and truncation honesty (caps documented: the walk scans at most 2500 rows and top keeps at most 100 groups — a truncated aggregate is a PARTIAL answer, never a tenant-wide total); date fields bucket via the closed groupBy suffix <field>@month | @week | @year (ISO labels, UTC-anchored). Use it for totals, sums, counts and hours per ticket, resource, company, contract or month (group by any field), e.g. time entries hours grouped by ticket and resource",
|
|
@@ -93852,7 +94399,7 @@ const CAPABILITY_DATA = {
|
|
|
93852
94399
|
"preset": "retry-ffb3a9cb"
|
|
93853
94400
|
},
|
|
93854
94401
|
"errors": {
|
|
93855
|
-
"set":
|
|
94402
|
+
"set": 27
|
|
93856
94403
|
},
|
|
93857
94404
|
"metadata": {
|
|
93858
94405
|
"purpose": "Accounts-receivable aging at a point in time, in one budgeted call: open invoices per company bucketed by days past due (current, 1-30, 31-60, 61-90, over 90, no due date), with totals per currency.",
|
|
@@ -93918,7 +94465,7 @@ const CAPABILITY_DATA = {
|
|
|
93918
94465
|
"preset": "retry-ffb3a9cb"
|
|
93919
94466
|
},
|
|
93920
94467
|
"errors": {
|
|
93921
|
-
"set":
|
|
94468
|
+
"set": 28
|
|
93922
94469
|
},
|
|
93923
94470
|
"metadata": {
|
|
93924
94471
|
"purpose": "Read static creation requirements, prior validation findings and unproven input guidance. This is not a live test of current-tenant capability, inventory or permissions.",
|
|
@@ -94244,7 +94791,7 @@ const CAPABILITY_DATA = {
|
|
|
94244
94791
|
"preset": "retry-ffb3a9cb"
|
|
94245
94792
|
},
|
|
94246
94793
|
"errors": {
|
|
94247
|
-
"set":
|
|
94794
|
+
"set": 29
|
|
94248
94795
|
},
|
|
94249
94796
|
"metadata": {
|
|
94250
94797
|
"purpose": "Fetch the LIVE vendor field catalog for the named resources in one bounded read call: which fields exist, which are required, types, maxLength, read-only, queryable, picklist-ness — the on-demand refresh for the point-in-time pins (operations.createGuidance, the zoneFacts) when the vendor has moved since they were verified. The wire cost (resources × include) is refused pre-request above the cap, never truncated; with the opt-in fieldCache configured, repeat reads inside the TTL cost no wire. It reports picklist-ness as a flag (isPickList) and picklist field NAMES (picklistFields); with the opt-in labels: true the projected picklist rows carry the vendor's exposed picklist VALUES (labels next to each value), and without it the op serves no VALUES. A picklist VALUE the vendor does not expose to this API user is not resolvable from this catalog.",
|
|
@@ -94341,7 +94888,7 @@ const CAPABILITY_DATA = {
|
|
|
94341
94888
|
"preset": "retry-ffb3a9cb"
|
|
94342
94889
|
},
|
|
94343
94890
|
"errors": {
|
|
94344
|
-
"set":
|
|
94891
|
+
"set": 27
|
|
94345
94892
|
},
|
|
94346
94893
|
"metadata": {
|
|
94347
94894
|
"purpose": "Non-chargeable work in one budgeted call: non-billable and contract-covered billing items (value, labour hours, lines) per company, contract or contract type, posted or invoiced or not.",
|
|
@@ -94458,7 +95005,7 @@ const CAPABILITY_DATA = {
|
|
|
94458
95005
|
"preset": "retry-ffb3a9cb"
|
|
94459
95006
|
},
|
|
94460
95007
|
"errors": {
|
|
94461
|
-
"set":
|
|
95008
|
+
"set": 30
|
|
94462
95009
|
},
|
|
94463
95010
|
"metadata": {
|
|
94464
95011
|
"purpose": "Contract profit and margin grouped by contract, company, contract type, vertical or month over a window, in one budgeted call: a contracts.profitability fan-out with totals and per-contract coverage gaps.",
|
|
@@ -94548,7 +95095,7 @@ const CAPABILITY_DATA = {
|
|
|
94548
95095
|
"preset": "retry-ffb3a9cb"
|
|
94549
95096
|
},
|
|
94550
95097
|
"errors": {
|
|
94551
|
-
"set":
|
|
95098
|
+
"set": 27
|
|
94552
95099
|
},
|
|
94553
95100
|
"metadata": {
|
|
94554
95101
|
"purpose": "Monthly recurring revenue at a point in time per company, in one budgeted call: contract services, subscriptions and the month's contract charges (usage billing, counted as recurring revenue) reported apart, plus the contracts ending soon.",
|
|
@@ -94603,7 +95150,7 @@ const CAPABILITY_DATA = {
|
|
|
94603
95150
|
"preset": "retry-ffb3a9cb"
|
|
94604
95151
|
},
|
|
94605
95152
|
"errors": {
|
|
94606
|
-
"set":
|
|
95153
|
+
"set": 28
|
|
94607
95154
|
},
|
|
94608
95155
|
"metadata": {
|
|
94609
95156
|
"purpose": "Describe a resource’s SDK-covered parent/child operations, lookup keys and static create guidance without a vendor call. Current-user visibility and tenant inventory require live reads.",
|
|
@@ -95023,7 +95570,7 @@ const CAPABILITY_DATA = {
|
|
|
95023
95570
|
"preset": "retry-ffb3a9cb"
|
|
95024
95571
|
},
|
|
95025
95572
|
"errors": {
|
|
95026
|
-
"set":
|
|
95573
|
+
"set": 27
|
|
95027
95574
|
},
|
|
95028
95575
|
"metadata": {
|
|
95029
95576
|
"purpose": "Total revenue grouped by account vertical, contract type, company, contract, month or line of business over an invoice-date window, in one budgeted call with totals, excluded buckets, a reconciliation and optional non-chargeable work.",
|
|
@@ -95083,7 +95630,7 @@ const CAPABILITY_DATA = {
|
|
|
95083
95630
|
"preset": "retry-ffb3a9cb"
|
|
95084
95631
|
},
|
|
95085
95632
|
"errors": {
|
|
95086
|
-
"set":
|
|
95633
|
+
"set": 31
|
|
95087
95634
|
},
|
|
95088
95635
|
"metadata": {
|
|
95089
95636
|
"purpose": "Fence the vendor free text of a raw SDK read result in the untrusted-content markers, using the operation's own registry record as the field authority.",
|
|
@@ -95359,7 +95906,7 @@ const CAPABILITY_DATA = {
|
|
|
95359
95906
|
"preset": "retry-ffb3a9cb"
|
|
95360
95907
|
},
|
|
95361
95908
|
"errors": {
|
|
95362
|
-
"set":
|
|
95909
|
+
"set": 31
|
|
95363
95910
|
},
|
|
95364
95911
|
"metadata": {
|
|
95365
95912
|
"purpose": "Build a clickable Autotask UI deep link for a record in one ZERO-wire call, e.g. for the time entry or ticket a response is about.",
|
|
@@ -95450,7 +95997,7 @@ const CAPABILITY_DATA = {
|
|
|
95450
95997
|
"preset": "retry-ffb3a9cb"
|
|
95451
95998
|
},
|
|
95452
95999
|
"errors": {
|
|
95453
|
-
"set":
|
|
96000
|
+
"set": 32
|
|
95454
96001
|
},
|
|
95455
96002
|
"metadata": {
|
|
95456
96003
|
"purpose": "Work in progress in one budgeted call: billable time entries no billing item references yet (unposted), in hours, per company, resource or contract type, split approved / unapproved where the tenant records approval.",
|