node-autotask 0.65.0 → 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 +19 -0
- package/MCP_TOOL_CATALOG.json +34 -14
- package/README.md +1 -1
- package/capabilities.json +157 -96
- package/dist/capabilities-data.js +156 -95
- package/dist/capabilities.cjs +4 -4
- package/dist/capabilities.js +1 -1
- package/dist/{chunk-C73NILBZ.js → chunk-4HJVHVPE.js} +2 -2
- package/dist/{chunk-WKR5IJEC.cjs → chunk-FLVMENXG.cjs} +3 -3
- package/dist/{chunk-ULI4UUB3.js → chunk-KO36QZXN.js} +390 -405
- package/dist/{chunk-N4EO3KAY.js → chunk-L5K2D2MZ.js} +3 -3
- package/dist/{chunk-M63TK4ZH.cjs → chunk-QG3O5G4L.cjs} +175 -179
- package/dist/{chunk-MXLE2F5G.js → chunk-T5TI22K5.js} +4 -8
- package/dist/{chunk-NTHEFYA7.cjs → chunk-TIFJFCCN.cjs} +395 -410
- package/dist/{chunk-UHV7SAX6.cjs → chunk-XAJ7SBPE.cjs} +31 -31
- package/dist/{index-vcFKvZqm.d.ts → index-BZ11hF8H.d.ts} +10 -24
- package/dist/{index-CRVQBajX.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 +50 -34
- package/package.json +1 -1
package/capabilities.json
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
{
|
|
2
|
-
"generatedAt": "2026-11-
|
|
2
|
+
"generatedAt": "2026-11-17T05:04:54.713Z",
|
|
3
3
|
"groups": {
|
|
4
4
|
"B": {
|
|
5
|
-
"planHash": "
|
|
6
|
-
"builtAt": "2026-11-
|
|
5
|
+
"planHash": "94052c314d189d4b2fcf6bc842d983d4817c8410109074ed9505b682f4855790",
|
|
6
|
+
"builtAt": "2026-11-17T05:04:54.690Z",
|
|
7
7
|
"records": [
|
|
8
8
|
{
|
|
9
9
|
"id": "appointments.count",
|
|
@@ -609,7 +609,7 @@
|
|
|
609
609
|
},
|
|
610
610
|
"metadata": {
|
|
611
611
|
"purpose": "Update an appointment.",
|
|
612
|
-
"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
|
|
612
|
+
"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).",
|
|
613
613
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
614
614
|
"related": [
|
|
615
615
|
"appointments.get"
|
|
@@ -716,7 +716,7 @@
|
|
|
716
716
|
},
|
|
717
717
|
"metadata": {
|
|
718
718
|
"purpose": "Count billing code records matching a JSON filter.",
|
|
719
|
-
"usage": "Unwraps queryCount; returns a plain number.
|
|
719
|
+
"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.",
|
|
720
720
|
"preferredWhen": null,
|
|
721
721
|
"related": [
|
|
722
722
|
"billing_codes.query"
|
|
@@ -726,7 +726,7 @@
|
|
|
726
726
|
"surface": "billing_codes.count",
|
|
727
727
|
"kind": "unfiltered-blind",
|
|
728
728
|
"authority": "billing_codes.get",
|
|
729
|
-
"note": "
|
|
729
|
+
"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."
|
|
730
730
|
},
|
|
731
731
|
"untrustedFields": [
|
|
732
732
|
"description",
|
|
@@ -1040,7 +1040,7 @@
|
|
|
1040
1040
|
},
|
|
1041
1041
|
"metadata": {
|
|
1042
1042
|
"purpose": "Query BillingCode records with a JSON filter.",
|
|
1043
|
-
"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).
|
|
1043
|
+
"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.",
|
|
1044
1044
|
"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).",
|
|
1045
1045
|
"related": [
|
|
1046
1046
|
"billing_codes.resolve"
|
|
@@ -1050,7 +1050,7 @@
|
|
|
1050
1050
|
"surface": "billing_codes.query",
|
|
1051
1051
|
"kind": "unfiltered-blind",
|
|
1052
1052
|
"authority": "billing_codes.get",
|
|
1053
|
-
"note": "
|
|
1053
|
+
"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."
|
|
1054
1054
|
},
|
|
1055
1055
|
"untrustedFields": [
|
|
1056
1056
|
"description",
|
|
@@ -1990,7 +1990,7 @@
|
|
|
1990
1990
|
},
|
|
1991
1991
|
"metadata": {
|
|
1992
1992
|
"purpose": "Update a billing item.",
|
|
1993
|
-
"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
|
|
1993
|
+
"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).",
|
|
1994
1994
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
1995
1995
|
"related": [
|
|
1996
1996
|
"billing_items.get"
|
|
@@ -3203,7 +3203,7 @@
|
|
|
3203
3203
|
},
|
|
3204
3204
|
"metadata": {
|
|
3205
3205
|
"purpose": "Update a ChecklistLibrary (reusable checklist definition; container of library steps). Not a Task and not a per-ticket instance.",
|
|
3206
|
-
"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
|
|
3206
|
+
"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).",
|
|
3207
3207
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
3208
3208
|
"related": [
|
|
3209
3209
|
"checklist_libraries.get"
|
|
@@ -4992,7 +4992,7 @@
|
|
|
4992
4992
|
},
|
|
4993
4993
|
"metadata": {
|
|
4994
4994
|
"purpose": "Update a configuration item category.",
|
|
4995
|
-
"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
|
|
4995
|
+
"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).",
|
|
4996
4996
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
4997
4997
|
"related": [
|
|
4998
4998
|
"configuration_item_categories.get"
|
|
@@ -6272,7 +6272,7 @@
|
|
|
6272
6272
|
},
|
|
6273
6273
|
"metadata": {
|
|
6274
6274
|
"purpose": "Update a configuration item type.",
|
|
6275
|
-
"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
|
|
6275
|
+
"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).",
|
|
6276
6276
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
6277
6277
|
"related": [
|
|
6278
6278
|
"configuration_item_types.get"
|
|
@@ -7473,7 +7473,7 @@
|
|
|
7473
7473
|
},
|
|
7474
7474
|
"metadata": {
|
|
7475
7475
|
"purpose": "Update a contact group.",
|
|
7476
|
-
"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
|
|
7476
|
+
"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).",
|
|
7477
7477
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
7478
7478
|
"related": [
|
|
7479
7479
|
"contact_groups.get"
|
|
@@ -9240,7 +9240,7 @@
|
|
|
9240
9240
|
},
|
|
9241
9241
|
"metadata": {
|
|
9242
9242
|
"purpose": "Update a contract exclusion set.",
|
|
9243
|
-
"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
|
|
9243
|
+
"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).",
|
|
9244
9244
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
9245
9245
|
"related": [
|
|
9246
9246
|
"contract_exclusion_sets.get"
|
|
@@ -9821,7 +9821,7 @@
|
|
|
9821
9821
|
},
|
|
9822
9822
|
"metadata": {
|
|
9823
9823
|
"purpose": "Update a country.",
|
|
9824
|
-
"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
|
|
9824
|
+
"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).",
|
|
9825
9825
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
9826
9826
|
"related": [
|
|
9827
9827
|
"countries.get"
|
|
@@ -10356,6 +10356,67 @@
|
|
|
10356
10356
|
"compact": "CurrencySummary",
|
|
10357
10357
|
"status": "tested"
|
|
10358
10358
|
},
|
|
10359
|
+
{
|
|
10360
|
+
"id": "currencies.update",
|
|
10361
|
+
"resource": "currencies",
|
|
10362
|
+
"udfCapable": false,
|
|
10363
|
+
"operation": "update",
|
|
10364
|
+
"kind": "primitive",
|
|
10365
|
+
"endpoint": "PUT|PATCH /V1.0/Currencies",
|
|
10366
|
+
"effect": "write",
|
|
10367
|
+
"flags": [
|
|
10368
|
+
"idempotent"
|
|
10369
|
+
],
|
|
10370
|
+
"dryRun": true,
|
|
10371
|
+
"envelope": "OperationResultModel",
|
|
10372
|
+
"inputSchema": {
|
|
10373
|
+
"id": {
|
|
10374
|
+
"type": "string | number",
|
|
10375
|
+
"required": true,
|
|
10376
|
+
"description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
|
|
10377
|
+
},
|
|
10378
|
+
"data": {
|
|
10379
|
+
"type": "object",
|
|
10380
|
+
"required": true,
|
|
10381
|
+
"description": "The record payload (vendor model fields)."
|
|
10382
|
+
}
|
|
10383
|
+
},
|
|
10384
|
+
"inputSchemaStrict": true,
|
|
10385
|
+
"outputSchema": {
|
|
10386
|
+
"type": "OperationResultModel",
|
|
10387
|
+
"drops": []
|
|
10388
|
+
},
|
|
10389
|
+
"examples": [
|
|
10390
|
+
"await client.currencies.update('example-value', { name: 'example' }, { dryRun: true })"
|
|
10391
|
+
],
|
|
10392
|
+
"permissions": "unknown",
|
|
10393
|
+
"pagination": {
|
|
10394
|
+
"mode": "none"
|
|
10395
|
+
},
|
|
10396
|
+
"resolution": null,
|
|
10397
|
+
"retry": {
|
|
10398
|
+
"preset": "retry-1849870d"
|
|
10399
|
+
},
|
|
10400
|
+
"errors": {
|
|
10401
|
+
"set": 1
|
|
10402
|
+
},
|
|
10403
|
+
"metadata": {
|
|
10404
|
+
"purpose": "Update a currency, including its exchange rate and display settings.",
|
|
10405
|
+
"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).",
|
|
10406
|
+
"preferredWhen": "Change supported fields on an existing currency; the vendor specification does not define currency create or delete operations.",
|
|
10407
|
+
"related": [
|
|
10408
|
+
"currencies.get"
|
|
10409
|
+
],
|
|
10410
|
+
"collectionUpdate": true,
|
|
10411
|
+
"untrustedFields": [
|
|
10412
|
+
"description",
|
|
10413
|
+
"name"
|
|
10414
|
+
],
|
|
10415
|
+
"accountWide": true
|
|
10416
|
+
},
|
|
10417
|
+
"compact": null,
|
|
10418
|
+
"status": "tested"
|
|
10419
|
+
},
|
|
10359
10420
|
{
|
|
10360
10421
|
"id": "departments.count",
|
|
10361
10422
|
"resource": "departments",
|
|
@@ -10980,7 +11041,7 @@
|
|
|
10980
11041
|
},
|
|
10981
11042
|
"metadata": {
|
|
10982
11043
|
"purpose": "Update a department.",
|
|
10983
|
-
"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
|
|
11044
|
+
"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).",
|
|
10984
11045
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
10985
11046
|
"related": [
|
|
10986
11047
|
"departments.get"
|
|
@@ -11610,7 +11671,7 @@
|
|
|
11610
11671
|
},
|
|
11611
11672
|
"metadata": {
|
|
11612
11673
|
"purpose": "Update a domain registrar.",
|
|
11613
|
-
"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
|
|
11674
|
+
"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).",
|
|
11614
11675
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
11615
11676
|
"related": [
|
|
11616
11677
|
"domain_registrars.get"
|
|
@@ -13863,7 +13924,7 @@
|
|
|
13863
13924
|
},
|
|
13864
13925
|
"metadata": {
|
|
13865
13926
|
"purpose": "Update an expense report.",
|
|
13866
|
-
"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
|
|
13927
|
+
"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).",
|
|
13867
13928
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
13868
13929
|
"related": [
|
|
13869
13930
|
"expense_reports.get"
|
|
@@ -14503,7 +14564,7 @@
|
|
|
14503
14564
|
},
|
|
14504
14565
|
"metadata": {
|
|
14505
14566
|
"purpose": "Update a holiday set.",
|
|
14506
|
-
"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
|
|
14567
|
+
"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).",
|
|
14507
14568
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
14508
14569
|
"related": [
|
|
14509
14570
|
"holiday_sets.get"
|
|
@@ -15251,7 +15312,7 @@
|
|
|
15251
15312
|
},
|
|
15252
15313
|
"metadata": {
|
|
15253
15314
|
"purpose": "Create an inventory product.",
|
|
15254
|
-
"usage": "Returns OperationResultModel.itemId (the new id); the full record is not returned — follow up with get where needed.
|
|
15315
|
+
"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.",
|
|
15255
15316
|
"preferredWhen": "Only for a record that does not exist yet; prefer update for an id you already have.",
|
|
15256
15317
|
"related": [
|
|
15257
15318
|
"inventory_products.update"
|
|
@@ -15916,7 +15977,7 @@
|
|
|
15916
15977
|
},
|
|
15917
15978
|
"metadata": {
|
|
15918
15979
|
"purpose": "Update an inventory product.",
|
|
15919
|
-
"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
|
|
15980
|
+
"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).",
|
|
15920
15981
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
15921
15982
|
"related": [
|
|
15922
15983
|
"inventory_products.get"
|
|
@@ -17396,7 +17457,7 @@
|
|
|
17396
17457
|
},
|
|
17397
17458
|
"metadata": {
|
|
17398
17459
|
"purpose": "Update an opportunity category.",
|
|
17399
|
-
"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
|
|
17460
|
+
"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).",
|
|
17400
17461
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
17401
17462
|
"related": [
|
|
17402
17463
|
"opportunity_categories.get"
|
|
@@ -17869,7 +17930,7 @@
|
|
|
17869
17930
|
},
|
|
17870
17931
|
"metadata": {
|
|
17871
17932
|
"purpose": "Update an organizational level association.",
|
|
17872
|
-
"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
|
|
17933
|
+
"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).",
|
|
17873
17934
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
17874
17935
|
"related": [
|
|
17875
17936
|
"organizational_level_associations.get"
|
|
@@ -18365,7 +18426,7 @@
|
|
|
18365
18426
|
},
|
|
18366
18427
|
"metadata": {
|
|
18367
18428
|
"purpose": "Update an organizational level 1.",
|
|
18368
|
-
"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
|
|
18429
|
+
"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).",
|
|
18369
18430
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
18370
18431
|
"related": [
|
|
18371
18432
|
"organizational_level1s.get"
|
|
@@ -18865,7 +18926,7 @@
|
|
|
18865
18926
|
},
|
|
18866
18927
|
"metadata": {
|
|
18867
18928
|
"purpose": "Update an organizational level 2.",
|
|
18868
|
-
"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
|
|
18929
|
+
"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).",
|
|
18869
18930
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
18870
18931
|
"related": [
|
|
18871
18932
|
"organizational_level2s.get"
|
|
@@ -20258,7 +20319,7 @@
|
|
|
20258
20319
|
},
|
|
20259
20320
|
"metadata": {
|
|
20260
20321
|
"purpose": "Update a product.",
|
|
20261
|
-
"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
|
|
20322
|
+
"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).",
|
|
20262
20323
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
20263
20324
|
"related": [
|
|
20264
20325
|
"products.get"
|
|
@@ -20793,7 +20854,7 @@
|
|
|
20793
20854
|
},
|
|
20794
20855
|
"metadata": {
|
|
20795
20856
|
"purpose": "Update a purchase approval.",
|
|
20796
|
-
"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
|
|
20857
|
+
"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).",
|
|
20797
20858
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
20798
20859
|
"related": [
|
|
20799
20860
|
"purchase_approvals.get"
|
|
@@ -22436,7 +22497,7 @@
|
|
|
22436
22497
|
},
|
|
22437
22498
|
"metadata": {
|
|
22438
22499
|
"purpose": "Update a purchase order.",
|
|
22439
|
-
"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
|
|
22500
|
+
"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).",
|
|
22440
22501
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
22441
22502
|
"related": [
|
|
22442
22503
|
"purchase_orders.get"
|
|
@@ -26222,7 +26283,7 @@
|
|
|
26222
26283
|
},
|
|
26223
26284
|
"metadata": {
|
|
26224
26285
|
"purpose": "Update a resource.",
|
|
26225
|
-
"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
|
|
26286
|
+
"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).",
|
|
26226
26287
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
26227
26288
|
"related": [
|
|
26228
26289
|
"resources.get"
|
|
@@ -27056,7 +27117,7 @@
|
|
|
27056
27117
|
},
|
|
27057
27118
|
"metadata": {
|
|
27058
27119
|
"purpose": "Update a role.",
|
|
27059
|
-
"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
|
|
27120
|
+
"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).",
|
|
27060
27121
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
27061
27122
|
"related": [
|
|
27062
27123
|
"roles.get"
|
|
@@ -27644,7 +27705,7 @@
|
|
|
27644
27705
|
},
|
|
27645
27706
|
"metadata": {
|
|
27646
27707
|
"purpose": "Update a sales order.",
|
|
27647
|
-
"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
|
|
27708
|
+
"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).",
|
|
27648
27709
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
27649
27710
|
"related": [
|
|
27650
27711
|
"sales_orders.get"
|
|
@@ -30546,7 +30607,7 @@
|
|
|
30546
30607
|
},
|
|
30547
30608
|
"metadata": {
|
|
30548
30609
|
"purpose": "Update a service call.",
|
|
30549
|
-
"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
|
|
30610
|
+
"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).",
|
|
30550
30611
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
30551
30612
|
"related": [
|
|
30552
30613
|
"service_calls.get"
|
|
@@ -31825,7 +31886,7 @@
|
|
|
31825
31886
|
},
|
|
31826
31887
|
"metadata": {
|
|
31827
31888
|
"purpose": "Update a service.",
|
|
31828
|
-
"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
|
|
31889
|
+
"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).",
|
|
31829
31890
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
31830
31891
|
"related": [
|
|
31831
31892
|
"services.get"
|
|
@@ -34919,7 +34980,7 @@
|
|
|
34919
34980
|
},
|
|
34920
34981
|
"metadata": {
|
|
34921
34982
|
"purpose": "Update a tag group.",
|
|
34922
|
-
"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
|
|
34983
|
+
"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).",
|
|
34923
34984
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
34924
34985
|
"related": [
|
|
34925
34986
|
"tag_groups.get"
|
|
@@ -35530,7 +35591,7 @@
|
|
|
35530
35591
|
},
|
|
35531
35592
|
"metadata": {
|
|
35532
35593
|
"purpose": "Update a tag.",
|
|
35533
|
-
"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
|
|
35594
|
+
"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).",
|
|
35534
35595
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
35535
35596
|
"related": [
|
|
35536
35597
|
"tags.get"
|
|
@@ -36023,7 +36084,7 @@
|
|
|
36023
36084
|
},
|
|
36024
36085
|
"metadata": {
|
|
36025
36086
|
"purpose": "Update a tax region.",
|
|
36026
|
-
"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
|
|
36087
|
+
"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).",
|
|
36027
36088
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
36028
36089
|
"related": [
|
|
36029
36090
|
"tax_regions.get"
|
|
@@ -36643,7 +36704,7 @@
|
|
|
36643
36704
|
},
|
|
36644
36705
|
"metadata": {
|
|
36645
36706
|
"purpose": "Update a ticket category.",
|
|
36646
|
-
"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
|
|
36707
|
+
"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).",
|
|
36647
36708
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
36648
36709
|
"related": [
|
|
36649
36710
|
"ticket_categories.get"
|
|
@@ -38876,7 +38937,7 @@
|
|
|
38876
38937
|
},
|
|
38877
38938
|
"metadata": {
|
|
38878
38939
|
"purpose": "Update a ticket note webhook.",
|
|
38879
|
-
"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
|
|
38940
|
+
"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).",
|
|
38880
38941
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
38881
38942
|
"related": [
|
|
38882
38943
|
"ticket_note_webhooks.get"
|
|
@@ -39199,7 +39260,7 @@
|
|
|
39199
39260
|
"preferredWhen": null,
|
|
39200
39261
|
"related": [],
|
|
39201
39262
|
"passBackCursor": "nextCursor",
|
|
39202
|
-
"pointerNote": "
|
|
39263
|
+
"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.",
|
|
39203
39264
|
"untrustedFields": [
|
|
39204
39265
|
"UDF1",
|
|
39205
39266
|
"UDF10",
|
|
@@ -40198,7 +40259,7 @@
|
|
|
40198
40259
|
},
|
|
40199
40260
|
"metadata": {
|
|
40200
40261
|
"purpose": "Update a time entry.",
|
|
40201
|
-
"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
|
|
40262
|
+
"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).",
|
|
40202
40263
|
"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.",
|
|
40203
40264
|
"related": [
|
|
40204
40265
|
"time_entries.get"
|
|
@@ -41620,7 +41681,7 @@
|
|
|
41620
41681
|
"surface": "user_defined_field_definitions.count",
|
|
41621
41682
|
"kind": "unfiltered-blind",
|
|
41622
41683
|
"authority": "user_defined_field_definitions.get",
|
|
41623
|
-
"note": "
|
|
41684
|
+
"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."
|
|
41624
41685
|
},
|
|
41625
41686
|
"untrustedFields": [
|
|
41626
41687
|
"description",
|
|
@@ -42057,7 +42118,7 @@
|
|
|
42057
42118
|
},
|
|
42058
42119
|
"metadata": {
|
|
42059
42120
|
"purpose": "Update a UDF definition.",
|
|
42060
|
-
"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
|
|
42121
|
+
"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).",
|
|
42061
42122
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
42062
42123
|
"related": [
|
|
42063
42124
|
"user_defined_field_definitions.get"
|
|
@@ -42134,7 +42195,7 @@
|
|
|
42134
42195
|
"surface": "user_defined_field_list_items.count",
|
|
42135
42196
|
"kind": "unfiltered-blind",
|
|
42136
42197
|
"authority": "user_defined_field_list_items.get",
|
|
42137
|
-
"note": "
|
|
42198
|
+
"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."
|
|
42138
42199
|
},
|
|
42139
42200
|
"untrustedFields": [
|
|
42140
42201
|
"valueForDisplay",
|
|
@@ -42725,8 +42786,8 @@
|
|
|
42725
42786
|
]
|
|
42726
42787
|
},
|
|
42727
42788
|
"A": {
|
|
42728
|
-
"planHash": "
|
|
42729
|
-
"builtAt": "2026-11-
|
|
42789
|
+
"planHash": "94052c314d189d4b2fcf6bc842d983d4817c8410109074ed9505b682f4855790",
|
|
42790
|
+
"builtAt": "2026-11-17T05:04:54.690Z",
|
|
42730
42791
|
"records": [
|
|
42731
42792
|
{
|
|
42732
42793
|
"id": "companies.count",
|
|
@@ -42779,7 +42840,7 @@
|
|
|
42779
42840
|
},
|
|
42780
42841
|
"metadata": {
|
|
42781
42842
|
"purpose": "Count company records matching a JSON filter.",
|
|
42782
|
-
"usage": "Unwraps queryCount; returns a plain number.
|
|
42843
|
+
"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).",
|
|
42783
42844
|
"preferredWhen": null,
|
|
42784
42845
|
"related": [
|
|
42785
42846
|
"companies.query"
|
|
@@ -42789,7 +42850,7 @@
|
|
|
42789
42850
|
"surface": "companies.count",
|
|
42790
42851
|
"kind": "unowned-blind",
|
|
42791
42852
|
"authority": "companies.get",
|
|
42792
|
-
"note": "companies count
|
|
42853
|
+
"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."
|
|
42793
42854
|
},
|
|
42794
42855
|
"untrustedFields": [
|
|
42795
42856
|
"UDF1",
|
|
@@ -42991,7 +43052,7 @@
|
|
|
42991
43052
|
},
|
|
42992
43053
|
"examples": [
|
|
42993
43054
|
"await client.companies.fullProfile(1001)",
|
|
42994
|
-
"
|
|
43055
|
+
"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."
|
|
42995
43056
|
],
|
|
42996
43057
|
"permissions": "unknown",
|
|
42997
43058
|
"pagination": {
|
|
@@ -43006,7 +43067,7 @@
|
|
|
43006
43067
|
},
|
|
43007
43068
|
"metadata": {
|
|
43008
43069
|
"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.",
|
|
43009
|
-
"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);
|
|
43070
|
+
"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.",
|
|
43010
43071
|
"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.",
|
|
43011
43072
|
"related": [
|
|
43012
43073
|
"companies.get",
|
|
@@ -43016,7 +43077,7 @@
|
|
|
43016
43077
|
"tickets.query",
|
|
43017
43078
|
"projects.query"
|
|
43018
43079
|
],
|
|
43019
|
-
"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).
|
|
43080
|
+
"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.",
|
|
43020
43081
|
"untrustedFields": [
|
|
43021
43082
|
"UDF1",
|
|
43022
43083
|
"UDF10",
|
|
@@ -43622,7 +43683,7 @@
|
|
|
43622
43683
|
},
|
|
43623
43684
|
"metadata": {
|
|
43624
43685
|
"purpose": "Query Company records with a JSON filter.",
|
|
43625
|
-
"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).
|
|
43686
|
+
"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.",
|
|
43626
43687
|
"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).",
|
|
43627
43688
|
"related": [
|
|
43628
43689
|
"companies.resolve"
|
|
@@ -43632,7 +43693,7 @@
|
|
|
43632
43693
|
"surface": "companies.query",
|
|
43633
43694
|
"kind": "unowned-blind",
|
|
43634
43695
|
"authority": "companies.get",
|
|
43635
|
-
"note": "companies
|
|
43696
|
+
"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."
|
|
43636
43697
|
},
|
|
43637
43698
|
"untrustedFields": [
|
|
43638
43699
|
"UDF1",
|
|
@@ -44121,7 +44182,7 @@
|
|
|
44121
44182
|
},
|
|
44122
44183
|
"examples": [
|
|
44123
44184
|
"await client.companies.unbilledWork(1001, { source: 'posted_uninvoiced', includeParent: true, limit: 50 })",
|
|
44124
|
-
"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
|
|
44185
|
+
"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."
|
|
44125
44186
|
],
|
|
44126
44187
|
"permissions": "unknown",
|
|
44127
44188
|
"pagination": {
|
|
@@ -44136,7 +44197,7 @@
|
|
|
44136
44197
|
},
|
|
44137
44198
|
"metadata": {
|
|
44138
44199
|
"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",
|
|
44139
|
-
"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
|
|
44200
|
+
"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).",
|
|
44140
44201
|
"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",
|
|
44141
44202
|
"related": [
|
|
44142
44203
|
"companies.fullProfile",
|
|
@@ -44239,7 +44300,7 @@
|
|
|
44239
44300
|
},
|
|
44240
44301
|
"metadata": {
|
|
44241
44302
|
"purpose": "Update a company.",
|
|
44242
|
-
"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
|
|
44303
|
+
"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).",
|
|
44243
44304
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
44244
44305
|
"related": [
|
|
44245
44306
|
"companies.get"
|
|
@@ -47614,7 +47675,7 @@
|
|
|
47614
47675
|
},
|
|
47615
47676
|
"metadata": {
|
|
47616
47677
|
"purpose": "Update a company webhook.",
|
|
47617
|
-
"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
|
|
47678
|
+
"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).",
|
|
47618
47679
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
47619
47680
|
"related": [
|
|
47620
47681
|
"company_webhooks.get"
|
|
@@ -51181,7 +51242,7 @@
|
|
|
51181
51242
|
},
|
|
51182
51243
|
"metadata": {
|
|
51183
51244
|
"purpose": "Update a configuration item webhook.",
|
|
51184
|
-
"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
|
|
51245
|
+
"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).",
|
|
51185
51246
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
51186
51247
|
"related": [
|
|
51187
51248
|
"configuration_item_webhooks.get"
|
|
@@ -51305,7 +51366,7 @@
|
|
|
51305
51366
|
},
|
|
51306
51367
|
"examples": [
|
|
51307
51368
|
"await client.configurationItems.create({ companyID: 1001, productID: 123, isActive: true }, { dryRun: true })",
|
|
51308
|
-
"
|
|
51369
|
+
"Illustrative ids only: replace companyID and productID with known tenant records, then preview the create before applying it."
|
|
51309
51370
|
],
|
|
51310
51371
|
"permissions": "unknown",
|
|
51311
51372
|
"pagination": {
|
|
@@ -51320,7 +51381,7 @@
|
|
|
51320
51381
|
},
|
|
51321
51382
|
"metadata": {
|
|
51322
51383
|
"purpose": "Create a configuration item.",
|
|
51323
|
-
"usage": "Returns OperationResultModel.itemId (the new id); the full record is not returned — follow up with get where needed.
|
|
51384
|
+
"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).",
|
|
51324
51385
|
"preferredWhen": "Only for a record that does not exist yet; prefer update for an id you already have.",
|
|
51325
51386
|
"related": [
|
|
51326
51387
|
"configuration_items.update"
|
|
@@ -51933,7 +51994,7 @@
|
|
|
51933
51994
|
},
|
|
51934
51995
|
"examples": [
|
|
51935
51996
|
"await client.configurationItems.profile(1)",
|
|
51936
|
-
"
|
|
51997
|
+
"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."
|
|
51937
51998
|
],
|
|
51938
51999
|
"permissions": "unknown",
|
|
51939
52000
|
"pagination": {
|
|
@@ -51948,7 +52009,7 @@
|
|
|
51948
52009
|
},
|
|
51949
52010
|
"metadata": {
|
|
51950
52011
|
"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.",
|
|
51951
|
-
"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
|
|
52012
|
+
"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.",
|
|
51952
52013
|
"preferredWhen": "The single read for 'what is this configuration item' — replaces 5-6 raw reads + describes with one call.",
|
|
51953
52014
|
"related": [
|
|
51954
52015
|
"configuration_items.get",
|
|
@@ -51959,7 +52020,7 @@
|
|
|
51959
52020
|
"configuration_item_types.get",
|
|
51960
52021
|
"configuration_item_categories.get"
|
|
51961
52022
|
],
|
|
51962
|
-
"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;
|
|
52023
|
+
"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.",
|
|
51963
52024
|
"untrustedFields": [
|
|
51964
52025
|
"UDF1",
|
|
51965
52026
|
"UDF10",
|
|
@@ -52354,7 +52415,7 @@
|
|
|
52354
52415
|
},
|
|
52355
52416
|
"metadata": {
|
|
52356
52417
|
"purpose": "Update a configuration item.",
|
|
52357
|
-
"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
|
|
52418
|
+
"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).",
|
|
52358
52419
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
52359
52420
|
"related": [
|
|
52360
52421
|
"configuration_items.get"
|
|
@@ -53072,7 +53133,7 @@
|
|
|
53072
53133
|
},
|
|
53073
53134
|
"metadata": {
|
|
53074
53135
|
"purpose": "Update a contact webhook.",
|
|
53075
|
-
"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
|
|
53136
|
+
"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).",
|
|
53076
53137
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
53077
53138
|
"related": [
|
|
53078
53139
|
"contact_webhooks.get"
|
|
@@ -56289,7 +56350,7 @@
|
|
|
56289
56350
|
},
|
|
56290
56351
|
"metadata": {
|
|
56291
56352
|
"purpose": "Create a contract charge.",
|
|
56292
|
-
"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.
|
|
56353
|
+
"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.",
|
|
56293
56354
|
"preferredWhen": "Only for a record that does not exist yet; prefer update for an id you already have.",
|
|
56294
56355
|
"related": [
|
|
56295
56356
|
"contract_charges.update"
|
|
@@ -64067,7 +64128,7 @@
|
|
|
64067
64128
|
]
|
|
64068
64129
|
},
|
|
64069
64130
|
"writeQuirks": {
|
|
64070
|
-
"dateConventions": "date convention (
|
|
64131
|
+
"dateConventions": "date convention (verify against current field metadata): startDate and endDate are date-only at 00:00Z; tickets.dueDateTime is a true UTC instant."
|
|
64071
64132
|
}
|
|
64072
64133
|
},
|
|
64073
64134
|
"compact": null,
|
|
@@ -65154,7 +65215,7 @@
|
|
|
65154
65215
|
},
|
|
65155
65216
|
"metadata": {
|
|
65156
65217
|
"purpose": "Update a contract.",
|
|
65157
|
-
"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
|
|
65218
|
+
"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).",
|
|
65158
65219
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
65159
65220
|
"related": [
|
|
65160
65221
|
"contracts.get"
|
|
@@ -65186,7 +65247,7 @@
|
|
|
65186
65247
|
"description"
|
|
65187
65248
|
],
|
|
65188
65249
|
"writeQuirks": {
|
|
65189
|
-
"dateConventions": "date convention (
|
|
65250
|
+
"dateConventions": "date convention (verify against current field metadata): startDate and endDate are date-only at 00:00Z; tickets.dueDateTime is a true UTC instant."
|
|
65190
65251
|
}
|
|
65191
65252
|
},
|
|
65192
65253
|
"compact": null,
|
|
@@ -65845,7 +65906,7 @@
|
|
|
65845
65906
|
},
|
|
65846
65907
|
"metadata": {
|
|
65847
65908
|
"purpose": "Update an invoice.",
|
|
65848
|
-
"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
|
|
65909
|
+
"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).",
|
|
65849
65910
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
65850
65911
|
"related": [
|
|
65851
65912
|
"invoices.get"
|
|
@@ -66637,7 +66698,7 @@
|
|
|
66637
66698
|
},
|
|
66638
66699
|
"metadata": {
|
|
66639
66700
|
"purpose": "Update an opportunity.",
|
|
66640
|
-
"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
|
|
66701
|
+
"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).",
|
|
66641
66702
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
66642
66703
|
"related": [
|
|
66643
66704
|
"opportunities.get"
|
|
@@ -67991,7 +68052,7 @@
|
|
|
67991
68052
|
},
|
|
67992
68053
|
"metadata": {
|
|
67993
68054
|
"purpose": "Create a project charge.",
|
|
67994
|
-
"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.
|
|
68055
|
+
"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.",
|
|
67995
68056
|
"preferredWhen": "Only for a record that does not exist yet; prefer update for an id you already have.",
|
|
67996
68057
|
"related": [
|
|
67997
68058
|
"project_charges.update"
|
|
@@ -70121,7 +70182,7 @@
|
|
|
70121
70182
|
},
|
|
70122
70183
|
"metadata": {
|
|
70123
70184
|
"purpose": "Update a project.",
|
|
70124
|
-
"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
|
|
70185
|
+
"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).",
|
|
70125
70186
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
70126
70187
|
"related": [
|
|
70127
70188
|
"projects.get"
|
|
@@ -71384,7 +71445,7 @@
|
|
|
71384
71445
|
},
|
|
71385
71446
|
"metadata": {
|
|
71386
71447
|
"purpose": "Update a quote location.",
|
|
71387
|
-
"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
|
|
71448
|
+
"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).",
|
|
71388
71449
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
71389
71450
|
"related": [
|
|
71390
71451
|
"quote_locations.get"
|
|
@@ -72035,7 +72096,7 @@
|
|
|
72035
72096
|
},
|
|
72036
72097
|
"metadata": {
|
|
72037
72098
|
"purpose": "Update a quote.",
|
|
72038
|
-
"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
|
|
72099
|
+
"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).",
|
|
72039
72100
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
72040
72101
|
"related": [
|
|
72041
72102
|
"quotes.get"
|
|
@@ -72906,7 +72967,7 @@
|
|
|
72906
72967
|
},
|
|
72907
72968
|
"metadata": {
|
|
72908
72969
|
"purpose": "Update a subscription.",
|
|
72909
|
-
"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
|
|
72970
|
+
"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).",
|
|
72910
72971
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
72911
72972
|
"related": [
|
|
72912
72973
|
"subscriptions.get"
|
|
@@ -80121,7 +80182,7 @@
|
|
|
80121
80182
|
},
|
|
80122
80183
|
"metadata": {
|
|
80123
80184
|
"purpose": "Update a ticket webhook.",
|
|
80124
|
-
"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
|
|
80185
|
+
"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).",
|
|
80125
80186
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
80126
80187
|
"related": [
|
|
80127
80188
|
"ticket_webhooks.get"
|
|
@@ -80277,7 +80338,7 @@
|
|
|
80277
80338
|
},
|
|
80278
80339
|
"metadata": {
|
|
80279
80340
|
"purpose": "Count ticket records matching a JSON filter.",
|
|
80280
|
-
"usage": "Unwraps queryCount; returns a plain number.
|
|
80341
|
+
"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).",
|
|
80281
80342
|
"preferredWhen": null,
|
|
80282
80343
|
"related": [
|
|
80283
80344
|
"tickets.query"
|
|
@@ -80287,7 +80348,7 @@
|
|
|
80287
80348
|
"surface": "tickets.count",
|
|
80288
80349
|
"kind": "unfiltered-blind",
|
|
80289
80350
|
"authority": "tickets.get",
|
|
80290
|
-
"note": "
|
|
80351
|
+
"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."
|
|
80291
80352
|
},
|
|
80292
80353
|
"untrustedFields": [
|
|
80293
80354
|
"UDF1",
|
|
@@ -81385,7 +81446,7 @@
|
|
|
81385
81446
|
},
|
|
81386
81447
|
"metadata": {
|
|
81387
81448
|
"purpose": "Query Ticket records with a JSON filter.",
|
|
81388
|
-
"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).
|
|
81449
|
+
"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.",
|
|
81389
81450
|
"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).",
|
|
81390
81451
|
"related": [
|
|
81391
81452
|
"tickets.resolve"
|
|
@@ -81395,7 +81456,7 @@
|
|
|
81395
81456
|
"surface": "tickets.query",
|
|
81396
81457
|
"kind": "unfiltered-blind",
|
|
81397
81458
|
"authority": "tickets.get",
|
|
81398
|
-
"note": "
|
|
81459
|
+
"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."
|
|
81399
81460
|
},
|
|
81400
81461
|
"untrustedFields": [
|
|
81401
81462
|
"UDF1",
|
|
@@ -82077,7 +82138,7 @@
|
|
|
82077
82138
|
},
|
|
82078
82139
|
"metadata": {
|
|
82079
82140
|
"purpose": "Update a ticket.",
|
|
82080
|
-
"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
|
|
82141
|
+
"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).",
|
|
82081
82142
|
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
82082
82143
|
"related": [
|
|
82083
82144
|
"tickets.get"
|
|
@@ -82134,8 +82195,8 @@
|
|
|
82134
82195
|
]
|
|
82135
82196
|
},
|
|
82136
82197
|
"operations": {
|
|
82137
|
-
"planHash": "
|
|
82138
|
-
"builtAt": "2026-11-
|
|
82198
|
+
"planHash": "94052c314d189d4b2fcf6bc842d983d4817c8410109074ed9505b682f4855790",
|
|
82199
|
+
"builtAt": "2026-11-17T05:04:54.690Z",
|
|
82139
82200
|
"records": [
|
|
82140
82201
|
{
|
|
82141
82202
|
"id": "operations.aggregate",
|
|
@@ -82162,7 +82223,7 @@
|
|
|
82162
82223
|
"opts": {
|
|
82163
82224
|
"type": "object",
|
|
82164
82225
|
"required": false,
|
|
82165
|
-
"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
|
|
82226
|
+
"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).",
|
|
82166
82227
|
"properties": [
|
|
82167
82228
|
{
|
|
82168
82229
|
"name": "groupBy",
|
|
@@ -82207,7 +82268,7 @@
|
|
|
82207
82268
|
"examples": [
|
|
82208
82269
|
"await invoke(client, 'operations.aggregate', ['billing_items.query', [{ field: 'companyID', op: 'eq', value: 1001 }]])",
|
|
82209
82270
|
"await invoke(client, 'operations.aggregate', ['time_entries.query', [{ field: 'dateWorked', op: 'gte', value: '2026-09-01' }], { groupBy: ['ticketID'], sum: ['hoursWorked'], top: 10 }])",
|
|
82210
|
-
"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
|
|
82271
|
+
"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."
|
|
82211
82272
|
],
|
|
82212
82273
|
"permissions": "unknown",
|
|
82213
82274
|
"pagination": {
|
|
@@ -82222,14 +82283,14 @@
|
|
|
82222
82283
|
},
|
|
82223
82284
|
"metadata": {
|
|
82224
82285
|
"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",
|
|
82225
|
-
"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
|
|
82286
|
+
"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.",
|
|
82226
82287
|
"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",
|
|
82227
82288
|
"related": [
|
|
82228
82289
|
"<dynamic> — the 116 *.query surfaces",
|
|
82229
82290
|
"operations.fieldCatalog",
|
|
82230
82291
|
"autotask_catalog"
|
|
82231
82292
|
],
|
|
82232
|
-
"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
|
|
82293
|
+
"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)."
|
|
82233
82294
|
},
|
|
82234
82295
|
"compact": "AggregateResult",
|
|
82235
82296
|
"status": "tested"
|
|
@@ -82368,14 +82429,14 @@
|
|
|
82368
82429
|
"set": 17
|
|
82369
82430
|
},
|
|
82370
82431
|
"metadata": {
|
|
82371
|
-
"purpose": "
|
|
82372
|
-
"usage": "args[0] is
|
|
82373
|
-
"preferredWhen": "
|
|
82432
|
+
"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.",
|
|
82433
|
+
"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.",
|
|
82434
|
+
"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.",
|
|
82374
82435
|
"related": [
|
|
82375
82436
|
"operations.relationshipMap",
|
|
82376
82437
|
"autotask_catalog"
|
|
82377
82438
|
],
|
|
82378
|
-
"args": "
|
|
82439
|
+
"args": "Optional { resources?: string[], kind?: CreateBlockerKind }. No vendor requests; unknown resources produce RESOURCE_UNKNOWN and invalid blocker kinds produce CONFIG_ERROR."
|
|
82379
82440
|
},
|
|
82380
82441
|
"compact": "CreateGuidanceReport",
|
|
82381
82442
|
"status": "tested"
|
|
@@ -82909,7 +82970,7 @@
|
|
|
82909
82970
|
},
|
|
82910
82971
|
"examples": [
|
|
82911
82972
|
"await invoke(client, 'operations.relationshipMap', ['tickets'])",
|
|
82912
|
-
"
|
|
82973
|
+
"Returns SDK relationship coverage and static creation guidance without vendor traffic. Read the current tenant’s records and metadata before inferring visibility or availability."
|
|
82913
82974
|
],
|
|
82914
82975
|
"permissions": "unknown",
|
|
82915
82976
|
"pagination": {
|
|
@@ -82923,14 +82984,14 @@
|
|
|
82923
82984
|
"set": 17
|
|
82924
82985
|
},
|
|
82925
82986
|
"metadata": {
|
|
82926
|
-
"purpose": "Describe
|
|
82927
|
-
"usage": "args[0] is the
|
|
82928
|
-
"preferredWhen": "
|
|
82987
|
+
"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.",
|
|
82988
|
+
"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.",
|
|
82989
|
+
"preferredWhen": "Before composing related operations; use live read operations to establish the current tenant’s records and API-user visibility.",
|
|
82929
82990
|
"related": [
|
|
82930
82991
|
"operations.resolveAny",
|
|
82931
82992
|
"autotask_catalog"
|
|
82932
82993
|
],
|
|
82933
|
-
"args": "args[0] is the
|
|
82994
|
+
"args": "args[0] is the resource key. No vendor request; query/get and current field metadata establish live visibility and required values."
|
|
82934
82995
|
},
|
|
82935
82996
|
"compact": "RelationshipResource",
|
|
82936
82997
|
"status": "tested"
|