node-autotask 0.89.0 → 0.91.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.
Files changed (39) hide show
  1. package/CHANGELOG.md +10 -0
  2. package/MCP_TOOL_CATALOG.json +217 -9
  3. package/README.md +1 -1
  4. package/capabilities.json +873 -53
  5. package/dist/capabilities-data.js +872 -52
  6. package/dist/capabilities.cjs +4 -4
  7. package/dist/capabilities.js +1 -1
  8. package/dist/{chunk-OVIYLMGB.js → chunk-2GP7W6QB.js} +113 -12
  9. package/dist/{chunk-ZADTVF6M.js → chunk-43ADHLZJ.js} +3 -3
  10. package/dist/{chunk-4MPQ5CDB.cjs → chunk-5PUHGPKG.cjs} +200 -200
  11. package/dist/{chunk-SHJ7EOBW.cjs → chunk-KRYDLTY3.cjs} +3 -3
  12. package/dist/{chunk-YAXEPESA.cjs → chunk-RXXITZH4.cjs} +118 -17
  13. package/dist/{chunk-4EIN7AZJ.js → chunk-WAHRZDV4.js} +2 -2
  14. package/dist/{chunk-2PWAWWWM.js → chunk-Y2KXGSWM.js} +4 -2
  15. package/dist/{chunk-BRU7TZOD.cjs → chunk-YFC5VAKK.cjs} +32 -30
  16. package/dist/{index-CoTtEn8U.d.cts → index-BfGOllfY.d.cts} +4 -2
  17. package/dist/{index-Wh6bLfv_.d.ts → index-C3jXvpXZ.d.ts} +4 -2
  18. package/dist/{index-4jmitXBs.d.cts → index-Dy92Xbpv.d.cts} +75 -1
  19. package/dist/{index-4jmitXBs.d.ts → index-Dy92Xbpv.d.ts} +75 -1
  20. package/dist/index.cjs +85 -85
  21. package/dist/index.d.cts +3 -3
  22. package/dist/index.d.ts +3 -3
  23. package/dist/index.js +5 -5
  24. package/dist/operations/index.cjs +51 -51
  25. package/dist/operations/index.d.cts +4 -4
  26. package/dist/operations/index.d.ts +4 -4
  27. package/dist/operations/index.js +2 -2
  28. package/dist/pool.cjs +12 -12
  29. package/dist/pool.d.cts +1 -1
  30. package/dist/pool.d.ts +1 -1
  31. package/dist/pool.js +4 -4
  32. package/dist/resources/index.cjs +27 -27
  33. package/dist/resources/index.d.cts +2 -2
  34. package/dist/resources/index.d.ts +2 -2
  35. package/dist/resources/index.js +3 -3
  36. package/dist/types/index.d.cts +1 -1
  37. package/dist/types/index.d.ts +1 -1
  38. package/docs/API.md +4 -2
  39. package/package.json +1 -1
@@ -162,6 +162,36 @@ const CAPABILITY_DATA = {
162
162
  "RESPONSE_REJECTED",
163
163
  "QUERY_TOO_LONG"
164
164
  ],
