node-autotask 0.64.1 → 0.66.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 +36 -0
- package/MCP_TOOL_CATALOG.json +35 -15
- package/README.md +1 -1
- package/capabilities.json +174 -113
- package/dist/capabilities-data.js +173 -112
- package/dist/capabilities.cjs +4 -4
- package/dist/capabilities.js +1 -1
- package/dist/{chunk-NWQVMOP5.js → chunk-4HJVHVPE.js} +2 -2
- package/dist/{chunk-ENRW25IT.cjs → chunk-FLVMENXG.cjs} +3 -3
- package/dist/{chunk-BQNC4RYG.js → chunk-KO36QZXN.js} +418 -414
- package/dist/{chunk-C3OLJGY5.js → chunk-L5K2D2MZ.js} +3 -3
- package/dist/{chunk-MIKVE6VJ.cjs → chunk-QG3O5G4L.cjs} +175 -179
- package/dist/{chunk-SVCTQVTV.js → chunk-T5TI22K5.js} +4 -8
- package/dist/{chunk-AGGOZD2J.cjs → chunk-TIFJFCCN.cjs} +423 -419
- package/dist/{chunk-7DC524X3.cjs → chunk-XAJ7SBPE.cjs} +31 -31
- package/dist/{index-RkTNsoOz.d.ts → index-BZ11hF8H.d.ts} +10 -24
- package/dist/{index-B7bZQ34O.d.cts → index-DnisYPlj.d.cts} +10 -24
- package/dist/index.cjs +84 -84
- package/dist/index.d.cts +2 -2
- package/dist/index.d.ts +2 -2
- package/dist/index.js +5 -5
- package/dist/operations/index.cjs +50 -50
- package/dist/operations/index.d.cts +3 -3
- package/dist/operations/index.d.ts +3 -3
- package/dist/operations/index.js +2 -2
- package/dist/pool.cjs +8 -8
- package/dist/pool.js +4 -4
- package/dist/resources/index.cjs +27 -27
- package/dist/resources/index.d.cts +1 -1
- package/dist/resources/index.d.ts +1 -1
- package/dist/resources/index.js +3 -3
- package/docs/API.md +2 -2
- package/docs/VENDOR-QUIRKS.md +64 -37
- package/package.json +1 -1
|
@@ -348,8 +348,8 @@ const CAPABILITY_DATA = {
|
|
|
348
348
|
],
|
|
349
349
|
"groups": {
|
|
350
350
|
"B": {
|
|
351
|
-
"planHash": "
|
|
352
|
-
"builtAt": "2026-11-
|
|
351
|
+
"planHash": "94052c314d189d4b2fcf6bc842d983d4817c8410109074ed9505b682f4855790",
|
|
352
|
+
"builtAt": "2026-11-17T05:04:54.690Z",
|
|
353
353
|
"records": [
|
|
354
354
|
{
|
|
355
355
|
"id": "appointments.count",
|
|
@@ -955,7 +955,7 @@ const CAPABILITY_DATA = {
|
|
|
955
955
|
},
|
|
956
956
|
"metadata": {
|
|
957
957
|
"purpose": "Update an appointment.",
|
|
958
|
-
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET
|
|
958
|
+
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET; when a stale-check field is configured, the same read also supplies that guard) before the PUT; explicit nulls send null, omitted fields keep the current value. Pass raw: true in the opts bag to send the body as-is (no merge).",
|
|
959
959
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
960
960
|
"related": [
|
|
961
961
|
"appointments.get"
|
|
@@ -1062,7 +1062,7 @@ const CAPABILITY_DATA = {
|
|
|
1062
1062
|
},
|
|
1063
1063
|
"metadata": {
|
|
1064
1064
|
"purpose": "Count billing code records matching a JSON filter.",
|
|
1065
|
-
"usage": "Unwraps queryCount; returns a plain number.
|
|
1065
|
+
"usage": "Unwraps queryCount; returns a plain number. Visibility caution: an unfiltered billing-code count/query may be inconclusive. Scope with `useType` (1 = general, 3 = internal) and `isActive`, then verify a known code by id.",
|
|
1066
1066
|
"preferredWhen": null,
|
|
1067
1067
|
"related": [
|
|
1068
1068
|
"billing_codes.query"
|
|
@@ -1072,7 +1072,7 @@ const CAPABILITY_DATA = {
|
|
|
1072
1072
|
"surface": "billing_codes.count",
|
|
1073
1073
|
"kind": "unfiltered-blind",
|
|
1074
1074
|
"authority": "billing_codes.get",
|
|
1075
|
-
"note": "
|
|
1075
|
+
"note": "The unfiltered billing_codes count result may be limited by API-user visibility. A zero or empty response is INCONCLUSIVE about tenant inventory or API capability. Narrow the query and verify a known record with billing_codes.get; if that read is not permitted, ask the user for the missing information. Scope allocation codes with useType and isActive."
|
|
1076
1076
|
},
|
|
1077
1077
|
"untrustedFields": [
|
|
1078
1078
|
"description",
|
|
@@ -1386,7 +1386,7 @@ const CAPABILITY_DATA = {
|
|
|
1386
1386
|
},
|
|
1387
1387
|
"metadata": {
|
|
1388
1388
|
"purpose": "Query BillingCode records with a JSON filter.",
|
|
1389
|
-
"usage": "Server-side pagination: one call walks the vendor cursor internally (page 1 POSTs the QueryModel body with MaxRecords = the walk's internal page size (at most 500; the default POST path — `via: 'get'` issues a GET on page 1); later pages POST the SAME body — IncludeFields, MaxRecords and the preserved filter — to the absolute vendor cursor, rebased to the client base URL; the vendor honours IncludeFields on a continuation and ignores MaxRecords there, so a later page carries the vendor's own page size) until the limit is met or the cursor is null; 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).
|
|
1389
|
+
"usage": "Server-side pagination: one call walks the vendor cursor internally (page 1 POSTs the QueryModel body with MaxRecords = the walk's internal page size (at most 500; the default POST path — `via: 'get'` issues a GET on page 1); later pages POST the SAME body — IncludeFields, MaxRecords and the preserved filter — to the absolute vendor cursor, rebased to the client base URL; the vendor honours IncludeFields on a continuation and ignores MaxRecords there, so a later page carries the vendor's own page size) until the limit is met or the cursor is null; 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). Visibility caution: an unfiltered billing-code count/query may be inconclusive. Scope with `useType` (1 = general, 3 = internal) and `isActive`, then verify a known code by id. 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.",
|
|
1390
1390
|
"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).",
|
|
1391
1391
|
"related": [
|
|
1392
1392
|
"billing_codes.resolve"
|
|
@@ -1396,7 +1396,7 @@ const CAPABILITY_DATA = {
|
|
|
1396
1396
|
"surface": "billing_codes.query",
|
|
1397
1397
|
"kind": "unfiltered-blind",
|
|
1398
1398
|
"authority": "billing_codes.get",
|
|
1399
|
-
"note": "
|
|
1399
|
+
"note": "The unfiltered billing_codes query result may be limited by API-user visibility. A zero or empty response is INCONCLUSIVE about tenant inventory or API capability. Narrow the query and verify a known record with billing_codes.get; if that read is not permitted, ask the user for the missing information. Scope allocation codes with useType and isActive."
|
|
1400
1400
|
},
|
|
1401
1401
|
"untrustedFields": [
|
|
1402
1402
|
"description",
|
|
@@ -2336,7 +2336,7 @@ const CAPABILITY_DATA = {
|
|
|
2336
2336
|
},
|
|
2337
2337
|
"metadata": {
|
|
2338
2338
|
"purpose": "Update a billing item.",
|
|
2339
|
-
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET
|
|
2339
|
+
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET; when a stale-check field is configured, the same read also supplies that guard) before the PUT; explicit nulls send null, omitted fields keep the current value. Pass raw: true in the opts bag to send the body as-is (no merge).",
|
|
2340
2340
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
2341
2341
|
"related": [
|
|
2342
2342
|
"billing_items.get"
|
|
@@ -3549,7 +3549,7 @@ const CAPABILITY_DATA = {
|
|
|
3549
3549
|
},
|
|
3550
3550
|
"metadata": {
|
|
3551
3551
|
"purpose": "Update a ChecklistLibrary (reusable checklist definition; container of library steps). Not a Task and not a per-ticket instance.",
|
|
3552
|
-
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET
|
|
3552
|
+
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET; when a stale-check field is configured, the same read also supplies that guard) before the PUT; explicit nulls send null, omitted fields keep the current value. Pass raw: true in the opts bag to send the body as-is (no merge).",
|
|
3553
3553
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
3554
3554
|
"related": [
|
|
3555
3555
|
"checklist_libraries.get"
|
|
@@ -5338,7 +5338,7 @@ const CAPABILITY_DATA = {
|
|
|
5338
5338
|
},
|
|
5339
5339
|
"metadata": {
|
|
5340
5340
|
"purpose": "Update a configuration item category.",
|
|
5341
|
-
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET
|
|
5341
|
+
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET; when a stale-check field is configured, the same read also supplies that guard) before the PUT; explicit nulls send null, omitted fields keep the current value. Pass raw: true in the opts bag to send the body as-is (no merge).",
|
|
5342
5342
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
5343
5343
|
"related": [
|
|
5344
5344
|
"configuration_item_categories.get"
|
|
@@ -6618,7 +6618,7 @@ const CAPABILITY_DATA = {
|
|
|
6618
6618
|
},
|
|
6619
6619
|
"metadata": {
|
|
6620
6620
|
"purpose": "Update a configuration item type.",
|
|
6621
|
-
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET
|
|
6621
|
+
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET; when a stale-check field is configured, the same read also supplies that guard) before the PUT; explicit nulls send null, omitted fields keep the current value. Pass raw: true in the opts bag to send the body as-is (no merge).",
|
|
6622
6622
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
6623
6623
|
"related": [
|
|
6624
6624
|
"configuration_item_types.get"
|
|
@@ -7819,7 +7819,7 @@ const CAPABILITY_DATA = {
|
|
|
7819
7819
|
},
|
|
7820
7820
|
"metadata": {
|
|
7821
7821
|
"purpose": "Update a contact group.",
|
|
7822
|
-
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET
|
|
7822
|
+
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET; when a stale-check field is configured, the same read also supplies that guard) before the PUT; explicit nulls send null, omitted fields keep the current value. Pass raw: true in the opts bag to send the body as-is (no merge).",
|
|
7823
7823
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
7824
7824
|
"related": [
|
|
7825
7825
|
"contact_groups.get"
|
|
@@ -9586,7 +9586,7 @@ const CAPABILITY_DATA = {
|
|
|
9586
9586
|
},
|
|
9587
9587
|
"metadata": {
|
|
9588
9588
|
"purpose": "Update a contract exclusion set.",
|
|
9589
|
-
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET
|
|
9589
|
+
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET; when a stale-check field is configured, the same read also supplies that guard) before the PUT; explicit nulls send null, omitted fields keep the current value. Pass raw: true in the opts bag to send the body as-is (no merge).",
|
|
9590
9590
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
9591
9591
|
"related": [
|
|
9592
9592
|
"contract_exclusion_sets.get"
|
|
@@ -10167,7 +10167,7 @@ const CAPABILITY_DATA = {
|
|
|
10167
10167
|
},
|
|
10168
10168
|
"metadata": {
|
|
10169
10169
|
"purpose": "Update a country.",
|
|
10170
|
-
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET
|
|
10170
|
+
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET; when a stale-check field is configured, the same read also supplies that guard) before the PUT; explicit nulls send null, omitted fields keep the current value. Pass raw: true in the opts bag to send the body as-is (no merge).",
|
|
10171
10171
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
10172
10172
|
"related": [
|
|
10173
10173
|
"countries.get"
|
|
@@ -10702,6 +10702,67 @@ const CAPABILITY_DATA = {
|
|
|
10702
10702
|
"compact": "CurrencySummary",
|
|
10703
10703
|
"status": "tested"
|
|
10704
10704
|
},
|
|
10705
|
+
{
|
|
10706
|
+
"id": "currencies.update",
|
|
10707
|
+
"resource": "currencies",
|
|
10708
|
+
"udfCapable": false,
|
|
10709
|
+
"operation": "update",
|
|
10710
|
+
"kind": "primitive",
|
|
10711
|
+
"endpoint": "PUT|PATCH /V1.0/Currencies",
|
|
10712
|
+
"effect": "write",
|
|
10713
|
+
"flags": [
|
|
10714
|
+
"idempotent"
|
|
10715
|
+
],
|
|
10716
|
+
"dryRun": true,
|
|
10717
|
+
"envelope": "OperationResultModel",
|
|
10718
|
+
"inputSchema": {
|
|
10719
|
+
"id": {
|
|
10720
|
+
"type": "string | number",
|
|
10721
|
+
"required": true,
|
|
10722
|
+
"description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
|
|
10723
|
+
},
|
|
10724
|
+
"data": {
|
|
10725
|
+
"type": "object",
|
|
10726
|
+
"required": true,
|
|
10727
|
+
"description": "The record payload (vendor model fields)."
|
|
10728
|
+
}
|
|
10729
|
+
},
|
|
10730
|
+
"inputSchemaStrict": true,
|
|
10731
|
+
"outputSchema": {
|
|
10732
|
+
"type": "OperationResultModel",
|
|
10733
|
+
"drops": []
|
|
10734
|
+
},
|
|
10735
|
+
"examples": [
|
|
10736
|
+
"await client.currencies.update('example-value', { name: 'example' }, { dryRun: true })"
|
|
10737
|
+
],
|
|
10738
|
+
"permissions": "unknown",
|
|
10739
|
+
"pagination": {
|
|
10740
|
+
"mode": "none"
|
|
10741
|
+
},
|
|
10742
|
+
"resolution": null,
|
|
10743
|
+
"retry": {
|
|
10744
|
+
"preset": "retry-1849870d"
|
|
10745
|
+
},
|
|
10746
|
+
"errors": {
|
|
10747
|
+
"set": 1
|
|
10748
|
+
},
|
|
10749
|
+
"metadata": {
|
|
10750
|
+
"purpose": "Update a currency, including its exchange rate and display settings.",
|
|
10751
|
+
"usage": "Updates via the documented collection PUT route after merging supplied fields into a fresh record. The vendored specification also lists PATCH; this method sends PUT. No stale-check field is configured for this operation. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET; when a stale-check field is configured, the same read also supplies that guard) before the PUT; explicit nulls send null, omitted fields keep the current value. Pass raw: true in the opts bag to send the body as-is (no merge).",
|
|
10752
|
+
"preferredWhen": "Change supported fields on an existing currency; the vendor specification does not define currency create or delete operations.",
|
|
10753
|
+
"related": [
|
|
10754
|
+
"currencies.get"
|
|
10755
|
+
],
|
|
10756
|
+
"collectionUpdate": true,
|
|
10757
|
+
"untrustedFields": [
|
|
10758
|
+
"description",
|
|
10759
|
+
"name"
|
|
10760
|
+
],
|
|
10761
|
+
"accountWide": true
|
|
10762
|
+
},
|
|
10763
|
+
"compact": null,
|
|
10764
|
+
"status": "tested"
|
|
10765
|
+
},
|
|
10705
10766
|
{
|
|
10706
10767
|
"id": "departments.count",
|
|
10707
10768
|
"resource": "departments",
|
|
@@ -11326,7 +11387,7 @@ const CAPABILITY_DATA = {
|
|
|
11326
11387
|
},
|
|
11327
11388
|
"metadata": {
|
|
11328
11389
|
"purpose": "Update a department.",
|
|
11329
|
-
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET
|
|
11390
|
+
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET; when a stale-check field is configured, the same read also supplies that guard) before the PUT; explicit nulls send null, omitted fields keep the current value. Pass raw: true in the opts bag to send the body as-is (no merge).",
|
|
11330
11391
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
11331
11392
|
"related": [
|
|
11332
11393
|
"departments.get"
|
|
@@ -11956,7 +12017,7 @@ const CAPABILITY_DATA = {
|
|
|
11956
12017
|
},
|
|
11957
12018
|
"metadata": {
|
|
11958
12019
|
"purpose": "Update a domain registrar.",
|
|
11959
|
-
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET
|
|
12020
|
+
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET; when a stale-check field is configured, the same read also supplies that guard) before the PUT; explicit nulls send null, omitted fields keep the current value. Pass raw: true in the opts bag to send the body as-is (no merge).",
|
|
11960
12021
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
11961
12022
|
"related": [
|
|
11962
12023
|
"domain_registrars.get"
|
|
@@ -14209,7 +14270,7 @@ const CAPABILITY_DATA = {
|
|
|
14209
14270
|
},
|
|
14210
14271
|
"metadata": {
|
|
14211
14272
|
"purpose": "Update an expense report.",
|
|
14212
|
-
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET
|
|
14273
|
+
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET; when a stale-check field is configured, the same read also supplies that guard) before the PUT; explicit nulls send null, omitted fields keep the current value. Pass raw: true in the opts bag to send the body as-is (no merge).",
|
|
14213
14274
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
14214
14275
|
"related": [
|
|
14215
14276
|
"expense_reports.get"
|
|
@@ -14849,7 +14910,7 @@ const CAPABILITY_DATA = {
|
|
|
14849
14910
|
},
|
|
14850
14911
|
"metadata": {
|
|
14851
14912
|
"purpose": "Update a holiday set.",
|
|
14852
|
-
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET
|
|
14913
|
+
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET; when a stale-check field is configured, the same read also supplies that guard) before the PUT; explicit nulls send null, omitted fields keep the current value. Pass raw: true in the opts bag to send the body as-is (no merge).",
|
|
14853
14914
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
14854
14915
|
"related": [
|
|
14855
14916
|
"holiday_sets.get"
|
|
@@ -15597,7 +15658,7 @@ const CAPABILITY_DATA = {
|
|
|
15597
15658
|
},
|
|
15598
15659
|
"metadata": {
|
|
15599
15660
|
"purpose": "Create an inventory product.",
|
|
15600
|
-
"usage": "Returns OperationResultModel.itemId (the new id); the full record is not returned — follow up with get where needed.
|
|
15661
|
+
"usage": "Returns OperationResultModel.itemId (the new id); the full record is not returned — follow up with get where needed. Use a known valid productID or query products for a readable product. If the API user cannot read the required product, ask an operator for its id or permission to access it before retrying.",
|
|
15601
15662
|
"preferredWhen": "Only for a record that does not exist yet; prefer update for an id you already have.",
|
|
15602
15663
|
"related": [
|
|
15603
15664
|
"inventory_products.update"
|
|
@@ -16262,7 +16323,7 @@ const CAPABILITY_DATA = {
|
|
|
16262
16323
|
},
|
|
16263
16324
|
"metadata": {
|
|
16264
16325
|
"purpose": "Update an inventory product.",
|
|
16265
|
-
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET
|
|
16326
|
+
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET; when a stale-check field is configured, the same read also supplies that guard) before the PUT; explicit nulls send null, omitted fields keep the current value. Pass raw: true in the opts bag to send the body as-is (no merge).",
|
|
16266
16327
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
16267
16328
|
"related": [
|
|
16268
16329
|
"inventory_products.get"
|
|
@@ -17742,7 +17803,7 @@ const CAPABILITY_DATA = {
|
|
|
17742
17803
|
},
|
|
17743
17804
|
"metadata": {
|
|
17744
17805
|
"purpose": "Update an opportunity category.",
|
|
17745
|
-
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET
|
|
17806
|
+
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET; when a stale-check field is configured, the same read also supplies that guard) before the PUT; explicit nulls send null, omitted fields keep the current value. Pass raw: true in the opts bag to send the body as-is (no merge).",
|
|
17746
17807
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
17747
17808
|
"related": [
|
|
17748
17809
|
"opportunity_categories.get"
|
|
@@ -18215,7 +18276,7 @@ const CAPABILITY_DATA = {
|
|
|
18215
18276
|
},
|
|
18216
18277
|
"metadata": {
|
|
18217
18278
|
"purpose": "Update an organizational level association.",
|
|
18218
|
-
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET
|
|
18279
|
+
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET; when a stale-check field is configured, the same read also supplies that guard) before the PUT; explicit nulls send null, omitted fields keep the current value. Pass raw: true in the opts bag to send the body as-is (no merge).",
|
|
18219
18280
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
18220
18281
|
"related": [
|
|
18221
18282
|
"organizational_level_associations.get"
|
|
@@ -18711,7 +18772,7 @@ const CAPABILITY_DATA = {
|
|
|
18711
18772
|
},
|
|
18712
18773
|
"metadata": {
|
|
18713
18774
|
"purpose": "Update an organizational level 1.",
|
|
18714
|
-
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET
|
|
18775
|
+
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET; when a stale-check field is configured, the same read also supplies that guard) before the PUT; explicit nulls send null, omitted fields keep the current value. Pass raw: true in the opts bag to send the body as-is (no merge).",
|
|
18715
18776
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
18716
18777
|
"related": [
|
|
18717
18778
|
"organizational_level1s.get"
|
|
@@ -19211,7 +19272,7 @@ const CAPABILITY_DATA = {
|
|
|
19211
19272
|
},
|
|
19212
19273
|
"metadata": {
|
|
19213
19274
|
"purpose": "Update an organizational level 2.",
|
|
19214
|
-
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET
|
|
19275
|
+
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET; when a stale-check field is configured, the same read also supplies that guard) before the PUT; explicit nulls send null, omitted fields keep the current value. Pass raw: true in the opts bag to send the body as-is (no merge).",
|
|
19215
19276
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
19216
19277
|
"related": [
|
|
19217
19278
|
"organizational_level2s.get"
|
|
@@ -20604,7 +20665,7 @@ const CAPABILITY_DATA = {
|
|
|
20604
20665
|
},
|
|
20605
20666
|
"metadata": {
|
|
20606
20667
|
"purpose": "Update a product.",
|
|
20607
|
-
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET
|
|
20668
|
+
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET; when a stale-check field is configured, the same read also supplies that guard) before the PUT; explicit nulls send null, omitted fields keep the current value. Pass raw: true in the opts bag to send the body as-is (no merge).",
|
|
20608
20669
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
20609
20670
|
"related": [
|
|
20610
20671
|
"products.get"
|
|
@@ -21139,7 +21200,7 @@ const CAPABILITY_DATA = {
|
|
|
21139
21200
|
},
|
|
21140
21201
|
"metadata": {
|
|
21141
21202
|
"purpose": "Update a purchase approval.",
|
|
21142
|
-
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET
|
|
21203
|
+
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET; when a stale-check field is configured, the same read also supplies that guard) before the PUT; explicit nulls send null, omitted fields keep the current value. Pass raw: true in the opts bag to send the body as-is (no merge).",
|
|
21143
21204
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
21144
21205
|
"related": [
|
|
21145
21206
|
"purchase_approvals.get"
|
|
@@ -22782,7 +22843,7 @@ const CAPABILITY_DATA = {
|
|
|
22782
22843
|
},
|
|
22783
22844
|
"metadata": {
|
|
22784
22845
|
"purpose": "Update a purchase order.",
|
|
22785
|
-
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET
|
|
22846
|
+
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET; when a stale-check field is configured, the same read also supplies that guard) before the PUT; explicit nulls send null, omitted fields keep the current value. Pass raw: true in the opts bag to send the body as-is (no merge).",
|
|
22786
22847
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
22787
22848
|
"related": [
|
|
22788
22849
|
"purchase_orders.get"
|
|
@@ -26568,7 +26629,7 @@ const CAPABILITY_DATA = {
|
|
|
26568
26629
|
},
|
|
26569
26630
|
"metadata": {
|
|
26570
26631
|
"purpose": "Update a resource.",
|
|
26571
|
-
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET
|
|
26632
|
+
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET; when a stale-check field is configured, the same read also supplies that guard) before the PUT; explicit nulls send null, omitted fields keep the current value. Pass raw: true in the opts bag to send the body as-is (no merge). No delete: the vendor defines no DELETE for this entity (the endpoint 405s; cleanup is UI-only).",
|
|
26572
26633
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
26573
26634
|
"related": [
|
|
26574
26635
|
"resources.get"
|
|
@@ -27402,7 +27463,7 @@ const CAPABILITY_DATA = {
|
|
|
27402
27463
|
},
|
|
27403
27464
|
"metadata": {
|
|
27404
27465
|
"purpose": "Update a role.",
|
|
27405
|
-
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET
|
|
27466
|
+
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET; when a stale-check field is configured, the same read also supplies that guard) before the PUT; explicit nulls send null, omitted fields keep the current value. Pass raw: true in the opts bag to send the body as-is (no merge).",
|
|
27406
27467
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
27407
27468
|
"related": [
|
|
27408
27469
|
"roles.get"
|
|
@@ -27990,7 +28051,7 @@ const CAPABILITY_DATA = {
|
|
|
27990
28051
|
},
|
|
27991
28052
|
"metadata": {
|
|
27992
28053
|
"purpose": "Update a sales order.",
|
|
27993
|
-
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET
|
|
28054
|
+
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET; when a stale-check field is configured, the same read also supplies that guard) before the PUT; explicit nulls send null, omitted fields keep the current value. Pass raw: true in the opts bag to send the body as-is (no merge).",
|
|
27994
28055
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
27995
28056
|
"related": [
|
|
27996
28057
|
"sales_orders.get"
|
|
@@ -30892,7 +30953,7 @@ const CAPABILITY_DATA = {
|
|
|
30892
30953
|
},
|
|
30893
30954
|
"metadata": {
|
|
30894
30955
|
"purpose": "Update a service call.",
|
|
30895
|
-
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET
|
|
30956
|
+
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET; when a stale-check field is configured, the same read also supplies that guard) before the PUT; explicit nulls send null, omitted fields keep the current value. Pass raw: true in the opts bag to send the body as-is (no merge).",
|
|
30896
30957
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
30897
30958
|
"related": [
|
|
30898
30959
|
"service_calls.get"
|
|
@@ -32171,7 +32232,7 @@ const CAPABILITY_DATA = {
|
|
|
32171
32232
|
},
|
|
32172
32233
|
"metadata": {
|
|
32173
32234
|
"purpose": "Update a service.",
|
|
32174
|
-
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET
|
|
32235
|
+
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET; when a stale-check field is configured, the same read also supplies that guard) before the PUT; explicit nulls send null, omitted fields keep the current value. Pass raw: true in the opts bag to send the body as-is (no merge).",
|
|
32175
32236
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
32176
32237
|
"related": [
|
|
32177
32238
|
"services.get"
|
|
@@ -35265,7 +35326,7 @@ const CAPABILITY_DATA = {
|
|
|
35265
35326
|
},
|
|
35266
35327
|
"metadata": {
|
|
35267
35328
|
"purpose": "Update a tag group.",
|
|
35268
|
-
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET
|
|
35329
|
+
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET; when a stale-check field is configured, the same read also supplies that guard) before the PUT; explicit nulls send null, omitted fields keep the current value. Pass raw: true in the opts bag to send the body as-is (no merge).",
|
|
35269
35330
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
35270
35331
|
"related": [
|
|
35271
35332
|
"tag_groups.get"
|
|
@@ -35876,7 +35937,7 @@ const CAPABILITY_DATA = {
|
|
|
35876
35937
|
},
|
|
35877
35938
|
"metadata": {
|
|
35878
35939
|
"purpose": "Update a tag.",
|
|
35879
|
-
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET
|
|
35940
|
+
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET; when a stale-check field is configured, the same read also supplies that guard) before the PUT; explicit nulls send null, omitted fields keep the current value. Pass raw: true in the opts bag to send the body as-is (no merge).",
|
|
35880
35941
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
35881
35942
|
"related": [
|
|
35882
35943
|
"tags.get"
|
|
@@ -36369,7 +36430,7 @@ const CAPABILITY_DATA = {
|
|
|
36369
36430
|
},
|
|
36370
36431
|
"metadata": {
|
|
36371
36432
|
"purpose": "Update a tax region.",
|
|
36372
|
-
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET
|
|
36433
|
+
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET; when a stale-check field is configured, the same read also supplies that guard) before the PUT; explicit nulls send null, omitted fields keep the current value. Pass raw: true in the opts bag to send the body as-is (no merge).",
|
|
36373
36434
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
36374
36435
|
"related": [
|
|
36375
36436
|
"tax_regions.get"
|
|
@@ -36989,7 +37050,7 @@ const CAPABILITY_DATA = {
|
|
|
36989
37050
|
},
|
|
36990
37051
|
"metadata": {
|
|
36991
37052
|
"purpose": "Update a ticket category.",
|
|
36992
|
-
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET
|
|
37053
|
+
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET; when a stale-check field is configured, the same read also supplies that guard) before the PUT; explicit nulls send null, omitted fields keep the current value. Pass raw: true in the opts bag to send the body as-is (no merge).",
|
|
36993
37054
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
36994
37055
|
"related": [
|
|
36995
37056
|
"ticket_categories.get"
|
|
@@ -39222,7 +39283,7 @@ const CAPABILITY_DATA = {
|
|
|
39222
39283
|
},
|
|
39223
39284
|
"metadata": {
|
|
39224
39285
|
"purpose": "Update a ticket note webhook.",
|
|
39225
|
-
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET
|
|
39286
|
+
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET; when a stale-check field is configured, the same read also supplies that guard) before the PUT; explicit nulls send null, omitted fields keep the current value. Pass raw: true in the opts bag to send the body as-is (no merge).",
|
|
39226
39287
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
39227
39288
|
"related": [
|
|
39228
39289
|
"ticket_note_webhooks.get"
|
|
@@ -39372,7 +39433,7 @@ const CAPABILITY_DATA = {
|
|
|
39372
39433
|
},
|
|
39373
39434
|
"examples": [
|
|
39374
39435
|
"await client.timeEntries.create({ resourceID: 2001, dateWorked: '2026-10-03' }, { dryRun: true })",
|
|
39375
|
-
"
|
|
39436
|
+
"the low-level escape hatch — posts exactly the given body (resourceID is the only vendor-required field) and lets the vendor linkage/allocation-code gates surface verbatim Resolve the allocation code yourself (billing_codes query with the family + active filter — the unfiltered surface is blind) or pass a linkage pin (ticketID/taskID/roleID)."
|
|
39376
39437
|
],
|
|
39377
39438
|
"permissions": "unknown",
|
|
39378
39439
|
"pagination": {
|
|
@@ -39387,7 +39448,7 @@ const CAPABILITY_DATA = {
|
|
|
39387
39448
|
},
|
|
39388
39449
|
"metadata": {
|
|
39389
39450
|
"purpose": "Create a time entry.",
|
|
39390
|
-
"usage": "Returns OperationResultModel.itemId (the new id); the full record is not returned — follow up with get where needed.",
|
|
39451
|
+
"usage": "Returns OperationResultModel.itemId (the new id); the full record is not returned — follow up with get where needed. On internal-organisation tickets (companyID 0) showOnInvoice must be false — true is refused by the vendor (500 \"This time entry cannot be shown on an Invoice because it is for your internal organization.\"); the vendor stores isNonBillable true on internal-organisation entries (a create that sent false read back true)",
|
|
39391
39452
|
"preferredWhen": "Only for a record that does not exist yet; prefer update for an id you already have.",
|
|
39392
39453
|
"related": [
|
|
39393
39454
|
"time_entries.update"
|
|
@@ -39540,12 +39601,12 @@ const CAPABILITY_DATA = {
|
|
|
39540
39601
|
"set": 8
|
|
39541
39602
|
},
|
|
39542
39603
|
"metadata": {
|
|
39543
|
-
"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 (
|
|
39604
|
+
"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.",
|
|
39544
39605
|
"usage": "dateWorkedWindow(from, to, opts?): from/to are required inclusive 'YYYY-MM-DD' UTC days (impossible calendar days like 2026-02-31 and from-after-to are refused pre-request, zero wire). opts.state: 'posted' | 'unposted' — client-side narrowing AFTER the join (replaces the old posted boolean and the getPosted/getUnposted state modes); omitted = both. opts.limit 1-500 (default 500 = the hard cap); opts.ticketID / opts.resourceID eq narrowings sent server-side. Returns { items, postedCount, unpostedCount, window { from, to } (wire bounds, second precision), nextCursor, unconfirmed, truncated }: postedCount/unpostedCount split EVERY entry read (before state narrowing) while items is narrowed, so counts cover the returned rows ONLY (at most limit); truncated is true when the entry read has a live next-page cursor or a join page was truncated; unconfirmed entries sit in neither count nor items. Paging: opts.cursor (a previous nextCursor; a cursor whose path is not the TimeEntries continuation is refused RESPONSE_REJECTED; over 2048 chars refused). opts.countOnly: true (with opts.maxVendorCalls integer 1-200, default 30) returns the whole-window totals { window, total, postedCount, unpostedCount, vendorCalls, estimate, budget } instead of rows: one count call sizes the window, every entry page is read ids-only and joined at 250 ids per join, then the window is counted again — over budget BUDGET_EXCEEDED (the estimate named), a truncated join RESOLUTION_TRUNCATED, a distinct-id total equal to neither count INVALID_RESPONSE; no short total is ever returned. 429 and vendor faults propagate typed. Wire: one bounded POST /V1.0/TimeEntries/query (MaxRecords, dateWorked gte/lte + the eq narrowings) plus at most 2 BillingItems join queries (250 ids each). For a window with more rows than the cap, page with cursor or reconcile through time_entries.query with the same dateWorked filter (its 2500-row walk cap).",
|
|
39545
39606
|
"preferredWhen": null,
|
|
39546
39607
|
"related": [],
|
|
39547
39608
|
"passBackCursor": "nextCursor",
|
|
39548
|
-
"pointerNote": "
|
|
39609
|
+
"pointerNote": "time_entries.dateWorkedWindow derives posted state from a billing_items.timeEntryID join instead of filtering on a postedDate field. A matching billing item establishes posted state; the helper does not depend on billingApprovalDateTime. A billing-items read or join fault propagates as a typed error, without returning a partial posted-state result.",
|
|
39549
39610
|
"untrustedFields": [
|
|
39550
39611
|
"UDF1",
|
|
39551
39612
|
"UDF10",
|
|
@@ -40544,7 +40605,7 @@ const CAPABILITY_DATA = {
|
|
|
40544
40605
|
},
|
|
40545
40606
|
"metadata": {
|
|
40546
40607
|
"purpose": "Update a time entry.",
|
|
40547
|
-
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. ticketID does NOT persist on update: the vendor returns success but keeps the old ticketID (probed live
|
|
40608
|
+
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. ticketID does NOT persist on update: the vendor returns success but keeps the old ticketID (probed live, 2026-10-21). To re-parent use time_entries.moveToTicket (create, verify, delete). The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET; when a stale-check field is configured, the same read also supplies that guard) before the PUT; explicit nulls send null, omitted fields keep the current value. Pass raw: true in the opts bag to send the body as-is (no merge).",
|
|
40548
40609
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change. Not for ticketID: the vendor ignores it on update; use time_entries.moveToTicket.",
|
|
40549
40610
|
"related": [
|
|
40550
40611
|
"time_entries.get"
|
|
@@ -41966,7 +42027,7 @@ const CAPABILITY_DATA = {
|
|
|
41966
42027
|
"surface": "user_defined_field_definitions.count",
|
|
41967
42028
|
"kind": "unfiltered-blind",
|
|
41968
42029
|
"authority": "user_defined_field_definitions.get",
|
|
41969
|
-
"note": "
|
|
42030
|
+
"note": "The unfiltered user_defined_field_definitions count can return zero despite existing records. Re-check with an id gt 0 filter or page user_defined_field_definitions.query; the query is not classified blind by this count-only warning. A zero unfiltered count does not prove absence; verify a known record with user_defined_field_definitions.get if permitted."
|
|
41970
42031
|
},
|
|
41971
42032
|
"untrustedFields": [
|
|
41972
42033
|
"description",
|
|
@@ -42403,7 +42464,7 @@ const CAPABILITY_DATA = {
|
|
|
42403
42464
|
},
|
|
42404
42465
|
"metadata": {
|
|
42405
42466
|
"purpose": "Update a UDF definition.",
|
|
42406
|
-
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. Vendor constraints: `dataType` and `udfType` cannot be changed; `isFieldMapping` is immutable (a mapped field only accepts `isActive`/`sortOrder` updates); a `List` UDF's `defaultValue` is a list item's `valueForDisplay` (set it only after the items exist). The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET
|
|
42467
|
+
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. Vendor constraints: `dataType` and `udfType` cannot be changed; `isFieldMapping` is immutable (a mapped field only accepts `isActive`/`sortOrder` updates); a `List` UDF's `defaultValue` is a list item's `valueForDisplay` (set it only after the items exist). The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET; when a stale-check field is configured, the same read also supplies that guard) before the PUT; explicit nulls send null, omitted fields keep the current value. Pass raw: true in the opts bag to send the body as-is (no merge).",
|
|
42407
42468
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
42408
42469
|
"related": [
|
|
42409
42470
|
"user_defined_field_definitions.get"
|
|
@@ -42480,7 +42541,7 @@ const CAPABILITY_DATA = {
|
|
|
42480
42541
|
"surface": "user_defined_field_list_items.count",
|
|
42481
42542
|
"kind": "unfiltered-blind",
|
|
42482
42543
|
"authority": "user_defined_field_list_items.get",
|
|
42483
|
-
"note": "
|
|
42544
|
+
"note": "The unfiltered user_defined_field_list_items count can return zero despite existing records. Re-check with an id gt 0 filter or page user_defined_field_list_items.query; the query is not classified blind by this count-only warning. A zero unfiltered count does not prove absence; verify a known record with user_defined_field_list_items.get if permitted."
|
|
42484
42545
|
},
|
|
42485
42546
|
"untrustedFields": [
|
|
42486
42547
|
"valueForDisplay",
|
|
@@ -43071,8 +43132,8 @@ const CAPABILITY_DATA = {
|
|
|
43071
43132
|
]
|
|
43072
43133
|
},
|
|
43073
43134
|
"A": {
|
|
43074
|
-
"planHash": "
|
|
43075
|
-
"builtAt": "2026-11-
|
|
43135
|
+
"planHash": "94052c314d189d4b2fcf6bc842d983d4817c8410109074ed9505b682f4855790",
|
|
43136
|
+
"builtAt": "2026-11-17T05:04:54.690Z",
|
|
43076
43137
|
"records": [
|
|
43077
43138
|
{
|
|
43078
43139
|
"id": "companies.count",
|
|
@@ -43125,7 +43186,7 @@ const CAPABILITY_DATA = {
|
|
|
43125
43186
|
},
|
|
43126
43187
|
"metadata": {
|
|
43127
43188
|
"purpose": "Count company records matching a JSON filter.",
|
|
43128
|
-
"usage": "Unwraps queryCount; returns a plain number.
|
|
43189
|
+
"usage": "Unwraps queryCount; returns a plain number. Visibility caution: company count/query may omit records the API user cannot list; an empty result is inconclusive about tenant inventory. Verify a known record with get(id).",
|
|
43129
43190
|
"preferredWhen": null,
|
|
43130
43191
|
"related": [
|
|
43131
43192
|
"companies.query"
|
|
@@ -43135,7 +43196,7 @@ const CAPABILITY_DATA = {
|
|
|
43135
43196
|
"surface": "companies.count",
|
|
43136
43197
|
"kind": "unowned-blind",
|
|
43137
43198
|
"authority": "companies.get",
|
|
43138
|
-
"note": "companies count
|
|
43199
|
+
"note": "The companies count result may be limited by API-user visibility. A zero or empty response is INCONCLUSIVE about tenant inventory or API capability. Narrow the query and verify a known record with companies.get; if that read is not permitted, ask the user for the missing information."
|
|
43139
43200
|
},
|
|
43140
43201
|
"untrustedFields": [
|
|
43141
43202
|
"UDF1",
|
|
@@ -43192,7 +43253,7 @@ const CAPABILITY_DATA = {
|
|
|
43192
43253
|
},
|
|
43193
43254
|
"examples": [
|
|
43194
43255
|
"await client.companies.create({ companyName: 'Example', companyType: 1, phone: '1300555001', isActive: true, ownerResourceID: 2001 }, { dryRun: true })",
|
|
43195
|
-
"
|
|
43256
|
+
"validated: created a company with this body (required: companyName, companyType, phone, ownerResourceID — a non-API-only resource). CompanyModel has NO description field (the vendor silently 200s unknown fields); the create auto-creates a vendor \"Primary Address\" location (UI-only cleanup)."
|
|
43196
43257
|
],
|
|
43197
43258
|
"permissions": "unknown",
|
|
43198
43259
|
"pagination": {
|
|
@@ -43337,7 +43398,7 @@ const CAPABILITY_DATA = {
|
|
|
43337
43398
|
},
|
|
43338
43399
|
"examples": [
|
|
43339
43400
|
"await client.companies.fullProfile(1001)",
|
|
43340
|
-
"
|
|
43401
|
+
"Use a known company id. The openTickets query excludes the tenant-resolved closed statuses and discloses any fallback assumption in closedStatus. Empty lists do not establish tenant-wide absence; conservative visibility warnings depend on the applicable filter-aware predicate. A missing company returns NOT_FOUND."
|
|
43341
43402
|
],
|
|
43342
43403
|
"permissions": "unknown",
|
|
43343
43404
|
"pagination": {
|
|
@@ -43352,7 +43413,7 @@ const CAPABILITY_DATA = {
|
|
|
43352
43413
|
},
|
|
43353
43414
|
"metadata": {
|
|
43354
43415
|
"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.",
|
|
43355
|
-
"usage": "args[0] is the company id (number); args[1] (optional) is the options object { contactLimit?: number (default 50), noteLimit?: number (default 50), ticketLimit?: number (default 50), projectLimit?: number (default 50), names?: boolean (default false — ON adds the opt-in name/label siblings — the company row (owner / created-by resource names), the openTickets rows (the same closed-scope ticket-field siblings as tickets.fullContext, incl. the ticket picklist labels), the projects rows (lead / creator resource names + the contract name — project picklists stay OUT of the closed label scope) — + the top-level `names` section; the siblings ride the existing default-on caches (NO new cache)), maxNameReads?: number (default 20 — the budget of COLD wire name reads: cache hits are free of the budget, lowerable never raised; over-budget ids serve name: null and the names section sets `truncated: true`, never an error) }. Wire: exactly 6 reads (companies.get + 5 companyID-filtered queries). With names: true, N added name reads (N = the distinct uncached ids, capped by maxNameReads) + at most ONE fieldCatalog labels read (zero wire on a warm fieldCache). The openTickets part: open = status NOT in the resolved closed set — the closed ids come from the tenant's Tickets status picklist via `tickets.statusSemantics` (one cache-aware field-metadata read, zero wire on a warm cache), falling back to id 5 with `source: 'assumed'` and a part `note` that discloses it; the part carries `closedStatus { closedIds, source, note }` and the always-filtered query applies the resolved leaf (a single `not-eq` for one closed id, `notIn` for several);
|
|
43416
|
+
"usage": "args[0] is the company id (number); args[1] (optional) is the options object { contactLimit?: number (default 50), noteLimit?: number (default 50), ticketLimit?: number (default 50), projectLimit?: number (default 50), names?: boolean (default false — ON adds the opt-in name/label siblings — the company row (owner / created-by resource names), the openTickets rows (the same closed-scope ticket-field siblings as tickets.fullContext, incl. the ticket picklist labels), the projects rows (lead / creator resource names + the contract name — project picklists stay OUT of the closed label scope) — + the top-level `names` section; the siblings ride the existing default-on caches (NO new cache)), maxNameReads?: number (default 20 — the budget of COLD wire name reads: cache hits are free of the budget, lowerable never raised; over-budget ids serve name: null and the names section sets `truncated: true`, never an error) }. Wire: exactly 6 reads (companies.get + 5 companyID-filtered queries). With names: true, N added name reads (N = the distinct uncached ids, capped by maxNameReads) + at most ONE fieldCatalog labels read (zero wire on a warm fieldCache). The openTickets part: open = status NOT in the resolved closed set — the closed ids come from the tenant's Tickets status picklist via `tickets.statusSemantics` (one cache-aware field-metadata read, zero wire on a warm cache), falling back to id 5 with `source: 'assumed'` and a part `note` that discloses it; the part carries `closedStatus { closedIds, source, note }` and the always-filtered query applies the resolved leaf (a single `not-eq` for one closed id, `notIn` for several); an empty scoped query shows no records returned to this API user, not proven tenant-wide absence. A conservative visibility warning is attached only when its filter-aware predicate covers the call; non-empty rows are returned as data. A missing company returns NOT_FOUND.",
|
|
43356
43417
|
"preferredWhen": "The single read for 'what do you know about this company' — replaces 6 raw reads + describes with one call. companies.get alone is just the record.",
|
|
43357
43418
|
"related": [
|
|
43358
43419
|
"companies.get",
|
|
@@ -43362,7 +43423,7 @@ const CAPABILITY_DATA = {
|
|
|
43362
43423
|
"tickets.query",
|
|
43363
43424
|
"projects.query"
|
|
43364
43425
|
],
|
|
43365
|
-
"args": "args[0] is the company id (number); args[1] (optional) is the options object { contactLimit?: number, noteLimit?: number, ticketLimit?: number, projectLimit?: number } (all default 50), names?: boolean (default false — the opt-in name/label siblings + the `names` section), maxNameReads?: number (default 20, lowerable never raised — the budget of cold wire name reads).
|
|
43426
|
+
"args": "args[0] is the company id (number); args[1] (optional) is the options object { contactLimit?: number, noteLimit?: number, ticketLimit?: number, projectLimit?: number } (all default 50), names?: boolean (default false — the opt-in name/label siblings + the `names` section), maxNameReads?: number (default 20, lowerable never raised — the budget of cold wire name reads). Bounded reads only, with no mutations. Empty lists reflect the current API-user query result; verify a known id before inferring tenant-wide absence.",
|
|
43366
43427
|
"untrustedFields": [
|
|
43367
43428
|
"UDF1",
|
|
43368
43429
|
"UDF10",
|
|
@@ -43968,7 +44029,7 @@ const CAPABILITY_DATA = {
|
|
|
43968
44029
|
},
|
|
43969
44030
|
"metadata": {
|
|
43970
44031
|
"purpose": "Query Company records with a JSON filter.",
|
|
43971
|
-
"usage": "Server-side pagination: one call walks the vendor cursor internally (page 1 POSTs the QueryModel body with MaxRecords = the walk's internal page size (at most 500; the default POST path — `via: 'get'` issues a GET on page 1); later pages POST the SAME body — IncludeFields, MaxRecords and the preserved filter — to the absolute vendor cursor, rebased to the client base URL; the vendor honours IncludeFields on a continuation and ignores MaxRecords there, so a later page carries the vendor's own page size) until the limit is met or the cursor is null; 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).
|
|
44032
|
+
"usage": "Server-side pagination: one call walks the vendor cursor internally (page 1 POSTs the QueryModel body with MaxRecords = the walk's internal page size (at most 500; the default POST path — `via: 'get'` issues a GET on page 1); later pages POST the SAME body — IncludeFields, MaxRecords and the preserved filter — to the absolute vendor cursor, rebased to the client base URL; the vendor honours IncludeFields on a continuation and ignores MaxRecords there, so a later page carries the vendor's own page size) until the limit is met or the cursor is null; 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). Visibility caution: company count/query may omit records the API user cannot list; an empty result is inconclusive about tenant inventory. Verify a known record with get(id). 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.",
|
|
43972
44033
|
"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).",
|
|
43973
44034
|
"related": [
|
|
43974
44035
|
"companies.resolve"
|
|
@@ -43978,7 +44039,7 @@ const CAPABILITY_DATA = {
|
|
|
43978
44039
|
"surface": "companies.query",
|
|
43979
44040
|
"kind": "unowned-blind",
|
|
43980
44041
|
"authority": "companies.get",
|
|
43981
|
-
"note": "companies
|
|
44042
|
+
"note": "The companies query result may be limited by API-user visibility. A zero or empty response is INCONCLUSIVE about tenant inventory or API capability. Narrow the query and verify a known record with companies.get; if that read is not permitted, ask the user for the missing information."
|
|
43982
44043
|
},
|
|
43983
44044
|
"untrustedFields": [
|
|
43984
44045
|
"UDF1",
|
|
@@ -44467,7 +44528,7 @@ const CAPABILITY_DATA = {
|
|
|
44467
44528
|
},
|
|
44468
44529
|
"examples": [
|
|
44469
44530
|
"await client.companies.unbilledWork(1001, { source: 'posted_uninvoiced', includeParent: true, limit: 50 })",
|
|
44470
|
-
"Synthetic shape (no tenant data): args (company id, optional UnbilledWorkOptions). 6(+1) bounded reads, zero mutating — the join rides the company's tickets AND the company's projects' tasks (the vendored time_entries model carries no company field); the billing part rides the billing_join column list; the unposted anti-join + totals + warnings are client-side (zero wire); a filtered empty part
|
|
44531
|
+
"Synthetic shape (no tenant data): args (company id, optional UnbilledWorkOptions). 6(+1) bounded reads, zero mutating — the join rides the company's tickets AND the company's projects' tasks (the vendored time_entries model carries no company field); the billing part rides the billing_join column list; the unposted anti-join + totals + warnings are client-side (zero wire); a filtered empty part reports no rows returned under current API-user visibility, without establishing tenant-wide absence; company missing → NOT_FOUND."
|
|
44471
44532
|
],
|
|
44472
44533
|
"permissions": "unknown",
|
|
44473
44534
|
"pagination": {
|
|
@@ -44482,7 +44543,7 @@ const CAPABILITY_DATA = {
|
|
|
44482
44543
|
},
|
|
44483
44544
|
"metadata": {
|
|
44484
44545
|
"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",
|
|
44485
|
-
"usage": "args[0] is the company id (number); args[1] (optional) is UnbilledWorkOptions { source?: 'posted_uninvoiced' (default — the billing items with no invoiceID (notExist), the uninvoiced mark) | 'invoice' (invoiceID = invoiceId; the invoice record itself is NOT fetched in v1 — the items already carry invoiceID/itemDate/amounts) | 'date_range' (itemDate window — dateFrom + dateTo REQUIRED) | 'tickets' (ticketID in ticketIds; the time-entries part additionally joins those tickets directly), includeParent?: boolean (default true — ONE level only, via company.parentCompanyID; dangling → parent: null, parent parts empty, NOT an error), dateFrom?/dateTo?: string (YYYY-MM-DD — the itemDate window on the billing part in EVERY source, the dateWorked window on the time part; required for date_range), invoiceId?: number | string (required shape for invoice), ticketIds?: (number | string)[] (required non-empty for tickets), includeNotes?: boolean (default false — the note fields EXCLUDED; when true the time part requests summaryNotes and the billing part description, each capped at noteChars with the marker BEFORE the server-side untrusted wrapper), noteChars?: number (default 400, integer >= 1), rollup?: 'ticket' (default — per-ticket rows; the unassigned bucket carries ticketId null) | 'entry' (the capped per-entry list), limit?: number (default 50, clamped 1..500 — the per-part record cap) }. Wire: exactly 6 bounded reads without a parent (company get + tickets + projects + tasks + billing + time queries), 7 with a parent present — zero mutating; includeNotes/noteChars/rollup add ZERO wire (response-side). The join: the company's ticket ids (tickets query, companyID in) + the company's task ids (projects query, companyID in → tasks query, projectID in); the time query is or [taskID in, ticketID in] (the join sets are capped at 300 ids per list — the 8000-char filter cap — with a documented note when truncated); an EMPTY join set skips the time part with status 'skipped' + the honest note (no tasks/tickets to join against is NOT evidence of no time entries). Per part: the capped/hasMore flags + the status 'ok' | 'blind' | 'skipped' (the blind stamp is the filter-aware predicate — a
|
|
44546
|
+
"usage": "args[0] is the company id (number); args[1] (optional) is UnbilledWorkOptions { source?: 'posted_uninvoiced' (default — the billing items with no invoiceID (notExist), the uninvoiced mark) | 'invoice' (invoiceID = invoiceId; the invoice record itself is NOT fetched in v1 — the items already carry invoiceID/itemDate/amounts) | 'date_range' (itemDate window — dateFrom + dateTo REQUIRED) | 'tickets' (ticketID in ticketIds; the time-entries part additionally joins those tickets directly), includeParent?: boolean (default true — ONE level only, via company.parentCompanyID; dangling → parent: null, parent parts empty, NOT an error), dateFrom?/dateTo?: string (YYYY-MM-DD — the itemDate window on the billing part in EVERY source, the dateWorked window on the time part; required for date_range), invoiceId?: number | string (required shape for invoice), ticketIds?: (number | string)[] (required non-empty for tickets), includeNotes?: boolean (default false — the note fields EXCLUDED; when true the time part requests summaryNotes and the billing part description, each capped at noteChars with the marker BEFORE the server-side untrusted wrapper), noteChars?: number (default 400, integer >= 1), rollup?: 'ticket' (default — per-ticket rows; the unassigned bucket carries ticketId null) | 'entry' (the capped per-entry list), limit?: number (default 50, clamped 1..500 — the per-part record cap) }. Wire: exactly 6 bounded reads without a parent (company get + tickets + projects + tasks + billing + time queries), 7 with a parent present — zero mutating; includeNotes/noteChars/rollup add ZERO wire (response-side). The join: the company's ticket ids (tickets query, companyID in) + the company's task ids (projects query, companyID in → tasks query, projectID in); the time query is or [taskID in, ticketID in] (the join sets are capped at 300 ids per list — the 8000-char filter cap — with a documented note when truncated); an EMPTY join set skips the time part with status 'skipped' + the honest note (no tasks/tickets to join against is NOT evidence of no time entries). Per part: the capped/hasMore flags + the status 'ok' | 'blind' | 'skipped' (the blind stamp is the filter-aware predicate — a filtered empty part reports no rows returned under current API-user visibility, without establishing tenant-wide absence; unfiltered-blind surfaces do not stamp filtered calls). The billing part rides the billing_join column list as its IncludeFields (the join's columns, + id; + description with includeNotes). The client-side folds (zero wire): rollup (billing items by ticketID; time entries by their own ticketID — the vendored TaskModel carries no ticket field, so the entry's own ticketID is the only resolvable ticket link; null → the unassigned bucket), unposted (the fetched entries whose id is in no fetched billing item's timeEntryID), totals { preTax = Σ extendedPrice, hours = Σ hoursWorked, entryCount, totalAmount, taxDollars — surfaced for reconciliation } derived from the SAME folded rows (one source of truth), warnings { noTimeEntry (the billing items whose timeEntryID is empty/0 — capped list + count), hourDelta (the billing items WITH a resolvable time entry where |billed quantity − hoursWorked| > 0 — strict; capped list + count) }. Company missing → NOT_FOUND (zero further wire). Closed opts bag: an unknown key → typed CONFIG_ERROR naming the key + the valid keys (one-round complete problem list, pre-request, zero wire).",
|
|
44486
44547
|
"preferredWhen": "For allocation-style questions about one company's posted/uninvoiced work — replaces the multi-call billing×time×ticket hand-join; companies.fullProfile for the general company picture; operations.aggregate for cross-resource existence/totals",
|
|
44487
44548
|
"related": [
|
|
44488
44549
|
"companies.fullProfile",
|
|
@@ -44585,7 +44646,7 @@ const CAPABILITY_DATA = {
|
|
|
44585
44646
|
},
|
|
44586
44647
|
"metadata": {
|
|
44587
44648
|
"purpose": "Update a company.",
|
|
44588
|
-
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. CompanyModel has no `description` field (61 spec properties); the vendor accepts and 200s unknown fields on update with NO state change (receipt) — use documented fields; verify the changed field via get, not the 200. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET
|
|
44649
|
+
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. CompanyModel has no `description` field (61 spec properties); the vendor accepts and 200s unknown fields on update with NO state change (receipt) — use documented fields; verify the changed field via get, not the 200. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET; when a stale-check field is configured, the same read also supplies that guard) before the PUT; explicit nulls send null, omitted fields keep the current value. Pass raw: true in the opts bag to send the body as-is (no merge). No delete: the vendor defines no DELETE for this entity (the endpoint 405s; cleanup is UI-only).",
|
|
44589
44650
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
44590
44651
|
"related": [
|
|
44591
44652
|
"companies.get"
|
|
@@ -47960,7 +48021,7 @@ const CAPABILITY_DATA = {
|
|
|
47960
48021
|
},
|
|
47961
48022
|
"metadata": {
|
|
47962
48023
|
"purpose": "Update a company webhook.",
|
|
47963
|
-
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET
|
|
48024
|
+
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET; when a stale-check field is configured, the same read also supplies that guard) before the PUT; explicit nulls send null, omitted fields keep the current value. Pass raw: true in the opts bag to send the body as-is (no merge).",
|
|
47964
48025
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
47965
48026
|
"related": [
|
|
47966
48027
|
"company_webhooks.get"
|
|
@@ -51527,7 +51588,7 @@ const CAPABILITY_DATA = {
|
|
|
51527
51588
|
},
|
|
51528
51589
|
"metadata": {
|
|
51529
51590
|
"purpose": "Update a configuration item webhook.",
|
|
51530
|
-
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET
|
|
51591
|
+
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET; when a stale-check field is configured, the same read also supplies that guard) before the PUT; explicit nulls send null, omitted fields keep the current value. Pass raw: true in the opts bag to send the body as-is (no merge).",
|
|
51531
51592
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
51532
51593
|
"related": [
|
|
51533
51594
|
"configuration_item_webhooks.get"
|
|
@@ -51651,7 +51712,7 @@ const CAPABILITY_DATA = {
|
|
|
51651
51712
|
},
|
|
51652
51713
|
"examples": [
|
|
51653
51714
|
"await client.configurationItems.create({ companyID: 1001, productID: 123, isActive: true }, { dryRun: true })",
|
|
51654
|
-
"
|
|
51715
|
+
"Illustrative ids only: replace companyID and productID with known tenant records, then preview the create before applying it."
|
|
51655
51716
|
],
|
|
51656
51717
|
"permissions": "unknown",
|
|
51657
51718
|
"pagination": {
|
|
@@ -51666,7 +51727,7 @@ const CAPABILITY_DATA = {
|
|
|
51666
51727
|
},
|
|
51667
51728
|
"metadata": {
|
|
51668
51729
|
"purpose": "Create a configuration item.",
|
|
51669
|
-
"usage": "Returns OperationResultModel.itemId (the new id); the full record is not returned — follow up with get where needed.
|
|
51730
|
+
"usage": "Returns OperationResultModel.itemId (the new id); the full record is not returned — follow up with get where needed. productID must reference an existing Product; resolve it from tenant data or ask for a known id. No delete: the vendor defines no DELETE for this entity (the endpoint 405s; cleanup is UI-only).",
|
|
51670
51731
|
"preferredWhen": "Only for a record that does not exist yet; prefer update for an id you already have.",
|
|
51671
51732
|
"related": [
|
|
51672
51733
|
"configuration_items.update"
|
|
@@ -52279,7 +52340,7 @@ const CAPABILITY_DATA = {
|
|
|
52279
52340
|
},
|
|
52280
52341
|
"examples": [
|
|
52281
52342
|
"await client.configurationItems.profile(1)",
|
|
52282
|
-
"
|
|
52343
|
+
"Replace the illustrative id with a known configuration item (asset/device) id. The profile reads the item and its related records; a missing item returns NOT_FOUND. Product-association rows are returned from the scoped query, without inferring tenant inventory from a product count."
|
|
52283
52344
|
],
|
|
52284
52345
|
"permissions": "unknown",
|
|
52285
52346
|
"pagination": {
|
|
@@ -52294,7 +52355,7 @@ const CAPABILITY_DATA = {
|
|
|
52294
52355
|
},
|
|
52295
52356
|
"metadata": {
|
|
52296
52357
|
"purpose": "Get the full profile of one configuration item in a single call: the item, its type and category records, its notes, related items and billing-product associations.",
|
|
52297
|
-
"usage": "args[0] is the configuration item id (number); args[1] (optional) is the options object { noteLimit?: number (default 50), relatedLimit?: number (default 50), names?: boolean (default false — ON adds the opt-in name sibling on the ci row (closed scope: the contract name — the CI row has no issue-listed picklist fields, so no labels) + the top-level `names` section; the sibling rides the existing default-on caches (NO new cache)), maxNameReads?: number (default 20 — the budget of COLD wire name reads, lowerable never raised; over-budget ids serve name: null and the names section sets `truncated: true`, never an error) }. Wire: <=6 reads (get + type + category + 3 item-scoped queries; a dangling type/category FK skips its read). With names: true, N added name reads (N = the distinct uncached FK ids, capped by maxNameReads). productAssociations
|
|
52358
|
+
"usage": "args[0] is the configuration item id (number); args[1] (optional) is the options object { noteLimit?: number (default 50), relatedLimit?: number (default 50), names?: boolean (default false — ON adds the opt-in name sibling on the ci row (closed scope: the contract name — the CI row has no issue-listed picklist fields, so no labels) + the top-level `names` section; the sibling rides the existing default-on caches (NO new cache)), maxNameReads?: number (default 20 — the budget of COLD wire name reads, lowerable never raised; over-budget ids serve name: null and the names section sets `truncated: true`, never an error) }. Wire: <=6 reads (get + type + category + 3 item-scoped queries; a dangling type/category FK skips its read). With names: true, N added name reads (N = the distinct uncached FK ids, capped by maxNameReads). productAssociations contains the scoped query rows and capped flag, with blind: false on a successful read; a product create requirement does not imply that associations are unreadable. A missing configuration item returns NOT_FOUND.",
|
|
52298
52359
|
"preferredWhen": "The single read for 'what is this configuration item' — replaces 5-6 raw reads + describes with one call.",
|
|
52299
52360
|
"related": [
|
|
52300
52361
|
"configuration_items.get",
|
|
@@ -52305,7 +52366,7 @@ const CAPABILITY_DATA = {
|
|
|
52305
52366
|
"configuration_item_types.get",
|
|
52306
52367
|
"configuration_item_categories.get"
|
|
52307
52368
|
],
|
|
52308
|
-
"args": "args[0] is the configuration item id (number); args[1] (optional) is the options object { noteLimit?: number (default 50), relatedLimit?: number (default 50), names?: boolean (default false — the opt-in contract-name sibling on the ci row + the `names` section), maxNameReads?: number (default 20, lowerable never raised — the budget of cold wire name reads) }. <=6 bounded reads inside, zero mutating;
|
|
52369
|
+
"args": "args[0] is the configuration item id (number); args[1] (optional) is the options object { noteLimit?: number (default 50), relatedLimit?: number (default 50), names?: boolean (default false — the opt-in contract-name sibling on the ci row + the `names` section), maxNameReads?: number (default 20, lowerable never raised — the budget of cold wire name reads) }. <=6 bounded reads inside, zero mutating; product associations are returned from the scoped vendor query without a static inventory or visibility assumption.",
|
|
52309
52370
|
"untrustedFields": [
|
|
52310
52371
|
"UDF1",
|
|
52311
52372
|
"UDF10",
|
|
@@ -52700,7 +52761,7 @@ const CAPABILITY_DATA = {
|
|
|
52700
52761
|
},
|
|
52701
52762
|
"metadata": {
|
|
52702
52763
|
"purpose": "Update a configuration item.",
|
|
52703
|
-
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET
|
|
52764
|
+
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET; when a stale-check field is configured, the same read also supplies that guard) before the PUT; explicit nulls send null, omitted fields keep the current value. Pass raw: true in the opts bag to send the body as-is (no merge). No delete: the vendor defines no DELETE for this entity (the endpoint 405s; cleanup is UI-only).",
|
|
52704
52765
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
52705
52766
|
"related": [
|
|
52706
52767
|
"configuration_items.get"
|
|
@@ -53418,7 +53479,7 @@ const CAPABILITY_DATA = {
|
|
|
53418
53479
|
},
|
|
53419
53480
|
"metadata": {
|
|
53420
53481
|
"purpose": "Update a contact webhook.",
|
|
53421
|
-
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET
|
|
53482
|
+
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET; when a stale-check field is configured, the same read also supplies that guard) before the PUT; explicit nulls send null, omitted fields keep the current value. Pass raw: true in the opts bag to send the body as-is (no merge).",
|
|
53422
53483
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
53423
53484
|
"related": [
|
|
53424
53485
|
"contact_webhooks.get"
|
|
@@ -53551,7 +53612,7 @@ const CAPABILITY_DATA = {
|
|
|
53551
53612
|
},
|
|
53552
53613
|
"examples": [
|
|
53553
53614
|
"await client.contacts.create(1001, { firstName: 'Jane', lastName: 'Doe', companyID: 1001, isActive: 1 }, { dryRun: true })",
|
|
53554
|
-
"
|
|
53615
|
+
"validated required set: firstName, lastName, companyID, isActive — isActive is a NUMBER (1/0), not a boolean (a JSON boolean 500s at the vendor parse layer). The create is parent-scoped (the company id rides the scoped path + the body)."
|
|
53555
53616
|
],
|
|
53556
53617
|
"permissions": "unknown",
|
|
53557
53618
|
"pagination": {
|
|
@@ -53566,7 +53627,7 @@ const CAPABILITY_DATA = {
|
|
|
53566
53627
|
},
|
|
53567
53628
|
"metadata": {
|
|
53568
53629
|
"purpose": "Create a contact. (under a company)",
|
|
53569
|
-
"usage": "Returns OperationResultModel.itemId (the new id); the full record is not returned — follow up with get where needed. Parent-scoped: parentId is a path parameter. Live-required: firstName, lastName, companyID, isActive — isActive is a NUMBER (1), not a boolean
|
|
53630
|
+
"usage": "Returns OperationResultModel.itemId (the new id); the full record is not returned — follow up with get where needed. Parent-scoped: parentId is a path parameter. Live-required: firstName, lastName, companyID, isActive — isActive is a NUMBER (1), not a boolean; the spec declares no required fields.",
|
|
53570
53631
|
"preferredWhen": "Only for a record that does not exist yet; prefer update for an id you already have.",
|
|
53571
53632
|
"related": [
|
|
53572
53633
|
"contacts.update"
|
|
@@ -54770,7 +54831,7 @@ const CAPABILITY_DATA = {
|
|
|
54770
54831
|
},
|
|
54771
54832
|
"metadata": {
|
|
54772
54833
|
"purpose": "Update a contact. (under a company)",
|
|
54773
|
-
"usage": "Issues PATCH on the collection (swagger documents put+patch there; the node strips the id from the path and the vendor keys the record by the id in the body). Stale check via lastModifiedDate where present. Parent-scoped: parentId + id. isActive is a NUMBER (1/0)
|
|
54834
|
+
"usage": "Issues PATCH on the collection (swagger documents put+patch there; the node strips the id from the path and the vendor keys the record by the id in the body). Stale check via lastModifiedDate where present. Parent-scoped: parentId + id. isActive is a NUMBER (1/0) — a JSON boolean 500s at the vendor parse layer (ContactModel; LocationModel takes a boolean).",
|
|
54774
54835
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
54775
54836
|
"related": [
|
|
54776
54837
|
"contacts.get"
|
|
@@ -56635,7 +56696,7 @@ const CAPABILITY_DATA = {
|
|
|
56635
56696
|
},
|
|
56636
56697
|
"metadata": {
|
|
56637
56698
|
"purpose": "Create a contract charge.",
|
|
56638
|
-
"usage": "Returns OperationResultModel.itemId (the new id); the full record is not returned — follow up with get where needed. Parent-scoped: parentId is a path parameter.
|
|
56699
|
+
"usage": "Returns OperationResultModel.itemId (the new id); the full record is not returned — follow up with get where needed. Parent-scoped: parentId is a path parameter. The parentId path parameter must name a valid contracts record. Query the current tenant or read a known parent id; if the API user cannot read the required record, ask for the id. Do not infer API unavailability from an empty list.",
|
|
56639
56700
|
"preferredWhen": "Only for a record that does not exist yet; prefer update for an id you already have.",
|
|
56640
56701
|
"related": [
|
|
56641
56702
|
"contract_charges.update"
|
|
@@ -64413,7 +64474,7 @@ const CAPABILITY_DATA = {
|
|
|
64413
64474
|
]
|
|
64414
64475
|
},
|
|
64415
64476
|
"writeQuirks": {
|
|
64416
|
-
"dateConventions": "date convention (
|
|
64477
|
+
"dateConventions": "date convention (verify against current field metadata): startDate and endDate are date-only at 00:00Z; tickets.dueDateTime is a true UTC instant."
|
|
64417
64478
|
}
|
|
64418
64479
|
},
|
|
64419
64480
|
"compact": null,
|
|
@@ -65500,7 +65561,7 @@ const CAPABILITY_DATA = {
|
|
|
65500
65561
|
},
|
|
65501
65562
|
"metadata": {
|
|
65502
65563
|
"purpose": "Update a contract.",
|
|
65503
|
-
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET
|
|
65564
|
+
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET; when a stale-check field is configured, the same read also supplies that guard) before the PUT; explicit nulls send null, omitted fields keep the current value. Pass raw: true in the opts bag to send the body as-is (no merge).",
|
|
65504
65565
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
65505
65566
|
"related": [
|
|
65506
65567
|
"contracts.get"
|
|
@@ -65532,7 +65593,7 @@ const CAPABILITY_DATA = {
|
|
|
65532
65593
|
"description"
|
|
65533
65594
|
],
|
|
65534
65595
|
"writeQuirks": {
|
|
65535
|
-
"dateConventions": "date convention (
|
|
65596
|
+
"dateConventions": "date convention (verify against current field metadata): startDate and endDate are date-only at 00:00Z; tickets.dueDateTime is a true UTC instant."
|
|
65536
65597
|
}
|
|
65537
65598
|
},
|
|
65538
65599
|
"compact": null,
|
|
@@ -66191,7 +66252,7 @@ const CAPABILITY_DATA = {
|
|
|
66191
66252
|
},
|
|
66192
66253
|
"metadata": {
|
|
66193
66254
|
"purpose": "Update an invoice.",
|
|
66194
|
-
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET
|
|
66255
|
+
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET; when a stale-check field is configured, the same read also supplies that guard) before the PUT; explicit nulls send null, omitted fields keep the current value. Pass raw: true in the opts bag to send the body as-is (no merge).",
|
|
66195
66256
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
66196
66257
|
"related": [
|
|
66197
66258
|
"invoices.get"
|
|
@@ -66983,7 +67044,7 @@ const CAPABILITY_DATA = {
|
|
|
66983
67044
|
},
|
|
66984
67045
|
"metadata": {
|
|
66985
67046
|
"purpose": "Update an opportunity.",
|
|
66986
|
-
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET
|
|
67047
|
+
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET; when a stale-check field is configured, the same read also supplies that guard) before the PUT; explicit nulls send null, omitted fields keep the current value. Pass raw: true in the opts bag to send the body as-is (no merge).",
|
|
66987
67048
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
66988
67049
|
"related": [
|
|
66989
67050
|
"opportunities.get"
|
|
@@ -68337,7 +68398,7 @@ const CAPABILITY_DATA = {
|
|
|
68337
68398
|
},
|
|
68338
68399
|
"metadata": {
|
|
68339
68400
|
"purpose": "Create a project charge.",
|
|
68340
|
-
"usage": "Returns OperationResultModel.itemId (the new id); the full record is not returned — follow up with get where needed. Parent-scoped: parentId is a path parameter.
|
|
68401
|
+
"usage": "Returns OperationResultModel.itemId (the new id); the full record is not returned — follow up with get where needed. Parent-scoped: parentId is a path parameter. The parentId path parameter must name a valid projects record. Query the current tenant or read a known parent id; if the API user cannot read the required record, ask for the id. Do not infer API unavailability from an empty list.",
|
|
68341
68402
|
"preferredWhen": "Only for a record that does not exist yet; prefer update for an id you already have.",
|
|
68342
68403
|
"related": [
|
|
68343
68404
|
"project_charges.update"
|
|
@@ -69645,7 +69706,7 @@ const CAPABILITY_DATA = {
|
|
|
69645
69706
|
},
|
|
69646
69707
|
"examples": [
|
|
69647
69708
|
"await client.projects.create({ projectName: 'Example', description: 'Example', companyID: 0, projectType: 2, status: 1, startDateTime: '2026-10-03T00:00:00Z', endDateTime: '2026-10-10T00:00:00Z' }, { dryRun: true })",
|
|
69648
|
-
"
|
|
69709
|
+
"validated: created a project with this full proven body (companyID 0 = tenant-global; project 8002 was a sample record, never-mutated fixture reference). Per-field minimality was not isolated live — keep the full shape."
|
|
69649
69710
|
],
|
|
69650
69711
|
"permissions": "unknown",
|
|
69651
69712
|
"pagination": {
|
|
@@ -70467,7 +70528,7 @@ const CAPABILITY_DATA = {
|
|
|
70467
70528
|
},
|
|
70468
70529
|
"metadata": {
|
|
70469
70530
|
"purpose": "Update a project.",
|
|
70470
|
-
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET
|
|
70531
|
+
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET; when a stale-check field is configured, the same read also supplies that guard) before the PUT; explicit nulls send null, omitted fields keep the current value. Pass raw: true in the opts bag to send the body as-is (no merge). No delete: the vendor defines no DELETE for this entity (the endpoint 405s; cleanup is UI-only).",
|
|
70471
70532
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
70472
70533
|
"related": [
|
|
70473
70534
|
"projects.get"
|
|
@@ -71730,7 +71791,7 @@ const CAPABILITY_DATA = {
|
|
|
71730
71791
|
},
|
|
71731
71792
|
"metadata": {
|
|
71732
71793
|
"purpose": "Update a quote location.",
|
|
71733
|
-
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET
|
|
71794
|
+
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET; when a stale-check field is configured, the same read also supplies that guard) before the PUT; explicit nulls send null, omitted fields keep the current value. Pass raw: true in the opts bag to send the body as-is (no merge).",
|
|
71734
71795
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
71735
71796
|
"related": [
|
|
71736
71797
|
"quote_locations.get"
|
|
@@ -72381,7 +72442,7 @@ const CAPABILITY_DATA = {
|
|
|
72381
72442
|
},
|
|
72382
72443
|
"metadata": {
|
|
72383
72444
|
"purpose": "Update a quote.",
|
|
72384
|
-
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET
|
|
72445
|
+
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET; when a stale-check field is configured, the same read also supplies that guard) before the PUT; explicit nulls send null, omitted fields keep the current value. Pass raw: true in the opts bag to send the body as-is (no merge).",
|
|
72385
72446
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
72386
72447
|
"related": [
|
|
72387
72448
|
"quotes.get"
|
|
@@ -73252,7 +73313,7 @@ const CAPABILITY_DATA = {
|
|
|
73252
73313
|
},
|
|
73253
73314
|
"metadata": {
|
|
73254
73315
|
"purpose": "Update a subscription.",
|
|
73255
|
-
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET
|
|
73316
|
+
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET; when a stale-check field is configured, the same read also supplies that guard) before the PUT; explicit nulls send null, omitted fields keep the current value. Pass raw: true in the opts bag to send the body as-is (no merge).",
|
|
73256
73317
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
73257
73318
|
"related": [
|
|
73258
73319
|
"subscriptions.get"
|
|
@@ -73938,7 +73999,7 @@ const CAPABILITY_DATA = {
|
|
|
73938
73999
|
},
|
|
73939
74000
|
"examples": [
|
|
73940
74001
|
"await client.tasks.create(8001, { title: 'Example', projectID: 8001, taskType: 1, status: 1 }, { dryRun: true })",
|
|
73941
|
-
"
|
|
74002
|
+
"verified: created task 7003 with this body under project 8001 (the DEL-GAP fixture — FK/read only, never mutated). projectID is REQUIRED IN THE BODY (the scoped parent path carries the parent too); taskType is an integer picklist (1/2); a missing required field 500s with a typed field-level error."
|
|
73942
74003
|
],
|
|
73943
74004
|
"permissions": "unknown",
|
|
73944
74005
|
"pagination": {
|
|
@@ -77705,7 +77766,7 @@ const CAPABILITY_DATA = {
|
|
|
77705
77766
|
},
|
|
77706
77767
|
"metadata": {
|
|
77707
77768
|
"purpose": "Update a ticket charge.",
|
|
77708
|
-
"usage": "Issues PATCH on the collection (swagger documents put+patch there; the node strips the id from the path and the vendor keys the record by the id in the body). Stale check via lastModifiedDate where present. Parent-scoped: parentId + id. ticketID does NOT persist on update (success returned, old ticketID kept; probed live
|
|
77769
|
+
"usage": "Issues PATCH on the collection (swagger documents put+patch there; the node strips the id from the path and the vendor keys the record by the id in the body). Stale check via lastModifiedDate where present. Parent-scoped: parentId + id. ticketID does NOT persist on update (success returned, old ticketID kept; probed live, 2026-10-21). To re-parent use ticket_charges.moveToTicket (create, verify, delete).",
|
|
77709
77770
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change. Not for ticketID: use ticket_charges.moveToTicket.",
|
|
77710
77771
|
"related": [
|
|
77711
77772
|
"ticket_charges.get"
|
|
@@ -78758,8 +78819,8 @@ const CAPABILITY_DATA = {
|
|
|
78758
78819
|
"drops": []
|
|
78759
78820
|
},
|
|
78760
78821
|
"examples": [
|
|
78761
|
-
"await client.ticketNotes.create(7001, { description: 'Example', noteType: 1, publish: 1 }, { dryRun: true })",
|
|
78762
|
-
"
|
|
78822
|
+
"await client.ticketNotes.create(7001, { description: 'Example', noteType: 1, publish: 1, title: 'Example' }, { dryRun: true })",
|
|
78823
|
+
"validated: a title-less note was created under ticket 7001; with a title the create succeeds and without one the vendor refuses (body verbatim: \"Missing Required Field: title.\"); publish is an INTEGER picklist (1/2/4), NOT a boolean (a JSON boolean 500s); noteType is an integer; ticketID is NOT in the body (the scoped parent path supplies it)."
|
|
78763
78824
|
],
|
|
78764
78825
|
"permissions": "unknown",
|
|
78765
78826
|
"pagination": {
|
|
@@ -78774,7 +78835,7 @@ const CAPABILITY_DATA = {
|
|
|
78774
78835
|
},
|
|
78775
78836
|
"metadata": {
|
|
78776
78837
|
"purpose": "Create a ticket note.",
|
|
78777
|
-
"usage": "Returns OperationResultModel.itemId (the new id); the full record is not returned — follow up with get where needed. Parent-scoped: parentId is a path parameter. publish is an integer picklist (1/2/4) and noteType is an integer — both INT, a JSON boolean 500s at the vendor parse layer. Live-required: description, noteType, publish; ticketID is NOT in the body (the scoped parent path supplies it)
|
|
78838
|
+
"usage": "Returns OperationResultModel.itemId (the new id); the full record is not returned — follow up with get where needed. Parent-scoped: parentId is a path parameter. publish is an integer picklist (1/2/4) and noteType is an integer — both INT, a JSON boolean 500s at the vendor parse layer. Live-required: description, noteType, publish, title; ticketID is NOT in the body (the scoped parent path supplies it). A title-less create is refused by the vendor (\"Missing Required Field: title.\"); a create with title succeeded. No delete: the vendor defines no DELETE for this entity (the endpoint 405s; cleanup is UI-only).",
|
|
78778
78839
|
"preferredWhen": "Only for a record that does not exist yet; prefer update for an id you already have.",
|
|
78779
78840
|
"related": [
|
|
78780
78841
|
"ticket_notes.update"
|
|
@@ -79234,7 +79295,7 @@ const CAPABILITY_DATA = {
|
|
|
79234
79295
|
},
|
|
79235
79296
|
"metadata": {
|
|
79236
79297
|
"purpose": "Update a ticket note.",
|
|
79237
|
-
"usage": "Issues PATCH on the collection (swagger documents put+patch there; the node strips the id from the path and the vendor keys the record by the id in the body). Stale check via lastModifiedDate where present. Parent-scoped: parentId + id. Setting ticketID in the body MOVES the note: the parent-scoped update (oldTicketID, noteId, { ticketID: newTicketID }) persists (probed live
|
|
79298
|
+
"usage": "Issues PATCH on the collection (swagger documents put+patch there; the node strips the id from the path and the vendor keys the record by the id in the body). Stale check via lastModifiedDate where present. Parent-scoped: parentId + id. Setting ticketID in the body MOVES the note: the parent-scoped update (oldTicketID, noteId, { ticketID: newTicketID }) persists (probed live, 2026-10-21). There is no unscoped route (404) and notes cannot be deleted (405), so a note is never moved by create-then-delete. No delete: the vendor defines no DELETE for this entity (the endpoint 405s; cleanup is UI-only).",
|
|
79238
79299
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
79239
79300
|
"related": [
|
|
79240
79301
|
"ticket_notes.get"
|
|
@@ -80467,7 +80528,7 @@ const CAPABILITY_DATA = {
|
|
|
80467
80528
|
},
|
|
80468
80529
|
"metadata": {
|
|
80469
80530
|
"purpose": "Update a ticket webhook.",
|
|
80470
|
-
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET
|
|
80531
|
+
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET; when a stale-check field is configured, the same read also supplies that guard) before the PUT; explicit nulls send null, omitted fields keep the current value. Pass raw: true in the opts bag to send the body as-is (no merge).",
|
|
80471
80532
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
80472
80533
|
"related": [
|
|
80473
80534
|
"ticket_webhooks.get"
|
|
@@ -80515,7 +80576,7 @@ const CAPABILITY_DATA = {
|
|
|
80515
80576
|
},
|
|
80516
80577
|
"examples": [
|
|
80517
80578
|
"await client.tickets.changeStatus(7002, 14, {}, { dryRun: true })",
|
|
80518
|
-
"
|
|
80579
|
+
"args (ticket id, targetStatus from the tenant's LIVE status picklist (the entity metadata is the oracle; the values + labels are discoverable with operations.fieldCatalog({ resources: [tickets], fields: [status], labels: true })), optional caller fields, opts). The node validates the status pre-request against the live picklist (the vendor's own validation decides when the metadata is unavailable), merges the current record (one GET) and fills the proven-safe defaults for the fields the target status requires that the record lacks (the per-status map is live-discovered vendor state). current === target → typed NO_CHANGE (zero mutating wire). 7002 = a sample ticket (verified present); dry-run shown — apply mutates the ticket."
|
|
80519
80580
|
],
|
|
80520
80581
|
"permissions": "unknown",
|
|
80521
80582
|
"pagination": {
|
|
@@ -80623,7 +80684,7 @@ const CAPABILITY_DATA = {
|
|
|
80623
80684
|
},
|
|
80624
80685
|
"metadata": {
|
|
80625
80686
|
"purpose": "Count ticket records matching a JSON filter.",
|
|
80626
|
-
"usage": "Unwraps queryCount; returns a plain number.
|
|
80687
|
+
"usage": "Unwraps queryCount; returns a plain number. Visibility caution: the tickets count/query surface may omit records the current API user cannot list. An empty result is inconclusive about tenant inventory; verify a known record with get(id).",
|
|
80627
80688
|
"preferredWhen": null,
|
|
80628
80689
|
"related": [
|
|
80629
80690
|
"tickets.query"
|
|
@@ -80633,7 +80694,7 @@ const CAPABILITY_DATA = {
|
|
|
80633
80694
|
"surface": "tickets.count",
|
|
80634
80695
|
"kind": "unfiltered-blind",
|
|
80635
80696
|
"authority": "tickets.get",
|
|
80636
|
-
"note": "
|
|
80697
|
+
"note": "The unfiltered tickets count result may be limited by API-user visibility. A zero or empty response is INCONCLUSIVE about tenant inventory or API capability. Narrow the query and verify a known record with tickets.get; if that read is not permitted, ask the user for the missing information."
|
|
80637
80698
|
},
|
|
80638
80699
|
"untrustedFields": [
|
|
80639
80700
|
"UDF1",
|
|
@@ -80694,7 +80755,7 @@ const CAPABILITY_DATA = {
|
|
|
80694
80755
|
},
|
|
80695
80756
|
"examples": [
|
|
80696
80757
|
"await client.tickets.create({ title: 'Example', status: 1, priority: 3, companyID: 1001, queueID: 3001 }, { dryRun: true })",
|
|
80697
|
-
"
|
|
80758
|
+
"validated: created a ticket with exactly this field set (companyID anonymized to the fixture company 1001). A body missing any of title/status/priority/companyID/queueID 500s with a typed field-level error."
|
|
80698
80759
|
],
|
|
80699
80760
|
"permissions": "unknown",
|
|
80700
80761
|
"pagination": {
|
|
@@ -81051,7 +81112,7 @@ const CAPABILITY_DATA = {
|
|
|
81051
81112
|
},
|
|
81052
81113
|
"examples": [
|
|
81053
81114
|
"await client.tickets.fullContext(7002)",
|
|
81054
|
-
"
|
|
81115
|
+
"validated: a run served 7002 in 5 wire (ticket + company part + 3 scoped queries; the dangling FK parts were 'absent'; 5 notes; long text capped at the default textLimit and flagged). args: (ticket id, optional { noteLimit (default 50), timeEntryLimit (default 50), includeAttachments (default true — metadata only: ids + names), includeHistories (default false), textLimit (default 500) }). Wire: 8 bounded reads (10 with histories). A missing/dangling FK part is null + 'absent' — a part miss never fails the op; the ticket itself missing → NOT_FOUND."
|
|
81055
81116
|
],
|
|
81056
81117
|
"permissions": "unknown",
|
|
81057
81118
|
"pagination": {
|
|
@@ -81731,7 +81792,7 @@ const CAPABILITY_DATA = {
|
|
|
81731
81792
|
},
|
|
81732
81793
|
"metadata": {
|
|
81733
81794
|
"purpose": "Query Ticket records with a JSON filter.",
|
|
81734
|
-
"usage": "Server-side pagination: one call walks the vendor cursor internally (page 1 POSTs the QueryModel body with MaxRecords = the walk's internal page size (at most 500; the default POST path — `via: 'get'` issues a GET on page 1); later pages POST the SAME body — IncludeFields, MaxRecords and the preserved filter — to the absolute vendor cursor, rebased to the client base URL; the vendor honours IncludeFields on a continuation and ignores MaxRecords there, so a later page carries the vendor's own page size) until the limit is met or the cursor is null; 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).
|
|
81795
|
+
"usage": "Server-side pagination: one call walks the vendor cursor internally (page 1 POSTs the QueryModel body with MaxRecords = the walk's internal page size (at most 500; the default POST path — `via: 'get'` issues a GET on page 1); later pages POST the SAME body — IncludeFields, MaxRecords and the preserved filter — to the absolute vendor cursor, rebased to the client base URL; the vendor honours IncludeFields on a continuation and ignores MaxRecords there, so a later page carries the vendor's own page size) until the limit is met or the cursor is null; 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). Visibility caution: the tickets count/query surface may omit records the current API user cannot list. An empty result is inconclusive about tenant inventory; verify a known record with get(id). 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.",
|
|
81735
81796
|
"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).",
|
|
81736
81797
|
"related": [
|
|
81737
81798
|
"tickets.resolve"
|
|
@@ -81741,7 +81802,7 @@ const CAPABILITY_DATA = {
|
|
|
81741
81802
|
"surface": "tickets.query",
|
|
81742
81803
|
"kind": "unfiltered-blind",
|
|
81743
81804
|
"authority": "tickets.get",
|
|
81744
|
-
"note": "
|
|
81805
|
+
"note": "The unfiltered tickets query result may be limited by API-user visibility. A zero or empty response is INCONCLUSIVE about tenant inventory or API capability. Narrow the query and verify a known record with tickets.get; if that read is not permitted, ask the user for the missing information."
|
|
81745
81806
|
},
|
|
81746
81807
|
"untrustedFields": [
|
|
81747
81808
|
"UDF1",
|
|
@@ -82423,7 +82484,7 @@ const CAPABILITY_DATA = {
|
|
|
82423
82484
|
},
|
|
82424
82485
|
"metadata": {
|
|
82425
82486
|
"purpose": "Update a ticket.",
|
|
82426
|
-
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET
|
|
82487
|
+
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET; when a stale-check field is configured, the same read also supplies that guard) before the PUT; explicit nulls send null, omitted fields keep the current value. Pass raw: true in the opts bag to send the body as-is (no merge). No delete: the vendor defines no DELETE for this entity (the endpoint 405s; cleanup is UI-only).",
|
|
82427
82488
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
82428
82489
|
"related": [
|
|
82429
82490
|
"tickets.get"
|
|
@@ -82480,8 +82541,8 @@ const CAPABILITY_DATA = {
|
|
|
82480
82541
|
]
|
|
82481
82542
|
},
|
|
82482
82543
|
"operations": {
|
|
82483
|
-
"planHash": "
|
|
82484
|
-
"builtAt": "2026-11-
|
|
82544
|
+
"planHash": "94052c314d189d4b2fcf6bc842d983d4817c8410109074ed9505b682f4855790",
|
|
82545
|
+
"builtAt": "2026-11-17T05:04:54.690Z",
|
|
82485
82546
|
"records": [
|
|
82486
82547
|
{
|
|
82487
82548
|
"id": "operations.aggregate",
|
|
@@ -82508,7 +82569,7 @@ const CAPABILITY_DATA = {
|
|
|
82508
82569
|
"opts": {
|
|
82509
82570
|
"type": "object",
|
|
82510
82571
|
"required": false,
|
|
82511
|
-
"description": "AggregateOptions — { groupBy?: string[] (vendor field names), sum?: string[] (numeric vendor fields), top?: number (default 25, clamped 1..100 — the group-row cap), limit?: number (total-record cap for the walk modes, default 2500 = the house BOUNDED_QUERY_MAX_LIMIT — the hard max), names?: boolean (absent = the client's labels option — OFF by default; true — group keys gain label siblings, e.g. key.ticketIDName, key.statusLabel — null, never missing, when the field is keyed with a null value, a 0 id or an unresolved value (a picklist 0 is labelled when the picklist defines it); false = raw ids), acknowledgeUnscoped?: boolean (a group/sum with NO filter — absent or empty — walks the whole tenant table and is refused PRE-REQUEST with the typed SCOPE_REQUIRED (zero wire) unless this is true; the count mode is unaffected — one vendor count, no walk) }. NEITHER groupBy nor sum = COUNT mode (one vendor /query/count call — no walk; a 0 on a plan-pinned blind surface is marked blind: true with the sentinel — never a silent absence; a
|
|
82572
|
+
"description": "AggregateOptions — { groupBy?: string[] (vendor field names), sum?: string[] (numeric vendor fields), top?: number (default 25, clamped 1..100 — the group-row cap), limit?: number (total-record cap for the walk modes, default 2500 = the house BOUNDED_QUERY_MAX_LIMIT — the hard max), names?: boolean (absent = the client's labels option — OFF by default; true — group keys gain label siblings, e.g. key.ticketIDName, key.statusLabel — null, never missing, when the field is keyed with a null value, a 0 id or an unresolved value (a picklist 0 is labelled when the picklist defines it); false = raw ids), acknowledgeUnscoped?: boolean (a group/sum with NO filter — absent or empty — walks the whole tenant table and is refused PRE-REQUEST with the typed SCOPE_REQUIRED (zero wire) unless this is true; the count mode is unaffected — one vendor count, no walk) }. NEITHER groupBy nor sum = COUNT mode (one vendor /query/count call — no walk; a 0 on a plan-pinned blind surface is marked blind: true with the sentinel — never a silent absence; a filtered 0 on an unfiltered-blind surface is an unstamped result under current API-user visibility, not proof of tenant-wide absence). The walk modes fold client-side: hasMore/totalScanned carry the truncation honesty (no silent partial sums) and a mid-walk RATE_LIMITED propagates (the partial fold is discarded).",
|
|
82512
82573
|
"properties": [
|
|
82513
82574
|
{
|
|
82514
82575
|
"name": "groupBy",
|
|
@@ -82553,7 +82614,7 @@ const CAPABILITY_DATA = {
|
|
|
82553
82614
|
"examples": [
|
|
82554
82615
|
"await invoke(client, 'operations.aggregate', ['billing_items.query', [{ field: 'companyID', op: 'eq', value: 1001 }]])",
|
|
82555
82616
|
"await invoke(client, 'operations.aggregate', ['time_entries.query', [{ field: 'dateWorked', op: 'gte', value: '2026-09-01' }], { groupBy: ['ticketID'], sum: ['hoursWorked'], top: 10 }])",
|
|
82556
|
-
"Synthetic shape (no tenant data): args (invoke form) = the operation (exactly the plan resource's.query op — e.g. billing_items.query), the filter (the query-bag filter grammar — an empty array = the unfiltered call), and the optional AggregateOptions. NEITHER groupBy nor sum = COUNT mode (ONE vendor /query/count — no walk; a 0 on a plan-pinned blind surface is marked blind: true with the sentinel — never a silent absence; a
|
|
82617
|
+
"Synthetic shape (no tenant data): args (invoke form) = the operation (exactly the plan resource's.query op — e.g. billing_items.query), the filter (the query-bag filter grammar — an empty array = the unfiltered call), and the optional AggregateOptions. NEITHER groupBy nor sum = COUNT mode (ONE vendor /query/count — no walk; a 0 on a plan-pinned blind surface is marked blind: true with the sentinel — never a silent absence; a filtered 0 on an unfiltered-blind surface is an unstamped result under current API-user visibility, not proof of tenant-wide absence). Walk modes: page size min(500, limit), ≤ ceil(limit/500) pages + the 1000-page guard; groups/sums cover the returned rows ONLY when hasMore (no silent partial sums). Read op — no dry run."
|
|
82557
82618
|
],
|
|
82558
82619
|
"permissions": "unknown",
|
|
82559
82620
|
"pagination": {
|
|
@@ -82568,14 +82629,14 @@ const CAPABILITY_DATA = {
|
|
|
82568
82629
|
},
|
|
82569
82630
|
"metadata": {
|
|
82570
82631
|
"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",
|
|
82571
|
-
"usage": "args[0] is the operation — EXACTLY <planResourceKey>.query (a plan resource WITH a query row — the registry is the closed set; a special op, a.count row, or an unknown resource is refused pre-request naming autotask_catalog). args[1] is the filter (the query-bag filter grammar: 13 operators; caps 500 OR-conditions / 1 UDF / 8000 chars; field names in vendor casing via operations.fieldCatalog; an empty array = the unfiltered call). args[2] (optional) is AggregateOptions { groupBy?: string[] (vendor field names; a DATE-TYPED field may carry the closed bucket suffix @month | @week | @year — the group key is named by the full spec (e.g. dateWorked@month) and carries the ISO bucket label 2026-09 / 2026-W38 / 2026 read on the UTC calendar — (the API is UTC; date-only value = its UTC day, zoned datetime = its instant, zoneless datetime = a UTC wall time; week = the ISO 8601 week date, Monday start, ISO year); the base validates against the vendored MODEL_FIELD_SETS AND the resource date-typed fields (MODEL_DATE_FIELDS — the vendored model string date/date-time fields) pre-request (zero wire; an unknown suffix or a non-date base is the typed CONFIG_ERROR in the one-round complete problem list); a null/absent value folds into the one null bucket group and a value that parses as no date keeps its raw value as its own group), sum?: string[] (numeric vendor fields), top?: number (default 25, clamped 1..100 — the group-row cap), limit?: number (default 2500 = the house BOUNDED_QUERY_MAX_LIMIT — the hard max) }. Modes: NEITHER groupBy NOR sum → COUNT (ONE POST /V1.0/<Entity>/query/count — the vendor count endpoint; no walk; a 0 on a plan-pinned blind surface is marked blind: true with the typed sentinel — never a silent absence; a
|
|
82632
|
+
"usage": "args[0] is the operation — EXACTLY <planResourceKey>.query (a plan resource WITH a query row — the registry is the closed set; a special op, a.count row, or an unknown resource is refused pre-request naming autotask_catalog). args[1] is the filter (the query-bag filter grammar: 13 operators; caps 500 OR-conditions / 1 UDF / 8000 chars; field names in vendor casing via operations.fieldCatalog; an empty array = the unfiltered call). args[2] (optional) is AggregateOptions { groupBy?: string[] (vendor field names; a DATE-TYPED field may carry the closed bucket suffix @month | @week | @year — the group key is named by the full spec (e.g. dateWorked@month) and carries the ISO bucket label 2026-09 / 2026-W38 / 2026 read on the UTC calendar — (the API is UTC; date-only value = its UTC day, zoned datetime = its instant, zoneless datetime = a UTC wall time; week = the ISO 8601 week date, Monday start, ISO year); the base validates against the vendored MODEL_FIELD_SETS AND the resource date-typed fields (MODEL_DATE_FIELDS — the vendored model string date/date-time fields) pre-request (zero wire; an unknown suffix or a non-date base is the typed CONFIG_ERROR in the one-round complete problem list); a null/absent value folds into the one null bucket group and a value that parses as no date keeps its raw value as its own group), sum?: string[] (numeric vendor fields), top?: number (default 25, clamped 1..100 — the group-row cap), limit?: number (default 2500 = the house BOUNDED_QUERY_MAX_LIMIT — the hard max) }. Modes: NEITHER groupBy NOR sum → COUNT (ONE POST /V1.0/<Entity>/query/count — the vendor count endpoint; no walk; a 0 on a plan-pinned blind surface is marked blind: true with the typed sentinel — never a silent absence; a filtered 0 on an unfiltered-blind surface is an unstamped result under current API-user visibility, not proof of tenant-wide absence, never a sentinel). groupBy and/or sum → the house bounded walk of <resource>.query (server-side pagination; page size min(500, limit); the 1000-page guard) + the client-side fold (per-group count + the sum fields — non-numeric/absent values contribute 0, documented; top-N groups, descending count, deterministic group-key tie-break). Result: { mode, count?, groups? [{ key, count, sums? }], totalGroups? (distinct groups before top), groupsTruncated? (top dropped groups), totalScanned?, hasMore?, truncated (D6: the walk hit its limit — groups may be incomplete; count mode: false), blind?, blindSurface?, emptyReason? } — when hasMore is true, groups/sums cover the RETURNED rows ONLY (no silent partial sums — the truncation honesty). MANDATORY PARTIAL MARKER: a truncated aggregate (hasMore true OR groupsTruncated true) is a PARTIAL answer — never a tenant-wide total: the walk scans at most `limit` rows (default and hard max 2500 = the house BOUNDED_QUERY_MAX_LIMIT), `top` keeps at most 100 groups (default 25; a larger top is clamped, never raised), and totalScanned stays reported for reasoning (the rows the fold actually scanned; the tenant-wide total is obtainable via <resource>.count with the same filter). For an exact tenant-wide answer narrow the filter (e.g. a dateWorked window) so the set fits the caps, or use the bounded query op (the same <resource>.query op — the autotask_query surface) with the same filter for the exact full set within its 2500-row walk cap; raw REST for the rest. A zero-row walk carries the blindSurface/emptyReason stamps (no silent empty groups); a mid-walk RATE_LIMITED propagates (the partial fold is discarded — the error is the answer). Wire: count = 1 POST; walk ≤ ceil(limit/500) pages + the guard. READ op — no dry-run/confirm interaction. groupBy/sum field names validate against the vendored MODEL_FIELD_SETS pre-request (the complete problem list in one typed error, zero wire; a live-field opt-in is a follow-up, not this op). groupBy and sum accept the query resource’s self-prefix aliases; normalized group names preserve date-bucket suffixes. True parent relation paths are not stripped. Dotted UDF filters are always refused before metadata or vendor requests.",
|
|
82572
82633
|
"preferredWhen": "For existence checks and totals over any queryable table (count mode is one call vs a 50k-char page); group-by/sum folds the vendor has no endpoint for; a targeted read is cheaper when you need the rows",
|
|
82573
82634
|
"related": [
|
|
82574
82635
|
"<dynamic> — the 116 *.query surfaces",
|
|
82575
82636
|
"operations.fieldCatalog",
|
|
82576
82637
|
"autotask_catalog"
|
|
82577
82638
|
],
|
|
82578
|
-
"args": "args[0] is the operation (<planResourceKey>.query ONLY — a special op, a.count row, or an unknown resource is refused naming autotask_catalog); args[1] is the filter (the query-bag filter grammar: 13 operators, caps 500 OR-conditions / 1 UDF / 8000 chars; field names in vendor casing via operations.fieldCatalog; an empty array = the unfiltered call); args[2] (optional) is AggregateOptions { groupBy?: string[] (vendor field names; a DATE-TYPED field may carry the closed bucket suffix @month | @week | @year — the group key is named by the full spec (e.g. dateWorked@month) and carries the ISO bucket label 2026-09 / 2026-W38 / 2026 read on the UTC calendar — (the API is UTC; date-only value = its UTC day, zoned datetime = its instant, zoneless datetime = a UTC wall time; week = the ISO 8601 week date, Monday start, ISO year); the base validates against the vendored MODEL_FIELD_SETS AND the resource date-typed fields (MODEL_DATE_FIELDS — the vendored model string date/date-time fields) pre-request (zero wire; an unknown suffix or a non-date base is the typed CONFIG_ERROR in the one-round complete problem list); a null/absent value folds into the one null bucket group and a value that parses as no date keeps its raw value as its own group), sum?: string[] (numeric vendor fields), top?: number (default 25, clamped 1..100 — the group-row cap), limit?: number (default 2500 = the house BOUNDED_QUERY_MAX_LIMIT — the hard max), acknowledgeUnscoped?: boolean (a group/sum with NO filter — absent or empty — walks the whole tenant table and is refused PRE-REQUEST with the typed SCOPE_REQUIRED (zero wire) unless this is true; the count mode is unaffected — one vendor count, no walk; the narrow remedy is a filter with an id scope: eq/in on an id field) }. NEITHER groupBy nor sum = COUNT mode (one vendor /query/count call — no walk; a 0 on a plan-pinned blind surface is marked blind: true — never a silent absence; a
|
|
82639
|
+
"args": "args[0] is the operation (<planResourceKey>.query ONLY — a special op, a.count row, or an unknown resource is refused naming autotask_catalog); args[1] is the filter (the query-bag filter grammar: 13 operators, caps 500 OR-conditions / 1 UDF / 8000 chars; field names in vendor casing via operations.fieldCatalog; an empty array = the unfiltered call); args[2] (optional) is AggregateOptions { groupBy?: string[] (vendor field names; a DATE-TYPED field may carry the closed bucket suffix @month | @week | @year — the group key is named by the full spec (e.g. dateWorked@month) and carries the ISO bucket label 2026-09 / 2026-W38 / 2026 read on the UTC calendar — (the API is UTC; date-only value = its UTC day, zoned datetime = its instant, zoneless datetime = a UTC wall time; week = the ISO 8601 week date, Monday start, ISO year); the base validates against the vendored MODEL_FIELD_SETS AND the resource date-typed fields (MODEL_DATE_FIELDS — the vendored model string date/date-time fields) pre-request (zero wire; an unknown suffix or a non-date base is the typed CONFIG_ERROR in the one-round complete problem list); a null/absent value folds into the one null bucket group and a value that parses as no date keeps its raw value as its own group), sum?: string[] (numeric vendor fields), top?: number (default 25, clamped 1..100 — the group-row cap), limit?: number (default 2500 = the house BOUNDED_QUERY_MAX_LIMIT — the hard max), acknowledgeUnscoped?: boolean (a group/sum with NO filter — absent or empty — walks the whole tenant table and is refused PRE-REQUEST with the typed SCOPE_REQUIRED (zero wire) unless this is true; the count mode is unaffected — one vendor count, no walk; the narrow remedy is a filter with an id scope: eq/in on an id field) }. NEITHER groupBy nor sum = COUNT mode (one vendor /query/count call — no walk; a 0 on a plan-pinned blind surface is marked blind: true — never a silent absence; a filtered 0 on an unfiltered-blind surface is an unstamped result under current API-user visibility, not proof of tenant-wide absence). The walk modes fold client-side: hasMore/totalScanned = the truncation honesty (no silent partial sums) — a truncated aggregate (hasMore or groupsTruncated true) is a PARTIAL answer, never a tenant-wide total: the walk scans at most `limit` rows (default and hard max 2500) and `top` keeps at most 100 groups (default 25; clamped, never raised); for an exact tenant-wide answer narrow the filter (e.g. a dateWorked window) so the set fits the caps, or use the bounded query op (autotask_query) with the same filter (its 2500-row walk cap); raw REST for the rest. A mid-walk RATE_LIMITED propagates (the partial fold is discarded)."
|
|
82579
82640
|
},
|
|
82580
82641
|
"compact": "AggregateResult",
|
|
82581
82642
|
"status": "tested"
|
|
@@ -82714,14 +82775,14 @@ const CAPABILITY_DATA = {
|
|
|
82714
82775
|
"set": 17
|
|
82715
82776
|
},
|
|
82716
82777
|
"metadata": {
|
|
82717
|
-
"purpose": "
|
|
82718
|
-
"usage": "args[0] is
|
|
82719
|
-
"preferredWhen": "
|
|
82778
|
+
"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.",
|
|
82779
|
+
"usage": "args[0] is optional { resources?: string[], kind?: CreateBlockerKind }. Returns rows and catalog-wide counts; filters narrow rows, not counts. Each row keeps observed requirements, unproven status, diagnostic blocker kind, evidence and delete boundary. Reference-tenant failures do not establish current API-user blindness or impossible creates. Read current field metadata and preview valid inputs.",
|
|
82780
|
+
"preferredWhen": "Consult before a create, together with current field metadata and a governed preview; never substitute static reference-tenant observations for a live permission or inventory check.",
|
|
82720
82781
|
"related": [
|
|
82721
82782
|
"operations.relationshipMap",
|
|
82722
82783
|
"autotask_catalog"
|
|
82723
82784
|
],
|
|
82724
|
-
"args": "
|
|
82785
|
+
"args": "Optional { resources?: string[], kind?: CreateBlockerKind }. No vendor requests; unknown resources produce RESOURCE_UNKNOWN and invalid blocker kinds produce CONFIG_ERROR."
|
|
82725
82786
|
},
|
|
82726
82787
|
"compact": "CreateGuidanceReport",
|
|
82727
82788
|
"status": "tested"
|
|
@@ -83255,7 +83316,7 @@ const CAPABILITY_DATA = {
|
|
|
83255
83316
|
},
|
|
83256
83317
|
"examples": [
|
|
83257
83318
|
"await invoke(client, 'operations.relationshipMap', ['tickets'])",
|
|
83258
|
-
"
|
|
83319
|
+
"Returns SDK relationship coverage and static creation guidance without vendor traffic. Read the current tenant’s records and metadata before inferring visibility or availability."
|
|
83259
83320
|
],
|
|
83260
83321
|
"permissions": "unknown",
|
|
83261
83322
|
"pagination": {
|
|
@@ -83269,14 +83330,14 @@ const CAPABILITY_DATA = {
|
|
|
83269
83330
|
"set": 17
|
|
83270
83331
|
},
|
|
83271
83332
|
"metadata": {
|
|
83272
|
-
"purpose": "Describe
|
|
83273
|
-
"usage": "args[0] is the
|
|
83274
|
-
"preferredWhen": "
|
|
83333
|
+
"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.",
|
|
83334
|
+
"usage": "args[0] is the resource key. Returns the relationship map, operation coverage and static zoneFacts guidance. The legacy zoneFacts name records prior observations, not a zone capability selector or a current-tenant permission check. Unknown resources produce RESOURCE_UNKNOWN.",
|
|
83335
|
+
"preferredWhen": "Before composing related operations; use live read operations to establish the current tenant’s records and API-user visibility.",
|
|
83275
83336
|
"related": [
|
|
83276
83337
|
"operations.resolveAny",
|
|
83277
83338
|
"autotask_catalog"
|
|
83278
83339
|
],
|
|
83279
|
-
"args": "args[0] is the
|
|
83340
|
+
"args": "args[0] is the resource key. No vendor request; query/get and current field metadata establish live visibility and required values."
|
|
83280
83341
|
},
|
|
83281
83342
|
"compact": "RelationshipResource",
|
|
83282
83343
|
"status": "tested"
|