servicem8 0.9.0 → 0.9.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (263) hide show
  1. package/README.md +10 -0
  2. package/api.json +1092 -627
  3. package/bin/mcp-server.js +1366 -532
  4. package/bin/mcp-server.js.map +27 -11
  5. package/dist/commonjs/funcs/jobTemplatesCreateJobFromTemplate.d.ts +3 -0
  6. package/dist/commonjs/funcs/jobTemplatesCreateJobFromTemplate.d.ts.map +1 -1
  7. package/dist/commonjs/funcs/jobTemplatesCreateJobFromTemplate.js +3 -0
  8. package/dist/commonjs/funcs/jobTemplatesCreateJobFromTemplate.js.map +1 -1
  9. package/dist/commonjs/funcs/jobTemplatesCreateJobTemplates.d.ts +24 -0
  10. package/dist/commonjs/funcs/jobTemplatesCreateJobTemplates.d.ts.map +1 -0
  11. package/dist/commonjs/funcs/jobTemplatesCreateJobTemplates.js +138 -0
  12. package/dist/commonjs/funcs/jobTemplatesCreateJobTemplates.js.map +1 -0
  13. package/dist/commonjs/funcs/jobTemplatesDeleteJobTemplates.d.ts +22 -0
  14. package/dist/commonjs/funcs/jobTemplatesDeleteJobTemplates.d.ts.map +1 -0
  15. package/dist/commonjs/funcs/jobTemplatesDeleteJobTemplates.js +136 -0
  16. package/dist/commonjs/funcs/jobTemplatesDeleteJobTemplates.js.map +1 -0
  17. package/dist/commonjs/funcs/jobTemplatesGetJobTemplates.d.ts +20 -0
  18. package/dist/commonjs/funcs/jobTemplatesGetJobTemplates.d.ts.map +1 -0
  19. package/dist/commonjs/funcs/jobTemplatesGetJobTemplates.js +134 -0
  20. package/dist/commonjs/funcs/jobTemplatesGetJobTemplates.js.map +1 -0
  21. package/dist/commonjs/funcs/jobTemplatesListJobTemplates.d.ts +23 -0
  22. package/dist/commonjs/funcs/jobTemplatesListJobTemplates.d.ts.map +1 -0
  23. package/dist/commonjs/funcs/jobTemplatesListJobTemplates.js +122 -0
  24. package/dist/commonjs/funcs/jobTemplatesListJobTemplates.js.map +1 -0
  25. package/dist/commonjs/funcs/jobTemplatesUpdateJobTemplates.d.ts +20 -0
  26. package/dist/commonjs/funcs/jobTemplatesUpdateJobTemplates.d.ts.map +1 -0
  27. package/dist/commonjs/funcs/jobTemplatesUpdateJobTemplates.js +135 -0
  28. package/dist/commonjs/funcs/jobTemplatesUpdateJobTemplates.js.map +1 -0
  29. package/dist/commonjs/lib/config.d.ts +3 -3
  30. package/dist/commonjs/lib/config.js +3 -3
  31. package/dist/commonjs/mcp-server/mcp-server.js +1 -1
  32. package/dist/commonjs/mcp-server/server.d.ts.map +1 -1
  33. package/dist/commonjs/mcp-server/server.js +20 -10
  34. package/dist/commonjs/mcp-server/server.js.map +1 -1
  35. package/dist/commonjs/mcp-server/tools/jobTemplatesCreateJobFromTemplate.d.ts.map +1 -1
  36. package/dist/commonjs/mcp-server/tools/jobTemplatesCreateJobFromTemplate.js +3 -0
  37. package/dist/commonjs/mcp-server/tools/jobTemplatesCreateJobFromTemplate.js.map +1 -1
  38. package/dist/commonjs/mcp-server/tools/jobTemplatesCreateJobTemplates.d.ts +8 -0
  39. package/dist/commonjs/mcp-server/tools/jobTemplatesCreateJobTemplates.d.ts.map +1 -0
  40. package/dist/commonjs/mcp-server/tools/jobTemplatesCreateJobTemplates.js +74 -0
  41. package/dist/commonjs/mcp-server/tools/jobTemplatesCreateJobTemplates.js.map +1 -0
  42. package/dist/commonjs/mcp-server/tools/jobTemplatesDeleteJobTemplates.d.ts +8 -0
  43. package/dist/commonjs/mcp-server/tools/jobTemplatesDeleteJobTemplates.d.ts.map +1 -0
  44. package/dist/commonjs/mcp-server/tools/jobTemplatesDeleteJobTemplates.js +73 -0
  45. package/dist/commonjs/mcp-server/tools/jobTemplatesDeleteJobTemplates.js.map +1 -0
  46. package/dist/commonjs/mcp-server/tools/jobTemplatesGetJobTemplates.d.ts +8 -0
  47. package/dist/commonjs/mcp-server/tools/jobTemplatesGetJobTemplates.d.ts.map +1 -0
  48. package/dist/commonjs/mcp-server/tools/jobTemplatesGetJobTemplates.js +69 -0
  49. package/dist/commonjs/mcp-server/tools/jobTemplatesGetJobTemplates.js.map +1 -0
  50. package/dist/commonjs/mcp-server/tools/jobTemplatesListJobTemplates.d.ts +3 -0
  51. package/dist/commonjs/mcp-server/tools/jobTemplatesListJobTemplates.d.ts.map +1 -0
  52. package/dist/commonjs/mcp-server/tools/jobTemplatesListJobTemplates.js +35 -0
  53. package/dist/commonjs/mcp-server/tools/jobTemplatesListJobTemplates.js.map +1 -0
  54. package/dist/commonjs/mcp-server/tools/jobTemplatesUpdateJobTemplates.d.ts +8 -0
  55. package/dist/commonjs/mcp-server/tools/jobTemplatesUpdateJobTemplates.d.ts.map +1 -0
  56. package/dist/commonjs/mcp-server/tools/jobTemplatesUpdateJobTemplates.js +69 -0
  57. package/dist/commonjs/mcp-server/tools/jobTemplatesUpdateJobTemplates.js.map +1 -0
  58. package/dist/commonjs/models/components/index.d.ts +1 -0
  59. package/dist/commonjs/models/components/index.d.ts.map +1 -1
  60. package/dist/commonjs/models/components/index.js +1 -0
  61. package/dist/commonjs/models/components/index.js.map +1 -1
  62. package/dist/commonjs/models/components/jobtemplate.d.ts +111 -0
  63. package/dist/commonjs/models/components/jobtemplate.d.ts.map +1 -0
  64. package/dist/commonjs/models/components/jobtemplate.js +137 -0
  65. package/dist/commonjs/models/components/jobtemplate.js.map +1 -0
  66. package/dist/commonjs/models/components/jobtemplateoverrides.d.ts +7 -2
  67. package/dist/commonjs/models/components/jobtemplateoverrides.d.ts.map +1 -1
  68. package/dist/commonjs/models/components/jobtemplateoverrides.js +4 -0
  69. package/dist/commonjs/models/components/jobtemplateoverrides.js.map +1 -1
  70. package/dist/commonjs/models/operations/createjobtemplates.d.ts +57 -0
  71. package/dist/commonjs/models/operations/createjobtemplates.d.ts.map +1 -0
  72. package/dist/commonjs/models/operations/createjobtemplates.js +115 -0
  73. package/dist/commonjs/models/operations/createjobtemplates.js.map +1 -0
  74. package/dist/commonjs/models/operations/deletejobtemplates.d.ts +54 -0
  75. package/dist/commonjs/models/operations/deletejobtemplates.d.ts.map +1 -0
  76. package/dist/commonjs/models/operations/deletejobtemplates.js +96 -0
  77. package/dist/commonjs/models/operations/deletejobtemplates.js.map +1 -0
  78. package/dist/commonjs/models/operations/getjobtemplates.d.ts +54 -0
  79. package/dist/commonjs/models/operations/getjobtemplates.d.ts.map +1 -0
  80. package/dist/commonjs/models/operations/getjobtemplates.js +99 -0
  81. package/dist/commonjs/models/operations/getjobtemplates.js.map +1 -0
  82. package/dist/commonjs/models/operations/index.d.ts +5 -0
  83. package/dist/commonjs/models/operations/index.d.ts.map +1 -1
  84. package/dist/commonjs/models/operations/index.js +5 -0
  85. package/dist/commonjs/models/operations/index.js.map +1 -1
  86. package/dist/commonjs/models/operations/listjobtemplates.d.ts +26 -0
  87. package/dist/commonjs/models/operations/listjobtemplates.d.ts.map +1 -0
  88. package/dist/commonjs/models/operations/listjobtemplates.js +72 -0
  89. package/dist/commonjs/models/operations/listjobtemplates.js.map +1 -0
  90. package/dist/commonjs/models/operations/updatejobtemplates.d.ts +59 -0
  91. package/dist/commonjs/models/operations/updatejobtemplates.d.ts.map +1 -0
  92. package/dist/commonjs/models/operations/updatejobtemplates.js +107 -0
  93. package/dist/commonjs/models/operations/updatejobtemplates.js.map +1 -0
  94. package/dist/commonjs/sdk/jobtemplates.d.ts +57 -0
  95. package/dist/commonjs/sdk/jobtemplates.d.ts.map +1 -1
  96. package/dist/commonjs/sdk/jobtemplates.js +71 -0
  97. package/dist/commonjs/sdk/jobtemplates.js.map +1 -1
  98. package/dist/commonjs/sdk/sdk.d.ts +4 -4
  99. package/dist/commonjs/sdk/sdk.d.ts.map +1 -1
  100. package/dist/commonjs/sdk/sdk.js +6 -6
  101. package/dist/commonjs/sdk/sdk.js.map +1 -1
  102. package/dist/esm/funcs/jobTemplatesCreateJobFromTemplate.d.ts +3 -0
  103. package/dist/esm/funcs/jobTemplatesCreateJobFromTemplate.d.ts.map +1 -1
  104. package/dist/esm/funcs/jobTemplatesCreateJobFromTemplate.js +3 -0
  105. package/dist/esm/funcs/jobTemplatesCreateJobFromTemplate.js.map +1 -1
  106. package/dist/esm/funcs/jobTemplatesCreateJobTemplates.d.ts +24 -0
  107. package/dist/esm/funcs/jobTemplatesCreateJobTemplates.d.ts.map +1 -0
  108. package/dist/esm/funcs/jobTemplatesCreateJobTemplates.js +102 -0
  109. package/dist/esm/funcs/jobTemplatesCreateJobTemplates.js.map +1 -0
  110. package/dist/esm/funcs/jobTemplatesDeleteJobTemplates.d.ts +22 -0
  111. package/dist/esm/funcs/jobTemplatesDeleteJobTemplates.d.ts.map +1 -0
  112. package/dist/esm/funcs/jobTemplatesDeleteJobTemplates.js +100 -0
  113. package/dist/esm/funcs/jobTemplatesDeleteJobTemplates.js.map +1 -0
  114. package/dist/esm/funcs/jobTemplatesGetJobTemplates.d.ts +20 -0
  115. package/dist/esm/funcs/jobTemplatesGetJobTemplates.d.ts.map +1 -0
  116. package/dist/esm/funcs/jobTemplatesGetJobTemplates.js +98 -0
  117. package/dist/esm/funcs/jobTemplatesGetJobTemplates.js.map +1 -0
  118. package/dist/esm/funcs/jobTemplatesListJobTemplates.d.ts +23 -0
  119. package/dist/esm/funcs/jobTemplatesListJobTemplates.d.ts.map +1 -0
  120. package/dist/esm/funcs/jobTemplatesListJobTemplates.js +86 -0
  121. package/dist/esm/funcs/jobTemplatesListJobTemplates.js.map +1 -0
  122. package/dist/esm/funcs/jobTemplatesUpdateJobTemplates.d.ts +20 -0
  123. package/dist/esm/funcs/jobTemplatesUpdateJobTemplates.d.ts.map +1 -0
  124. package/dist/esm/funcs/jobTemplatesUpdateJobTemplates.js +99 -0
  125. package/dist/esm/funcs/jobTemplatesUpdateJobTemplates.js.map +1 -0
  126. package/dist/esm/lib/config.d.ts +3 -3
  127. package/dist/esm/lib/config.js +3 -3
  128. package/dist/esm/mcp-server/mcp-server.js +1 -1
  129. package/dist/esm/mcp-server/server.d.ts.map +1 -1
  130. package/dist/esm/mcp-server/server.js +20 -10
  131. package/dist/esm/mcp-server/server.js.map +1 -1
  132. package/dist/esm/mcp-server/tools/jobTemplatesCreateJobFromTemplate.d.ts.map +1 -1
  133. package/dist/esm/mcp-server/tools/jobTemplatesCreateJobFromTemplate.js +3 -0
  134. package/dist/esm/mcp-server/tools/jobTemplatesCreateJobFromTemplate.js.map +1 -1
  135. package/dist/esm/mcp-server/tools/jobTemplatesCreateJobTemplates.d.ts +8 -0
  136. package/dist/esm/mcp-server/tools/jobTemplatesCreateJobTemplates.d.ts.map +1 -0
  137. package/dist/esm/mcp-server/tools/jobTemplatesCreateJobTemplates.js +38 -0
  138. package/dist/esm/mcp-server/tools/jobTemplatesCreateJobTemplates.js.map +1 -0
  139. package/dist/esm/mcp-server/tools/jobTemplatesDeleteJobTemplates.d.ts +8 -0
  140. package/dist/esm/mcp-server/tools/jobTemplatesDeleteJobTemplates.d.ts.map +1 -0
  141. package/dist/esm/mcp-server/tools/jobTemplatesDeleteJobTemplates.js +37 -0
  142. package/dist/esm/mcp-server/tools/jobTemplatesDeleteJobTemplates.js.map +1 -0
  143. package/dist/esm/mcp-server/tools/jobTemplatesGetJobTemplates.d.ts +8 -0
  144. package/dist/esm/mcp-server/tools/jobTemplatesGetJobTemplates.d.ts.map +1 -0
  145. package/dist/esm/mcp-server/tools/jobTemplatesGetJobTemplates.js +33 -0
  146. package/dist/esm/mcp-server/tools/jobTemplatesGetJobTemplates.js.map +1 -0
  147. package/dist/esm/mcp-server/tools/jobTemplatesListJobTemplates.d.ts +3 -0
  148. package/dist/esm/mcp-server/tools/jobTemplatesListJobTemplates.d.ts.map +1 -0
  149. package/dist/esm/mcp-server/tools/jobTemplatesListJobTemplates.js +32 -0
  150. package/dist/esm/mcp-server/tools/jobTemplatesListJobTemplates.js.map +1 -0
  151. package/dist/esm/mcp-server/tools/jobTemplatesUpdateJobTemplates.d.ts +8 -0
  152. package/dist/esm/mcp-server/tools/jobTemplatesUpdateJobTemplates.d.ts.map +1 -0
  153. package/dist/esm/mcp-server/tools/jobTemplatesUpdateJobTemplates.js +33 -0
  154. package/dist/esm/mcp-server/tools/jobTemplatesUpdateJobTemplates.js.map +1 -0
  155. package/dist/esm/models/components/index.d.ts +1 -0
  156. package/dist/esm/models/components/index.d.ts.map +1 -1
  157. package/dist/esm/models/components/index.js +1 -0
  158. package/dist/esm/models/components/index.js.map +1 -1
  159. package/dist/esm/models/components/jobtemplate.d.ts +111 -0
  160. package/dist/esm/models/components/jobtemplate.d.ts.map +1 -0
  161. package/dist/esm/models/components/jobtemplate.js +97 -0
  162. package/dist/esm/models/components/jobtemplate.js.map +1 -0
  163. package/dist/esm/models/components/jobtemplateoverrides.d.ts +7 -2
  164. package/dist/esm/models/components/jobtemplateoverrides.d.ts.map +1 -1
  165. package/dist/esm/models/components/jobtemplateoverrides.js +4 -0
  166. package/dist/esm/models/components/jobtemplateoverrides.js.map +1 -1
  167. package/dist/esm/models/operations/createjobtemplates.d.ts +57 -0
  168. package/dist/esm/models/operations/createjobtemplates.d.ts.map +1 -0
  169. package/dist/esm/models/operations/createjobtemplates.js +75 -0
  170. package/dist/esm/models/operations/createjobtemplates.js.map +1 -0
  171. package/dist/esm/models/operations/deletejobtemplates.d.ts +54 -0
  172. package/dist/esm/models/operations/deletejobtemplates.d.ts.map +1 -0
  173. package/dist/esm/models/operations/deletejobtemplates.js +56 -0
  174. package/dist/esm/models/operations/deletejobtemplates.js.map +1 -0
  175. package/dist/esm/models/operations/getjobtemplates.d.ts +54 -0
  176. package/dist/esm/models/operations/getjobtemplates.d.ts.map +1 -0
  177. package/dist/esm/models/operations/getjobtemplates.js +59 -0
  178. package/dist/esm/models/operations/getjobtemplates.js.map +1 -0
  179. package/dist/esm/models/operations/index.d.ts +5 -0
  180. package/dist/esm/models/operations/index.d.ts.map +1 -1
  181. package/dist/esm/models/operations/index.js +5 -0
  182. package/dist/esm/models/operations/index.js.map +1 -1
  183. package/dist/esm/models/operations/listjobtemplates.d.ts +26 -0
  184. package/dist/esm/models/operations/listjobtemplates.d.ts.map +1 -0
  185. package/dist/esm/models/operations/listjobtemplates.js +34 -0
  186. package/dist/esm/models/operations/listjobtemplates.js.map +1 -0
  187. package/dist/esm/models/operations/updatejobtemplates.d.ts +59 -0
  188. package/dist/esm/models/operations/updatejobtemplates.d.ts.map +1 -0
  189. package/dist/esm/models/operations/updatejobtemplates.js +67 -0
  190. package/dist/esm/models/operations/updatejobtemplates.js.map +1 -0
  191. package/dist/esm/sdk/jobtemplates.d.ts +57 -0
  192. package/dist/esm/sdk/jobtemplates.d.ts.map +1 -1
  193. package/dist/esm/sdk/jobtemplates.js +71 -0
  194. package/dist/esm/sdk/jobtemplates.js.map +1 -1
  195. package/dist/esm/sdk/sdk.d.ts +4 -4
  196. package/dist/esm/sdk/sdk.d.ts.map +1 -1
  197. package/dist/esm/sdk/sdk.js +6 -6
  198. package/dist/esm/sdk/sdk.js.map +1 -1
  199. package/docs/sdks/allocationwindows/README.md +4 -4
  200. package/docs/sdks/assets/README.md +6 -6
  201. package/docs/sdks/assettypefields/README.md +8 -8
  202. package/docs/sdks/assettypes/README.md +4 -4
  203. package/docs/sdks/attachments/README.md +12 -12
  204. package/docs/sdks/badges/README.md +12 -12
  205. package/docs/sdks/bundles/README.md +4 -4
  206. package/docs/sdks/categories/README.md +4 -4
  207. package/docs/sdks/clients/README.md +8 -8
  208. package/docs/sdks/companycontacts/README.md +8 -8
  209. package/docs/sdks/emailtemplates/README.md +4 -4
  210. package/docs/sdks/feedback/README.md +8 -8
  211. package/docs/sdks/formfields/README.md +8 -8
  212. package/docs/sdks/formresponses/README.md +28 -28
  213. package/docs/sdks/forms/README.md +8 -8
  214. package/docs/sdks/jobactivities/README.md +20 -20
  215. package/docs/sdks/joballocations/README.md +24 -24
  216. package/docs/sdks/jobchecklists/README.md +32 -32
  217. package/docs/sdks/jobcontacts/README.md +8 -8
  218. package/docs/sdks/jobmaterialbundles/README.md +12 -12
  219. package/docs/sdks/jobmaterials/README.md +20 -20
  220. package/docs/sdks/jobpayments/README.md +16 -16
  221. package/docs/sdks/jobqueues/README.md +4 -4
  222. package/docs/sdks/jobs/README.md +32 -32
  223. package/docs/sdks/jobtemplates/README.md +434 -0
  224. package/docs/sdks/knowledgearticles/README.md +4 -4
  225. package/docs/sdks/locations/README.md +4 -4
  226. package/docs/sdks/materials/README.md +8 -8
  227. package/docs/sdks/notes/README.md +12 -12
  228. package/docs/sdks/securityroles/README.md +4 -4
  229. package/docs/sdks/smstemplates/README.md +4 -4
  230. package/docs/sdks/staffmembers/README.md +12 -12
  231. package/docs/sdks/staffmessages/README.md +16 -16
  232. package/docs/sdks/tasks/README.md +20 -20
  233. package/docs/sdks/taxrates/README.md +4 -4
  234. package/docs/sdks/vendors/README.md +2 -2
  235. package/examples/package-lock.json +1 -1
  236. package/jsr.json +1 -1
  237. package/package.json +1 -1
  238. package/src/funcs/jobTemplatesCreateJobFromTemplate.ts +3 -0
  239. package/src/funcs/jobTemplatesCreateJobTemplates.ts +190 -0
  240. package/src/funcs/jobTemplatesDeleteJobTemplates.ts +189 -0
  241. package/src/funcs/jobTemplatesGetJobTemplates.ts +187 -0
  242. package/src/funcs/jobTemplatesListJobTemplates.ts +166 -0
  243. package/src/funcs/jobTemplatesUpdateJobTemplates.ts +188 -0
  244. package/src/lib/config.ts +3 -3
  245. package/src/mcp-server/mcp-server.ts +1 -1
  246. package/src/mcp-server/server.ts +20 -10
  247. package/src/mcp-server/tools/jobTemplatesCreateJobFromTemplate.ts +3 -0
  248. package/src/mcp-server/tools/jobTemplatesCreateJobTemplates.ts +48 -0
  249. package/src/mcp-server/tools/jobTemplatesDeleteJobTemplates.ts +47 -0
  250. package/src/mcp-server/tools/jobTemplatesGetJobTemplates.ts +42 -0
  251. package/src/mcp-server/tools/jobTemplatesListJobTemplates.ts +39 -0
  252. package/src/mcp-server/tools/jobTemplatesUpdateJobTemplates.ts +43 -0
  253. package/src/models/components/index.ts +1 -0
  254. package/src/models/components/jobtemplate.ts +198 -0
  255. package/src/models/components/jobtemplateoverrides.ts +11 -2
  256. package/src/models/operations/createjobtemplates.ts +147 -0
  257. package/src/models/operations/deletejobtemplates.ts +125 -0
  258. package/src/models/operations/getjobtemplates.ts +130 -0
  259. package/src/models/operations/index.ts +5 -0
  260. package/src/models/operations/listjobtemplates.ts +69 -0
  261. package/src/models/operations/updatejobtemplates.ts +141 -0
  262. package/src/sdk/jobtemplates.ts +110 -0
  263. package/src/sdk/sdk.ts +10 -10