165
+ [
166
+ "BAD_REQUEST",
167
+ "CONFIG_ERROR",
168
+ "NETWORK_ERROR",
169
+ "UNAUTHORIZED",
170
+ "FORBIDDEN",
171
+ "RATE_LIMITED",
172
+ "TIMEOUT",
173
+ "SERVER_ERROR",
174
+ "INVALID_RESPONSE",
175
+ "ABORTED",
176
+ "RESPONSE_TOO_LARGE",
177
+ "REDIRECT_BLOCKED"
178
+ ],
179
+ [
180
+ "BAD_REQUEST",
181
+ "CONFIG_ERROR",
182
+ "NETWORK_ERROR",
183
+ "UNAUTHORIZED",
184
+ "FORBIDDEN",
185
+ "RATE_LIMITED",
186
+ "TIMEOUT",
187
+ "SERVER_ERROR",
188
+ "INVALID_RESPONSE",
189
+ "ABORTED",
190
+ "RESPONSE_TOO_LARGE",
191
+ "REDIRECT_BLOCKED",
192
+ "RESPONSE_REJECTED",
193
+ "SCOPE_REQUIRED"
194
+ ],
165
195
  [
166
196
  "BAD_REQUEST",
167
197
  "CONFIG_ERROR",
@@ -462,8 +492,8 @@ const CAPABILITY_DATA = {
462
492
  ],
463
493
  "groups": {
464
494
  "B": {
465
- "planHash": "911f1470a0ebbe66c39579e8d26d97253914f4fecfe3b8d69ee61bd1710be132",
466
- "builtAt": "2026-11-20T22:03:19.289Z",
495
+ "planHash": "fe0c9ce6a957bb730c1bdb9fb46498e61e2d04cc1cdd861d796ac26f982ab505",
496
+ "builtAt": "2026-11-21T05:09:04.076Z",
467
497
  "records": [
468
498
  {
469
499
  "id": "appointments.count",
@@ -17237,6 +17267,401 @@ const CAPABILITY_DATA = {
17237
17267
  "compact": null,
17238
17268
  "status": "tested"
17239
17269
  },
17270
+ {
17271
+ "id": "internal_locations.count",
17272
+ "resource": "internal_locations",
17273
+ "udfCapable": false,
17274
+ "operation": "count",
17275
+ "kind": "primitive",
17276
+ "endpoint": "POST /V1.0/InternalLocations/query/count",
17277
+ "effect": "read",
17278
+ "flags": [],
17279
+ "dryRun": false,
17280
+ "envelope": "QueryCountResultModel",
17281
+ "inputSchema": {
17282
+ "params": {
17283
+ "type": "object",
17284
+ "required": false,
17285
+ "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.",
17286
+ "properties": [
17287
+ {
17288
+ "name": "filter",
17289
+ "type": "FilterCondition[]",
17290
+ "optional": true
17291
+ },
17292
+ {
17293
+ "name": "fieldCheck",
17294
+ "type": "boolean",
17295
+ "optional": true
17296
+ }
17297
+ ]
17298
+ }
17299
+ },
17300
+ "inputSchemaStrict": true,
17301
+ "outputSchema": {
17302
+ "type": "QueryCountResultModel",
17303
+ "drops": []
17304
+ },
17305
+ "examples": [
17306
+ "await invoke(client, 'internal_locations.count', [{ filter: [{ field: 'id', op: 'eq', value: 1 }] }])"
17307
+ ],
17308
+ "permissions": "unknown",
17309
+ "pagination": {
17310
+ "mode": "none"
17311
+ },
17312
+ "resolution": null,
17313
+ "retry": {
17314
+ "preset": "retry-ffb3a9cb"
17315
+ },
17316
+ "errors": {
17317
+ "set": 8
17318
+ },
17319
+ "metadata": {
17320
+ "purpose": "Count internal location records matching a JSON filter.",
17321
+ "usage": "Unwraps queryCount; returns a plain number. Read-only internal location view configured in Admin Company Setup, distinct from CompanySiteConfigurations and InternalLocationWithBusinessHours; no create, update, delete or UDF writes, and no automatic write routing to another entity. timeZone returns a Microsoft Time Zone Index value. Country queries match the country display label; for a custom country mapped to Other, filter country with the literal Other rather than the custom text returned in the record. Visibility depends on API-user permissions and tenant data; an empty query does not prove absence. Enable redactPersonalData to mask the SDK personal-data field set.",
17322
+ "preferredWhen": null,
17323
+ "related": [
17324
+ "internal_locations.query"
17325
+ ],
17326
+ "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 / 1 UDF / 8000 chars.",
17327
+ "untrustedFields": [
17328
+ "additionalAddressInfo",
17329
+ "country",
17330
+ "name",
17331
+ "timeZone"
17332
+ ]
17333
+ },
17334
+ "compact": null,
17335
+ "status": "tested"
17336
+ },
17337
+ {
17338
+ "id": "internal_locations.get",
17339
+ "resource": "internal_locations",
17340
+ "udfCapable": false,
17341
+ "operation": "get",
17342
+ "kind": "primitive",
17343
+ "endpoint": "GET /V1.0/InternalLocations/{id}",
17344
+ "effect": "read",
17345
+ "flags": [],
17346
+ "dryRun": false,
17347
+ "envelope": "ItemQueryResultModel[InternalLocationModel,InternalLocation]",
17348
+ "inputSchema": {
17349
+ "id": {
17350
+ "type": "string | number",
17351
+ "required": true,
17352
+ "description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
17353
+ },
17354
+ "opts": {
17355
+ "type": "object",
17356
+ "required": false,
17357
+ "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.",
17358
+ "properties": [
17359
+ {
17360
+ "name": "fresh",
17361
+ "type": "boolean",
17362
+ "optional": true
17363
+ }
17364
+ ]
17365
+ }
17366
+ },
17367
+ "inputSchemaStrict": true,
17368
+ "outputSchema": {
17369
+ "type": "ItemQueryResultModel[InternalLocationModel,InternalLocation]",
17370
+ "drops": []
17371
+ },
17372
+ "examples": [
17373
+ "await invoke(client, 'internal_locations.get', [3])"
17374
+ ],
17375
+ "permissions": "unknown",
17376
+ "pagination": {
17377
+ "mode": "none"
17378
+ },
17379
+ "resolution": null,
17380
+ "retry": {
17381
+ "preset": "retry-ffb3a9cb"
17382
+ },
17383
+ "errors": {
17384
+ "set": 3
17385
+ },
17386
+ "metadata": {
17387
+ "purpose": "Get one InternalLocation by id.",
17388
+ "usage": "Returns item from the standard item envelope; item: null is a typed not-found. Read-only internal location view configured in Admin Company Setup, distinct from CompanySiteConfigurations and InternalLocationWithBusinessHours; no create, update, delete or UDF writes, and no automatic write routing to another entity. timeZone returns a Microsoft Time Zone Index value. Country queries match the country display label; for a custom country mapped to Other, filter country with the literal Other rather than the custom text returned in the record. Visibility depends on API-user permissions and tenant data; an empty query does not prove absence. Enable redactPersonalData to mask the SDK personal-data field set.",
17389
+ "preferredWhen": "Use a known internal location id; use internal_locations.query for bounded discovery.",
17390
+ "related": [
17391
+ "internal_locations.query"
17392
+ ],
17393
+ "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 internal_locations.query with includeFields.",
17394
+ "untrustedFields": [
17395
+ "additionalAddressInfo",
17396
+ "country",
17397
+ "name",
17398
+ "timeZone"
17399
+ ]
17400
+ },
17401
+ "compact": null,
17402
+ "status": "tested"
17403
+ },
17404
+ {
17405
+ "id": "internal_locations.getEntityInfo",
17406
+ "resource": "internal_locations",
17407
+ "udfCapable": false,
17408
+ "operation": "getEntityInfo",
17409
+ "kind": "primitive",
17410
+ "endpoint": "GET /V1.0/InternalLocations/entityInformation",
17411
+ "effect": "read",
17412
+ "flags": [],
17413
+ "dryRun": false,
17414
+ "envelope": "EntityInformationResultModel",
17415
+ "inputSchema": {},
17416
+ "inputSchemaStrict": true,
17417
+ "outputSchema": {
17418
+ "type": "EntityInformationResultModel",
17419
+ "drops": []
17420
+ },
17421
+ "examples": [
17422
+ "await client.internalLocations.getEntityInfo()"
17423
+ ],
17424
+ "permissions": "unknown",
17425
+ "pagination": {
17426
+ "mode": "none"
17427
+ },
17428
+ "resolution": null,
17429
+ "retry": {
17430
+ "preset": "retry-ffb3a9cb"
17431
+ },
17432
+ "errors": {
17433
+ "set": 8
17434
+ },
17435
+ "metadata": {
17436
+ "purpose": "Get the InternalLocation capability metadata (canCreate/canUpdate/hasUserDefinedFields/...).",
17437
+ "usage": "Unwraps info{}; drives client-side capability checks. Read-only internal location view configured in Admin Company Setup, distinct from CompanySiteConfigurations and InternalLocationWithBusinessHours; no create, update, delete or UDF writes, and no automatic write routing to another entity. timeZone returns a Microsoft Time Zone Index value. Country queries match the country display label; for a custom country mapped to Other, filter country with the literal Other rather than the custom text returned in the record. Visibility depends on API-user permissions and tenant data; an empty query does not prove absence. Enable redactPersonalData to mask the SDK personal-data field set.",
17438
+ "preferredWhen": null,
17439
+ "related": [
17440
+ "internal_locations.getFieldInfo"
17441
+ ],
17442
+ "untrustedFields": [
17443
+ "additionalAddressInfo",
17444
+ "country",
17445
+ "name",
17446
+ "timeZone"
17447
+ ]
17448
+ },
17449
+ "compact": null,
17450
+ "status": "tested"
17451
+ },
17452
+ {
17453
+ "id": "internal_locations.getFieldInfo",
17454
+ "resource": "internal_locations",
17455
+ "udfCapable": false,
17456
+ "operation": "getFieldInfo",
17457
+ "kind": "primitive",
17458
+ "endpoint": "GET /V1.0/InternalLocations/entityInformation/fields",
17459
+ "effect": "read",
17460
+ "flags": [],
17461
+ "dryRun": false,
17462
+ "envelope": "FieldInformationResultModel",
17463
+ "inputSchema": {},
17464
+ "inputSchemaStrict": true,
17465
+ "outputSchema": {
17466
+ "type": "FieldInformationResultModel",
17467
+ "drops": []
17468
+ },
17469
+ "examples": [
17470
+ "await client.internalLocations.getFieldInfo()"
17471
+ ],
17472
+ "permissions": "unknown",
17473
+ "pagination": {
17474
+ "mode": "none"
17475
+ },
17476
+ "resolution": null,
17477
+ "retry": {
17478
+ "preset": "retry-ffb3a9cb"
17479
+ },
17480
+ "errors": {
17481
+ "set": 8
17482
+ },
17483
+ "metadata": {
17484
+ "purpose": "Get the InternalLocation field catalog (types, picklists, required, maxLength) — the full raw field dump (the largest read of the info trio; compact discovery: operations.fieldCatalog).",
17485
+ "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.",
17486
+ "preferredWhen": "Read-only internal location view configured in Admin Company Setup, distinct from CompanySiteConfigurations and InternalLocationWithBusinessHours; no create, update, delete or UDF writes, and no automatic write routing to another entity. timeZone returns a Microsoft Time Zone Index value. Country queries match the country display label; for a custom country mapped to Other, filter country with the literal Other rather than the custom text returned in the record. Visibility depends on API-user permissions and tenant data; an empty query does not prove absence. Enable redactPersonalData to mask the SDK personal-data field set.",
17487
+ "related": [
17488
+ "internal_locations.getEntityInfo",
17489
+ "internal_locations.getUdfInfo"
17490
+ ],
17491
+ "untrustedFields": [
17492
+ "additionalAddressInfo",
17493
+ "country",
17494
+ "name",
17495
+ "timeZone"
17496
+ ]
17497
+ },
17498
+ "compact": null,
17499
+ "status": "tested"
17500
+ },
17501
+ {
17502
+ "id": "internal_locations.getUdfInfo",
17503
+ "resource": "internal_locations",
17504
+ "udfCapable": false,
17505
+ "operation": "getUdfInfo",
17506
+ "kind": "primitive",
17507
+ "endpoint": "GET /V1.0/InternalLocations/entityInformation/userDefinedFields",
17508
+ "effect": "read",
17509
+ "flags": [],
17510
+ "dryRun": false,
17511
+ "envelope": "UserDefinedFieldInformationResultModel",
17512
+ "inputSchema": {},
17513
+ "inputSchemaStrict": true,
17514
+ "outputSchema": {
17515
+ "type": "UserDefinedFieldInformationResultModel",
17516
+ "drops": []
17517
+ },
17518
+ "examples": [
17519
+ "await client.internalLocations.getUdfInfo()"
17520
+ ],
17521
+ "permissions": "unknown",
17522
+ "pagination": {
17523
+ "mode": "none"
17524
+ },
17525
+ "resolution": null,
17526
+ "retry": {
17527
+ "preset": "retry-ffb3a9cb"
17528
+ },
17529
+ "errors": {
17530
+ "set": 8
17531
+ },
17532
+ "metadata": {
17533
+ "purpose": "Get the InternalLocation user-defined-field catalog.",
17534
+ "usage": "Unwraps fields[]; only meaningful where the entity is UDF-capable. (entity is not UDF-capable; catalog is expected empty). Read-only internal location view configured in Admin Company Setup, distinct from CompanySiteConfigurations and InternalLocationWithBusinessHours; no create, update, delete or UDF writes, and no automatic write routing to another entity. timeZone returns a Microsoft Time Zone Index value. Country queries match the country display label; for a custom country mapped to Other, filter country with the literal Other rather than the custom text returned in the record. Visibility depends on API-user permissions and tenant data; an empty query does not prove absence. Enable redactPersonalData to mask the SDK personal-data field set.",
17535
+ "preferredWhen": null,
17536
+ "related": [
17537
+ "internal_locations.getFieldInfo"
17538
+ ],
17539
+ "untrustedFields": [
17540
+ "additionalAddressInfo",
17541
+ "country",
17542
+ "name",
17543
+ "timeZone"
17544
+ ]
17545
+ },
17546
+ "compact": null,
17547
+ "status": "tested"
17548
+ },
17549
+ {
17550
+ "id": "internal_locations.query",
17551
+ "resource": "internal_locations",
17552
+ "udfCapable": false,
17553
+ "operation": "query",
17554
+ "kind": "primitive",
17555
+ "endpoint": "GET|POST /V1.0/InternalLocations/query",
17556
+ "effect": "read",
17557
+ "flags": [],
17558
+ "dryRun": false,
17559
+ "envelope": "QueryActionResult[InternalLocationModel,InternalLocation]",
17560
+ "inputSchema": {
17561
+ "params": {
17562
+ "type": "object",
17563
+ "required": false,
17564
+ "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); the one udf:true condition per query is exempt (a tenant UDF name is absent from the vendored spec by definition); 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 / 1 UDF / 8000 chars.",
17565
+ "properties": [
17566
+ {
17567
+ "name": "filter",
17568
+ "type": "FilterCondition[]",
17569
+ "optional": true
17570
+ },
17571
+ {
17572
+ "name": "limit",
17573
+ "type": "number",
17574
+ "optional": true,
17575
+ "default": 500
17576
+ },
17577
+ {
17578
+ "name": "latest",
17579
+ "type": "number",
17580
+ "optional": true
17581
+ },
17582
+ {
17583
+ "name": "noteChars",
17584
+ "type": "number",
17585
+ "optional": true
17586
+ },
17587
+ {
17588
+ "name": "includeFields",
17589
+ "type": "string[]",
17590
+ "optional": true
17591
+ },
17592
+ {
17593
+ "name": "fieldCheck",
17594
+ "type": "boolean",
17595
+ "optional": true,
17596
+ "default": true
17597
+ },
17598
+ {
17599
+ "name": "names",
17600
+ "type": "boolean",
17601
+ "optional": true
17602
+ },
17603
+ {
17604
+ "name": "via",
17605
+ "type": "\"post\" | \"get\"",
17606
+ "optional": true
17607
+ },
17608
+ {
17609
+ "name": "acknowledgeUnscoped",
17610
+ "type": "boolean",
17611
+ "optional": true
17612
+ },
17613
+ {
17614
+ "name": "walk",
17615
+ "type": "object",
17616
+ "optional": true
17617
+ }
17618
+ ]
17619
+ }
17620
+ },
17621
+ "inputSchemaStrict": true,
17622
+ "outputSchema": {
17623
+ "type": "QueryActionResult[InternalLocationModel,InternalLocation]",
17624
+ "drops": []
17625
+ },
17626
+ "examples": [
17627
+ "await invoke(client, 'internal_locations.query', [{ filter: [{ field: 'id', op: 'eq', value: 1 }], limit: 25 }])"
17628
+ ],
17629
+ "permissions": "unknown",
17630
+ "pagination": {
17631
+ "mode": "cursor",
17632
+ "vendorDefault": 10,
17633
+ "vendorMax": 500,
17634
+ "pageGuard": 1000,
17635
+ "queryBounded": {
17636
+ "default": 500,
17637
+ "max": 2500
17638
+ }
17639
+ },
17640
+ "resolution": null,
17641
+ "retry": {
17642
+ "preset": "retry-ffb3a9cb"
17643
+ },
17644
+ "errors": {
17645
+ "set": 9
17646
+ },
17647
+ "metadata": {
17648
+ "purpose": "Query InternalLocation records with a JSON filter.",
17649
+ "usage": "Server-side pagination: one call walks the vendor cursor internally and preserves the initial HTTP method until the limit is met or the cursor is null. By default, each POST carries the same QueryModel body (IncludeFields, MaxRecords and the original filter). The vendor honours IncludeFields on POST continuations and uses its own continuation page size. With `via: 'get'`, the SDK follows the GET cursor with the original search parameters. Cursors must stay on the configured origin; 1000-page guard (hasMore stays true at the guard). 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. Read-only internal location view configured in Admin Company Setup, distinct from CompanySiteConfigurations and InternalLocationWithBusinessHours; no create, update, delete or UDF writes, and no automatic write routing to another entity. timeZone returns a Microsoft Time Zone Index value. Country queries match the country display label; for a custom country mapped to Other, filter country with the literal Other rather than the custom text returned in the record. Visibility depends on API-user permissions and tenant data; an empty query does not prove absence. Enable redactPersonalData to mask the SDK personal-data field set.",
17650
+ "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).",
17651
+ "related": [
17652
+ "internal_locations.get"
17653
+ ],
17654
+ "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 / 1 UDF / 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.",
17655
+ "untrustedFields": [
17656
+ "additionalAddressInfo",
17657
+ "country",
17658
+ "name",
17659
+ "timeZone"
17660
+ ]
17661
+ },
17662
+ "compact": null,
17663
+ "status": "tested"
17664
+ },
17240
17665
  {
17241
17666
  "id": "inventory_products.count",
17242
17667
  "resource": "inventory_products",
@@ -18600,7 +19025,7 @@ const CAPABILITY_DATA = {
18600
19025
  "preset": "retry-1849870d"
18601
19026
  },
18602
19027
  "errors": {
18603
- "set": 8
19028
+ "set": 10
18604
19029
  },
18605
19030
  "metadata": {
18606
19031
  "purpose": "delete article root records.",
@@ -30100,7 +30525,7 @@ const CAPABILITY_DATA = {
30100
30525
  "preset": "retry-ffb3a9cb"
30101
30526
  },
30102
30527
  "errors": {
30103
- "set": 9
30528
+ "set": 11
30104
30529
  },
30105
30530
  "metadata": {
30106
30531
  "purpose": "Get a resource's workload in a single call: its open tickets (rows + the exact open totals), its task assignments and the tasks behind them, its time-off balances and requests.",
@@ -34306,7 +34731,7 @@ const CAPABILITY_DATA = {
34306
34731
  "preset": "retry-ffb3a9cb"
34307
34732
  },
34308
34733
  "errors": {
34309
- "set": 10
34734
+ "set": 12
34310
34735
  },
34311
34736
  "metadata": {
34312
34737
  "purpose": "Get a service call with its tickets, tasks and resource assignments in a single call — the assignment join runs through the call's task row ids (serviceCallTaskID).",
@@ -36068,6 +36493,389 @@ const CAPABILITY_DATA = {
36068
36493
  "compact": null,
36069
36494
  "status": "tested"
36070
36495
  },
36496
+ {
36497
+ "id": "shipping_types.count",
36498
+ "resource": "shipping_types",
36499
+ "udfCapable": false,
36500
+ "operation": "count",
36501
+ "kind": "primitive",
36502
+ "endpoint": "POST /V1.0/ShippingTypes/query/count",
36503
+ "effect": "read",
36504
+ "flags": [],
36505
+ "dryRun": false,
36506
+ "envelope": "QueryCountResultModel",
36507
+ "inputSchema": {
36508
+ "params": {
36509
+ "type": "object",
36510
+ "required": false,
36511
+ "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.",
36512
+ "properties": [
36513
+ {
36514
+ "name": "filter",
36515
+ "type": "FilterCondition[]",
36516
+ "optional": true
36517
+ },
36518
+ {
36519
+ "name": "fieldCheck",
36520
+ "type": "boolean",
36521
+ "optional": true
36522
+ }
36523
+ ]
36524
+ }
36525
+ },
36526
+ "inputSchemaStrict": true,
36527
+ "outputSchema": {
36528
+ "type": "QueryCountResultModel",
36529
+ "drops": []
36530
+ },
36531
+ "examples": [
36532
+ "await invoke(client, 'shipping_types.count', [{ filter: [{ field: 'id', op: 'eq', value: 1 }] }])"
36533
+ ],
36534
+ "permissions": "unknown",
36535
+ "pagination": {
36536
+ "mode": "none"
36537
+ },
36538
+ "resolution": null,
36539
+ "retry": {
36540
+ "preset": "retry-ffb3a9cb"
36541
+ },
36542
+ "errors": {
36543
+ "set": 8
36544
+ },
36545
+ "metadata": {
36546
+ "purpose": "Count shipping type records matching a JSON filter.",
36547
+ "usage": "Unwraps queryCount; returns a plain number. Read-only shipping catalog configured in Admin and referenced by Quotes in CRM; no create, update, delete or UDF writes. Visibility depends on API-user permissions and tenant data; an empty query does not prove absence. The official field table labels billingCodeID as a ProjectCharges reference, but its name and that reference disagree; no new navigation contract is inferred. Discover authoritative field metadata with shipping_types.getFieldInfo before interpreting the reference.",
36548
+ "preferredWhen": null,
36549
+ "related": [
36550
+ "shipping_types.query"
36551
+ ],
36552
+ "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 / 1 UDF / 8000 chars.",
36553
+ "untrustedFields": [
36554
+ "description",
36555
+ "name"
36556
+ ]
36557
+ },
36558
+ "compact": null,
36559
+ "status": "tested"
36560
+ },
36561
+ {
36562
+ "id": "shipping_types.get",
36563
+ "resource": "shipping_types",
36564
+ "udfCapable": false,
36565
+ "operation": "get",
36566
+ "kind": "primitive",
36567
+ "endpoint": "GET /V1.0/ShippingTypes/{id}",
36568
+ "effect": "read",
36569
+ "flags": [],
36570
+ "dryRun": false,
36571
+ "envelope": "ItemQueryResultModel[ShippingTypeModel,ShippingType]",
36572
+ "inputSchema": {
36573
+ "id": {
36574
+ "type": "string | number",
36575
+ "required": true,
36576
+ "description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
36577
+ },
36578
+ "opts": {
36579
+ "type": "object",
36580
+ "required": false,
36581
+ "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.",
36582
+ "properties": [
36583
+ {
36584
+ "name": "fresh",
36585
+ "type": "boolean",
36586
+ "optional": true
36587
+ }
36588
+ ]
36589
+ }
36590
+ },
36591
+ "inputSchemaStrict": true,
36592
+ "outputSchema": {
36593
+ "type": "ItemQueryResultModel[ShippingTypeModel,ShippingType]",
36594
+ "drops": []
36595
+ },
36596
+ "examples": [
36597
+ "await invoke(client, 'shipping_types.get', [3])"
36598
+ ],
36599
+ "permissions": "unknown",
36600
+ "pagination": {
36601
+ "mode": "none"
36602
+ },
36603
+ "resolution": null,
36604
+ "retry": {
36605
+ "preset": "retry-ffb3a9cb"
36606
+ },
36607
+ "errors": {
36608
+ "set": 3
36609
+ },
36610
+ "metadata": {
36611
+ "purpose": "Get one ShippingType by id.",
36612
+ "usage": "Returns item from the standard item envelope; item: null is a typed not-found. Read-only shipping catalog configured in Admin and referenced by Quotes in CRM; no create, update, delete or UDF writes. Visibility depends on API-user permissions and tenant data; an empty query does not prove absence. The official field table labels billingCodeID as a ProjectCharges reference, but its name and that reference disagree; no new navigation contract is inferred. Discover authoritative field metadata with shipping_types.getFieldInfo before interpreting the reference.",
36613
+ "preferredWhen": "Use a known shipping type id; use shipping_types.query for bounded discovery.",
36614
+ "related": [
36615
+ "shipping_types.query"
36616
+ ],
36617
+ "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 a shipping_types.query with includeFields.",
36618
+ "untrustedFields": [
36619
+ "description",
36620
+ "name"
36621
+ ]
36622
+ },
36623
+ "compact": null,
36624
+ "status": "tested"
36625
+ },
36626
+ {
36627
+ "id": "shipping_types.getEntityInfo",
36628
+ "resource": "shipping_types",
36629
+ "udfCapable": false,
36630
+ "operation": "getEntityInfo",
36631
+ "kind": "primitive",
36632
+ "endpoint": "GET /V1.0/ShippingTypes/entityInformation",
36633
+ "effect": "read",
36634
+ "flags": [],
36635
+ "dryRun": false,
36636
+ "envelope": "EntityInformationResultModel",
36637
+ "inputSchema": {},
36638
+ "inputSchemaStrict": true,
36639
+ "outputSchema": {
36640
+ "type": "EntityInformationResultModel",
36641
+ "drops": []
36642
+ },
36643
+ "examples": [
36644
+ "await client.shippingTypes.getEntityInfo()"
36645
+ ],
36646
+ "permissions": "unknown",
36647
+ "pagination": {
36648
+ "mode": "none"
36649
+ },
36650
+ "resolution": null,
36651
+ "retry": {
36652
+ "preset": "retry-ffb3a9cb"
36653
+ },
36654
+ "errors": {
36655
+ "set": 8
36656
+ },
36657
+ "metadata": {
36658
+ "purpose": "Get the ShippingType capability metadata (canCreate/canUpdate/hasUserDefinedFields/...).",
36659
+ "usage": "Unwraps info{}; drives client-side capability checks. Read-only shipping catalog configured in Admin and referenced by Quotes in CRM; no create, update, delete or UDF writes. Visibility depends on API-user permissions and tenant data; an empty query does not prove absence. The official field table labels billingCodeID as a ProjectCharges reference, but its name and that reference disagree; no new navigation contract is inferred. Discover authoritative field metadata with shipping_types.getFieldInfo before interpreting the reference.",
36660
+ "preferredWhen": null,
36661
+ "related": [
36662
+ "shipping_types.getFieldInfo"
36663
+ ],
36664
+ "untrustedFields": [
36665
+ "description",
36666
+ "name"
36667
+ ]
36668
+ },
36669
+ "compact": null,
36670
+ "status": "tested"
36671
+ },
36672
+ {
36673
+ "id": "shipping_types.getFieldInfo",
36674
+ "resource": "shipping_types",
36675
+ "udfCapable": false,
36676
+ "operation": "getFieldInfo",
36677
+ "kind": "primitive",
36678
+ "endpoint": "GET /V1.0/ShippingTypes/entityInformation/fields",
36679
+ "effect": "read",
36680
+ "flags": [],
36681
+ "dryRun": false,
36682
+ "envelope": "FieldInformationResultModel",
36683
+ "inputSchema": {},
36684
+ "inputSchemaStrict": true,
36685
+ "outputSchema": {
36686
+ "type": "FieldInformationResultModel",
36687
+ "drops": []
36688
+ },
36689
+ "examples": [
36690
+ "await client.shippingTypes.getFieldInfo()"
36691
+ ],
36692
+ "permissions": "unknown",
36693
+ "pagination": {
36694
+ "mode": "none"
36695
+ },
36696
+ "resolution": null,
36697
+ "retry": {
36698
+ "preset": "retry-ffb3a9cb"
36699
+ },
36700
+ "errors": {
36701
+ "set": 8
36702
+ },
36703
+ "metadata": {
36704
+ "purpose": "Get the ShippingType field catalog (types, picklists, required, maxLength) — the full raw field dump (the largest read of the info trio; compact discovery: operations.fieldCatalog).",
36705
+ "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.",
36706
+ "preferredWhen": "Read-only shipping catalog configured in Admin and referenced by Quotes in CRM; no create, update, delete or UDF writes. Visibility depends on API-user permissions and tenant data; an empty query does not prove absence. The official field table labels billingCodeID as a ProjectCharges reference, but its name and that reference disagree; no new navigation contract is inferred. Discover authoritative field metadata with shipping_types.getFieldInfo before interpreting the reference.",
36707
+ "related": [
36708
+ "shipping_types.getEntityInfo",
36709
+ "shipping_types.getUdfInfo"
36710
+ ],
36711
+ "untrustedFields": [
36712
+ "description",
36713
+ "name"
36714
+ ]
36715
+ },
36716
+ "compact": null,
36717
+ "status": "tested"
36718
+ },
36719
+ {
36720
+ "id": "shipping_types.getUdfInfo",
36721
+ "resource": "shipping_types",
36722
+ "udfCapable": false,
36723
+ "operation": "getUdfInfo",
36724
+ "kind": "primitive",
36725
+ "endpoint": "GET /V1.0/ShippingTypes/entityInformation/userDefinedFields",
36726
+ "effect": "read",
36727
+ "flags": [],
36728
+ "dryRun": false,
36729
+ "envelope": "UserDefinedFieldInformationResultModel",
36730
+ "inputSchema": {},
36731
+ "inputSchemaStrict": true,
36732
+ "outputSchema": {
36733
+ "type": "UserDefinedFieldInformationResultModel",
36734
+ "drops": []
36735
+ },
36736
+ "examples": [
36737
+ "await client.shippingTypes.getUdfInfo()"
36738
+ ],
36739
+ "permissions": "unknown",
36740
+ "pagination": {
36741
+ "mode": "none"
36742
+ },
36743
+ "resolution": null,
36744
+ "retry": {
36745
+ "preset": "retry-ffb3a9cb"
36746
+ },
36747
+ "errors": {
36748
+ "set": 8
36749
+ },
36750
+ "metadata": {
36751
+ "purpose": "Get the ShippingType user-defined-field catalog.",
36752
+ "usage": "Unwraps fields[]; only meaningful where the entity is UDF-capable. (entity is not UDF-capable; catalog is expected empty). Read-only shipping catalog configured in Admin and referenced by Quotes in CRM; no create, update, delete or UDF writes. Visibility depends on API-user permissions and tenant data; an empty query does not prove absence. The official field table labels billingCodeID as a ProjectCharges reference, but its name and that reference disagree; no new navigation contract is inferred. Discover authoritative field metadata with shipping_types.getFieldInfo before interpreting the reference.",
36753
+ "preferredWhen": null,
36754
+ "related": [
36755
+ "shipping_types.getFieldInfo"
36756
+ ],
36757
+ "untrustedFields": [
36758
+ "description",
36759
+ "name"
36760
+ ]
36761
+ },
36762
+ "compact": null,
36763
+ "status": "tested"
36764
+ },
36765
+ {
36766
+ "id": "shipping_types.query",
36767
+ "resource": "shipping_types",
36768
+ "udfCapable": false,
36769
+ "operation": "query",
36770
+ "kind": "primitive",
36771
+ "endpoint": "GET|POST /V1.0/ShippingTypes/query",
36772
+ "effect": "read",
36773
+ "flags": [],
36774
+ "dryRun": false,
36775
+ "envelope": "QueryActionResult[ShippingTypeModel,ShippingType]",
36776
+ "inputSchema": {
36777
+ "params": {
36778
+ "type": "object",
36779
+ "required": false,
36780
+ "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); the one udf:true condition per query is exempt (a tenant UDF name is absent from the vendored spec by definition); 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 / 1 UDF / 8000 chars.",
36781
+ "properties": [
36782
+ {
36783
+ "name": "filter",
36784
+ "type": "FilterCondition[]",
36785
+ "optional": true
36786
+ },
36787
+ {
36788
+ "name": "limit",
36789
+ "type": "number",
36790
+ "optional": true,
36791
+ "default": 500
36792
+ },
36793
+ {
36794
+ "name": "latest",
36795
+ "type": "number",
36796
+ "optional": true
36797
+ },
36798
+ {
36799
+ "name": "noteChars",
36800
+ "type": "number",
36801
+ "optional": true
36802
+ },
36803
+ {
36804
+ "name": "includeFields",
36805
+ "type": "string[]",
36806
+ "optional": true
36807
+ },
36808
+ {
36809
+ "name": "fieldCheck",
36810
+ "type": "boolean",
36811
+ "optional": true,
36812
+ "default": true
36813
+ },
36814
+ {
36815
+ "name": "names",
36816
+ "type": "boolean",
36817
+ "optional": true
36818
+ },
36819
+ {
36820
+ "name": "via",
36821
+ "type": "\"post\" | \"get\"",
36822
+ "optional": true
36823
+ },
36824
+ {
36825
+ "name": "acknowledgeUnscoped",
36826
+ "type": "boolean",
36827
+ "optional": true
36828
+ },
36829
+ {
36830
+ "name": "walk",
36831
+ "type": "object",
36832
+ "optional": true
36833
+ }
36834
+ ]
36835
+ }
36836
+ },
36837
+ "inputSchemaStrict": true,
36838
+ "outputSchema": {
36839
+ "type": "QueryActionResult[ShippingTypeModel,ShippingType]",
36840
+ "drops": []
36841
+ },
36842
+ "examples": [
36843
+ "await invoke(client, 'shipping_types.query', [{ filter: [{ field: 'id', op: 'eq', value: 1 }], limit: 25 }])"
36844
+ ],
36845
+ "permissions": "unknown",
36846
+ "pagination": {
36847
+ "mode": "cursor",
36848
+ "vendorDefault": 10,
36849
+ "vendorMax": 500,
36850
+ "pageGuard": 1000,
36851
+ "queryBounded": {
36852
+ "default": 500,
36853
+ "max": 2500
36854
+ }
36855
+ },
36856
+ "resolution": null,
36857
+ "retry": {
36858
+ "preset": "retry-ffb3a9cb"
36859
+ },
36860
+ "errors": {
36861
+ "set": 9
36862
+ },
36863
+ "metadata": {
36864
+ "purpose": "Query ShippingType records with a JSON filter.",
36865
+ "usage": "Server-side pagination: one call walks the vendor cursor internally and preserves the initial HTTP method until the limit is met or the cursor is null. By default, each POST carries the same QueryModel body (IncludeFields, MaxRecords and the original filter). The vendor honours IncludeFields on POST continuations and uses its own continuation page size. With `via: 'get'`, the SDK follows the GET cursor with the original search parameters. Cursors must stay on the configured origin; 1000-page guard (hasMore stays true at the guard). 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. Read-only shipping catalog configured in Admin and referenced by Quotes in CRM; no create, update, delete or UDF writes. Visibility depends on API-user permissions and tenant data; an empty query does not prove absence. The official field table labels billingCodeID as a ProjectCharges reference, but its name and that reference disagree; no new navigation contract is inferred. Discover authoritative field metadata with shipping_types.getFieldInfo before interpreting the reference.",
36866
+ "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).",
36867
+ "related": [
36868
+ "shipping_types.get"
36869
+ ],
36870
+ "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 / 1 UDF / 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.",
36871
+ "untrustedFields": [
36872
+ "description",
36873
+ "name"
36874
+ ]
36875
+ },
36876
+ "compact": null,
36877
+ "status": "tested"
36878
+ },
36071
36879
  {
36072
36880
  "id": "skills.count",
36073
36881
  "resource": "skills",
@@ -43397,7 +44205,7 @@ const CAPABILITY_DATA = {
43397
44205
  "preset": "retry-ffb3a9cb"
43398
44206
  },
43399
44207
  "errors": {
43400
- "set": 11
44208
+ "set": 13
43401
44209
  },
43402
44210
  "metadata": {
43403
44211
  "purpose": "The ONE posted-state read: a bounded read over the inclusive dateWorked window [from, to] (UTC 'YYYY-MM-DD' days) with the posted/unposted split derived from the billing_items.timeEntryID join — never a postedDate read (the TimeEntry entity has no postedDate; postedDate exist|notExist 500s). Approval is NOT consulted (the vendor never populates billingApprovalDateTime yet bills those entries). The no-window form is gone: read with no dateWorked filter goes through time_entries.query.",
@@ -47063,8 +47871,8 @@ const CAPABILITY_DATA = {
47063
47871
  ]
47064
47872
  },
47065
47873
  "A": {
47066
- "planHash": "911f1470a0ebbe66c39579e8d26d97253914f4fecfe3b8d69ee61bd1710be132",
47067
- "builtAt": "2026-11-20T22:03:19.289Z",
47874
+ "planHash": "fe0c9ce6a957bb730c1bdb9fb46498e61e2d04cc1cdd861d796ac26f982ab505",
47875
+ "builtAt": "2026-11-21T05:09:04.076Z",
47068
47876
  "records": [
47069
47877
  {
47070
47878
  "id": "attachment_info.count",
@@ -47717,7 +48525,7 @@ const CAPABILITY_DATA = {
47717
48525
  "preset": "retry-ffb3a9cb"
47718
48526
  },
47719
48527
  "errors": {
47720
- "set": 12
48528
+ "set": 14
47721
48529
  },
47722
48530
  "metadata": {
47723
48531
  "purpose": "Get everything the node knows about one company in a single call: the company record, its locations, contacts and notes, its open tickets, and its projects — every part separately reported with caps.",
@@ -47906,7 +48714,7 @@ const CAPABILITY_DATA = {
47906
48714
  "preset": "retry-ffb3a9cb"
47907
48715
  },
47908
48716
  "errors": {
47909
- "set": 13
48717
+ "set": 15
47910
48718
  },
47911
48719
  "metadata": {
47912
48720
  "purpose": "Get a company with its primary context records in one call.",
@@ -48192,7 +49000,7 @@ const CAPABILITY_DATA = {
48192
49000
  "preset": "retry-ffb3a9cb"
48193
49001
  },
48194
49002
  "errors": {
48195
- "set": 13
49003
+ "set": 15
48196
49004
  },
48197
49005
  "metadata": {
48198
49006
  "purpose": "Plan a CRM write: from partial company/contact details, find the company, its locations and the location to link a contact to, duplicate contacts, the required fields still missing (with how to get each) and the next atomic write to preview.",
@@ -48946,7 +49754,7 @@ const CAPABILITY_DATA = {
48946
49754
  "preset": "retry-ffb3a9cb"
48947
49755
  },
48948
49756
  "errors": {
48949
- "set": 14
49757
+ "set": 16
48950
49758
  },
48951
49759
  "metadata": {
48952
49760
  "purpose": "One call for a company's unbilled work: its posted billing items (per source), the time behind them (joined through the company's tickets and tasks — time entries carry no companyID), the per-ticket rollup, the unposted anti-join section, ex-tax totals + hours, and the billing-vs-time warnings",
@@ -58252,7 +59060,7 @@ const CAPABILITY_DATA = {
58252
59060
  "preset": "retry-ffb3a9cb"
58253
59061
  },
58254
59062
  "errors": {
58255
- "set": 13
59063
+ "set": 15
58256
59064
  },
58257
59065
  "metadata": {
58258
59066
  "purpose": "Get a configuration item with its primary context records in one call.",
@@ -58645,7 +59453,7 @@ const CAPABILITY_DATA = {
58645
59453
  "preset": "retry-ffb3a9cb"
58646
59454
  },
58647
59455
  "errors": {
58648
- "set": 14
59456
+ "set": 16
58649
59457
  },
58650
59458
  "metadata": {
58651
59459
  "purpose": "Get the full profile of one configuration item in a single call: the item, its type, category and product records, its notes, related items, billing-product associations and subscriptions (software/licence terms keyed by configurationItemID).",
@@ -60233,7 +61041,7 @@ const CAPABILITY_DATA = {
60233
61041
  "preset": "retry-ffb3a9cb"
60234
61042
  },
60235
61043
  "errors": {
60236
- "set": 9
61044
+ "set": 11
60237
61045
  },
60238
61046
  "metadata": {
60239
61047
  "purpose": "Get a contact with its company and its open tickets in a single call: the contact (the parent-scoped root read, or row when the contact has no company FK), its company, and its open tickets — every part separately reported.",
@@ -60421,7 +61229,7 @@ const CAPABILITY_DATA = {
60421
61229
  "preset": "retry-ffb3a9cb"
60422
61230
  },
60423
61231
  "errors": {
60424
- "set": 13
61232
+ "set": 15
60425
61233
  },
60426
61234
  "metadata": {
60427
61235
  "purpose": "Get a contact with its primary context records in one call. (under a company)",
@@ -71361,7 +72169,7 @@ const CAPABILITY_DATA = {
71361
72169
  "preset": "retry-ffb3a9cb"
71362
72170
  },
71363
72171
  "errors": {
71364
- "set": 10
72172
+ "set": 12
71365
72173
  },
71366
72174
  "metadata": {
71367
72175
  "purpose": "Get a contract with its services, billing rules, recent charges and service units in a single call — the charges part is the N newest (the count-anchored `latest` 50).",
@@ -71737,7 +72545,7 @@ const CAPABILITY_DATA = {
71737
72545
  "preset": "retry-ffb3a9cb"
71738
72546
  },
71739
72547
  "errors": {
71740
- "set": 14
72548
+ "set": 16
71741
72549
  },
71742
72550
  "metadata": {
71743
72551
  "purpose": "Get the Line of Business chain for one contract in a single call: the association, the OrganizationalLevel2 (the customizable 'Line of Business' label) and the OrganizationalLevel1 (the division).",
@@ -71887,7 +72695,7 @@ const CAPABILITY_DATA = {
71887
72695
  "preset": "retry-ffb3a9cb"
71888
72696
  },
71889
72697
  "errors": {
71890
- "set": 14
72698
+ "set": 16
71891
72699
  },
71892
72700
  "metadata": {
71893
72701
  "purpose": "One call for a contract's profit-and-loss over a date window: monthly revenue (invoiced vs expected-but-unbilled), labour cost through an audited four-rung rate ladder, tooling/recurring/expense costs, break-even hours, the ticketCategory activity fold, the costliest tickets, suspected miscoded time, open/renewal items, and 11 built-in data-quality warnings",
@@ -72478,7 +73286,7 @@ const CAPABILITY_DATA = {
72478
73286
  "preset": "retry-c5657094"
72479
73287
  },
72480
73288
  "errors": {
72481
- "set": 15
73289
+ "set": 17
72482
73290
  },
72483
73291
  "metadata": {
72484
73292
  "purpose": "Create an inventory location.",
@@ -72804,7 +73612,7 @@ const CAPABILITY_DATA = {
72804
73612
  "preset": "retry-ffb3a9cb"
72805
73613
  },
72806
73614
  "errors": {
72807
- "set": 16
73615
+ "set": 18
72808
73616
  },
72809
73617
  "metadata": {
72810
73618
  "purpose": "Query InventoryLocation records with a JSON filter.",
@@ -72863,7 +73671,7 @@ const CAPABILITY_DATA = {
72863
73671
  "preset": "retry-c5657094"
72864
73672
  },
72865
73673
  "errors": {
72866
- "set": 17
73674
+ "set": 19
72867
73675
  },
72868
73676
  "metadata": {
72869
73677
  "purpose": "Update an inventory location.",
@@ -78133,7 +78941,7 @@ const CAPABILITY_DATA = {
78133
78941
  "preset": "retry-ffb3a9cb"
78134
78942
  },
78135
78943
  "errors": {
78136
- "set": 13
78944
+ "set": 15
78137
78945
  },
78138
78946
  "metadata": {
78139
78947
  "purpose": "Get a project with its primary context records in one call.",
@@ -80740,7 +81548,7 @@ const CAPABILITY_DATA = {
80740
81548
  "preset": "retry-ffb3a9cb"
80741
81549
  },
80742
81550
  "errors": {
80743
- "set": 10
81551
+ "set": 12
80744
81552
  },
80745
81553
  "metadata": {
80746
81554
  "purpose": "Get a quote with its line items in a single call — the items part is the bounded quoteID-filtered query.",
@@ -81684,7 +82492,7 @@ const CAPABILITY_DATA = {
81684
82492
  "preset": "retry-c5657094"
81685
82493
  },
81686
82494
  "errors": {
81687
- "set": 15
82495
+ "set": 17
81688
82496
  },
81689
82497
  "metadata": {
81690
82498
  "purpose": "Create an attachment under a task.",
@@ -81756,7 +82564,7 @@ const CAPABILITY_DATA = {
81756
82564
  "preset": "retry-1849870d"
81757
82565
  },
81758
82566
  "errors": {
81759
- "set": 18
82567
+ "set": 20
81760
82568
  },
81761
82569
  "metadata": {
81762
82570
  "purpose": "Delete an attachment under a task.",
@@ -82027,7 +82835,7 @@ const CAPABILITY_DATA = {
82027
82835
  "preset": "retry-ffb3a9cb"
82028
82836
  },
82029
82837
  "errors": {
82030
- "set": 16
82838
+ "set": 18
82031
82839
  },
82032
82840
  "metadata": {
82033
82841
  "purpose": "Query TaskAttachment records with a JSON filter.",
@@ -90795,7 +91603,7 @@ const CAPABILITY_DATA = {
90795
91603
  "preset": "retry-6980a375"
90796
91604
  },
90797
91605
  "errors": {
90798
- "set": 19
91606
+ "set": 21
90799
91607
  },
90800
91608
  "metadata": {
90801
91609
  "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).",
@@ -91200,7 +92008,7 @@ const CAPABILITY_DATA = {
91200
92008
  "preset": "retry-ffb3a9cb"
91201
92009
  },
91202
92010
  "errors": {
91203
- "set": 20
92011
+ "set": 22
91204
92012
  },
91205
92013
  "metadata": {
91206
92014
  "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.",
@@ -91331,7 +92139,7 @@ const CAPABILITY_DATA = {
91331
92139
  "preset": "retry-ffb3a9cb"
91332
92140
  },
91333
92141
  "errors": {
91334
- "set": 14
92142
+ "set": 16
91335
92143
  },
91336
92144
  "metadata": {
91337
92145
  "purpose": "Get the full context of one ticket in a single call: the ticket, its company, contact, assigned resource and project, plus its notes, time entries, attachment metadata and (opt-in) histories — every part separately reported.",
@@ -91536,7 +92344,7 @@ const CAPABILITY_DATA = {
91536
92344
  "preset": "retry-ffb3a9cb"
91537
92345
  },
91538
92346
  "errors": {
91539
- "set": 13
92347
+ "set": 15
91540
92348
  },
91541
92349
  "metadata": {
91542
92350
  "purpose": "Get a ticket with its primary context records in one call.",
@@ -91855,7 +92663,7 @@ const CAPABILITY_DATA = {
91855
92663
  "preset": "retry-ffb3a9cb"
91856
92664
  },
91857
92665
  "errors": {
91858
- "set": 14
92666
+ "set": 16
91859
92667
  },
91860
92668
  "metadata": {
91861
92669
  "purpose": "Get the full Line of Business chain for one ticket in a single call: the association, the OrganizationalLevel2 (the customizable 'Line of Business' label) and the OrganizationalLevel1 (the division).",
@@ -92293,7 +93101,7 @@ const CAPABILITY_DATA = {
92293
93101
  "preset": "retry-ffb3a9cb"
92294
93102
  },
92295
93103
  "errors": {
92296
- "set": 13
93104
+ "set": 15
92297
93105
  },
92298
93106
  "metadata": {
92299
93107
  "purpose": "Run the SLA health check for a ticket (numeric ticket id).",
@@ -92390,7 +93198,7 @@ const CAPABILITY_DATA = {
92390
93198
  "preset": "retry-ffb3a9cb"
92391
93199
  },
92392
93200
  "errors": {
92393
- "set": 21
93201
+ "set": 23
92394
93202
  },
92395
93203
  "metadata": {
92396
93204
  "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).",
@@ -92488,7 +93296,7 @@ const CAPABILITY_DATA = {
92488
93296
  "preset": "retry-ffb3a9cb"
92489
93297
  },
92490
93298
  "errors": {
92491
- "set": 13
93299
+ "set": 15
92492
93300
  },
92493
93301
  "metadata": {
92494
93302
  "purpose": "Get a one-call summary of a ticket (numeric ticket id).",
@@ -92598,7 +93406,7 @@ const CAPABILITY_DATA = {
92598
93406
  "preset": "retry-ffb3a9cb"
92599
93407
  },
92600
93408
  "errors": {
92601
- "set": 13
93409
+ "set": 15
92602
93410
  },
92603
93411
  "metadata": {
92604
93412
  "purpose": "Get the event timeline of a ticket (numeric ticket id).",
@@ -92749,8 +93557,8 @@ const CAPABILITY_DATA = {
92749
93557
  ]
92750
93558
  },
92751
93559
  "operations": {
92752
- "planHash": "911f1470a0ebbe66c39579e8d26d97253914f4fecfe3b8d69ee61bd1710be132",
92753
- "builtAt": "2026-11-20T22:03:19.289Z",
93560
+ "planHash": "fe0c9ce6a957bb730c1bdb9fb46498e61e2d04cc1cdd861d796ac26f982ab505",
93561
+ "builtAt": "2026-11-21T05:09:04.076Z",
92754
93562
  "records": [
92755
93563
  {
92756
93564
  "id": "operations.aggregate",
@@ -92833,7 +93641,7 @@ const CAPABILITY_DATA = {
92833
93641
  "preset": "retry-ffb3a9cb"
92834
93642
  },
92835
93643
  "errors": {
92836
- "set": 22
93644
+ "set": 24
92837
93645
  },
92838
93646
  "metadata": {
92839
93647
  "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",
@@ -92867,6 +93675,7 @@ const CAPABILITY_DATA = {
92867
93675
  "UDF8",
92868
93676
  "UDF9",
92869
93677
  "action",
93678
+ "additionalAddressInfo",
92870
93679
  "additionalBillToAddressInformation",
92871
93680
  "additionalShipToAddressInformation",
92872
93681
  "alertText",
@@ -92887,6 +93696,7 @@ const CAPABILITY_DATA = {
92887
93696
  "contactName",
92888
93697
  "contractName",
92889
93698
  "costType",
93699
+ "country",
92890
93700
  "coveredByBlockRetainerContractLabel",
92891
93701
  "coveredByRecurringServiceFixedPricePerTicketContractLabel",
92892
93702
  "data",
@@ -92965,6 +93775,7 @@ const CAPABILITY_DATA = {
92965
93775
  "templateName",
92966
93776
  "ticketTitle",
92967
93777
  "timeFormat",
93778
+ "timeZone",
92968
93779
  "title",
92969
93780
  "travelAvailabilityPct",
92970
93781
  "userName",
@@ -93041,7 +93852,7 @@ const CAPABILITY_DATA = {
93041
93852
  "preset": "retry-ffb3a9cb"
93042
93853
  },
93043
93854
  "errors": {
93044
- "set": 23
93855
+ "set": 25
93045
93856
  },
93046
93857
  "metadata": {
93047
93858
  "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.",
@@ -93107,7 +93918,7 @@ const CAPABILITY_DATA = {
93107
93918
  "preset": "retry-ffb3a9cb"
93108
93919
  },
93109
93920
  "errors": {
93110
- "set": 24
93921
+ "set": 26
93111
93922
  },
93112
93923
  "metadata": {
93113
93924
  "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.",
@@ -93158,7 +93969,7 @@ const CAPABILITY_DATA = {
93158
93969
  "preset": "retry-ffb3a9cb"
93159
93970
  },
93160
93971
  "errors": {
93161
- "set": 14
93972
+ "set": 16
93162
93973
  },
93163
93974
  "metadata": {
93164
93975
  "purpose": "Resolve resource ids to display names in one opt-in call: per-id resources.get reads (never an id-in query) with blind-marked rows for ids the API user cannot resolve served from the read cache (each distinct id fetched at most once per cache lifetime).",
@@ -93210,7 +94021,7 @@ const CAPABILITY_DATA = {
93210
94021
  "preset": "retry-ffb3a9cb"
93211
94022
  },
93212
94023
  "errors": {
93213
- "set": 14
94024
+ "set": 16
93214
94025
  },
93215
94026
  "metadata": {
93216
94027
  "purpose": "Fetch up to 500 single records by id across mixed resources in one call (query-first chunked id-in reads with a per-id get fallback), with per-item typed results.",
@@ -93244,6 +94055,7 @@ const CAPABILITY_DATA = {
93244
94055
  "UDF8",
93245
94056
  "UDF9",
93246
94057
  "action",
94058
+ "additionalAddressInfo",
93247
94059
  "additionalBillToAddressInformation",
93248
94060
  "additionalShipToAddressInformation",
93249
94061
  "alertText",
@@ -93264,6 +94076,7 @@ const CAPABILITY_DATA = {
93264
94076
  "contactName",
93265
94077
  "contractName",
93266
94078
  "costType",
94079
+ "country",
93267
94080
  "coveredByBlockRetainerContractLabel",
93268
94081
  "coveredByRecurringServiceFixedPricePerTicketContractLabel",
93269
94082
  "data",
@@ -93342,6 +94155,7 @@ const CAPABILITY_DATA = {
93342
94155
  "templateName",
93343
94156
  "ticketTitle",
93344
94157
  "timeFormat",
94158
+ "timeZone",
93345
94159
  "title",
93346
94160
  "travelAvailabilityPct",
93347
94161
  "userName",
@@ -93430,7 +94244,7 @@ const CAPABILITY_DATA = {
93430
94244
  "preset": "retry-ffb3a9cb"
93431
94245
  },
93432
94246
  "errors": {
93433
- "set": 25
94247
+ "set": 27
93434
94248
  },
93435
94249
  "metadata": {
93436
94250
  "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.",
@@ -93527,7 +94341,7 @@ const CAPABILITY_DATA = {
93527
94341
  "preset": "retry-ffb3a9cb"
93528
94342
  },
93529
94343
  "errors": {
93530
- "set": 23
94344
+ "set": 25
93531
94345
  },
93532
94346
  "metadata": {
93533
94347
  "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.",
@@ -93644,7 +94458,7 @@ const CAPABILITY_DATA = {
93644
94458
  "preset": "retry-ffb3a9cb"
93645
94459
  },
93646
94460
  "errors": {
93647
- "set": 26
94461
+ "set": 28
93648
94462
  },
93649
94463
  "metadata": {
93650
94464
  "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.",
@@ -93734,7 +94548,7 @@ const CAPABILITY_DATA = {
93734
94548
  "preset": "retry-ffb3a9cb"
93735
94549
  },
93736
94550
  "errors": {
93737
- "set": 23
94551
+ "set": 25
93738
94552
  },
93739
94553
  "metadata": {
93740
94554
  "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.",
@@ -93789,7 +94603,7 @@ const CAPABILITY_DATA = {
93789
94603
  "preset": "retry-ffb3a9cb"
93790
94604
  },
93791
94605
  "errors": {
93792
- "set": 24
94606
+ "set": 26
93793
94607
  },
93794
94608
  "metadata": {
93795
94609
  "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.",
@@ -93897,6 +94711,7 @@ const CAPABILITY_DATA = {
93897
94711
  "UDF8",
93898
94712
  "UDF9",
93899
94713
  "action",
94714
+ "additionalAddressInfo",
93900
94715
  "additionalBillToAddressInformation",
93901
94716
  "additionalShipToAddressInformation",
93902
94717
  "alertText",
@@ -93917,6 +94732,7 @@ const CAPABILITY_DATA = {
93917
94732
  "contactName",
93918
94733
  "contractName",
93919
94734
  "costType",
94735
+ "country",
93920
94736
  "coveredByBlockRetainerContractLabel",
93921
94737
  "coveredByRecurringServiceFixedPricePerTicketContractLabel",
93922
94738
  "data",
@@ -93995,6 +94811,7 @@ const CAPABILITY_DATA = {
93995
94811
  "templateName",
93996
94812
  "ticketTitle",
93997
94813
  "timeFormat",
94814
+ "timeZone",
93998
94815
  "title",
93999
94816
  "travelAvailabilityPct",
94000
94817
  "userName",
@@ -94206,7 +95023,7 @@ const CAPABILITY_DATA = {
94206
95023
  "preset": "retry-ffb3a9cb"
94207
95024
  },
94208
95025
  "errors": {
94209
- "set": 23
95026
+ "set": 25
94210
95027
  },
94211
95028
  "metadata": {
94212
95029
  "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.",
@@ -94266,7 +95083,7 @@ const CAPABILITY_DATA = {
94266
95083
  "preset": "retry-ffb3a9cb"
94267
95084
  },
94268
95085
  "errors": {
94269
- "set": 27
95086
+ "set": 29
94270
95087
  },
94271
95088
  "metadata": {
94272
95089
  "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.",
@@ -94373,6 +95190,7 @@ const CAPABILITY_DATA = {
94373
95190
  "UDF8",
94374
95191
  "UDF9",
94375
95192
  "action",
95193
+ "additionalAddressInfo",
94376
95194
  "additionalBillToAddressInformation",
94377
95195
  "additionalShipToAddressInformation",
94378
95196
  "alertText",
@@ -94393,6 +95211,7 @@ const CAPABILITY_DATA = {
94393
95211
  "contactName",
94394
95212
  "contractName",
94395
95213
  "costType",
95214
+ "country",
94396
95215
  "coveredByBlockRetainerContractLabel",
94397
95216
  "coveredByRecurringServiceFixedPricePerTicketContractLabel",
94398
95217
  "data",
@@ -94471,6 +95290,7 @@ const CAPABILITY_DATA = {
94471
95290
  "templateName",
94472
95291
  "ticketTitle",
94473
95292
  "timeFormat",
95293
+ "timeZone",
94474
95294
  "title",
94475
95295
  "travelAvailabilityPct",
94476
95296
  "userName",
@@ -94539,7 +95359,7 @@ const CAPABILITY_DATA = {
94539
95359
  "preset": "retry-ffb3a9cb"
94540
95360
  },
94541
95361
  "errors": {
94542
- "set": 27
95362
+ "set": 29
94543
95363
  },
94544
95364
  "metadata": {
94545
95365
  "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.",
@@ -94630,7 +95450,7 @@ const CAPABILITY_DATA = {
94630
95450
  "preset": "retry-ffb3a9cb"
94631
95451
  },
94632
95452
  "errors": {
94633
- "set": 28
95453
+ "set": 30
94634
95454
  },
94635
95455
  "metadata": {
94636
95456
  "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.",