package/api.json CHANGED
@@ -51,7 +51,7 @@
51
51
  "success": {
52
52
  "value": [
53
53
  {
54
- "uuid": "123e4567-8a62-4e93-af1a-22fd88c5f7cb",
54
+ "uuid": "123e4567-8442-46f9-912b-23004f33aeab",
55
55
  "active": 1,
56
56
  "edit_date": "2025-07-01 12:00:00",
57
57
  "name": "string",
@@ -220,7 +220,7 @@
220
220
  "examples": {
221
221
  "success": {
222
222
  "value": {
223
- "uuid": "123e4567-60ce-40ec-b2b2-22fd8821e2bb",
223
+ "uuid": "123e4567-f08f-449c-86b7-23004728479b",
224
224
  "active": 1,
225
225
  "edit_date": "2025-07-01 12:00:00",
226
226
  "name": "string",
@@ -460,12 +460,12 @@
460
460
  "success": {
461
461
  "value": [
462
462
  {
463
- "uuid": "123e4567-cc8a-4113-b2b5-22fd80ea01fb",
463
+ "uuid": "123e4567-ecfe-483f-b068-230046f4084b",
464
464
  "active": 1,
465
465
  "edit_date": "2025-07-01 12:00:00",
466
- "company_uuid": "123e4567-4ca6-4055-8cc1-22fd8d3ac7db",
466
+ "company_uuid": "123e4567-d72a-41fc-a2cb-2300443af5ab",
467
467
  "asset_code": "string",
468
- "asset_type_uuid": "123e4567-dbf1-4e2f-84ab-22fd8f627e1b",
468
+ "asset_type_uuid": "123e4567-682e-455e-a02f-230045acdbbb",
469
469
  "name": "string",
470
470
  "lat": "number",
471
471
  "lng": "number",
@@ -559,12 +559,12 @@
559
559
  "examples": {
560
560
  "success": {
561
561
  "value": {
562
- "uuid": "123e4567-7ccb-4b6c-95f9-22fd8e3d4c4b",
562
+ "uuid": "123e4567-5e6b-4cda-bad8-23004735f98b",
563
563
  "active": 1,
564
564
  "edit_date": "2025-07-01 12:00:00",
565
- "company_uuid": "123e4567-4de0-4162-90d2-22fd8315b9bb",
565
+ "company_uuid": "123e4567-746c-47e6-aa18-2300470c4b4b",
566
566
  "asset_code": "string",
567
- "asset_type_uuid": "123e4567-9f20-426f-886c-22fd8dbcd9fb",
567
+ "asset_type_uuid": "123e4567-1e5f-4f09-8717-23004f78850b",
568
568
  "name": "string",
569
569
  "lat": "number",
570
570
  "lng": "number",
@@ -816,7 +816,7 @@
816
816
  "success": {
817
817
  "value": [
818
818
  {
819
- "uuid": "123e4567-5e05-4d6d-a7bf-22fd88e6d95b",
819
+ "uuid": "123e4567-b06b-435a-834f-23004b0e748b",
820
820
  "active": 1,
821
821
  "edit_date": "2025-07-01 12:00:00",
822
822
  "name": "string"
@@ -986,7 +986,7 @@
986
986
  "examples": {
987
987
  "success": {
988
988
  "value": {
989
- "uuid": "123e4567-eaea-4d4e-b1d5-22fd87803bbb",
989
+ "uuid": "123e4567-783b-4e18-9af8-23004ce0087b",
990
990
  "active": 1,
991
991
  "edit_date": "2025-07-01 12:00:00",
992
992
  "name": "string"
@@ -1227,10 +1227,10 @@
1227
1227
  "success": {
1228
1228
  "value": [
1229
1229
  {
1230
- "uuid": "123e4567-26d1-415e-a7ae-22fd83d770cb",
1230
+ "uuid": "123e4567-c1ed-4119-8681-23004d25214b",
1231
1231
  "active": 1,
1232
1232
  "edit_date": "2025-07-01 12:00:00",
1233
- "asset_type_uuid": "123e4567-0539-4bd0-ace2-22fd888bb7db",
1233
+ "asset_type_uuid": "123e4567-58a9-4000-b90e-23004a6acd0b",
1234
1234
  "name": "string",
1235
1235
  "field_data": {
1236
1236
  "fieldType": "string",
@@ -1406,10 +1406,10 @@
1406
1406
  "examples": {
1407
1407
  "success": {
1408
1408
  "value": {
1409
- "uuid": "123e4567-ea56-4631-9784-22fd862a1cbb",
1409
+ "uuid": "123e4567-33f1-48ce-a932-230044d91cdb",
1410
1410
  "active": 1,
1411
1411
  "edit_date": "2025-07-01 12:00:00",
1412
- "asset_type_uuid": "123e4567-6e3b-4a78-a3ae-22fd8b304f2b",
1412
+ "asset_type_uuid": "123e4567-8a59-4de7-a80d-23004550919b",
1413
1413
  "name": "string",
1414
1414
  "field_data": {
1415
1415
  "fieldType": "string",
@@ -1654,14 +1654,14 @@
1654
1654
  "success": {
1655
1655
  "value": [
1656
1656
  {
1657
- "uuid": "123e4567-1662-4107-903e-22fd80098f2b",
1657
+ "uuid": "123e4567-336c-4396-a7be-230043f1251b",
1658
1658
  "active": 1,
1659
1659
  "edit_date": "2025-07-01 12:00:00",
1660
1660
  "related_object": "string",
1661
- "related_object_uuid": "123e4567-062b-4087-b86a-22fd8475510b",
1661
+ "related_object_uuid": "123e4567-053b-4729-a187-230040f5b74b",
1662
1662
  "attachment_name": "string",
1663
1663
  "file_type": "string",
1664
- "created_by_staff_uuid": "123e4567-385d-4288-9ec9-22fd8f105acb",
1664
+ "created_by_staff_uuid": "123e4567-ada8-41bf-98ed-230048241ceb",
1665
1665
  "timestamp": "string",
1666
1666
  "attachment_source": "string",
1667
1667
  "tags": "string",
@@ -1835,14 +1835,14 @@
1835
1835
  "examples": {
1836
1836
  "success": {
1837
1837
  "value": {
1838
- "uuid": "123e4567-cf25-4998-a0eb-22fd8aa3388b",
1838
+ "uuid": "123e4567-0dae-46cc-b50b-2300486f24cb",
1839
1839
  "active": 1,
1840
1840
  "edit_date": "2025-07-01 12:00:00",
1841
1841
  "related_object": "string",
1842
- "related_object_uuid": "123e4567-19bb-4651-b298-22fd84d4f25b",
1842
+ "related_object_uuid": "123e4567-4de2-4168-97ac-230042585dbb",
1843
1843
  "attachment_name": "string",
1844
1844
  "file_type": "string",
1845
- "created_by_staff_uuid": "123e4567-86f6-47c3-a061-22fd8ba66d9b",
1845
+ "created_by_staff_uuid": "123e4567-0d95-437a-af11-23004b48772b",
1846
1846
  "timestamp": "string",
1847
1847
  "attachment_source": "string",
1848
1848
  "tags": "string",
@@ -2087,14 +2087,14 @@
2087
2087
  "success": {
2088
2088
  "value": [
2089
2089
  {
2090
- "uuid": "123e4567-3ba2-4814-8792-22fd89db767b",
2090
+ "uuid": "123e4567-55a9-49c3-8abd-23004d4cab5b",
2091
2091
  "active": 1,
2092
2092
  "edit_date": "2025-07-01 12:00:00",
2093
2093
  "name": "string",
2094
2094
  "automatically_allocated": "string",
2095
2095
  "file_name": "string",
2096
- "regarding_form_uuid": "123e4567-cf8b-4bd7-b13f-22fd84c1437b",
2097
- "regarding_asset_type_uuid": "123e4567-cd39-4760-99eb-22fd87eafc7b"
2096
+ "regarding_form_uuid": "123e4567-7e8a-4907-9de4-2300452a7e4b",
2097
+ "regarding_asset_type_uuid": "123e4567-00be-4b1e-b6fc-2300406d098b"
2098
2098
  }
2099
2099
  ]
2100
2100
  }
@@ -2261,14 +2261,14 @@
2261
2261
  "examples": {
2262
2262
  "success": {
2263
2263
  "value": {
2264
- "uuid": "123e4567-7363-4578-b9df-22fd8d86b15b",
2264
+ "uuid": "123e4567-d833-40be-b7c5-230044688e0b",
2265
2265
  "active": 1,
2266
2266
  "edit_date": "2025-07-01 12:00:00",
2267
2267
  "name": "string",
2268
2268
  "automatically_allocated": "string",
2269
2269
  "file_name": "string",
2270
- "regarding_form_uuid": "123e4567-1a8f-468f-abab-22fd8993d4eb",
2271
- "regarding_asset_type_uuid": "123e4567-89ea-4a49-b427-22fd84585eeb"
2270
+ "regarding_form_uuid": "123e4567-cb7b-44ef-8284-23004eab4ddb",
2271
+ "regarding_asset_type_uuid": "123e4567-f236-46d6-aeb5-23004e6a572b"
2272
2272
  }
2273
2273
  }
2274
2274
  }
@@ -2508,7 +2508,7 @@
2508
2508
  {
2509
2509
  "name": "string",
2510
2510
  "colour": "string",
2511
- "uuid": "123e4567-0804-40cb-8ff1-22fd810792db",
2511
+ "uuid": "123e4567-6727-4225-bcc9-230041f8aeeb",
2512
2512
  "active": 1,
2513
2513
  "edit_date": "2025-07-01 12:00:00"
2514
2514
  }
@@ -2679,7 +2679,7 @@
2679
2679
  "value": {
2680
2680
  "name": "string",
2681
2681
  "colour": "string",
2682
- "uuid": "123e4567-2cfc-4b12-8e34-22fd8eefdd4b",
2682
+ "uuid": "123e4567-9446-4647-a7bd-2300499f6efb",
2683
2683
  "active": 1,
2684
2684
  "edit_date": "2025-07-01 12:00:00"
2685
2685
  }
@@ -2924,7 +2924,7 @@
2924
2924
  "address": "string",
2925
2925
  "billing_address": "string",
2926
2926
  "parent_company_uuid": "string",
2927
- "uuid": "123e4567-db9f-4564-9b67-22fd8532aa3b",
2927
+ "uuid": "123e4567-863e-46a2-ab4d-230042e09e5b",
2928
2928
  "active": 1,
2929
2929
  "edit_date": "2025-07-01 12:00:00",
2930
2930
  "website": "string",
@@ -2936,7 +2936,7 @@
2936
2936
  "address_country": "string",
2937
2937
  "fax_number": "string",
2938
2938
  "badges": "string",
2939
- "tax_rate_uuid": "123e4567-970b-4fe9-b6cc-22fd8660e9fb",
2939
+ "tax_rate_uuid": "123e4567-ee09-4d59-bfbe-23004ca586bb",
2940
2940
  "billing_attention": "string",
2941
2941
  "payment_terms": "string"
2942
2942
  }
@@ -3110,7 +3110,7 @@
3110
3110
  "address": "string",
3111
3111
  "billing_address": "string",
3112
3112
  "parent_company_uuid": "string",
3113
- "uuid": "123e4567-10f3-4958-a080-22fd81ff424b",
3113
+ "uuid": "123e4567-c402-4d05-ab03-23004ce4688b",
3114
3114
  "active": 1,
3115
3115
  "edit_date": "2025-07-01 12:00:00",
3116
3116
  "website": "string",
@@ -3122,7 +3122,7 @@
3122
3122
  "address_country": "string",
3123
3123
  "fax_number": "string",
3124
3124
  "badges": "string",
3125
- "tax_rate_uuid": "123e4567-1377-447d-9c98-22fd88f488ab",
3125
+ "tax_rate_uuid": "123e4567-2de3-4203-a95c-230044bf95eb",
3126
3126
  "billing_attention": "string",
3127
3127
  "payment_terms": "string"
3128
3128
  }
@@ -3362,10 +3362,10 @@
3362
3362
  "success": {
3363
3363
  "value": [
3364
3364
  {
3365
- "uuid": "123e4567-c80c-4e1c-ae35-22fd85ded6fb",
3365
+ "uuid": "123e4567-22b0-433b-b56b-2300434cd4bb",
3366
3366
  "active": 1,
3367
3367
  "edit_date": "2025-07-01 12:00:00",
3368
- "company_uuid": "123e4567-89d4-45f7-a142-22fd8852fe4b",
3368
+ "company_uuid": "123e4567-7ed0-409f-8265-23004a64082b",
3369
3369
  "first": "string",
3370
3370
  "last": "string",
3371
3371
  "phone": "string",
@@ -3539,10 +3539,10 @@
3539
3539
  "examples": {
3540
3540
  "success": {
3541
3541
  "value": {
3542
- "uuid": "123e4567-b6c3-47be-9b9b-22fd89a7f8eb",
3542
+ "uuid": "123e4567-7432-4791-b25d-230044bda2ab",
3543
3543
  "active": 1,
3544
3544
  "edit_date": "2025-07-01 12:00:00",
3545
- "company_uuid": "123e4567-73dc-474d-943a-22fd8b9a92cb",
3545
+ "company_uuid": "123e4567-b696-4b76-8195-23004e2fce0b",
3546
3546
  "first": "string",
3547
3547
  "last": "string",
3548
3548
  "phone": "string",
@@ -3785,7 +3785,7 @@
3785
3785
  "success": {
3786
3786
  "value": [
3787
3787
  {
3788
- "uuid": "123e4567-c96e-47b3-8afd-22fd8c244d9b",
3788
+ "uuid": "123e4567-19a5-4dc2-90d7-230043348b3b",
3789
3789
  "active": 1,
3790
3790
  "edit_date": "2025-07-01 12:00:00",
3791
3791
  "name": "string",
@@ -3953,7 +3953,7 @@
3953
3953
  "examples": {
3954
3954
  "success": {
3955
3955
  "value": {
3956
- "uuid": "123e4567-9e6b-44dd-8286-22fd8bb9159b",
3956
+ "uuid": "123e4567-fe0c-4bb0-a876-230049ce8feb",
3957
3957
  "active": 1,
3958
3958
  "edit_date": "2025-07-01 12:00:00",
3959
3959
  "name": "string",
@@ -4190,12 +4190,12 @@
4190
4190
  "success": {
4191
4191
  "value": [
4192
4192
  {
4193
- "uuid": "123e4567-cbcf-495a-900c-22fd89de296b",
4193
+ "uuid": "123e4567-dc5b-42fe-a0db-23004869885b",
4194
4194
  "active": 1,
4195
4195
  "edit_date": "2025-07-01 12:00:00",
4196
4196
  "timestamp": "string",
4197
4197
  "related_object": "string",
4198
- "related_object_uuid": "123e4567-3e62-4e79-b569-22fd87e7dfeb",
4198
+ "related_object_uuid": "123e4567-3996-46ff-8885-2300452eebdb",
4199
4199
  "rating": "string",
4200
4200
  "comment": "string"
4201
4201
  }
@@ -4360,12 +4360,12 @@
4360
4360
  "examples": {
4361
4361
  "success": {
4362
4362
  "value": {
4363
- "uuid": "123e4567-3b35-42b3-a935-22fd85c20c4b",
4363
+ "uuid": "123e4567-7f7b-417b-bd18-230045e2bc8b",
4364
4364
  "active": 1,
4365
4365
  "edit_date": "2025-07-01 12:00:00",
4366
4366
  "timestamp": "string",
4367
4367
  "related_object": "string",
4368
- "related_object_uuid": "123e4567-1abb-4ff4-a996-22fd85cebb8b",
4368
+ "related_object_uuid": "123e4567-6b7b-4167-877f-23004a1b467b",
4369
4369
  "rating": "string",
4370
4370
  "comment": "string"
4371
4371
  }
@@ -4600,7 +4600,7 @@
4600
4600
  "value": [
4601
4601
  {
4602
4602
  "name": "string",
4603
- "document_template_uuid": "123e4567-6959-42d1-98a7-22fd89b8ed0b",
4603
+ "document_template_uuid": "123e4567-845a-470c-9c07-23004831cd9b",
4604
4604
  "can_be_used_independently": "string",
4605
4605
  "badge_mandatory_state": "string",
4606
4606
  "template_fields": [
@@ -4611,7 +4611,7 @@
4611
4611
  "sortOrder": "string"
4612
4612
  }
4613
4613
  ],
4614
- "uuid": "123e4567-a984-45d8-9da4-22fd8f3694db",
4614
+ "uuid": "123e4567-ec02-4400-ab53-23004fa0e64b",
4615
4615
  "active": 1,
4616
4616
  "edit_date": "2025-07-01 12:00:00"
4617
4617
  }
@@ -4777,7 +4777,7 @@
4777
4777
  "success": {
4778
4778
  "value": {
4779
4779
  "name": "string",
4780
- "document_template_uuid": "123e4567-0e39-4464-8caa-22fd873477cb",
4780
+ "document_template_uuid": "123e4567-2e8a-4c00-9c18-23004e71e89b",
4781
4781
  "can_be_used_independently": "string",
4782
4782
  "badge_mandatory_state": "string",
4783
4783
  "template_fields": [
@@ -4788,7 +4788,7 @@
4788
4788
  "sortOrder": "string"
4789
4789
  }
4790
4790
  ],
4791
- "uuid": "123e4567-a592-4a62-853b-22fd81ea1c5b",
4791
+ "uuid": "123e4567-73d2-4ae0-983e-23004a5dd52b",
4792
4792
  "active": 1,
4793
4793
  "edit_date": "2025-07-01 12:00:00"
4794
4794
  }
@@ -5022,10 +5022,10 @@
5022
5022
  "success": {
5023
5023
  "value": [
5024
5024
  {
5025
- "uuid": "123e4567-d085-4c7e-ab27-22fd88f66c0b",
5025
+ "uuid": "123e4567-f283-4530-b524-2300451eb25b",
5026
5026
  "active": 1,
5027
5027
  "edit_date": "2025-07-01 12:00:00",
5028
- "form_uuid": "123e4567-8286-410c-a76d-22fd8f973bcb",
5028
+ "form_uuid": "123e4567-47d9-4430-a0c1-23004ceff98b",
5029
5029
  "name": "string",
5030
5030
  "field_data_json": "string",
5031
5031
  "sort_order": "string"
@@ -5191,10 +5191,10 @@
5191
5191
  "examples": {
5192
5192
  "success": {
5193
5193
  "value": {
5194
- "uuid": "123e4567-5320-47d0-a83c-22fd813a455b",
5194
+ "uuid": "123e4567-31e1-4b4f-a63e-2300427c8a7b",
5195
5195
  "active": 1,
5196
5196
  "edit_date": "2025-07-01 12:00:00",
5197
- "form_uuid": "123e4567-3c24-4709-84a6-22fd8385a75b",
5197
+ "form_uuid": "123e4567-cda1-4c1e-a506-2300474138eb",
5198
5198
  "name": "string",
5199
5199
  "field_data_json": "string",
5200
5200
  "sort_order": "string"
@@ -5429,18 +5429,18 @@
5429
5429
  "success": {
5430
5430
  "value": [
5431
5431
  {
5432
- "uuid": "123e4567-d293-4045-9d31-22fd8bf3220b",
5432
+ "uuid": "123e4567-2c8b-4cd1-969d-230041701d4b",
5433
5433
  "active": 1,
5434
5434
  "edit_date": "2025-07-01 12:00:00",
5435
- "form_uuid": "123e4567-41e2-4335-9224-22fd868102bb",
5436
- "staff_uuid": "123e4567-4b55-4a9e-ab81-22fd8fc188fb",
5435
+ "form_uuid": "123e4567-d76e-4740-9e93-2300499ebbeb",
5436
+ "staff_uuid": "123e4567-755c-4b60-9f8c-23004e17cc6b",
5437
5437
  "regarding_object": "string",
5438
- "regarding_object_uuid": "123e4567-c330-4fe7-b0b3-22fd81e9fa1b",
5438
+ "regarding_object_uuid": "123e4567-6700-485c-8c0d-23004ba9c12b",
5439
5439
  "field_data": "string",
5440
5440
  "timestamp": "2025-07-01 12:00:00",
5441
- "form_by_staff_uuid": "123e4567-7f6e-43a3-a698-22fd8f0111bb",
5442
- "document_attachment_uuid": "123e4567-4eee-4762-9d4a-22fd8fe5658b",
5443
- "asset_uuid": "123e4567-1302-4121-94cd-22fd8587f9fb"
5441
+ "form_by_staff_uuid": "123e4567-9e33-49b9-8a01-23004c2ecedb",
5442
+ "document_attachment_uuid": "123e4567-ed18-46ee-b22f-230042083bab",
5443
+ "asset_uuid": "123e4567-f055-46f2-992a-23004373918b"
5444
5444
  }
5445
5445
  ]
5446
5446
  }
@@ -5603,18 +5603,18 @@
5603
5603
  "examples": {
5604
5604
  "success": {
5605
5605
  "value": {
5606
- "uuid": "123e4567-67c7-419e-a425-22fd845ab6bb",
5606
+ "uuid": "123e4567-9ce7-471b-9b4d-230041dcc59b",
5607
5607
  "active": 1,
5608
5608
  "edit_date": "2025-07-01 12:00:00",
5609
- "form_uuid": "123e4567-4c32-4887-a9ea-22fd8672240b",
5610
- "staff_uuid": "123e4567-acc4-4c21-943d-22fd8917278b",
5609
+ "form_uuid": "123e4567-6799-440b-8cc1-23004a82087b",
5610
+ "staff_uuid": "123e4567-557d-4717-af48-230045c519ab",
5611
5611
  "regarding_object": "string",
5612
- "regarding_object_uuid": "123e4567-29b4-4ce0-ba8e-22fd835475ab",
5612
+ "regarding_object_uuid": "123e4567-1aa2-4b22-94fa-2300450c63eb",
5613
5613
  "field_data": "string",
5614
5614
  "timestamp": "2025-07-01 12:00:00",
5615
- "form_by_staff_uuid": "123e4567-7489-41cf-be5d-22fd8c036a8b",
5616
- "document_attachment_uuid": "123e4567-bf27-4bea-8086-22fd80c2f6bb",
5617
- "asset_uuid": "123e4567-6020-4ad0-85cf-22fd8229f45b"
5615
+ "form_by_staff_uuid": "123e4567-1160-429f-aed5-2300488017bb",
5616
+ "document_attachment_uuid": "123e4567-dd5e-4c57-b21f-23004acb91cb",
5617
+ "asset_uuid": "123e4567-0579-429d-954f-23004c815f5b"
5618
5618
  }
5619
5619
  }
5620
5620
  }
@@ -5815,6 +5815,158 @@
5815
5815
  }
5816
5816
  }
5817
5817
  },
5818
+ "/inboxmessage.json": {
5819
+ "get": {
5820
+ "tags": [
5821
+ "Inbox"
5822
+ ],
5823
+ "operationId": "listInboxMessages",
5824
+ "summary": "List inbox messages",
5825
+ "description": "Retrieves a paginated list of inbox messages with optional filtering",
5826
+ "security": [
5827
+ {
5828
+ "apiKey": []
5829
+ },
5830
+ {
5831
+ "oauth2": [
5832
+ "read_inbox"
5833
+ ]
5834
+ }
5835
+ ],
5836
+ "parameters": [
5837
+ {
5838
+ "name": "limit",
5839
+ "in": "query",
5840
+ "description": "Maximum number of messages to return (1-500)",
5841
+ "schema": {
5842
+ "type": "integer",
5843
+ "minimum": 1,
5844
+ "maximum": 500,
5845
+ "default": 50
5846
+ }
5847
+ },
5848
+ {
5849
+ "name": "offset",
5850
+ "in": "query",
5851
+ "description": "Number of messages to skip for pagination",
5852
+ "schema": {
5853
+ "type": "integer",
5854
+ "minimum": 0,
5855
+ "default": 0
5856
+ }
5857
+ },
5858
+ {
5859
+ "name": "filter",
5860
+ "in": "query",
5861
+ "description": "Filter messages by status",
5862
+ "schema": {
5863
+ "type": "string",
5864
+ "enum": [
5865
+ "all",
5866
+ "unread",
5867
+ "archived",
5868
+ "snoozed"
5869
+ ],
5870
+ "default": "all"
5871
+ }
5872
+ },
5873
+ {
5874
+ "name": "search",
5875
+ "in": "query",
5876
+ "description": "Search messages by subject, from name, or from email",
5877
+ "schema": {
5878
+ "type": "string"
5879
+ }
5880
+ }
5881
+ ],
5882
+ "responses": {
5883
+ "200": {
5884
+ "description": "Successful response",
5885
+ "content": {
5886
+ "application/json": {
5887
+ "schema": {
5888
+ "$ref": "#/components/schemas/InboxMessagesResponse"
5889
+ }
5890
+ }
5891
+ }
5892
+ },
5893
+ "403": {
5894
+ "description": "Forbidden - Missing permission or OAuth scope",
5895
+ "content": {
5896
+ "application/json": {
5897
+ "schema": {
5898
+ "$ref": "#/components/schemas/Error"
5899
+ }
5900
+ }
5901
+ }
5902
+ },
5903
+ "400": {
5904
+ "description": "Service Unavailable - Inbox not enabled",
5905
+ "content": {
5906
+ "application/json": {
5907
+ "schema": {
5908
+ "$ref": "#/components/schemas/Error"
5909
+ }
5910
+ }
5911
+ }
5912
+ }
5913
+ }
5914
+ }
5915
+ },
5916
+ "/inboxmessage/{uuid}.json": {
5917
+ "get": {
5918
+ "tags": [
5919
+ "Inbox"
5920
+ ],
5921
+ "operationId": "getInboxMessage",
5922
+ "summary": "Get inbox message details",
5923
+ "description": "Retrieves detailed information about a specific inbox message including attachments and conversation history",
5924
+ "security": [
5925
+ {
5926
+ "apiKey": []
5927
+ },
5928
+ {
5929
+ "oauth2": [
5930
+ "read_inbox"
5931
+ ]
5932
+ }
5933
+ ],
5934
+ "parameters": [
5935
+ {
5936
+ "name": "uuid",
5937
+ "in": "path",
5938
+ "required": true,
5939
+ "description": "UUID of the inbox message",
5940
+ "schema": {
5941
+ "type": "string",
5942
+ "format": "uuid"
5943
+ }
5944
+ }
5945
+ ],
5946
+ "responses": {
5947
+ "200": {
5948
+ "description": "Successful response",
5949
+ "content": {
5950
+ "application/json": {
5951
+ "schema": {
5952
+ "$ref": "#/components/schemas/InboxMessageDetail"
5953
+ }
5954
+ }
5955
+ }
5956
+ },
5957
+ "404": {
5958
+ "description": "Message not found",
5959
+ "content": {
5960
+ "application/json": {
5961
+ "schema": {
5962
+ "$ref": "#/components/schemas/Error"
5963
+ }
5964
+ }
5965
+ }
5966
+ }
5967
+ }
5968
+ }
5969
+ },
5818
5970
  "/job.json": {
5819
5971
  "get": {
5820
5972
  "tags": [
@@ -5848,18 +6000,18 @@
5848
6000
  "success": {
5849
6001
  "value": [
5850
6002
  {
5851
- "created_by_staff_uuid": "123e4567-3a91-40b9-9d66-22fd80e858eb",
6003
+ "created_by_staff_uuid": "123e4567-74e7-4764-9d9b-23004e3723fb",
5852
6004
  "date": "YYYY-MM-DD",
5853
- "company_uuid": "123e4567-ef30-4583-8cf2-22fd8762424b",
6005
+ "company_uuid": "123e4567-a7e6-4631-b737-230040e4155b",
5854
6006
  "billing_address": "string",
5855
6007
  "status": "string",
5856
6008
  "lng": "number",
5857
6009
  "lat": "number",
5858
6010
  "payment_date": "2025-07-01 12:00:00",
5859
- "payment_actioned_by_uuid": "123e4567-db47-4dc5-b5dc-22fd8daf883b",
6011
+ "payment_actioned_by_uuid": "123e4567-8f15-408b-8c19-230047ea135b",
5860
6012
  "payment_method": "string",
5861
6013
  "payment_amount": "string",
5862
- "category_uuid": "123e4567-6ad5-447a-b010-22fd8df616db",
6014
+ "category_uuid": "123e4567-bd9b-41b7-b5f4-23004184c33b",
5863
6015
  "payment_note": "string",
5864
6016
  "geo_is_valid": "string",
5865
6017
  "purchase_order_number": "string",
@@ -5873,9 +6025,9 @@
5873
6025
  "geo_city": "string",
5874
6026
  "geo_street": "string",
5875
6027
  "geo_number": "string",
5876
- "queue_uuid": "123e4567-d26b-41a4-a606-22fd800fd50b",
6028
+ "queue_uuid": "123e4567-b354-4528-b03f-2300418ce5cb",
5877
6029
  "queue_expiry_date": "2025-07-01 12:00:00",
5878
- "queue_assigned_staff_uuid": "123e4567-d368-41e3-8c01-22fd86b6e0db",
6030
+ "queue_assigned_staff_uuid": "123e4567-0f9f-462e-8641-230043fe7e3b",
5879
6031
  "badges": "string",
5880
6032
  "quote_date": "2025-07-01 12:00:00",
5881
6033
  "quote_sent": "string",
@@ -5883,7 +6035,7 @@
5883
6035
  "work_order_date": "2025-07-01 12:00:00",
5884
6036
  "active_network_request_uuid": "string",
5885
6037
  "related_knowledge_articles": "string",
5886
- "uuid": "123e4567-16bd-4510-afab-22fd8c5a6c2b",
6038
+ "uuid": "123e4567-90ee-4846-925a-230040395d4b",
5887
6039
  "active": 1,
5888
6040
  "edit_date": "2025-07-01 12:00:00",
5889
6041
  "job_address": "string",
@@ -5896,7 +6048,7 @@
5896
6048
  "payment_received": "string",
5897
6049
  "payment_received_stamp": "2025-07-01 12:00:00",
5898
6050
  "completion_date": "2025-07-01 12:00:00",
5899
- "completion_actioned_by_uuid": "123e4567-41c9-43ec-8213-22fd8e6a054b",
6051
+ "completion_actioned_by_uuid": "123e4567-88c5-4bc7-9dfe-23004384483b",
5900
6052
  "unsuccessful_date": "2025-07-01 12:00:00",
5901
6053
  "job_is_scheduled_until_stamp": "2025-07-01 12:00:00"
5902
6054
  }
@@ -6065,18 +6217,18 @@
6065
6217
  "examples": {
6066
6218
  "success": {
6067
6219
  "value": {
6068
- "created_by_staff_uuid": "123e4567-d4c6-43f3-b07b-22fd8d32bf4b",
6220
+ "created_by_staff_uuid": "123e4567-c4f3-457e-861b-230043ef99bb",
6069
6221
  "date": "YYYY-MM-DD",
6070
- "company_uuid": "123e4567-0081-47df-9e78-22fd8bf6018b",
6222
+ "company_uuid": "123e4567-fa4e-4e33-be7f-23004257b64b",
6071
6223
  "billing_address": "string",
6072
6224
  "status": "string",
6073
6225
  "lng": "number",
6074
6226
  "lat": "number",
6075
6227
  "payment_date": "2025-07-01 12:00:00",
6076
- "payment_actioned_by_uuid": "123e4567-d7bc-436c-8709-22fd8972321b",
6228
+ "payment_actioned_by_uuid": "123e4567-cf24-4474-8774-230041da8bbb",
6077
6229
  "payment_method": "string",
6078
6230
  "payment_amount": "string",
6079
- "category_uuid": "123e4567-225a-465d-a72f-22fd85fa71bb",
6231
+ "category_uuid": "123e4567-5ee2-49a7-b055-23004704b60b",
6080
6232
  "payment_note": "string",
6081
6233
  "geo_is_valid": "string",
6082
6234
  "purchase_order_number": "string",
@@ -6090,9 +6242,9 @@
6090
6242
  "geo_city": "string",
6091
6243
  "geo_street": "string",
6092
6244
  "geo_number": "string",
6093
- "queue_uuid": "123e4567-7b52-48e2-a4f4-22fd88eec20b",
6245
+ "queue_uuid": "123e4567-1a1f-427e-aa8a-23004b1b93fb",
6094
6246
  "queue_expiry_date": "2025-07-01 12:00:00",
6095
- "queue_assigned_staff_uuid": "123e4567-45e4-4900-abcb-22fd8b4c81cb",
6247
+ "queue_assigned_staff_uuid": "123e4567-8947-473a-8fe5-23004e6bb0eb",
6096
6248
  "badges": "string",
6097
6249
  "quote_date": "2025-07-01 12:00:00",
6098
6250
  "quote_sent": "string",
@@ -6100,7 +6252,7 @@
6100
6252
  "work_order_date": "2025-07-01 12:00:00",
6101
6253
  "active_network_request_uuid": "string",
6102
6254
  "related_knowledge_articles": "string",
6103
- "uuid": "123e4567-9280-4e78-8099-22fd8c20976b",
6255
+ "uuid": "123e4567-49a5-4b1c-88df-23004012810b",
6104
6256
  "active": 1,
6105
6257
  "edit_date": "2025-07-01 12:00:00",
6106
6258
  "job_address": "string",
@@ -6113,7 +6265,7 @@
6113
6265
  "payment_received": "string",
6114
6266
  "payment_received_stamp": "2025-07-01 12:00:00",
6115
6267
  "completion_date": "2025-07-01 12:00:00",
6116
- "completion_actioned_by_uuid": "123e4567-a90b-489d-b833-22fd8fc3dcdb",
6268
+ "completion_actioned_by_uuid": "123e4567-bf14-4945-87c6-23004ca8febb",
6117
6269
  "unsuccessful_date": "2025-07-01 12:00:00",
6118
6270
  "job_is_scheduled_until_stamp": "2025-07-01 12:00:00"
6119
6271
  }
@@ -6353,11 +6505,11 @@
6353
6505
  "success": {
6354
6506
  "value": [
6355
6507
  {
6356
- "uuid": "123e4567-bddf-41af-b83b-22fd85900edb",
6508
+ "uuid": "123e4567-2e3b-4bac-8441-23004e1ca0bb",
6357
6509
  "active": 1,
6358
6510
  "edit_date": "2025-07-01 12:00:00",
6359
- "job_uuid": "123e4567-cf14-421e-934e-22fd84769dfb",
6360
- "staff_uuid": "123e4567-b436-46b5-a02b-22fd808fe80b",
6511
+ "job_uuid": "123e4567-0c9c-44ff-bdb8-230041ca84cb",
6512
+ "staff_uuid": "123e4567-0e46-426f-9d2d-23004dd60f5b",
6361
6513
  "start_date": "2025-07-01 12:00:00",
6362
6514
  "end_date": "2025-07-01 12:00:00",
6363
6515
  "activity_was_scheduled": "string",
@@ -6367,10 +6519,10 @@
6367
6519
  "has_been_opened_timestamp": "2025-07-01 12:00:00",
6368
6520
  "travel_time_in_seconds": "string",
6369
6521
  "travel_distance_in_meters": "string",
6370
- "allocated_by_staff_uuid": "123e4567-a5c8-439c-9e71-22fd8b9e901b",
6522
+ "allocated_by_staff_uuid": "123e4567-47f4-4100-ad39-230047156ddb",
6371
6523
  "allocated_timestamp": "2025-07-01 12:00:00",
6372
- "material_uuid": "123e4567-c0ee-46ff-9114-22fd875ebcdb",
6373
- "edit_by_staff_uuid": "123e4567-e9e3-4a40-b848-22fd8b813ecb"
6524
+ "material_uuid": "123e4567-ea05-43a7-9fe2-23004b47638b",
6525
+ "edit_by_staff_uuid": "123e4567-3b02-4a9f-9d8d-23004905f26b"
6374
6526
  }
6375
6527
  ]
6376
6528
  }
@@ -6537,11 +6689,11 @@
6537
6689
  "examples": {
6538
6690
  "success": {
6539
6691
  "value": {
6540
- "uuid": "123e4567-a486-425e-862b-22fd85f8d98b",
6692
+ "uuid": "123e4567-0973-4f64-95d0-23004f521d3b",
6541
6693
  "active": 1,
6542
6694
  "edit_date": "2025-07-01 12:00:00",
6543
- "job_uuid": "123e4567-c355-4be6-8677-22fd8210f5ab",
6544
- "staff_uuid": "123e4567-034b-4275-9a9d-22fd8095af9b",
6695
+ "job_uuid": "123e4567-00ec-486d-a608-2300486fa18b",
6696
+ "staff_uuid": "123e4567-e758-4aef-9b6a-230046e581eb",
6545
6697
  "start_date": "2025-07-01 12:00:00",
6546
6698
  "end_date": "2025-07-01 12:00:00",
6547
6699
  "activity_was_scheduled": "string",
@@ -6551,10 +6703,10 @@
6551
6703
  "has_been_opened_timestamp": "2025-07-01 12:00:00",
6552
6704
  "travel_time_in_seconds": "string",
6553
6705
  "travel_distance_in_meters": "string",
6554
- "allocated_by_staff_uuid": "123e4567-9063-4b8d-a759-22fd80f16adb",
6706
+ "allocated_by_staff_uuid": "123e4567-1f27-4093-9eb6-23004c6ba35b",
6555
6707
  "allocated_timestamp": "2025-07-01 12:00:00",
6556
- "material_uuid": "123e4567-7784-4e83-886c-22fd8052ed8b",
6557
- "edit_by_staff_uuid": "123e4567-863e-4163-94af-22fd8b1ca2fb"
6708
+ "material_uuid": "123e4567-91b4-4920-8b6d-230049442a0b",
6709
+ "edit_by_staff_uuid": "123e4567-7c98-490d-bce9-23004b58439b"
6558
6710
  }
6559
6711
  }
6560
6712
  }
@@ -6792,15 +6944,15 @@
6792
6944
  "success": {
6793
6945
  "value": [
6794
6946
  {
6795
- "uuid": "123e4567-4f4b-4559-b1a6-22fd8397543b",
6947
+ "uuid": "123e4567-7b6a-47d5-a994-23004bb0e37b",
6796
6948
  "active": 1,
6797
6949
  "edit_date": "2025-07-01 12:00:00",
6798
- "job_uuid": "123e4567-b547-4fdc-b79d-22fd832f000b",
6799
- "queue_uuid": "123e4567-7fa4-4b2a-a45f-22fd84eba95b",
6800
- "staff_uuid": "123e4567-702d-45e9-ac09-22fd8b1d175b",
6950
+ "job_uuid": "123e4567-b105-458f-8c62-230043b30f5b",
6951
+ "queue_uuid": "123e4567-3903-44bc-a11b-23004855e89b",
6952
+ "staff_uuid": "123e4567-4798-4c8f-b561-23004a487abb",
6801
6953
  "allocation_date": "2025-07-01 12:00:00",
6802
- "allocation_window_uuid": "123e4567-5231-4fa6-835f-22fd87a7539b",
6803
- "allocated_by_staff_uuid": "123e4567-8957-4d42-96c0-22fd8d4f062b",
6954
+ "allocation_window_uuid": "123e4567-6013-40dd-960d-2300438b0f5b",
6955
+ "allocated_by_staff_uuid": "123e4567-64cc-4b6b-81f4-230041a8b9ab",
6804
6956
  "allocated_timestamp": "2025-07-01 12:00:00",
6805
6957
  "expiry_timestamp": "2025-07-01 12:00:00",
6806
6958
  "read_timestamp": "2025-07-01 12:00:00",
@@ -6977,15 +7129,15 @@
6977
7129
  "examples": {
6978
7130
  "success": {
6979
7131
  "value": {
6980
- "uuid": "123e4567-9ffb-4236-9f53-22fd8584b13b",
7132
+ "uuid": "123e4567-d024-43e2-8d88-23004c784d0b",
6981
7133
  "active": 1,
6982
7134
  "edit_date": "2025-07-01 12:00:00",
6983
- "job_uuid": "123e4567-3dae-4766-b2a1-22fd8b9369db",
6984
- "queue_uuid": "123e4567-3e4e-4e26-8f69-22fd82b2f74b",
6985
- "staff_uuid": "123e4567-c2e4-4cf4-8e7c-22fd8389410b",
7135
+ "job_uuid": "123e4567-b23b-43ee-86f7-2300416c910b",
7136
+ "queue_uuid": "123e4567-daa5-4f4b-adca-23004fa051fb",
7137
+ "staff_uuid": "123e4567-e444-4a8e-afd9-2300431c676b",
6986
7138
  "allocation_date": "2025-07-01 12:00:00",
6987
- "allocation_window_uuid": "123e4567-8b0d-4f2d-a0de-22fd8404c13b",
6988
- "allocated_by_staff_uuid": "123e4567-7532-4cc7-b49e-22fd845761ab",
7139
+ "allocation_window_uuid": "123e4567-cff2-48e0-9b8f-23004815aa4b",
7140
+ "allocated_by_staff_uuid": "123e4567-a957-4303-a3a2-230048dcfd4b",
6989
7141
  "allocated_timestamp": "2025-07-01 12:00:00",
6990
7142
  "expiry_timestamp": "2025-07-01 12:00:00",
6991
7143
  "read_timestamp": "2025-07-01 12:00:00",
@@ -7231,27 +7383,27 @@
7231
7383
  "success": {
7232
7384
  "value": [
7233
7385
  {
7234
- "uuid": "123e4567-aa49-47ec-92eb-22fd811f8d6b",
7386
+ "uuid": "123e4567-a50a-470d-8e03-230044eb82bb",
7235
7387
  "active": 1,
7236
7388
  "edit_date": "2025-07-01 12:00:00",
7237
- "job_uuid": "123e4567-24d0-4d98-b8c8-22fd865af7eb",
7389
+ "job_uuid": "123e4567-2867-4e95-b7b2-23004ddb5c4b",
7238
7390
  "name": "string",
7239
7391
  "section_name": "string",
7240
7392
  "item_type": "string",
7241
7393
  "sort_order": "string",
7242
7394
  "completed_timestamp": "2025-07-01 12:00:00",
7243
- "completed_by_staff_uuid": "123e4567-4208-4172-b147-22fd85fd3e6b",
7244
- "completed_during_checkin_uuid": "123e4567-3379-4499-a6e9-22fd8339a92b",
7395
+ "completed_by_staff_uuid": "123e4567-f6be-4f8f-8e96-23004fca4d7b",
7396
+ "completed_during_checkin_uuid": "123e4567-6095-409b-bd8a-23004970d6bb",
7245
7397
  "reminder_type": "string",
7246
7398
  "reminder_data": "string",
7247
7399
  "regarding_object": "string",
7248
- "regarding_object_uuid": "123e4567-a364-4fdf-a4d5-22fd873eedbb",
7400
+ "regarding_object_uuid": "123e4567-ef99-4311-a859-23004789f35b",
7249
7401
  "fulfilled_by_object_name": "string",
7250
- "fulfilled_by_object_uuid": "123e4567-f08f-4fb9-8420-22fd8709d01b",
7251
- "assigned_to_staff_uuids": "123e4567-877a-4309-906f-22fd857a663b",
7402
+ "fulfilled_by_object_uuid": "123e4567-4914-43ff-9bc8-2300453235eb",
7403
+ "assigned_to_staff_uuids": "123e4567-a840-4032-aeca-23004d09e6bb",
7252
7404
  "is_locked": "string",
7253
7405
  "assigned_timestamp": "2025-07-01 12:00:00",
7254
- "assigned_by_staff_uuid": "123e4567-e33b-4d1e-97a0-22fd8eb5a4bb"
7406
+ "assigned_by_staff_uuid": "123e4567-5b22-4b87-8414-23004b54bb8b"
7255
7407
  }
7256
7408
  ]
7257
7409
  }
@@ -7414,27 +7566,27 @@
7414
7566
  "examples": {
7415
7567
  "success": {
7416
7568
  "value": {
7417
- "uuid": "123e4567-6c23-4293-8375-22fd81c0650b",
7569
+ "uuid": "123e4567-29e0-4f18-a452-230043a91ffb",
7418
7570
  "active": 1,
7419
7571
  "edit_date": "2025-07-01 12:00:00",
7420
- "job_uuid": "123e4567-3816-4e1f-9e82-22fd89605f5b",
7572
+ "job_uuid": "123e4567-f44c-409e-9a7b-23004556377b",
7421
7573
  "name": "string",
7422
7574
  "section_name": "string",
7423
7575
  "item_type": "string",
7424
7576
  "sort_order": "string",
7425
7577
  "completed_timestamp": "2025-07-01 12:00:00",
7426
- "completed_by_staff_uuid": "123e4567-f474-49a6-aed4-22fd82d2ea9b",
7427
- "completed_during_checkin_uuid": "123e4567-fbf1-40bf-9fb0-22fd8a6759bb",
7578
+ "completed_by_staff_uuid": "123e4567-abd6-4f3f-81a2-23004c01a31b",
7579
+ "completed_during_checkin_uuid": "123e4567-0984-4e0f-b26f-23004c69ad1b",
7428
7580
  "reminder_type": "string",
7429
7581
  "reminder_data": "string",
7430
7582
  "regarding_object": "string",
7431
- "regarding_object_uuid": "123e4567-778d-4da5-9ecd-22fd84ea4e6b",
7583
+ "regarding_object_uuid": "123e4567-35a5-47dd-8a6f-23004ca3cdbb",
7432
7584
  "fulfilled_by_object_name": "string",
7433
- "fulfilled_by_object_uuid": "123e4567-b02c-4503-b0dc-22fd8d068fdb",
7434
- "assigned_to_staff_uuids": "123e4567-f335-449f-813d-22fd8caa2feb",
7585
+ "fulfilled_by_object_uuid": "123e4567-429b-4822-981e-23004a45646b",
7586
+ "assigned_to_staff_uuids": "123e4567-70fc-4f78-8ff6-230048665f6b",
7435
7587
  "is_locked": "string",
7436
7588
  "assigned_timestamp": "2025-07-01 12:00:00",
7437
- "assigned_by_staff_uuid": "123e4567-a1f2-4019-9faa-22fd8e6b1e8b"
7589
+ "assigned_by_staff_uuid": "123e4567-f2a9-472b-83fe-23004066c22b"
7438
7590
  }
7439
7591
  }
7440
7592
  }
@@ -7668,10 +7820,10 @@
7668
7820
  "success": {
7669
7821
  "value": [
7670
7822
  {
7671
- "uuid": "123e4567-2c70-4da5-a55f-22fd8e970efb",
7823
+ "uuid": "123e4567-f50d-4598-8878-230040fbef9b",
7672
7824
  "active": 1,
7673
7825
  "edit_date": "2025-07-01 12:00:00",
7674
- "job_uuid": "123e4567-ece7-4658-9a35-22fd820b69db",
7826
+ "job_uuid": "123e4567-563d-4bbd-ad3b-230045e8a3fb",
7675
7827
  "first": "string",
7676
7828
  "last": "string",
7677
7829
  "phone": "string",
@@ -7845,10 +7997,10 @@
7845
7997
  "examples": {
7846
7998
  "success": {
7847
7999
  "value": {
7848
- "uuid": "123e4567-7b02-4dea-ac87-22fd806d190b",
8000
+ "uuid": "123e4567-8457-4127-83fd-23004e5a931b",
7849
8001
  "active": 1,
7850
8002
  "edit_date": "2025-07-01 12:00:00",
7851
- "job_uuid": "123e4567-9f96-4e24-92fe-22fd8a95768b",
8003
+ "job_uuid": "123e4567-eae3-4227-bbdc-2300476039eb",
7852
8004
  "first": "string",
7853
8005
  "last": "string",
7854
8006
  "phone": "string",
@@ -8093,21 +8245,21 @@
8093
8245
  "success": {
8094
8246
  "value": [
8095
8247
  {
8096
- "uuid": "123e4567-0596-47e8-b12b-22fd8f0d746b",
8248
+ "uuid": "123e4567-10f0-41af-9ea8-23004e70a7ab",
8097
8249
  "active": 1,
8098
8250
  "edit_date": "2025-07-01 12:00:00",
8099
- "job_uuid": "123e4567-2759-4d31-9b8b-22fd8564bebb",
8100
- "material_uuid": "123e4567-53d5-411a-b03b-22fd881743cb",
8251
+ "job_uuid": "123e4567-d146-4545-8438-23004f61cefb",
8252
+ "material_uuid": "123e4567-451a-4423-84bd-23004d9371bb",
8101
8253
  "name": "string",
8102
8254
  "quantity": "string",
8103
8255
  "price": "string",
8104
8256
  "displayed_amount": "string",
8105
8257
  "displayed_amount_is_tax_inclusive": "string",
8106
- "tax_rate_uuid": "123e4567-288c-47a4-af24-22fd85ea99ab",
8258
+ "tax_rate_uuid": "123e4567-1f1d-44c5-a012-23004205e7cb",
8107
8259
  "sort_order": "string",
8108
8260
  "cost": "string",
8109
8261
  "displayed_cost": "string",
8110
- "job_material_bundle_uuid": "123e4567-78b5-447d-a39a-22fd872184fb"
8262
+ "job_material_bundle_uuid": "123e4567-b6d0-4dd8-bf1b-230044b1221b"
8111
8263
  }
8112
8264
  ]
8113
8265
  }
@@ -8274,21 +8426,21 @@
8274
8426
  "examples": {
8275
8427
  "success": {
8276
8428
  "value": {
8277
- "uuid": "123e4567-bc2a-4a90-a136-22fd813386bb",
8429
+ "uuid": "123e4567-58e1-4c6d-8455-230043bb924b",
8278
8430
  "active": 1,
8279
8431
  "edit_date": "2025-07-01 12:00:00",
8280
- "job_uuid": "123e4567-27ee-4d40-a509-22fd82d7b65b",
8281
- "material_uuid": "123e4567-e840-440a-ad2e-22fd848b8e9b",
8432
+ "job_uuid": "123e4567-7138-49f8-bbf3-2300428870cb",
8433
+ "material_uuid": "123e4567-1345-4b96-8ecd-230041477c4b",
8282
8434
  "name": "string",
8283
8435
  "quantity": "string",
8284
8436
  "price": "string",
8285
8437
  "displayed_amount": "string",
8286
8438
  "displayed_amount_is_tax_inclusive": "string",
8287
- "tax_rate_uuid": "123e4567-11de-4b12-89e4-22fd85bb05cb",
8439
+ "tax_rate_uuid": "123e4567-7f30-4406-a11b-23004d34489b",
8288
8440
  "sort_order": "string",
8289
8441
  "cost": "string",
8290
8442
  "displayed_cost": "string",
8291
- "job_material_bundle_uuid": "123e4567-bc0c-41fc-b463-22fd8743c70b"
8443
+ "job_material_bundle_uuid": "123e4567-8ca6-470f-ad90-23004f52a86b"
8292
8444
  }
8293
8445
  }
8294
8446
  }
@@ -8524,15 +8676,15 @@
8524
8676
  "success": {
8525
8677
  "value": [
8526
8678
  {
8527
- "uuid": "123e4567-797c-481f-8351-22fd839cc88b",
8679
+ "uuid": "123e4567-3681-4f57-b97c-23004a009b9b",
8528
8680
  "active": 1,
8529
8681
  "edit_date": "2025-07-01 12:00:00",
8530
8682
  "item_number": "string",
8531
8683
  "name": "string",
8532
8684
  "quantity": "string",
8533
8685
  "sort_order": "string",
8534
- "material_bundle_uuid": "123e4567-1948-4d94-9da8-22fd8326406b",
8535
- "job_uuid": "123e4567-bf88-4f9f-b9ae-22fd8ef9e2bb"
8686
+ "material_bundle_uuid": "123e4567-34e7-4b01-bcb8-230046d8521b",
8687
+ "job_uuid": "123e4567-656d-40c6-84ae-23004804bccb"
8536
8688
  }
8537
8689
  ]
8538
8690
  }
@@ -8695,15 +8847,15 @@
8695
8847
  "examples": {
8696
8848
  "success": {
8697
8849
  "value": {
8698
- "uuid": "123e4567-c7f3-458c-b37e-22fd8b68fb3b",
8850
+ "uuid": "123e4567-0c6b-4fa9-8d46-2300459cf92b",
8699
8851
  "active": 1,
8700
8852
  "edit_date": "2025-07-01 12:00:00",
8701
8853
  "item_number": "string",
8702
8854
  "name": "string",
8703
8855
  "quantity": "string",
8704
8856
  "sort_order": "string",
8705
- "material_bundle_uuid": "123e4567-c218-40a1-a566-22fd883e4d0b",
8706
- "job_uuid": "123e4567-b4bc-4287-9692-22fd857e31bb"
8857
+ "material_bundle_uuid": "123e4567-b3be-4d4d-acd8-230040765a8b",
8858
+ "job_uuid": "123e4567-97a0-40f4-9fa2-2300486c810b"
8707
8859
  }
8708
8860
  }
8709
8861
  }
@@ -8759,7 +8911,422 @@
8759
8911
  {
8760
8912
  "name": "uuid",
8761
8913
  "in": "path",
8762
- "description": "UUID of the Job Material Bundle",
8914
+ "description": "UUID of the Job Material Bundle",
8915
+ "required": true,
8916
+ "schema": {
8917
+ "type": "string",
8918
+ "format": "uuid"
8919
+ }
8920
+ }
8921
+ ],
8922
+ "requestBody": {
8923
+ "description": "Job Material Bundle fields to update",
8924
+ "required": true,
8925
+ "content": {
8926
+ "application/json": {
8927
+ "schema": {
8928
+ "$ref": "#/components/schemas/JobMaterialBundle"
8929
+ }
8930
+ }
8931
+ }
8932
+ },
8933
+ "responses": {
8934
+ "200": {
8935
+ "description": "Success",
8936
+ "content": {
8937
+ "application/json": {
8938
+ "schema": {
8939
+ "$ref": "#/components/schemas/Result"
8940
+ },
8941
+ "examples": {
8942
+ "success": {
8943
+ "value": {
8944
+ "errorCode": "0",
8945
+ "message": "OK"
8946
+ }
8947
+ }
8948
+ }
8949
+ }
8950
+ }
8951
+ },
8952
+ "400": {
8953
+ "description": "Bad Request",
8954
+ "content": {
8955
+ "application/json": {
8956
+ "schema": {
8957
+ "$ref": "#/components/schemas/Error"
8958
+ },
8959
+ "examples": {
8960
+ "badRequest": {
8961
+ "value": {
8962
+ "errorCode": "1000",
8963
+ "message": "An error occurred completing your request"
8964
+ }
8965
+ }
8966
+ }
8967
+ }
8968
+ }
8969
+ },
8970
+ "default": {
8971
+ "description": "Unexpected error",
8972
+ "content": {
8973
+ "application/json": {
8974
+ "schema": {
8975
+ "$ref": "#/components/schemas/Error"
8976
+ }
8977
+ }
8978
+ }
8979
+ }
8980
+ }
8981
+ },
8982
+ "delete": {
8983
+ "tags": [
8984
+ "Job Material Bundles"
8985
+ ],
8986
+ "operationId": "deleteJobMaterialBundles",
8987
+ "summary": "Delete a Job Material Bundle",
8988
+ "description": "\n\t\t\t\nIn ServiceM8, deleting a record sets its `active` field to `0`. Inactive records are still accessible on the API, but are hidden in the UI. Inactive records can be restored by setting their `active` field to `1`.\n\n\t\t\t",
8989
+ "security": [
8990
+ {
8991
+ "apiKey": []
8992
+ },
8993
+ {
8994
+ "oauth2": []
8995
+ }
8996
+ ],
8997
+ "parameters": [
8998
+ {
8999
+ "name": "uuid",
9000
+ "in": "path",
9001
+ "description": "UUID of the Job Material Bundle",
9002
+ "required": true,
9003
+ "schema": {
9004
+ "type": "string",
9005
+ "format": "uuid"
9006
+ }
9007
+ }
9008
+ ],
9009
+ "responses": {
9010
+ "200": {
9011
+ "description": "Job Material Bundle successfully archived",
9012
+ "content": {
9013
+ "application/json": {
9014
+ "schema": {
9015
+ "$ref": "#/components/schemas/Result"
9016
+ },
9017
+ "examples": {
9018
+ "success": {
9019
+ "value": {
9020
+ "errorCode": "0",
9021
+ "message": "OK"
9022
+ }
9023
+ }
9024
+ }
9025
+ }
9026
+ }
9027
+ },
9028
+ "400": {
9029
+ "description": "Bad Request",
9030
+ "content": {
9031
+ "application/json": {
9032
+ "schema": {
9033
+ "$ref": "#/components/schemas/Error"
9034
+ },
9035
+ "examples": {
9036
+ "success": {
9037
+ "value": {
9038
+ "errorCode": "1000",
9039
+ "message": "An error occurred completing your request"
9040
+ }
9041
+ }
9042
+ }
9043
+ }
9044
+ }
9045
+ },
9046
+ "default": {
9047
+ "description": "Unexpected error",
9048
+ "content": {
9049
+ "application/json": {
9050
+ "schema": {
9051
+ "$ref": "#/components/schemas/Error"
9052
+ }
9053
+ }
9054
+ }
9055
+ }
9056
+ }
9057
+ }
9058
+ },
9059
+ "/jobpayment.json": {
9060
+ "get": {
9061
+ "tags": [
9062
+ "Job Payments"
9063
+ ],
9064
+ "operationId": "listJobPayments",
9065
+ "summary": "List all Job Payments",
9066
+ "description": "\n\t\t\t\n#### Filtering\nThis endpoint supports result filtering. For more information on how to filter this request, [go here](/docs/filtering).\n\t\t\t",
9067
+ "security": [
9068
+ {
9069
+ "apiKey": []
9070
+ },
9071
+ {
9072
+ "oauth2": []
9073
+ }
9074
+ ],
9075
+ "responses": {
9076
+ "200": {
9077
+ "description": "An array of Job Payments",
9078
+ "content": {
9079
+ "application/json": {
9080
+ "schema": {
9081
+ "type": "array",
9082
+ "items": {
9083
+ "$ref": "#/components/schemas/JobPayment"
9084
+ }
9085
+ },
9086
+ "examples": {
9087
+ "success": {
9088
+ "value": [
9089
+ {
9090
+ "uuid": "123e4567-c1d4-4290-8fea-23004416865b",
9091
+ "active": 1,
9092
+ "edit_date": "2025-07-01 12:00:00",
9093
+ "job_uuid": "123e4567-80db-451b-a6fb-2300429c673b",
9094
+ "actioned_by_uuid": "123e4567-3115-40d4-ab11-2300400d50cb",
9095
+ "timestamp": "string",
9096
+ "amount": "string",
9097
+ "method": "string",
9098
+ "note": "string",
9099
+ "attachment_uuid": "123e4567-d62a-43ea-95cb-230042b0a13b",
9100
+ "is_deposit": "string"
9101
+ }
9102
+ ]
9103
+ }
9104
+ }
9105
+ }
9106
+ }
9107
+ },
9108
+ "400": {
9109
+ "description": "Bad Request",
9110
+ "content": {
9111
+ "application/json": {
9112
+ "schema": {
9113
+ "$ref": "#/components/schemas/Error"
9114
+ },
9115
+ "examples": {
9116
+ "badRequest": {
9117
+ "value": {
9118
+ "errorCode": "1000",
9119
+ "message": "An error occurred completing your request"
9120
+ }
9121
+ }
9122
+ }
9123
+ }
9124
+ }
9125
+ },
9126
+ "default": {
9127
+ "description": "Unexpected error",
9128
+ "content": {
9129
+ "application/json": {
9130
+ "schema": {
9131
+ "$ref": "#/components/schemas/Error"
9132
+ }
9133
+ }
9134
+ }
9135
+ }
9136
+ }
9137
+ },
9138
+ "post": {
9139
+ "tags": [
9140
+ "Job Payments"
9141
+ ],
9142
+ "operationId": "createJobPayments",
9143
+ "summary": "Create a new Job Payment",
9144
+ "description": "\n\t\t\t\n#### Record UUID\nUUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the `x-record-uuid` response header.\n\n\t\t\t",
9145
+ "security": [
9146
+ {
9147
+ "apiKey": []
9148
+ },
9149
+ {
9150
+ "oauth2": []
9151
+ }
9152
+ ],
9153
+ "parameters": [],
9154
+ "requestBody": {
9155
+ "description": "Job Payment record to create",
9156
+ "required": true,
9157
+ "content": {
9158
+ "application/json": {
9159
+ "schema": {
9160
+ "$ref": "#/components/schemas/JobPayment"
9161
+ }
9162
+ }
9163
+ }
9164
+ },
9165
+ "responses": {
9166
+ "200": {
9167
+ "headers": {
9168
+ "x-record-uuid": {
9169
+ "description": "UUID of newly created Job Payment record",
9170
+ "schema": {
9171
+ "type": "string",
9172
+ "format": "uuid"
9173
+ }
9174
+ }
9175
+ },
9176
+ "description": "Success",
9177
+ "content": {
9178
+ "application/json": {
9179
+ "schema": {
9180
+ "$ref": "#/components/schemas/Result"
9181
+ },
9182
+ "examples": {
9183
+ "success": {
9184
+ "value": {
9185
+ "errorCode": "0",
9186
+ "message": "OK"
9187
+ }
9188
+ }
9189
+ }
9190
+ }
9191
+ }
9192
+ },
9193
+ "400": {
9194
+ "description": "Bad Request",
9195
+ "content": {
9196
+ "application/json": {
9197
+ "schema": {
9198
+ "$ref": "#/components/schemas/Error"
9199
+ },
9200
+ "examples": {
9201
+ "badRequest": {
9202
+ "value": {
9203
+ "errorCode": "1000",
9204
+ "message": "An error occurred completing your request"
9205
+ }
9206
+ }
9207
+ }
9208
+ }
9209
+ }
9210
+ },
9211
+ "default": {
9212
+ "description": "Unexpected error",
9213
+ "content": {
9214
+ "application/json": {
9215
+ "schema": {
9216
+ "$ref": "#/components/schemas/Error"
9217
+ }
9218
+ }
9219
+ }
9220
+ }
9221
+ }
9222
+ }
9223
+ },
9224
+ "/jobpayment/{uuid}.json": {
9225
+ "get": {
9226
+ "tags": [
9227
+ "Job Payments"
9228
+ ],
9229
+ "operationId": "getJobPayments",
9230
+ "summary": "Retrieve a Job Payment",
9231
+ "description": "",
9232
+ "security": [
9233
+ {
9234
+ "apiKey": []
9235
+ },
9236
+ {
9237
+ "oauth2": []
9238
+ }
9239
+ ],
9240
+ "parameters": [
9241
+ {
9242
+ "name": "uuid",
9243
+ "in": "path",
9244
+ "description": "UUID of the Job Payment",
9245
+ "required": true,
9246
+ "schema": {
9247
+ "type": "string",
9248
+ "format": "uuid"
9249
+ }
9250
+ }
9251
+ ],
9252
+ "responses": {
9253
+ "200": {
9254
+ "description": "Job Payment record",
9255
+ "content": {
9256
+ "application/json": {
9257
+ "schema": {
9258
+ "$ref": "#/components/schemas/JobPayment"
9259
+ },
9260
+ "examples": {
9261
+ "success": {
9262
+ "value": {
9263
+ "uuid": "123e4567-50ce-4731-a28f-230040a554bb",
9264
+ "active": 1,
9265
+ "edit_date": "2025-07-01 12:00:00",
9266
+ "job_uuid": "123e4567-1d28-458e-9aff-23004f59e93b",
9267
+ "actioned_by_uuid": "123e4567-21fe-4e85-8334-23004c05314b",
9268
+ "timestamp": "string",
9269
+ "amount": "string",
9270
+ "method": "string",
9271
+ "note": "string",
9272
+ "attachment_uuid": "123e4567-b5c4-488e-9450-23004f94bacb",
9273
+ "is_deposit": "string"
9274
+ }
9275
+ }
9276
+ }
9277
+ }
9278
+ }
9279
+ },
9280
+ "400": {
9281
+ "description": "Bad Request",
9282
+ "content": {
9283
+ "application/json": {
9284
+ "schema": {
9285
+ "$ref": "#/components/schemas/Error"
9286
+ },
9287
+ "examples": {
9288
+ "badRequest": {
9289
+ "value": {
9290
+ "errorCode": "1000",
9291
+ "message": "An error occurred completing your request"
9292
+ }
9293
+ }
9294
+ }
9295
+ }
9296
+ }
9297
+ },
9298
+ "default": {
9299
+ "description": "Unexpected error",
9300
+ "content": {
9301
+ "application/json": {
9302
+ "schema": {
9303
+ "$ref": "#/components/schemas/Error"
9304
+ }
9305
+ }
9306
+ }
9307
+ }
9308
+ }
9309
+ },
9310
+ "post": {
9311
+ "tags": [
9312
+ "Job Payments"
9313
+ ],
9314
+ "operationId": "updateJobPayments",
9315
+ "summary": "Update a Job Payment",
9316
+ "description": "",
9317
+ "security": [
9318
+ {
9319
+ "apiKey": []
9320
+ },
9321
+ {
9322
+ "oauth2": []
9323
+ }
9324
+ ],
9325
+ "parameters": [
9326
+ {
9327
+ "name": "uuid",
9328
+ "in": "path",
9329
+ "description": "UUID of the Job Payment",
8763
9330
  "required": true,
8764
9331
  "schema": {
8765
9332
  "type": "string",
@@ -8768,12 +9335,12 @@
8768
9335
  }
8769
9336
  ],
8770
9337
  "requestBody": {
8771
- "description": "Job Material Bundle fields to update",
9338
+ "description": "Job Payment fields to update",
8772
9339
  "required": true,
8773
9340
  "content": {
8774
9341
  "application/json": {
8775
9342
  "schema": {
8776
- "$ref": "#/components/schemas/JobMaterialBundle"
9343
+ "$ref": "#/components/schemas/JobPayment"
8777
9344
  }
8778
9345
  }
8779
9346
  }
@@ -8829,10 +9396,10 @@
8829
9396
  },
8830
9397
  "delete": {
8831
9398
  "tags": [
8832
- "Job Material Bundles"
9399
+ "Job Payments"
8833
9400
  ],
8834
- "operationId": "deleteJobMaterialBundles",
8835
- "summary": "Delete a Job Material Bundle",
9401
+ "operationId": "deleteJobPayments",
9402
+ "summary": "Delete a Job Payment",
8836
9403
  "description": "\n\t\t\t\nIn ServiceM8, deleting a record sets its `active` field to `0`. Inactive records are still accessible on the API, but are hidden in the UI. Inactive records can be restored by setting their `active` field to `1`.\n\n\t\t\t",
8837
9404
  "security": [
8838
9405
  {
@@ -8846,7 +9413,7 @@
8846
9413
  {
8847
9414
  "name": "uuid",
8848
9415
  "in": "path",
8849
- "description": "UUID of the Job Material Bundle",
9416
+ "description": "UUID of the Job Payment",
8850
9417
  "required": true,
8851
9418
  "schema": {
8852
9419
  "type": "string",
@@ -8856,7 +9423,7 @@
8856
9423
  ],
8857
9424
  "responses": {
8858
9425
  "200": {
8859
- "description": "Job Material Bundle successfully archived",
9426
+ "description": "Job Payment successfully archived",
8860
9427
  "content": {
8861
9428
  "application/json": {
8862
9429
  "schema": {
@@ -8904,48 +9471,43 @@
8904
9471
  }
8905
9472
  }
8906
9473
  },
8907
- "/jobpayment.json": {
9474
+ "/jobtemplate.json": {
8908
9475
  "get": {
8909
9476
  "tags": [
8910
- "Job Payments"
9477
+ "Job Templates"
8911
9478
  ],
8912
- "operationId": "listJobPayments",
8913
- "summary": "List all Job Payments",
8914
- "description": "\n\t\t\t\n#### Filtering\nThis endpoint supports result filtering. For more information on how to filter this request, [go here](/docs/filtering).\n\t\t\t",
9479
+ "operationId": "listJobTemplates",
9480
+ "summary": "List all Job Templates",
9481
+ "description": "\n\t\t\t\n#### Filtering\nThis endpoint supports result filtering. For more information on how to filter this request, [go here](/docs/filtering).\n\t\t\t\n\t\t\t\n#### OAuth Scope\nThis endpoint requires the following OAuth scope **read_jobs**.\n\n\t\t\t",
8915
9482
  "security": [
8916
9483
  {
8917
9484
  "apiKey": []
8918
9485
  },
8919
9486
  {
8920
- "oauth2": []
9487
+ "oauth2": [
9488
+ "read_jobs"
9489
+ ]
8921
9490
  }
8922
9491
  ],
8923
9492
  "responses": {
8924
9493
  "200": {
8925
- "description": "An array of Job Payments",
9494
+ "description": "An array of Job Templates",
8926
9495
  "content": {
8927
9496
  "application/json": {
8928
9497
  "schema": {
8929
9498
  "type": "array",
8930
9499
  "items": {
8931
- "$ref": "#/components/schemas/JobPayment"
9500
+ "$ref": "#/components/schemas/JobTemplate"
8932
9501
  }
8933
9502
  },
8934
9503
  "examples": {
8935
9504
  "success": {
8936
9505
  "value": [
8937
9506
  {
8938
- "uuid": "123e4567-3736-4603-9dd7-22fd88e7061b",
9507
+ "uuid": "123e4567-5b7a-48b0-aa59-230041c0c4fb",
8939
9508
  "active": 1,
8940
9509
  "edit_date": "2025-07-01 12:00:00",
8941
- "job_uuid": "123e4567-dd86-4c44-82d1-22fd83909e0b",
8942
- "actioned_by_uuid": "123e4567-a035-48bb-a1c9-22fd8040b6bb",
8943
- "timestamp": "string",
8944
- "amount": "string",
8945
- "method": "string",
8946
- "note": "string",
8947
- "attachment_uuid": "123e4567-6daa-42b8-b1fb-22fd83cbbbeb",
8948
- "is_deposit": "string"
9510
+ "name": "string"
8949
9511
  }
8950
9512
  ]
8951
9513
  }
@@ -8985,27 +9547,29 @@
8985
9547
  },
8986
9548
  "post": {
8987
9549
  "tags": [
8988
- "Job Payments"
9550
+ "Job Templates"
8989
9551
  ],
8990
- "operationId": "createJobPayments",
8991
- "summary": "Create a new Job Payment",
8992
- "description": "\n\t\t\t\n#### Record UUID\nUUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the `x-record-uuid` response header.\n\n\t\t\t",
9552
+ "operationId": "createJobTemplates",
9553
+ "summary": "Create a new Job Template",
9554
+ "description": "\n\t\t\t\n#### OAuth Scope\nThis endpoint requires the following OAuth scope **manage_jobs**.\n\n\t\t\t\n\t\t\t\n#### Record UUID\nUUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the `x-record-uuid` response header.\n\n\t\t\t",
8993
9555
  "security": [
8994
9556
  {
8995
9557
  "apiKey": []
8996
9558
  },
8997
9559
  {
8998
- "oauth2": []
9560
+ "oauth2": [
9561
+ "manage_jobs"
9562
+ ]
8999
9563
  }
9000
9564
  ],
9001
9565
  "parameters": [],
9002
9566
  "requestBody": {
9003
- "description": "Job Payment record to create",
9567
+ "description": "Job Template record to create",
9004
9568
  "required": true,
9005
9569
  "content": {
9006
9570
  "application/json": {
9007
9571
  "schema": {
9008
- "$ref": "#/components/schemas/JobPayment"
9572
+ "$ref": "#/components/schemas/JobTemplate"
9009
9573
  }
9010
9574
  }
9011
9575
  }
@@ -9014,7 +9578,7 @@
9014
9578
  "200": {
9015
9579
  "headers": {
9016
9580
  "x-record-uuid": {
9017
- "description": "UUID of newly created Job Payment record",
9581
+ "description": "UUID of newly created Job Template record",
9018
9582
  "schema": {
9019
9583
  "type": "string",
9020
9584
  "format": "uuid"
@@ -9069,27 +9633,29 @@
9069
9633
  }
9070
9634
  }
9071
9635
  },
9072
- "/jobpayment/{uuid}.json": {
9636
+ "/jobtemplate/{uuid}.json": {
9073
9637
  "get": {
9074
9638
  "tags": [
9075
- "Job Payments"
9639
+ "Job Templates"
9076
9640
  ],
9077
- "operationId": "getJobPayments",
9078
- "summary": "Retrieve a Job Payment",
9079
- "description": "",
9641
+ "operationId": "getJobTemplates",
9642
+ "summary": "Retrieve a Job Template",
9643
+ "description": "\n\t\t\t\n#### OAuth Scope\nThis endpoint requires the following OAuth scope **read_jobs**.\n\n\t\t\t",
9080
9644
  "security": [
9081
9645
  {
9082
9646
  "apiKey": []
9083
9647
  },
9084
9648
  {
9085
- "oauth2": []
9649
+ "oauth2": [
9650
+ "read_jobs"
9651
+ ]
9086
9652
  }
9087
9653
  ],
9088
9654
  "parameters": [
9089
9655
  {
9090
9656
  "name": "uuid",
9091
9657
  "in": "path",
9092
- "description": "UUID of the Job Payment",
9658
+ "description": "UUID of the Job Template",
9093
9659
  "required": true,
9094
9660
  "schema": {
9095
9661
  "type": "string",
@@ -9099,26 +9665,19 @@
9099
9665
  ],
9100
9666
  "responses": {
9101
9667
  "200": {
9102
- "description": "Job Payment record",
9668
+ "description": "Job Template record",
9103
9669
  "content": {
9104
9670
  "application/json": {
9105
9671
  "schema": {
9106
- "$ref": "#/components/schemas/JobPayment"
9672
+ "$ref": "#/components/schemas/JobTemplate"
9107
9673
  },
9108
9674
  "examples": {
9109
9675
  "success": {
9110
9676
  "value": {
9111
- "uuid": "123e4567-82d2-4ad2-8313-22fd815360eb",
9677
+ "uuid": "123e4567-8232-4c42-94af-23004e1a156b",
9112
9678
  "active": 1,
9113
9679
  "edit_date": "2025-07-01 12:00:00",
9114
- "job_uuid": "123e4567-d4d4-4bc3-b2a6-22fd89d9ca4b",
9115
- "actioned_by_uuid": "123e4567-e404-41f1-ba23-22fd80ea139b",
9116
- "timestamp": "string",
9117
- "amount": "string",
9118
- "method": "string",
9119
- "note": "string",
9120
- "attachment_uuid": "123e4567-f42b-4089-b8f6-22fd877e114b",
9121
- "is_deposit": "string"
9680
+ "name": "string"
9122
9681
  }
9123
9682
  }
9124
9683
  }
@@ -9157,24 +9716,26 @@
9157
9716
  },
9158
9717
  "post": {
9159
9718
  "tags": [
9160
- "Job Payments"
9719
+ "Job Templates"
9161
9720
  ],
9162
- "operationId": "updateJobPayments",
9163
- "summary": "Update a Job Payment",
9164
- "description": "",
9721
+ "operationId": "updateJobTemplates",
9722
+ "summary": "Update a Job Template",
9723
+ "description": "\n\t\t\t\n#### OAuth Scope\nThis endpoint requires the following OAuth scope **manage_jobs**.\n\n\t\t\t",
9165
9724
  "security": [
9166
9725
  {
9167
9726
  "apiKey": []
9168
9727
  },
9169
9728
  {
9170
- "oauth2": []
9729
+ "oauth2": [
9730
+ "manage_jobs"
9731
+ ]
9171
9732
  }
9172
9733
  ],
9173
9734
  "parameters": [
9174
9735
  {
9175
9736
  "name": "uuid",
9176
9737
  "in": "path",
9177
- "description": "UUID of the Job Payment",
9738
+ "description": "UUID of the Job Template",
9178
9739
  "required": true,
9179
9740
  "schema": {
9180
9741
  "type": "string",
@@ -9183,12 +9744,12 @@
9183
9744
  }
9184
9745
  ],
9185
9746
  "requestBody": {
9186
- "description": "Job Payment fields to update",
9747
+ "description": "Job Template fields to update",
9187
9748
  "required": true,
9188
9749
  "content": {
9189
9750
  "application/json": {
9190
9751
  "schema": {
9191
- "$ref": "#/components/schemas/JobPayment"
9752
+ "$ref": "#/components/schemas/JobTemplate"
9192
9753
  }
9193
9754
  }
9194
9755
  }
@@ -9244,24 +9805,26 @@
9244
9805
  },
9245
9806
  "delete": {
9246
9807
  "tags": [
9247
- "Job Payments"
9808
+ "Job Templates"
9248
9809
  ],
9249
- "operationId": "deleteJobPayments",
9250
- "summary": "Delete a Job Payment",
9251
- "description": "\n\t\t\t\nIn ServiceM8, deleting a record sets its `active` field to `0`. Inactive records are still accessible on the API, but are hidden in the UI. Inactive records can be restored by setting their `active` field to `1`.\n\n\t\t\t",
9810
+ "operationId": "deleteJobTemplates",
9811
+ "summary": "Delete a Job Template",
9812
+ "description": "\n\t\t\t\nIn ServiceM8, deleting a record sets its `active` field to `0`. Inactive records are still accessible on the API, but are hidden in the UI. Inactive records can be restored by setting their `active` field to `1`.\n\n\t\t\t\n\t\t\t\n#### OAuth Scope\nThis endpoint requires the following OAuth scope **manage_jobs**.\n\n\t\t\t",
9252
9813
  "security": [
9253
9814
  {
9254
9815
  "apiKey": []
9255
9816
  },
9256
9817
  {
9257
- "oauth2": []
9818
+ "oauth2": [
9819
+ "manage_jobs"
9820
+ ]
9258
9821
  }
9259
9822
  ],
9260
9823
  "parameters": [
9261
9824
  {
9262
9825
  "name": "uuid",
9263
9826
  "in": "path",
9264
- "description": "UUID of the Job Payment",
9827
+ "description": "UUID of the Job Template",
9265
9828
  "required": true,
9266
9829
  "schema": {
9267
9830
  "type": "string",
@@ -9271,7 +9834,7 @@
9271
9834
  ],
9272
9835
  "responses": {
9273
9836
  "200": {
9274
- "description": "Job Payment successfully archived",
9837
+ "description": "Job Template successfully archived",
9275
9838
  "content": {
9276
9839
  "application/json": {
9277
9840
  "schema": {
@@ -9352,7 +9915,7 @@
9352
9915
  "success": {
9353
9916
  "value": [
9354
9917
  {
9355
- "uuid": "123e4567-8dec-4be8-a8fa-22fd812b808b",
9918
+ "uuid": "123e4567-f00d-40c4-bacb-23004e93670b",
9356
9919
  "active": 1,
9357
9920
  "edit_date": "2025-07-01 12:00:00",
9358
9921
  "name": "string",
@@ -9533,7 +10096,7 @@
9533
10096
  "examples": {
9534
10097
  "success": {
9535
10098
  "value": {
9536
- "uuid": "123e4567-0ca9-4c34-b670-22fd89f0d05b",
10099
+ "uuid": "123e4567-231b-4def-bd50-23004826c90b",
9537
10100
  "active": 1,
9538
10101
  "edit_date": "2025-07-01 12:00:00",
9539
10102
  "name": "string",
@@ -9796,7 +10359,7 @@
9796
10359
  "state": "string",
9797
10360
  "lng": "number",
9798
10361
  "lat": "number",
9799
- "uuid": "123e4567-3977-4e1c-9e82-22fd8df6a92b",
10362
+ "uuid": "123e4567-430c-44f3-8d6a-2300413fb74b",
9800
10363
  "active": 1,
9801
10364
  "edit_date": "2025-07-01 12:00:00"
9802
10365
  }
@@ -9976,7 +10539,7 @@
9976
10539
  "state": "string",
9977
10540
  "lng": "number",
9978
10541
  "lat": "number",
9979
- "uuid": "123e4567-2c1f-4ae9-ab4e-22fd8d05a55b",
10542
+ "uuid": "123e4567-f9e9-4dc4-9a1f-23004fa1a3eb",
9980
10543
  "active": 1,
9981
10544
  "edit_date": "2025-07-01 12:00:00"
9982
10545
  }
@@ -10224,12 +10787,12 @@
10224
10787
  "price_includes_taxes": "string",
10225
10788
  "barcode": "string",
10226
10789
  "item_is_inventoried": "string",
10227
- "uuid": "123e4567-0add-4a15-b39b-22fd87d8877b",
10790
+ "uuid": "123e4567-2eb1-4968-aadd-23004829d28b",
10228
10791
  "active": 1,
10229
10792
  "edit_date": "2025-07-01 12:00:00",
10230
10793
  "item_description": "string",
10231
10794
  "use_description_for_invoicing": "string",
10232
- "tax_rate_uuid": "123e4567-f70a-4798-b77e-22fd8611824b"
10795
+ "tax_rate_uuid": "123e4567-5241-4839-a9f0-23004d09ce2b"
10233
10796
  }
10234
10797
  ]
10235
10798
  }
@@ -10404,12 +10967,12 @@
10404
10967
  "price_includes_taxes": "string",
10405
10968
  "barcode": "string",
10406
10969
  "item_is_inventoried": "string",
10407
- "uuid": "123e4567-fc44-4c3c-bbe3-22fd8d31e99b",
10970
+ "uuid": "123e4567-a2b4-486b-bad2-230049c6a30b",
10408
10971
  "active": 1,
10409
10972
  "edit_date": "2025-07-01 12:00:00",
10410
10973
  "item_description": "string",
10411
10974
  "use_description_for_invoicing": "string",
10412
- "tax_rate_uuid": "123e4567-e9bf-4b70-9dd2-22fd8d9cc22b"
10975
+ "tax_rate_uuid": "123e4567-33fe-407e-92d9-230049492a0b"
10413
10976
  }
10414
10977
  }
10415
10978
  }
@@ -10645,7 +11208,7 @@
10645
11208
  "success": {
10646
11209
  "value": [
10647
11210
  {
10648
- "uuid": "123e4567-bc8a-42ea-b7be-22fd895a599b",
11211
+ "uuid": "123e4567-bde3-43bb-b94d-23004805d3db",
10649
11212
  "active": 1,
10650
11213
  "edit_date": "2025-07-01 12:00:00",
10651
11214
  "item_number": "string",
@@ -10818,7 +11381,7 @@
10818
11381
  "examples": {
10819
11382
  "success": {
10820
11383
  "value": {
10821
- "uuid": "123e4567-21de-48ef-b6d9-22fd8359d81b",
11384
+ "uuid": "123e4567-577c-4266-9422-230047f0b98b",
10822
11385
  "active": 1,
10823
11386
  "edit_date": "2025-07-01 12:00:00",
10824
11387
  "item_number": "string",
@@ -11060,15 +11623,15 @@
11060
11623
  "success": {
11061
11624
  "value": [
11062
11625
  {
11063
- "uuid": "123e4567-86cf-4b0d-ae12-22fd8a20944b",
11626
+ "uuid": "123e4567-cca1-47d7-8c14-23004034429b",
11064
11627
  "active": 1,
11065
11628
  "edit_date": "2025-07-01 12:00:00",
11066
11629
  "related_object": "string",
11067
- "related_object_uuid": "123e4567-7786-49fb-9de0-22fd8a5152eb",
11630
+ "related_object_uuid": "123e4567-d47e-4bbc-85d6-23004c8cfdcb",
11068
11631
  "note": "string",
11069
11632
  "action_required": "string",
11070
- "action_completed_by_staff_uuid": "123e4567-ae01-4895-bd06-22fd8d2dd23b",
11071
- "edit_by_staff_uuid": "123e4567-253e-4348-a8c5-22fd80da95fb",
11633
+ "action_completed_by_staff_uuid": "123e4567-65ba-4d3d-bedd-230040e28b9b",
11634
+ "edit_by_staff_uuid": "123e4567-d659-4125-a70a-230047868fcb",
11072
11635
  "create_date": "2025-07-01 12:00:00"
11073
11636
  }
11074
11637
  ]
@@ -11232,15 +11795,15 @@
11232
11795
  "examples": {
11233
11796
  "success": {
11234
11797
  "value": {
11235
- "uuid": "123e4567-178a-4315-bb22-22fd8596521b",
11798
+ "uuid": "123e4567-b31c-46f4-a0ab-230040ee11cb",
11236
11799
  "active": 1,
11237
11800
  "edit_date": "2025-07-01 12:00:00",
11238
11801
  "related_object": "string",
11239
- "related_object_uuid": "123e4567-d9bf-4c8b-89e0-22fd8e52c65b",
11802
+ "related_object_uuid": "123e4567-36f3-4cc2-ab43-230043e22d9b",
11240
11803
  "note": "string",
11241
11804
  "action_required": "string",
11242
- "action_completed_by_staff_uuid": "123e4567-5193-4c8e-89a8-22fd8a5a3e4b",
11243
- "edit_by_staff_uuid": "123e4567-a352-418a-bbe1-22fd8260d3cb",
11805
+ "action_completed_by_staff_uuid": "123e4567-72e6-4849-9ebb-23004771114b",
11806
+ "edit_by_staff_uuid": "123e4567-4f0c-45d7-bddc-2300430c869b",
11244
11807
  "create_date": "2025-07-01 12:00:00"
11245
11808
  }
11246
11809
  }
@@ -11475,7 +12038,7 @@
11475
12038
  "success": {
11476
12039
  "value": [
11477
12040
  {
11478
- "uuid": "123e4567-ac3e-4054-8294-22fd85a32a2b",
12041
+ "uuid": "123e4567-4409-4c34-aa92-230042d72e7b",
11479
12042
  "active": 1,
11480
12043
  "edit_date": "2025-07-01 12:00:00",
11481
12044
  "name": "string",
@@ -11648,7 +12211,7 @@
11648
12211
  "examples": {
11649
12212
  "success": {
11650
12213
  "value": {
11651
- "uuid": "123e4567-c387-4e08-b19d-22fd80dc567b",
12214
+ "uuid": "123e4567-3603-4563-bac2-23004315691b",
11652
12215
  "active": 1,
11653
12216
  "edit_date": "2025-07-01 12:00:00",
11654
12217
  "name": "string",
@@ -11892,7 +12455,7 @@
11892
12455
  {
11893
12456
  "name": "string",
11894
12457
  "role_description": "string",
11895
- "uuid": "123e4567-6ee3-41f9-bc2b-22fd869ff04b",
12458
+ "uuid": "123e4567-fb03-4b4c-a6fa-230042e7584b",
11896
12459
  "active": 1,
11897
12460
  "edit_date": "2025-07-01 12:00:00"
11898
12461
  }
@@ -12059,7 +12622,7 @@
12059
12622
  "value": {
12060
12623
  "name": "string",
12061
12624
  "role_description": "string",
12062
- "uuid": "123e4567-25a2-4ded-95f2-22fd8454150b",
12625
+ "uuid": "123e4567-9030-43ac-901e-230047bb107b",
12063
12626
  "active": 1,
12064
12627
  "edit_date": "2025-07-01 12:00:00"
12065
12628
  }
@@ -12293,7 +12856,7 @@
12293
12856
  "success": {
12294
12857
  "value": [
12295
12858
  {
12296
- "uuid": "123e4567-659d-47f2-94fe-22fd89628d3b",
12859
+ "uuid": "123e4567-75b2-46d1-9215-23004f0fe03b",
12297
12860
  "active": 1,
12298
12861
  "edit_date": "2025-07-01 12:00:00",
12299
12862
  "name": "string",
@@ -12460,7 +13023,7 @@
12460
13023
  "examples": {
12461
13024
  "success": {
12462
13025
  "value": {
12463
- "uuid": "123e4567-9481-4d27-9689-22fd8031595b",
13026
+ "uuid": "123e4567-7277-4303-8278-230043dca62b",
12464
13027
  "active": 1,
12465
13028
  "edit_date": "2025-07-01 12:00:00",
12466
13029
  "name": "string",
@@ -12706,7 +13269,7 @@
12706
13269
  "lat": "number",
12707
13270
  "geo_timestamp": "2025-07-01 12:00:00",
12708
13271
  "job_title": "string",
12709
- "navigating_to_job_uuid": "123e4567-630d-41e1-b9ef-22fd82eab32b",
13272
+ "navigating_to_job_uuid": "123e4567-4813-4e68-951c-2300455fb37b",
12710
13273
  "navigating_timestamp": "2025-07-01 12:00:00",
12711
13274
  "navigating_expiry_timestamp": "2025-07-01 12:00:00",
12712
13275
  "color": "string",
@@ -12714,8 +13277,8 @@
12714
13277
  "status_message": "string",
12715
13278
  "status_message_timestamp": "2025-07-01 12:00:00",
12716
13279
  "hide_from_schedule": "string",
12717
- "security_role_uuid": "123e4567-95f4-4b8b-b20e-22fd87741d2b",
12718
- "uuid": "123e4567-74db-4bd0-b96c-22fd8d335feb",
13280
+ "security_role_uuid": "123e4567-20d6-433a-9797-230040d2120b",
13281
+ "uuid": "123e4567-f4a4-4d0a-83a2-23004c4e15fb",
12719
13282
  "active": 1,
12720
13283
  "edit_date": "2025-07-01 12:00:00",
12721
13284
  "can_receive_push_notification": "string"
@@ -12893,7 +13456,7 @@
12893
13456
  "lat": "number",
12894
13457
  "geo_timestamp": "2025-07-01 12:00:00",
12895
13458
  "job_title": "string",
12896
- "navigating_to_job_uuid": "123e4567-d786-43b4-8dd2-22fd874195db",
13459
+ "navigating_to_job_uuid": "123e4567-c79b-41cf-8ea9-230046c407ab",
12897
13460
  "navigating_timestamp": "2025-07-01 12:00:00",
12898
13461
  "navigating_expiry_timestamp": "2025-07-01 12:00:00",
12899
13462
  "color": "string",
@@ -12901,8 +13464,8 @@
12901
13464
  "status_message": "string",
12902
13465
  "status_message_timestamp": "2025-07-01 12:00:00",
12903
13466
  "hide_from_schedule": "string",
12904
- "security_role_uuid": "123e4567-25e0-4dca-b8dc-22fd818a8beb",
12905
- "uuid": "123e4567-3968-41e3-a624-22fd8219455b",
13467
+ "security_role_uuid": "123e4567-b648-482d-b0d9-2300457b682b",
13468
+ "uuid": "123e4567-77ab-4976-9977-23004f3dcc6b",
12906
13469
  "active": 1,
12907
13470
  "edit_date": "2025-07-01 12:00:00",
12908
13471
  "can_receive_push_notification": "string"
@@ -13141,16 +13704,16 @@
13141
13704
  "success": {
13142
13705
  "value": [
13143
13706
  {
13144
- "uuid": "123e4567-2b4a-458d-a26b-22fd8abf417b",
13707
+ "uuid": "123e4567-cf5c-4296-9822-230042d3e05b",
13145
13708
  "active": 1,
13146
13709
  "edit_date": "2025-07-01 12:00:00",
13147
- "from_staff_uuid": "123e4567-c205-436f-a1f4-22fd810b227b",
13148
- "to_staff_uuid": "123e4567-0c7d-4517-8785-22fd83465beb",
13710
+ "from_staff_uuid": "123e4567-ed16-4ca6-b3eb-23004dbd9a1b",
13711
+ "to_staff_uuid": "123e4567-a0d9-4499-86c0-230049f48cfb",
13149
13712
  "sent_timestamp": "2025-07-01 12:00:00",
13150
13713
  "delivered_timestamp": "2025-07-01 12:00:00",
13151
13714
  "read_timestamp": "2025-07-01 12:00:00",
13152
13715
  "message": "string",
13153
- "regarding_job_uuid": "123e4567-b81c-46fc-9bf6-22fd84b9f3fb",
13716
+ "regarding_job_uuid": "123e4567-6b95-43b6-86ac-230046e3d31b",
13154
13717
  "attached_json": "string"
13155
13718
  }
13156
13719
  ]
@@ -13314,16 +13877,16 @@
13314
13877
  "examples": {
13315
13878
  "success": {
13316
13879
  "value": {
13317
- "uuid": "123e4567-dd75-4b21-b927-22fd858dc39b",
13880
+ "uuid": "123e4567-5275-4b65-b217-23004dcf1e4b",
13318
13881
  "active": 1,
13319
13882
  "edit_date": "2025-07-01 12:00:00",
13320
- "from_staff_uuid": "123e4567-3282-48e5-ba33-22fd847d574b",
13321
- "to_staff_uuid": "123e4567-8843-41b8-a31f-22fd851a40ab",
13883
+ "from_staff_uuid": "123e4567-47f4-4dd0-b404-23004d911efb",
13884
+ "to_staff_uuid": "123e4567-7ea1-4780-99fd-2300498b02eb",
13322
13885
  "sent_timestamp": "2025-07-01 12:00:00",
13323
13886
  "delivered_timestamp": "2025-07-01 12:00:00",
13324
13887
  "read_timestamp": "2025-07-01 12:00:00",
13325
13888
  "message": "string",
13326
- "regarding_job_uuid": "123e4567-6675-4ea8-a7d7-22fd8389fffb",
13889
+ "regarding_job_uuid": "123e4567-86ca-4545-86f1-230048a80feb",
13327
13890
  "attached_json": "string"
13328
13891
  }
13329
13892
  }
@@ -13562,17 +14125,17 @@
13562
14125
  "task_details": "string",
13563
14126
  "name": "string",
13564
14127
  "related_object": "string",
13565
- "related_object_uuid": "123e4567-af00-407e-acd1-22fd8534b93b",
14128
+ "related_object_uuid": "123e4567-d0af-4e15-8c8e-23004231488b",
13566
14129
  "task_complete": "string",
13567
14130
  "completed_timestamp": "2025-07-01 12:00:00",
13568
- "completed_by_staff_uuid": "123e4567-aa74-45f7-87dd-22fd87972f9b",
13569
- "assigned_to_staff_uuid": "123e4567-59c3-4d64-8487-22fd820859eb",
14131
+ "completed_by_staff_uuid": "123e4567-835b-47a1-aed6-230047cd5dab",
14132
+ "assigned_to_staff_uuid": "123e4567-11cc-47f2-b1d7-23004804793b",
13570
14133
  "lng": "string",
13571
14134
  "lat": "string",
13572
- "uuid": "123e4567-2980-4366-9b27-22fd8805e41b",
14135
+ "uuid": "123e4567-2f22-491c-996c-23004b974a5b",
13573
14136
  "active": 1,
13574
14137
  "edit_date": "2025-07-01 12:00:00",
13575
- "created_by_staff_uuid": "123e4567-0bdb-4f38-a879-22fd8d04dd4b",
14138
+ "created_by_staff_uuid": "123e4567-4238-47e0-9a82-23004a92dd7b",
13576
14139
  "create_date": "2025-07-01 12:00:00"
13577
14140
  }
13578
14141
  ]
@@ -13744,17 +14307,17 @@
13744
14307
  "task_details": "string",
13745
14308
  "name": "string",
13746
14309
  "related_object": "string",
13747
- "related_object_uuid": "123e4567-d178-46c6-b5ee-22fd8ff5e77b",
14310
+ "related_object_uuid": "123e4567-a8c8-4014-97b2-23004877a5ab",
13748
14311
  "task_complete": "string",
13749
14312
  "completed_timestamp": "2025-07-01 12:00:00",
13750
- "completed_by_staff_uuid": "123e4567-b6b3-43ee-b687-22fd84d6db7b",
13751
- "assigned_to_staff_uuid": "123e4567-5532-476c-ad1a-22fd8573741b",
14313
+ "completed_by_staff_uuid": "123e4567-b1a0-4dee-aa61-230045ffdeeb",
14314
+ "assigned_to_staff_uuid": "123e4567-6ca8-4d9f-9bf0-23004b4e9feb",
13752
14315
  "lng": "string",
13753
14316
  "lat": "string",
13754
- "uuid": "123e4567-832a-4758-8647-22fd8b151cbb",
14317
+ "uuid": "123e4567-2588-4606-abc2-23004663296b",
13755
14318
  "active": 1,
13756
14319
  "edit_date": "2025-07-01 12:00:00",
13757
- "created_by_staff_uuid": "123e4567-301b-4730-9c0c-22fd8e38a58b",
14320
+ "created_by_staff_uuid": "123e4567-5c20-4e7d-a3cd-23004fb07e3b",
13758
14321
  "create_date": "2025-07-01 12:00:00"
13759
14322
  }
13760
14323
  }
@@ -13991,7 +14554,7 @@
13991
14554
  "success": {
13992
14555
  "value": [
13993
14556
  {
13994
- "uuid": "123e4567-49d8-4408-9fe4-22fd8941381b",
14557
+ "uuid": "123e4567-dbd7-45e4-af6b-230041280f6b",
13995
14558
  "active": 1,
13996
14559
  "edit_date": "2025-07-01 12:00:00",
13997
14560
  "name": "string",
@@ -14159,7 +14722,7 @@
14159
14722
  "examples": {
14160
14723
  "success": {
14161
14724
  "value": {
14162
- "uuid": "123e4567-f19d-47a1-82e4-22fd8a8fce8b",
14725
+ "uuid": "123e4567-5b85-4e45-92e6-23004e2d003b",
14163
14726
  "active": 1,
14164
14727
  "edit_date": "2025-07-01 12:00:00",
14165
14728
  "name": "string",
@@ -14398,7 +14961,7 @@
14398
14961
  "success": {
14399
14962
  "value": [
14400
14963
  {
14401
- "uuid": "123e4567-302b-421c-862f-22fd842c1acb",
14964
+ "uuid": "123e4567-1b42-4c2e-8410-230046a34e0b",
14402
14965
  "active": 1,
14403
14966
  "edit_date": "2025-07-01 12:00:00",
14404
14967
  "name": "string",
@@ -14507,7 +15070,7 @@
14507
15070
  "examples": {
14508
15071
  "success": {
14509
15072
  "value": {
14510
- "uuid": "123e4567-cc83-47e5-a7ac-22fd850ba79b",
15073
+ "uuid": "123e4567-892d-4a54-a2b9-230045a747db",
14511
15074
  "active": 1,
14512
15075
  "edit_date": "2025-07-01 12:00:00",
14513
15076
  "name": "string",
@@ -14635,173 +15198,21 @@
14635
15198
  "content": {
14636
15199
  "application/json": {
14637
15200
  "schema": {
14638
- "$ref": "#/components/schemas/Error"
14639
- },
14640
- "examples": {
14641
- "badRequest": {
14642
- "value": {
14643
- "errorCode": "1000",
14644
- "message": "An error occurred completing your request"
14645
- }
14646
- }
14647
- }
14648
- }
14649
- }
14650
- },
14651
- "default": {
14652
- "description": "Unexpected error",
14653
- "content": {
14654
- "application/json": {
14655
- "schema": {
14656
- "$ref": "#/components/schemas/Error"
14657
- }
14658
- }
14659
- }
14660
- }
14661
- }
14662
- }
14663
- },
14664
- "/inboxmessage.json": {
14665
- "get": {
14666
- "tags": [
14667
- "Inbox"
14668
- ],
14669
- "operationId": "listInboxMessages",
14670
- "summary": "List inbox messages",
14671
- "description": "Retrieves a paginated list of inbox messages with optional filtering",
14672
- "security": [
14673
- {
14674
- "apiKey": []
14675
- },
14676
- {
14677
- "oauth2": [
14678
- "read_inbox"
14679
- ]
14680
- }
14681
- ],
14682
- "parameters": [
14683
- {
14684
- "name": "limit",
14685
- "in": "query",
14686
- "description": "Maximum number of messages to return (1-500)",
14687
- "schema": {
14688
- "type": "integer",
14689
- "minimum": 1,
14690
- "maximum": 500,
14691
- "default": 50
14692
- }
14693
- },
14694
- {
14695
- "name": "offset",
14696
- "in": "query",
14697
- "description": "Number of messages to skip for pagination",
14698
- "schema": {
14699
- "type": "integer",
14700
- "minimum": 0,
14701
- "default": 0
14702
- }
14703
- },
14704
- {
14705
- "name": "filter",
14706
- "in": "query",
14707
- "description": "Filter messages by status",
14708
- "schema": {
14709
- "type": "string",
14710
- "enum": [
14711
- "all",
14712
- "unread",
14713
- "archived",
14714
- "snoozed"
14715
- ],
14716
- "default": "all"
14717
- }
14718
- },
14719
- {
14720
- "name": "search",
14721
- "in": "query",
14722
- "description": "Search messages by subject, from name, or from email",
14723
- "schema": {
14724
- "type": "string"
14725
- }
14726
- }
14727
- ],
14728
- "responses": {
14729
- "200": {
14730
- "description": "Successful response",
14731
- "content": {
14732
- "application/json": {
14733
- "schema": {
14734
- "$ref": "#/components/schemas/InboxMessagesResponse"
14735
- }
14736
- }
14737
- }
14738
- },
14739
- "403": {
14740
- "description": "Forbidden - Missing permission or OAuth scope",
14741
- "content": {
14742
- "application/json": {
14743
- "schema": {
14744
- "$ref": "#/components/schemas/Error"
14745
- }
14746
- }
14747
- }
14748
- },
14749
- "400": {
14750
- "description": "Service Unavailable - Inbox not enabled",
14751
- "content": {
14752
- "application/json": {
14753
- "schema": {
14754
- "$ref": "#/components/schemas/Error"
14755
- }
14756
- }
14757
- }
14758
- }
14759
- }
14760
- }
14761
- },
14762
- "/inboxmessage/{uuid}.json": {
14763
- "get": {
14764
- "tags": [
14765
- "Inbox"
14766
- ],
14767
- "operationId": "getInboxMessage",
14768
- "summary": "Get inbox message details",
14769
- "description": "Retrieves detailed information about a specific inbox message including attachments and conversation history",
14770
- "security": [
14771
- {
14772
- "apiKey": []
14773
- },
14774
- {
14775
- "oauth2": [
14776
- "read_inbox"
14777
- ]
14778
- }
14779
- ],
14780
- "parameters": [
14781
- {
14782
- "name": "uuid",
14783
- "in": "path",
14784
- "required": true,
14785
- "description": "UUID of the inbox message",
14786
- "schema": {
14787
- "type": "string",
14788
- "format": "uuid"
14789
- }
14790
- }
14791
- ],
14792
- "responses": {
14793
- "200": {
14794
- "description": "Successful response",
14795
- "content": {
14796
- "application/json": {
14797
- "schema": {
14798
- "$ref": "#/components/schemas/InboxMessageDetail"
15201
+ "$ref": "#/components/schemas/Error"
15202
+ },
15203
+ "examples": {
15204
+ "badRequest": {
15205
+ "value": {
15206
+ "errorCode": "1000",
15207
+ "message": "An error occurred completing your request"
15208
+ }
15209
+ }
14799
15210
  }
14800
15211
  }
14801
15212
  }
14802
15213
  },
14803
- "404": {
14804
- "description": "Message not found",
15214
+ "default": {
15215
+ "description": "Unexpected error",
14805
15216
  "content": {
14806
15217
  "application/json": {
14807
15218
  "schema": {
@@ -15173,7 +15584,7 @@
15173
15584
  ],
15174
15585
  "operationId": "createJobFromTemplate",
15175
15586
  "summary": "Create a job from a template",
15176
- "description": "Creates a new job by cloning an existing job template. All template entities (tasks, materials, checklists, quotes, custom fields) are cloned to the new job.\n\n#### Field Overrides\nOnly the following fields can be overridden when creating a job from a template:\n- `job_description` - Job description\n- `company_uuid` - UUID of the company/client\n- `job_address` - Street address for the job\n\nAny other fields in the request body will be ignored.\n\n#### OAuth Scope\nThis endpoint requires the following OAuth scope **manage_jobs**.",
15587
+ "description": "Creates a new job by cloning an existing job template. All template entities (tasks, materials, checklists, quotes, custom fields) are cloned to the new job.\n\n#### Field Overrides\nOnly the following fields can be overridden when creating a job from a template:\n- `job_description` - Job description\n- `company_uuid` - UUID of the company/client\n- `company_name` - Name of the company/client (will lookup existing or create new)\n- `job_address` - Street address for the job\n\n**Note:** You cannot specify both `company_uuid` and `company_name`. If `company_name` is provided, the system will first search for an existing company with that name. If found, it will use that company's UUID. If not found, a new company will be created.\n\nAny other fields in the request body will be ignored.\n\n#### OAuth Scope\nThis endpoint requires the following OAuth scope **manage_jobs**.",
15177
15588
  "security": [
15178
15589
  {
15179
15590
  "apiKey": []
@@ -15212,8 +15623,15 @@
15212
15623
  "company_uuid": "550e8400-e29b-41d4-a716-446655440001"
15213
15624
  }
15214
15625
  },
15626
+ "companyName": {
15627
+ "summary": "Using company name",
15628
+ "value": {
15629
+ "company_name": "ACME Corporation",
15630
+ "job_address": "456 Oak Avenue"
15631
+ }
15632
+ },
15215
15633
  "full": {
15216
- "summary": "All allowed overrides",
15634
+ "summary": "All allowed overrides with UUID",
15217
15635
  "value": {
15218
15636
  "job_description": "Annual HVAC maintenance",
15219
15637
  "company_uuid": "550e8400-e29b-41d4-a716-446655440001",
@@ -15286,6 +15704,13 @@
15286
15704
  "errorCode": 400,
15287
15705
  "message": "Invalid JSON in request body"
15288
15706
  }
15707
+ },
15708
+ "bothCompanyFields": {
15709
+ "summary": "Both company_uuid and company_name provided",
15710
+ "value": {
15711
+ "errorCode": 400,
15712
+ "message": "Cannot specify both company_uuid and company_name. Please provide only one."
15713
+ }
15289
15714
  }
15290
15715
  }
15291
15716
  }
@@ -15774,7 +16199,7 @@
15774
16199
  "uuid": {
15775
16200
  "format": "uuid",
15776
16201
  "description": "Unique identifier for this record",
15777
- "example": "123e4567-5899-4b7f-9274-22fd8d10965b",
16202
+ "example": "123e4567-caf6-444f-94cb-23004f3b089b",
15778
16203
  "type": "string"
15779
16204
  },
15780
16205
  "active": {
@@ -15811,7 +16236,7 @@
15811
16236
  "uuid": {
15812
16237
  "format": "uuid",
15813
16238
  "description": "Unique identifier for this record",
15814
- "example": "123e4567-22fe-44e4-8b3d-22fd892a941b",
16239
+ "example": "123e4567-8c87-43c8-9465-23004d21b3ab",
15815
16240
  "type": "string"
15816
16241
  },
15817
16242
  "active": {
@@ -15830,7 +16255,7 @@
15830
16255
  },
15831
16256
  "company_uuid": {
15832
16257
  "format": "uuid",
15833
- "example": "123e4567-0dc2-46fc-9a56-22fd80999a8b",
16258
+ "example": "123e4567-e416-49c6-86e9-230044b6e00b",
15834
16259
  "type": "string",
15835
16260
  "description": "UUID of the Client to which this Asset is attached"
15836
16261
  },
@@ -15840,7 +16265,7 @@
15840
16265
  },
15841
16266
  "asset_type_uuid": {
15842
16267
  "format": "uuid",
15843
- "example": "123e4567-f6ce-4e58-94de-22fd8c66f08b",
16268
+ "example": "123e4567-6385-4b8b-b29d-2300435ce1ab",
15844
16269
  "type": "string",
15845
16270
  "description": "UUID of an Asset Type which defines the fields that can be stored for this Asset (read only)"
15846
16271
  },
@@ -15910,7 +16335,7 @@
15910
16335
  "uuid": {
15911
16336
  "format": "uuid",
15912
16337
  "description": "Unique identifier for this record",
15913
- "example": "123e4567-2207-4183-bbe3-22fd8725fd6b",
16338
+ "example": "123e4567-b314-4a53-bbc8-23004e5bb40b",
15914
16339
  "type": "string"
15915
16340
  },
15916
16341
  "active": {
@@ -15939,7 +16364,7 @@
15939
16364
  "uuid": {
15940
16365
  "format": "uuid",
15941
16366
  "description": "Unique identifier for this record",
15942
- "example": "123e4567-7d7a-47c7-914b-22fd839db70b",
16367
+ "example": "123e4567-c311-4348-85c8-230049eb726b",
15943
16368
  "type": "string"
15944
16369
  },
15945
16370
  "active": {
@@ -15958,7 +16383,7 @@
15958
16383
  },
15959
16384
  "asset_type_uuid": {
15960
16385
  "format": "uuid",
15961
- "example": "123e4567-e073-429c-a2da-22fd8220480b",
16386
+ "example": "123e4567-a7a6-4882-b3b3-23004538790b",
15962
16387
  "type": "string",
15963
16388
  "description": "UUID of the Asset Type to which this field belongs. This field is read-only in the API. (Read only)"
15964
16389
  },
@@ -16009,7 +16434,7 @@
16009
16434
  "uuid": {
16010
16435
  "format": "uuid",
16011
16436
  "description": "Unique identifier for this record",
16012
- "example": "123e4567-e173-4475-b566-22fd82d91c9b",
16437
+ "example": "123e4567-3e61-44f8-92b7-23004bd3f19b",
16013
16438
  "type": "string"
16014
16439
  },
16015
16440
  "active": {
@@ -16031,7 +16456,7 @@
16031
16456
  },
16032
16457
  "related_object_uuid": {
16033
16458
  "format": "uuid",
16034
- "example": "123e4567-6c07-45f7-8f40-22fd8cde8b0b",
16459
+ "example": "123e4567-f189-4d26-b242-23004386c6fb",
16035
16460
  "type": "string"
16036
16461
  },
16037
16462
  "attachment_name": {
@@ -16046,7 +16471,7 @@
16046
16471
  },
16047
16472
  "created_by_staff_uuid": {
16048
16473
  "format": "uuid",
16049
- "example": "123e4567-3ec8-4a6b-bc54-22fd81e8fefb",
16474
+ "example": "123e4567-e2bc-4ac1-9f22-23004de3d8fb",
16050
16475
  "type": "string"
16051
16476
  },
16052
16477
  "timestamp": {
@@ -16092,7 +16517,7 @@
16092
16517
  "uuid": {
16093
16518
  "format": "uuid",
16094
16519
  "description": "Unique identifier for this record",
16095
- "example": "123e4567-2f00-44a1-a84f-22fd8169ed2b",
16520
+ "example": "123e4567-33ac-4f7d-95a1-23004300d40b",
16096
16521
  "type": "string"
16097
16522
  },
16098
16523
  "active": {
@@ -16122,12 +16547,12 @@
16122
16547
  },
16123
16548
  "regarding_form_uuid": {
16124
16549
  "format": "uuid",
16125
- "example": "123e4567-a935-44a6-904d-22fd8a5f0afb",
16550
+ "example": "123e4567-3128-429d-bf39-23004bb49e0b",
16126
16551
  "type": "string"
16127
16552
  },
16128
16553
  "regarding_asset_type_uuid": {
16129
16554
  "format": "uuid",
16130
- "example": "123e4567-ae26-4408-aed5-22fd829a00cb",
16555
+ "example": "123e4567-b420-4f99-97c7-23004e84afab",
16131
16556
  "type": "string",
16132
16557
  "description": "UUID of the asset type that this badge is associated with. Only applicable for asset-based badges. When set, the badge represents a specific asset type in the system and will appear on assets of this type."
16133
16558
  }
@@ -16150,7 +16575,7 @@
16150
16575
  "uuid": {
16151
16576
  "format": "uuid",
16152
16577
  "description": "Unique identifier for this record",
16153
- "example": "123e4567-30c6-49d9-a6e6-22fd85821e3b",
16578
+ "example": "123e4567-502e-4e7d-9584-2300407286fb",
16154
16579
  "type": "string"
16155
16580
  },
16156
16581
  "active": {
@@ -16200,7 +16625,7 @@
16200
16625
  "uuid": {
16201
16626
  "format": "uuid",
16202
16627
  "description": "Unique identifier for this record",
16203
- "example": "123e4567-0792-4abc-a9a0-22fd8bd5e04b",
16628
+ "example": "123e4567-866e-4015-a7f9-230043f6602b",
16204
16629
  "type": "string"
16205
16630
  },
16206
16631
  "active": {
@@ -16247,7 +16672,7 @@
16247
16672
  },
16248
16673
  "tax_rate_uuid": {
16249
16674
  "format": "uuid",
16250
- "example": "123e4567-d02c-4d30-823f-22fd8497f6cb",
16675
+ "example": "123e4567-d986-4c46-83d1-23004431149b",
16251
16676
  "type": "string"
16252
16677
  },
16253
16678
  "billing_attention": {
@@ -16267,7 +16692,7 @@
16267
16692
  "uuid": {
16268
16693
  "format": "uuid",
16269
16694
  "description": "Unique identifier for this record",
16270
- "example": "123e4567-c6eb-4b10-9f15-22fd88ec684b",
16695
+ "example": "123e4567-155e-482d-95b4-23004417bfdb",
16271
16696
  "type": "string"
16272
16697
  },
16273
16698
  "active": {
@@ -16286,7 +16711,7 @@
16286
16711
  },
16287
16712
  "company_uuid": {
16288
16713
  "format": "uuid",
16289
- "example": "123e4567-5878-45ea-bd2b-22fd882ceb2b",
16714
+ "example": "123e4567-2f08-4bd1-90b4-23004742a8cb",
16290
16715
  "type": "string"
16291
16716
  },
16292
16717
  "first": {
@@ -16319,7 +16744,7 @@
16319
16744
  "uuid": {
16320
16745
  "format": "uuid",
16321
16746
  "description": "Unique identifier for this record",
16322
- "example": "123e4567-c5dc-443a-8e61-22fd8c6c20cb",
16747
+ "example": "123e4567-2b12-4be7-b163-23004e2798db",
16323
16748
  "type": "string"
16324
16749
  },
16325
16750
  "active": {
@@ -16359,7 +16784,7 @@
16359
16784
  "uuid": {
16360
16785
  "format": "uuid",
16361
16786
  "description": "Unique identifier for this record",
16362
- "example": "123e4567-711a-4b5e-b117-22fd89dbcf6b",
16787
+ "example": "123e4567-d3fd-4d5b-9714-230046ea888b",
16363
16788
  "type": "string"
16364
16789
  },
16365
16790
  "active": {
@@ -16384,7 +16809,7 @@
16384
16809
  },
16385
16810
  "related_object_uuid": {
16386
16811
  "format": "uuid",
16387
- "example": "123e4567-41d1-41f5-958a-22fd8694994b",
16812
+ "example": "123e4567-8894-46e1-965d-230042db9a4b",
16388
16813
  "type": "string"
16389
16814
  },
16390
16815
  "rating": {
@@ -16405,7 +16830,7 @@
16405
16830
  "document_template_uuid": {
16406
16831
  "description": "UUID of the document template associated with this form. The template defines the layout and appearance of the form when it's generated as a document. References a document template object in the system.",
16407
16832
  "format": "uuid",
16408
- "example": "123e4567-b69d-4cbd-bcab-22fd83c64ccb",
16833
+ "example": "123e4567-5d2c-403b-8be4-23004681edfb",
16409
16834
  "type": "string"
16410
16835
  },
16411
16836
  "can_be_used_independently": {
@@ -16451,7 +16876,7 @@
16451
16876
  "uuid": {
16452
16877
  "format": "uuid",
16453
16878
  "description": "Unique identifier for this record",
16454
- "example": "123e4567-75e7-422d-9c67-22fd88d3f01b",
16879
+ "example": "123e4567-dda2-47c2-8bd9-23004bf126db",
16455
16880
  "type": "string"
16456
16881
  },
16457
16882
  "active": {
@@ -16476,7 +16901,7 @@
16476
16901
  "uuid": {
16477
16902
  "format": "uuid",
16478
16903
  "description": "Unique identifier for this record",
16479
- "example": "123e4567-c402-4a91-b9fa-22fd8f76f64b",
16904
+ "example": "123e4567-58dd-453d-9089-23004e9751cb",
16480
16905
  "type": "string"
16481
16906
  },
16482
16907
  "active": {
@@ -16495,7 +16920,7 @@
16495
16920
  },
16496
16921
  "form_uuid": {
16497
16922
  "format": "uuid",
16498
- "example": "123e4567-9a02-427b-93b3-22fd8f77b24b",
16923
+ "example": "123e4567-8cab-4f24-96dd-230042cd67fb",
16499
16924
  "type": "string"
16500
16925
  },
16501
16926
  "name": {
@@ -16515,7 +16940,7 @@
16515
16940
  "uuid": {
16516
16941
  "format": "uuid",
16517
16942
  "description": "Unique identifier for this record",
16518
- "example": "123e4567-77fe-4689-ae8e-22fd807ca85b",
16943
+ "example": "123e4567-e83a-41c7-aebb-230042c1c67b",
16519
16944
  "type": "string"
16520
16945
  },
16521
16946
  "active": {
@@ -16534,12 +16959,12 @@
16534
16959
  },
16535
16960
  "form_uuid": {
16536
16961
  "format": "uuid",
16537
- "example": "123e4567-6af1-49fd-91ea-22fd84644d6b",
16962
+ "example": "123e4567-1cb2-4cc0-9e6b-2300435cd50b",
16538
16963
  "type": "string"
16539
16964
  },
16540
16965
  "staff_uuid": {
16541
16966
  "format": "uuid",
16542
- "example": "123e4567-62d5-4a3b-aa55-22fd81f148eb",
16967
+ "example": "123e4567-de90-4531-8ac0-23004a4c6ecb",
16543
16968
  "type": "string"
16544
16969
  },
16545
16970
  "regarding_object": {
@@ -16547,7 +16972,7 @@
16547
16972
  },
16548
16973
  "regarding_object_uuid": {
16549
16974
  "format": "uuid",
16550
- "example": "123e4567-0a81-47a5-89da-22fd812769db",
16975
+ "example": "123e4567-34e6-4984-b1ea-23004791b4ab",
16551
16976
  "type": "string"
16552
16977
  },
16553
16978
  "field_data": {
@@ -16559,18 +16984,120 @@
16559
16984
  },
16560
16985
  "form_by_staff_uuid": {
16561
16986
  "format": "uuid",
16562
- "example": "123e4567-ac3e-4a2d-8e0e-22fd8c08ab9b",
16987
+ "example": "123e4567-f244-4140-9e72-230048c9c2bb",
16563
16988
  "type": "string"
16564
16989
  },
16565
16990
  "document_attachment_uuid": {
16566
16991
  "format": "uuid",
16567
- "example": "123e4567-8a3e-4ad2-82ff-22fd8626814b",
16992
+ "example": "123e4567-9c5b-438f-9301-23004e9ef27b",
16568
16993
  "type": "string"
16569
16994
  },
16570
16995
  "asset_uuid": {
16571
16996
  "format": "uuid",
16572
- "example": "123e4567-0877-437a-8186-22fd82ea81db",
16997
+ "example": "123e4567-8403-4494-84b3-230046a20a1b",
16998
+ "type": "string"
16999
+ }
17000
+ }
17001
+ },
17002
+ "InboxMessage": {
17003
+ "type": "object",
17004
+ "properties": {
17005
+ "uuid": {
17006
+ "type": "string",
17007
+ "format": "uuid"
17008
+ },
17009
+ "active": {
17010
+ "type": "boolean"
17011
+ },
17012
+ "edit_date": {
17013
+ "type": "string",
17014
+ "format": "date-time"
17015
+ },
17016
+ "timestamp": {
17017
+ "type": "string",
17018
+ "format": "date-time"
17019
+ },
17020
+ "read_timestamp": {
17021
+ "type": "string",
17022
+ "format": "date-time",
17023
+ "nullable": true
17024
+ },
17025
+ "last_reply_timestamp": {
17026
+ "type": "string",
17027
+ "format": "date-time",
17028
+ "nullable": true
17029
+ },
17030
+ "snooze_until_timestamp": {
17031
+ "type": "string",
17032
+ "format": "date-time",
17033
+ "nullable": true
17034
+ },
17035
+ "read_by_staff_uuid": {
17036
+ "type": "string",
17037
+ "format": "uuid",
17038
+ "nullable": true
17039
+ },
17040
+ "from_name": {
17041
+ "type": "string"
17042
+ },
17043
+ "from_email": {
17044
+ "type": "string"
17045
+ },
17046
+ "to_email": {
17047
+ "type": "string"
17048
+ },
17049
+ "subject": {
16573
17050
  "type": "string"
17051
+ },
17052
+ "message_text": {
17053
+ "type": "string"
17054
+ },
17055
+ "message_html": {
17056
+ "type": "string"
17057
+ },
17058
+ "is_archived": {
17059
+ "type": "boolean"
17060
+ },
17061
+ "archived_timestamp": {
17062
+ "type": "string",
17063
+ "format": "date-time",
17064
+ "nullable": true
17065
+ },
17066
+ "archived_by_staff_uuid": {
17067
+ "type": "string",
17068
+ "format": "uuid",
17069
+ "nullable": true
17070
+ },
17071
+ "regarding_company_uuid": {
17072
+ "type": "string",
17073
+ "format": "uuid",
17074
+ "nullable": true
17075
+ },
17076
+ "converted_to_job_uuid": {
17077
+ "type": "string",
17078
+ "format": "uuid",
17079
+ "nullable": true
17080
+ },
17081
+ "job_template_uuid": {
17082
+ "type": "string",
17083
+ "format": "uuid",
17084
+ "nullable": true
17085
+ },
17086
+ "message_type": {
17087
+ "type": "string",
17088
+ "enum": [
17089
+ "email",
17090
+ "sms",
17091
+ "online_booking",
17092
+ "phone_call",
17093
+ "reminder",
17094
+ "form",
17095
+ "network_request",
17096
+ "supplier_invoice",
17097
+ "asset",
17098
+ "partner_lead",
17099
+ "automation"
17100
+ ]
16574
17101
  }
16575
17102
  }
16576
17103
  },
@@ -16580,7 +17107,7 @@
16580
17107
  "created_by_staff_uuid": {
16581
17108
  "description": "UUID of the staff member who created this job. Records which staff member initially added the job to the system.",
16582
17109
  "format": "uuid",
16583
- "example": "123e4567-17ed-499e-b5cc-22fd8922cb5b",
17110
+ "example": "123e4567-c477-47af-9f24-230049e925db",
16584
17111
  "type": "string"
16585
17112
  },
16586
17113
  "date": {
@@ -16591,7 +17118,7 @@
16591
17118
  "company_uuid": {
16592
17119
  "description": "UUID reference to the client/company record associated with this job. Links the job to a client in the system, establishing the client-job relationship for billing and contact purposes.",
16593
17120
  "format": "uuid",
16594
- "example": "123e4567-9737-4bff-bead-22fd8f6ea44b",
17121
+ "example": "123e4567-ff75-4f7d-86cf-23004d314dcb",
16595
17122
  "type": "string"
16596
17123
  },
16597
17124
  "billing_address": {
@@ -16628,7 +17155,7 @@
16628
17155
  "payment_actioned_by_uuid": {
16629
17156
  "description": "Not used. Refer to JobPayment endpoint.",
16630
17157
  "format": "uuid",
16631
- "example": "123e4567-5ce8-4ed9-8d01-22fd8715648b",
17158
+ "example": "123e4567-6a3f-4ab6-b5b1-230042f3345b",
16632
17159
  "type": "string"
16633
17160
  },
16634
17161
  "payment_method": {
@@ -16642,7 +17169,7 @@
16642
17169
  "category_uuid": {
16643
17170
  "description": "UUID reference to the job category this job belongs to. Categories help organize jobs by type of work or department.",
16644
17171
  "format": "uuid",
16645
- "example": "123e4567-442a-41cd-8595-22fd8ce7341b",
17172
+ "example": "123e4567-43e6-47e4-9547-230040331e1b",
16646
17173
  "type": "string"
16647
17174
  },
16648
17175
  "payment_note": {
@@ -16700,7 +17227,7 @@
16700
17227
  "queue_uuid": {
16701
17228
  "description": "UUID reference to the queue this job is assigned to. Jobs can be organized into queues for workflow management.",
16702
17229
  "format": "uuid",
16703
- "example": "123e4567-d015-4766-9b61-22fd88eedb5b",
17230
+ "example": "123e4567-7221-446e-aab6-2300437683bb",
16704
17231
  "type": "string"
16705
17232
  },
16706
17233
  "queue_expiry_date": {
@@ -16711,7 +17238,7 @@
16711
17238
  "queue_assigned_staff_uuid": {
16712
17239
  "description": "UUID of a Staff Member who is responsible for managing this job while it is in the queue. Only populated when the job is in a Queue which tracks Staff assignment.",
16713
17240
  "format": "uuid",
16714
- "example": "123e4567-ba50-40b3-afd9-22fd87c1ccab",
17241
+ "example": "123e4567-f46e-4615-ae0c-23004cc18a4b",
16715
17242
  "type": "string"
16716
17243
  },
16717
17244
  "badges": {
@@ -16750,7 +17277,7 @@
16750
17277
  "uuid": {
16751
17278
  "format": "uuid",
16752
17279
  "description": "Unique identifier for this record",
16753
- "example": "123e4567-9ddd-4a1f-a368-22fd8fb2797b",
17280
+ "example": "123e4567-b637-492e-805d-2300444781ab",
16754
17281
  "type": "string"
16755
17282
  },
16756
17283
  "active": {
@@ -16806,7 +17333,7 @@
16806
17333
  },
16807
17334
  "completion_actioned_by_uuid": {
16808
17335
  "format": "uuid",
16809
- "example": "123e4567-b501-4400-be53-22fd83e6a36b",
17336
+ "example": "123e4567-895d-4014-adb6-23004c3dc8eb",
16810
17337
  "type": "string",
16811
17338
  "description": "UUID of the staff member who marked this job as completed. References a staff record in the system."
16812
17339
  },
@@ -16829,7 +17356,7 @@
16829
17356
  "uuid": {
16830
17357
  "format": "uuid",
16831
17358
  "description": "Unique identifier for this record",
16832
- "example": "123e4567-fae4-491f-9672-22fd8f61f39b",
17359
+ "example": "123e4567-af1e-42fa-b0e5-2300420d062b",
16833
17360
  "type": "string"
16834
17361
  },
16835
17362
  "active": {
@@ -16848,12 +17375,12 @@
16848
17375
  },
16849
17376
  "job_uuid": {
16850
17377
  "format": "uuid",
16851
- "example": "123e4567-8036-4dbd-b374-22fd86a950db",
17378
+ "example": "123e4567-9bc1-40a9-af82-230047111c0b",
16852
17379
  "type": "string"
16853
17380
  },
16854
17381
  "staff_uuid": {
16855
17382
  "format": "uuid",
16856
- "example": "123e4567-e760-45e4-beab-22fd877ef1cb",
17383
+ "example": "123e4567-0c3b-40f2-b2a9-23004b97f2fb",
16857
17384
  "type": "string"
16858
17385
  },
16859
17386
  "start_date": {
@@ -16888,7 +17415,7 @@
16888
17415
  },
16889
17416
  "allocated_by_staff_uuid": {
16890
17417
  "format": "uuid",
16891
- "example": "123e4567-d7dc-4af3-afe3-22fd8b4b594b",
17418
+ "example": "123e4567-502f-41b2-816e-230048e8a5ab",
16892
17419
  "type": "string"
16893
17420
  },
16894
17421
  "allocated_timestamp": {
@@ -16897,12 +17424,12 @@
16897
17424
  },
16898
17425
  "material_uuid": {
16899
17426
  "format": "uuid",
16900
- "example": "123e4567-a31c-4d0b-9943-22fd847e165b",
17427
+ "example": "123e4567-5f43-4c77-bf1d-2300456e4bcb",
16901
17428
  "type": "string"
16902
17429
  },
16903
17430
  "edit_by_staff_uuid": {
16904
17431
  "format": "uuid",
16905
- "example": "123e4567-bf64-432f-8466-22fd87323d6b",
17432
+ "example": "123e4567-f1f8-4bcb-aeaf-230048ffd1ab",
16906
17433
  "readOnly": true,
16907
17434
  "description": "UUID of Staff Member who last modified record"
16908
17435
  }
@@ -16914,7 +17441,7 @@
16914
17441
  "uuid": {
16915
17442
  "format": "uuid",
16916
17443
  "description": "Unique identifier for this record",
16917
- "example": "123e4567-3c8f-4a45-9295-22fd8b29f5eb",
17444
+ "example": "123e4567-8d88-4db4-a69a-23004a92277b",
16918
17445
  "type": "string"
16919
17446
  },
16920
17447
  "active": {
@@ -16933,17 +17460,17 @@
16933
17460
  },
16934
17461
  "job_uuid": {
16935
17462
  "format": "uuid",
16936
- "example": "123e4567-1f69-4e8c-8dfc-22fd84444ebb",
17463
+ "example": "123e4567-cd84-453c-843a-23004e0ec4db",
16937
17464
  "type": "string"
16938
17465
  },
16939
17466
  "queue_uuid": {
16940
17467
  "format": "uuid",
16941
- "example": "123e4567-53ab-4a1c-b0e8-22fd856c78db",
17468
+ "example": "123e4567-4c6b-473a-b745-23004288927b",
16942
17469
  "type": "string"
16943
17470
  },
16944
17471
  "staff_uuid": {
16945
17472
  "format": "uuid",
16946
- "example": "123e4567-e72d-425c-bd5d-22fd87f185bb",
17473
+ "example": "123e4567-d3d7-4dd1-8c0e-2300409563bb",
16947
17474
  "type": "string"
16948
17475
  },
16949
17476
  "allocation_date": {
@@ -16952,12 +17479,12 @@
16952
17479
  },
16953
17480
  "allocation_window_uuid": {
16954
17481
  "format": "uuid",
16955
- "example": "123e4567-cf65-4fec-8a01-22fd8417e3cb",
17482
+ "example": "123e4567-a09e-43be-8baf-23004f40281b",
16956
17483
  "type": "string"
16957
17484
  },
16958
17485
  "allocated_by_staff_uuid": {
16959
17486
  "format": "uuid",
16960
- "example": "123e4567-ffe7-4648-83d4-22fd8c34eaab",
17487
+ "example": "123e4567-527c-460e-a717-230042e7ab2b",
16961
17488
  "type": "string"
16962
17489
  },
16963
17490
  "allocated_timestamp": {
@@ -17003,7 +17530,7 @@
17003
17530
  "uuid": {
17004
17531
  "format": "uuid",
17005
17532
  "description": "Unique identifier for this record",
17006
- "example": "123e4567-f617-4e18-87f1-22fd81c5ee7b",
17533
+ "example": "123e4567-5aae-41d4-98a0-230042e8465b",
17007
17534
  "type": "string"
17008
17535
  },
17009
17536
  "active": {
@@ -17022,7 +17549,7 @@
17022
17549
  },
17023
17550
  "job_uuid": {
17024
17551
  "format": "uuid",
17025
- "example": "123e4567-ee87-4cf0-9aa1-22fd8cfec26b",
17552
+ "example": "123e4567-9b47-4991-ab50-23004ee319ab",
17026
17553
  "type": "string",
17027
17554
  "description": "UUID of the job this checklist item belongs to. This links the checklist item to a specific job in the system."
17028
17555
  },
@@ -17051,13 +17578,13 @@
17051
17578
  },
17052
17579
  "completed_by_staff_uuid": {
17053
17580
  "format": "uuid",
17054
- "example": "123e4567-25ac-40d3-b05c-22fd8e6f2f1b",
17581
+ "example": "123e4567-46fc-49b1-8787-23004e86d66b",
17055
17582
  "type": "string",
17056
17583
  "description": "UUID of the staff member who completed this checklist item. References a Staff object. Empty if the item is not completed."
17057
17584
  },
17058
17585
  "completed_during_checkin_uuid": {
17059
17586
  "format": "uuid",
17060
- "example": "123e4567-6bbc-420a-95d0-22fd85dd957b",
17587
+ "example": "123e4567-663c-40d0-811c-23004a05082b",
17061
17588
  "type": "string",
17062
17589
  "description": "UUID of the job check-in during which this checklist item was completed. This links the checklist completion to a specific check-in event in the job history."
17063
17590
  },
@@ -17128,7 +17655,7 @@
17128
17655
  },
17129
17656
  "regarding_object_uuid": {
17130
17657
  "format": "uuid",
17131
- "example": "123e4567-3280-419a-b05c-22fd8dec44fb",
17658
+ "example": "123e4567-cc03-4b14-96f2-23004ffc855b",
17132
17659
  "type": "string",
17133
17660
  "description": "The UUID of the object which this checklists item is related to. For example, for Form checklists, this is the UUID of the Form that must be completed to complete the checklist item."
17134
17661
  },
@@ -17138,13 +17665,13 @@
17138
17665
  },
17139
17666
  "fulfilled_by_object_uuid": {
17140
17667
  "format": "uuid",
17141
- "example": "123e4567-393b-45f4-8a90-22fd8b68a4ab",
17668
+ "example": "123e4567-3ee4-4e75-9b26-2300410ae4eb",
17142
17669
  "type": "string",
17143
17670
  "description": "The UUID of the object which completes this checklist item. For example, for Form checklists, this references the UUID of a FormResponse record."
17144
17671
  },
17145
17672
  "assigned_to_staff_uuids": {
17146
17673
  "format": "uuid",
17147
- "example": "123e4567-2888-410d-b6b8-22fd803b0afb",
17674
+ "example": "123e4567-43c2-4298-8229-23004885d03b",
17148
17675
  "type": "array",
17149
17676
  "description": "JSON array of staff UUIDs to whom this checklist item is assigned. Determines which staff members are responsible for completing this checklist item. Currently limited to a maximum of 1 staff member.",
17150
17677
  "items": {
@@ -17169,7 +17696,7 @@
17169
17696
  },
17170
17697
  "assigned_by_staff_uuid": {
17171
17698
  "format": "uuid",
17172
- "example": "123e4567-a7a7-49c2-b438-22fd8501ec4b",
17699
+ "example": "123e4567-5ab5-4108-9a48-23004db3afeb",
17173
17700
  "type": "string",
17174
17701
  "description": "The UUID of the staff member who assigned the checklist item to the staff member. (Read only)"
17175
17702
  }
@@ -17181,7 +17708,7 @@
17181
17708
  "uuid": {
17182
17709
  "format": "uuid",
17183
17710
  "description": "Unique identifier for this record",
17184
- "example": "123e4567-138a-482b-a56e-22fd86bf5eeb",
17711
+ "example": "123e4567-be0a-488d-85a2-2300455a0edb",
17185
17712
  "type": "string"
17186
17713
  },
17187
17714
  "active": {
@@ -17200,7 +17727,7 @@
17200
17727
  },
17201
17728
  "job_uuid": {
17202
17729
  "format": "uuid",
17203
- "example": "123e4567-645e-4fca-a0bd-22fd8bcc720b",
17730
+ "example": "123e4567-fcf7-42e9-8bf5-23004412855b",
17204
17731
  "type": "string"
17205
17732
  },
17206
17733
  "first": {
@@ -17233,7 +17760,7 @@
17233
17760
  "uuid": {
17234
17761
  "format": "uuid",
17235
17762
  "description": "Unique identifier for this record",
17236
- "example": "123e4567-5290-4ee6-a52b-22fd8a2e20fb",
17763
+ "example": "123e4567-3cd3-4be4-8943-23004439e2eb",
17237
17764
  "type": "string"
17238
17765
  },
17239
17766
  "active": {
@@ -17252,12 +17779,12 @@
17252
17779
  },
17253
17780
  "job_uuid": {
17254
17781
  "format": "uuid",
17255
- "example": "123e4567-f617-47ca-90dd-22fd887ec26b",
17782
+ "example": "123e4567-262f-4277-8366-23004ae8159b",
17256
17783
  "type": "string"
17257
17784
  },
17258
17785
  "material_uuid": {
17259
17786
  "format": "uuid",
17260
- "example": "123e4567-8151-4183-aefa-22fd8c44dcfb",
17787
+ "example": "123e4567-477b-4625-8cf0-2300478e938b",
17261
17788
  "type": "string"
17262
17789
  },
17263
17790
  "name": {
@@ -17279,7 +17806,7 @@
17279
17806
  },
17280
17807
  "tax_rate_uuid": {
17281
17808
  "format": "uuid",
17282
- "example": "123e4567-38b1-41d0-ad2c-22fd823d2ecb",
17809
+ "example": "123e4567-6aee-4454-869a-23004b877ebb",
17283
17810
  "type": "string"
17284
17811
  },
17285
17812
  "sort_order": {
@@ -17293,7 +17820,7 @@
17293
17820
  },
17294
17821
  "job_material_bundle_uuid": {
17295
17822
  "format": "uuid",
17296
- "example": "123e4567-843f-44aa-9898-22fd8cc0977b",
17823
+ "example": "123e4567-4f91-43cb-9860-2300486cf16b",
17297
17824
  "type": "string",
17298
17825
  "description": "UUID of a JobMaterialBundle which this JobMaterial belongs to. The default value is blank, which means that the JobMaterial is not part of a JobMaterialBundle."
17299
17826
  }
@@ -17308,7 +17835,7 @@
17308
17835
  "uuid": {
17309
17836
  "format": "uuid",
17310
17837
  "description": "Unique identifier for this record",
17311
- "example": "123e4567-f628-4565-9e30-22fd8ba4e1cb",
17838
+ "example": "123e4567-e863-42ba-9385-23004499306b",
17312
17839
  "type": "string"
17313
17840
  },
17314
17841
  "active": {
@@ -17343,13 +17870,13 @@
17343
17870
  },
17344
17871
  "material_bundle_uuid": {
17345
17872
  "format": "uuid",
17346
- "example": "123e4567-fc08-4532-89af-22fd8f812f4b",
17873
+ "example": "123e4567-2571-4292-9f64-2300467f804b",
17347
17874
  "type": "string",
17348
17875
  "description": "UUID of the MaterialBundle which this JobMaterialBundle was originally created from."
17349
17876
  },
17350
17877
  "job_uuid": {
17351
17878
  "format": "uuid",
17352
- "example": "123e4567-6d2e-4346-8add-22fd8e18287b",
17879
+ "example": "123e4567-4cdd-4338-9e2c-2300460522fb",
17353
17880
  "type": "string",
17354
17881
  "description": "UUID of the job that this material bundle is associated with. Links the bundle to a specific job record."
17355
17882
  }
@@ -17361,7 +17888,7 @@
17361
17888
  "uuid": {
17362
17889
  "format": "uuid",
17363
17890
  "description": "Unique identifier for this record",
17364
- "example": "123e4567-a2e4-4ea3-b925-22fd8c2071cb",
17891
+ "example": "123e4567-377b-4522-bf08-23004067315b",
17365
17892
  "type": "string"
17366
17893
  },
17367
17894
  "active": {
@@ -17380,12 +17907,12 @@
17380
17907
  },
17381
17908
  "job_uuid": {
17382
17909
  "format": "uuid",
17383
- "example": "123e4567-c9ed-4f25-be7c-22fd8a3cfaab",
17910
+ "example": "123e4567-4c4d-4a25-b425-23004d22804b",
17384
17911
  "type": "string"
17385
17912
  },
17386
17913
  "actioned_by_uuid": {
17387
17914
  "format": "uuid",
17388
- "example": "123e4567-509b-4e16-ad3f-22fd8d3ecf0b",
17915
+ "example": "123e4567-54ba-4c7d-90e8-230049815fbb",
17389
17916
  "type": "string"
17390
17917
  },
17391
17918
  "timestamp": {
@@ -17402,7 +17929,7 @@
17402
17929
  },
17403
17930
  "attachment_uuid": {
17404
17931
  "format": "uuid",
17405
- "example": "123e4567-4fe4-4e5b-8cf4-22fd889cdf3b",
17932
+ "example": "123e4567-cf9d-4cc3-8746-2300480f0a6b",
17406
17933
  "type": "string"
17407
17934
  },
17408
17935
  "is_deposit": {
@@ -17415,13 +17942,41 @@
17415
17942
  }
17416
17943
  }
17417
17944
  },
17945
+ "JobTemplate": {
17946
+ "type": "object",
17947
+ "properties": {
17948
+ "uuid": {
17949
+ "format": "uuid",
17950
+ "description": "Unique identifier for this record",
17951
+ "example": "123e4567-6a12-48e0-9e6e-2300450ba03b",
17952
+ "type": "string"
17953
+ },
17954
+ "active": {
17955
+ "enum": [
17956
+ 0,
17957
+ 1
17958
+ ],
17959
+ "type": "integer",
17960
+ "default": 1,
17961
+ "description": "Record active/deleted flag. Valid values are [0,1]"
17962
+ },
17963
+ "edit_date": {
17964
+ "example": "2025-07-01 12:00:00",
17965
+ "readOnly": true,
17966
+ "description": "Timestamp at which record was last modified"
17967
+ },
17968
+ "name": {
17969
+ "type": "string"
17970
+ }
17971
+ }
17972
+ },
17418
17973
  "KnowledgeArticle": {
17419
17974
  "type": "object",
17420
17975
  "properties": {
17421
17976
  "uuid": {
17422
17977
  "format": "uuid",
17423
17978
  "description": "Unique identifier for this record",
17424
- "example": "123e4567-02ce-47cc-a353-22fd851ac5ab",
17979
+ "example": "123e4567-3d7b-4b3b-84e7-2300405547eb",
17425
17980
  "type": "string"
17426
17981
  },
17427
17982
  "active": {
@@ -17551,7 +18106,7 @@
17551
18106
  "uuid": {
17552
18107
  "format": "uuid",
17553
18108
  "description": "Unique identifier for this record",
17554
- "example": "123e4567-50ec-4117-b93f-22fd86574f2b",
18109
+ "example": "123e4567-c92b-4271-a4d4-23004e575d7b",
17555
18110
  "type": "string"
17556
18111
  },
17557
18112
  "active": {
@@ -17621,7 +18176,7 @@
17621
18176
  "uuid": {
17622
18177
  "format": "uuid",
17623
18178
  "description": "Unique identifier for this record",
17624
- "example": "123e4567-e9cf-4eab-97b5-22fd84f1aa9b",
18179
+ "example": "123e4567-3a2c-4fc3-8283-23004230451b",
17625
18180
  "type": "string"
17626
18181
  },
17627
18182
  "active": {
@@ -17646,7 +18201,7 @@
17646
18201
  },
17647
18202
  "tax_rate_uuid": {
17648
18203
  "format": "uuid",
17649
- "example": "123e4567-eddf-4538-b5b7-22fd807ae23b",
18204
+ "example": "123e4567-bca2-4f10-8a18-230043aacbeb",
17650
18205
  "type": "string"
17651
18206
  }
17652
18207
  },
@@ -17660,7 +18215,7 @@
17660
18215
  "uuid": {
17661
18216
  "format": "uuid",
17662
18217
  "description": "Unique identifier for this record",
17663
- "example": "123e4567-b1b8-4845-a136-22fd8874bafb",
18218
+ "example": "123e4567-d993-4790-b011-23004af14deb",
17664
18219
  "type": "string"
17665
18220
  },
17666
18221
  "active": {
@@ -17721,7 +18276,7 @@
17721
18276
  "uuid": {
17722
18277
  "format": "uuid",
17723
18278
  "description": "Unique identifier for this record",
17724
- "example": "123e4567-1f95-4ea2-b9d8-22fd8f59c73b",
18279
+ "example": "123e4567-f208-4370-9f0e-23004cc5173b",
17725
18280
  "type": "string"
17726
18281
  },
17727
18282
  "active": {
@@ -17743,7 +18298,7 @@
17743
18298
  },
17744
18299
  "related_object_uuid": {
17745
18300
  "format": "uuid",
17746
- "example": "123e4567-c873-425f-ae77-22fd8305f44b",
18301
+ "example": "123e4567-054e-4288-8ec0-23004bd6938b",
17747
18302
  "type": "string"
17748
18303
  },
17749
18304
  "note": {
@@ -17754,12 +18309,12 @@
17754
18309
  },
17755
18310
  "action_completed_by_staff_uuid": {
17756
18311
  "format": "uuid",
17757
- "example": "123e4567-2350-4f3f-b5c4-22fd86c2948b",
18312
+ "example": "123e4567-cc45-4b40-a3a9-23004dc38d7b",
17758
18313
  "type": "string"
17759
18314
  },
17760
18315
  "edit_by_staff_uuid": {
17761
18316
  "format": "uuid",
17762
- "example": "123e4567-d39e-425c-aa81-22fd887281fb",
18317
+ "example": "123e4567-3693-46e0-bbf3-230045b4964b",
17763
18318
  "readOnly": true,
17764
18319
  "description": "UUID of Staff Member who last modified record"
17765
18320
  },
@@ -17775,7 +18330,7 @@
17775
18330
  "uuid": {
17776
18331
  "format": "uuid",
17777
18332
  "description": "Unique identifier for this record",
17778
- "example": "123e4567-f846-4a6c-914f-22fd8e81b42b",
18333
+ "example": "123e4567-a9c4-43ed-9857-23004e70199b",
17779
18334
  "type": "string"
17780
18335
  },
17781
18336
  "active": {
@@ -17829,7 +18384,7 @@
17829
18384
  "uuid": {
17830
18385
  "format": "uuid",
17831
18386
  "description": "Unique identifier for this record",
17832
- "example": "123e4567-f9c9-4602-a526-22fd8d74199b",
18387
+ "example": "123e4567-1681-48eb-b37b-23004a7be1db",
17833
18388
  "type": "string"
17834
18389
  },
17835
18390
  "active": {
@@ -17857,7 +18412,7 @@
17857
18412
  "uuid": {
17858
18413
  "format": "uuid",
17859
18414
  "description": "Unique identifier for this record",
17860
- "example": "123e4567-558b-49f7-8d59-22fd89e659fb",
18415
+ "example": "123e4567-437e-43b4-baff-23004bd5719b",
17861
18416
  "type": "string"
17862
18417
  },
17863
18418
  "active": {
@@ -17931,7 +18486,7 @@
17931
18486
  "navigating_to_job_uuid": {
17932
18487
  "description": "UUID of the job the staff member is currently navigating to. Used to track which job a staff member is traveling toward.",
17933
18488
  "format": "uuid",
17934
- "example": "123e4567-a2fb-4b60-846f-22fd80de6d9b",
18489
+ "example": "123e4567-2e9d-46f8-a1af-230047cc91eb",
17935
18490
  "type": "string"
17936
18491
  },
17937
18492
  "navigating_timestamp": {
@@ -17971,13 +18526,13 @@
17971
18526
  "security_role_uuid": {
17972
18527
  "description": "UUID of the primary security role assigned to this staff member. Controls the staff member's permissions and access levels throughout the system.",
17973
18528
  "format": "uuid",
17974
- "example": "123e4567-ae75-4eae-adef-22fd802aca3b",
18529
+ "example": "123e4567-04fc-4159-af14-2300469ca4bb",
17975
18530
  "type": "string"
17976
18531
  },
17977
18532
  "uuid": {
17978
18533
  "format": "uuid",
17979
18534
  "description": "Unique identifier for this record",
17980
- "example": "123e4567-d3d1-4eef-934d-22fd8277a70b",
18535
+ "example": "123e4567-d856-40ac-b471-230042eb3c8b",
17981
18536
  "type": "string"
17982
18537
  },
17983
18538
  "active": {
@@ -18010,7 +18565,7 @@
18010
18565
  "uuid": {
18011
18566
  "format": "uuid",
18012
18567
  "description": "Unique identifier for this record",
18013
- "example": "123e4567-322b-4c7b-a9c8-22fd89b40dcb",
18568
+ "example": "123e4567-0d28-44fc-b4d2-230043b9342b",
18014
18569
  "type": "string"
18015
18570
  },
18016
18571
  "active": {
@@ -18029,12 +18584,12 @@
18029
18584
  },
18030
18585
  "from_staff_uuid": {
18031
18586
  "format": "uuid",
18032
- "example": "123e4567-0a6d-4b9e-8b0e-22fd8c5ece9b",
18587
+ "example": "123e4567-ff1b-40ac-b7f3-2300430a0a3b",
18033
18588
  "type": "string"
18034
18589
  },
18035
18590
  "to_staff_uuid": {
18036
18591
  "format": "uuid",
18037
- "example": "123e4567-3773-43eb-9c06-22fd87851adb",
18592
+ "example": "123e4567-9c4b-4148-b15c-23004f08d7fb",
18038
18593
  "type": "string"
18039
18594
  },
18040
18595
  "sent_timestamp": {
@@ -18054,7 +18609,7 @@
18054
18609
  },
18055
18610
  "regarding_job_uuid": {
18056
18611
  "format": "uuid",
18057
- "example": "123e4567-fa1c-43e1-8216-22fd8d0c365b",
18612
+ "example": "123e4567-b3df-47e8-a73f-2300403f90db",
18058
18613
  "type": "string"
18059
18614
  },
18060
18615
  "attached_json": {
@@ -18085,7 +18640,7 @@
18085
18640
  "related_object_uuid": {
18086
18641
  "description": "UUID of the specific object instance this task is related to. Must be a valid UUID corresponding to an existing object of the type specified in related_object.",
18087
18642
  "format": "uuid",
18088
- "example": "123e4567-2c9f-44a5-8470-22fd84c6d6eb",
18643
+ "example": "123e4567-38d7-46f7-95f5-23004c88dd1b",
18089
18644
  "type": "string"
18090
18645
  },
18091
18646
  "task_complete": {
@@ -18100,13 +18655,13 @@
18100
18655
  "completed_by_staff_uuid": {
18101
18656
  "description": "UUID of the staff member who marked the task as complete. Automatically set to the current staff member's UUID when task_complete is changed to 1.",
18102
18657
  "format": "uuid",
18103
- "example": "123e4567-a11a-40b5-aa7a-22fd82f14c1b",
18658
+ "example": "123e4567-9801-4614-a246-230041ea594b",
18104
18659
  "type": "string"
18105
18660
  },
18106
18661
  "assigned_to_staff_uuid": {
18107
18662
  "description": "UUID of the staff member assigned to complete this task. Must be a valid staff UUID in the system.",
18108
18663
  "format": "uuid",
18109
- "example": "123e4567-5d96-4504-9341-22fd8df7b39b",
18664
+ "example": "123e4567-9b51-453d-a000-2300478c32db",
18110
18665
  "type": "string"
18111
18666
  },
18112
18667
  "lng": {
@@ -18118,7 +18673,7 @@
18118
18673
  "uuid": {
18119
18674
  "format": "uuid",
18120
18675
  "description": "Unique identifier for this record",
18121
- "example": "123e4567-00c3-4b07-9b6a-22fd888a902b",
18676
+ "example": "123e4567-65e9-4aa0-9b2d-23004a1d872b",
18122
18677
  "type": "string"
18123
18678
  },
18124
18679
  "active": {
@@ -18137,7 +18692,7 @@
18137
18692
  },
18138
18693
  "created_by_staff_uuid": {
18139
18694
  "format": "uuid",
18140
- "example": "123e4567-0a30-4625-ad38-22fd80ab7f0b",
18695
+ "example": "123e4567-6f1b-419c-bba9-230049629bab",
18141
18696
  "type": "string"
18142
18697
  },
18143
18698
  "create_date": {
@@ -18155,7 +18710,7 @@
18155
18710
  "uuid": {
18156
18711
  "format": "uuid",
18157
18712
  "description": "Unique identifier for this record",
18158
- "example": "123e4567-3172-431f-bea4-22fd84e8991b",
18713
+ "example": "123e4567-7637-40cb-b27f-23004614f5fb",
18159
18714
  "type": "string"
18160
18715
  },
18161
18716
  "active": {
@@ -18198,7 +18753,7 @@
18198
18753
  "uuid": {
18199
18754
  "format": "uuid",
18200
18755
  "description": "Unique identifier for this record",
18201
- "example": "123e4567-b82c-4c1e-bd63-22fd85cd889b",
18756
+ "example": "123e4567-0913-4dc3-8106-230048c166fb",
18202
18757
  "type": "string"
18203
18758
  },
18204
18759
  "active": {
@@ -18307,108 +18862,6 @@
18307
18862
  "name"
18308
18863
  ]
18309
18864
  },
18310
- "InboxMessage": {
18311
- "type": "object",
18312
- "properties": {
18313
- "uuid": {
18314
- "type": "string",
18315
- "format": "uuid"
18316
- },
18317
- "active": {
18318
- "type": "boolean"
18319
- },
18320
- "edit_date": {
18321
- "type": "string",
18322
- "format": "date-time"
18323
- },
18324
- "timestamp": {
18325
- "type": "string",
18326
- "format": "date-time"
18327
- },
18328
- "read_timestamp": {
18329
- "type": "string",
18330
- "format": "date-time",
18331
- "nullable": true
18332
- },
18333
- "last_reply_timestamp": {
18334
- "type": "string",
18335
- "format": "date-time",
18336
- "nullable": true
18337
- },
18338
- "snooze_until_timestamp": {
18339
- "type": "string",
18340
- "format": "date-time",
18341
- "nullable": true
18342
- },
18343
- "read_by_staff_uuid": {
18344
- "type": "string",
18345
- "format": "uuid",
18346
- "nullable": true
18347
- },
18348
- "from_name": {
18349
- "type": "string"
18350
- },
18351
- "from_email": {
18352
- "type": "string"
18353
- },
18354
- "to_email": {
18355
- "type": "string"
18356
- },
18357
- "subject": {
18358
- "type": "string"
18359
- },
18360
- "message_text": {
18361
- "type": "string"
18362
- },
18363
- "message_html": {
18364
- "type": "string"
18365
- },
18366
- "is_archived": {
18367
- "type": "boolean"
18368
- },
18369
- "archived_timestamp": {
18370
- "type": "string",
18371
- "format": "date-time",
18372
- "nullable": true
18373
- },
18374
- "archived_by_staff_uuid": {
18375
- "type": "string",
18376
- "format": "uuid",
18377
- "nullable": true
18378
- },
18379
- "regarding_company_uuid": {
18380
- "type": "string",
18381
- "format": "uuid",
18382
- "nullable": true
18383
- },
18384
- "converted_to_job_uuid": {
18385
- "type": "string",
18386
- "format": "uuid",
18387
- "nullable": true
18388
- },
18389
- "job_template_uuid": {
18390
- "type": "string",
18391
- "format": "uuid",
18392
- "nullable": true
18393
- },
18394
- "message_type": {
18395
- "type": "string",
18396
- "enum": [
18397
- "email",
18398
- "sms",
18399
- "online_booking",
18400
- "phone_call",
18401
- "reminder",
18402
- "form",
18403
- "network_request",
18404
- "supplier_invoice",
18405
- "asset",
18406
- "partner_lead",
18407
- "automation"
18408
- ]
18409
- }
18410
- }
18411
- },
18412
18865
  "InboxMessageDetail": {
18413
18866
  "allOf": [
18414
18867
  {
@@ -18582,7 +19035,7 @@
18582
19035
  },
18583
19036
  "JobTemplateOverrides": {
18584
19037
  "type": "object",
18585
- "description": "Optional field overrides when creating a job from a template. Only the following fields can be overridden: job_description, company_uuid, and job_address.",
19038
+ "description": "Optional field overrides when creating a job from a template. Only the following fields can be overridden: job_description, company_uuid, company_name, and job_address. Note: You cannot specify both company_uuid and company_name.",
18586
19039
  "properties": {
18587
19040
  "job_description": {
18588
19041
  "type": "string",
@@ -18591,7 +19044,11 @@
18591
19044
  "company_uuid": {
18592
19045
  "type": "string",
18593
19046
  "format": "uuid",
18594
- "description": "UUID of the company/client"
19047
+ "description": "UUID of the company/client. Cannot be used together with company_name."
19048
+ },
19049
+ "company_name": {
19050
+ "type": "string",
19051
+ "description": "Name of the company/client. If a company with this name exists, it will be used. Otherwise, a new company will be created. Cannot be used together with company_uuid."
18595
19052
  },
18596
19053
  "job_address": {
18597
19054
  "type": "string",
@@ -18828,6 +19285,10 @@
18828
19285
  "name": "Form Responses",
18829
19286
  "description": "Operations related to Form Responses"
18830
19287
  },
19288
+ {
19289
+ "name": "",
19290
+ "description": "Operations related to "
19291
+ },
18831
19292
  {
18832
19293
  "name": "Jobs",
18833
19294
  "description": "Operations related to Jobs"
@@ -18860,6 +19321,10 @@
18860
19321
  "name": "Job Payments",
18861
19322
  "description": "Operations related to Job Payments"
18862
19323
  },
19324
+ {
19325
+ "name": "Job Templates",
19326
+ "description": "Operations related to Job Templates"
19327
+ },
18863
19328
  {
18864
19329
  "name": "Knowledge Articles",
18865
19330
  "description": "Operations related to Knowledge Articles"