servicem8 0.7.0 → 0.9.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +0 -10
- package/api.json +629 -1076
- package/bin/mcp-server.js +532 -1359
- package/bin/mcp-server.js.map +8 -24
- package/dist/commonjs/lib/config.d.ts +3 -3
- package/dist/commonjs/lib/config.js +3 -3
- package/dist/commonjs/mcp-server/mcp-server.js +1 -1
- package/dist/commonjs/mcp-server/server.d.ts.map +1 -1
- package/dist/commonjs/mcp-server/server.js +10 -20
- package/dist/commonjs/mcp-server/server.js.map +1 -1
- package/dist/commonjs/models/components/index.d.ts +0 -1
- package/dist/commonjs/models/components/index.d.ts.map +1 -1
- package/dist/commonjs/models/components/index.js +0 -1
- package/dist/commonjs/models/components/index.js.map +1 -1
- package/dist/commonjs/models/operations/index.d.ts +0 -5
- package/dist/commonjs/models/operations/index.d.ts.map +1 -1
- package/dist/commonjs/models/operations/index.js +0 -5
- package/dist/commonjs/models/operations/index.js.map +1 -1
- package/dist/commonjs/sdk/jobtemplates.d.ts +0 -54
- package/dist/commonjs/sdk/jobtemplates.d.ts.map +1 -1
- package/dist/commonjs/sdk/jobtemplates.js +0 -68
- package/dist/commonjs/sdk/jobtemplates.js.map +1 -1
- package/dist/commonjs/sdk/sdk.d.ts +4 -4
- package/dist/commonjs/sdk/sdk.d.ts.map +1 -1
- package/dist/commonjs/sdk/sdk.js +6 -6
- package/dist/commonjs/sdk/sdk.js.map +1 -1
- package/dist/esm/lib/config.d.ts +3 -3
- package/dist/esm/lib/config.js +3 -3
- package/dist/esm/mcp-server/mcp-server.js +1 -1
- package/dist/esm/mcp-server/server.d.ts.map +1 -1
- package/dist/esm/mcp-server/server.js +10 -20
- package/dist/esm/mcp-server/server.js.map +1 -1
- package/dist/esm/models/components/index.d.ts +0 -1
- package/dist/esm/models/components/index.d.ts.map +1 -1
- package/dist/esm/models/components/index.js +0 -1
- package/dist/esm/models/components/index.js.map +1 -1
- package/dist/esm/models/operations/index.d.ts +0 -5
- package/dist/esm/models/operations/index.d.ts.map +1 -1
- package/dist/esm/models/operations/index.js +0 -5
- package/dist/esm/models/operations/index.js.map +1 -1
- package/dist/esm/sdk/jobtemplates.d.ts +0 -54
- package/dist/esm/sdk/jobtemplates.d.ts.map +1 -1
- package/dist/esm/sdk/jobtemplates.js +0 -68
- package/dist/esm/sdk/jobtemplates.js.map +1 -1
- package/dist/esm/sdk/sdk.d.ts +4 -4
- package/dist/esm/sdk/sdk.d.ts.map +1 -1
- package/dist/esm/sdk/sdk.js +6 -6
- package/dist/esm/sdk/sdk.js.map +1 -1
- package/docs/sdks/allocationwindows/README.md +4 -4
- package/docs/sdks/assets/README.md +6 -6
- package/docs/sdks/assettypefields/README.md +8 -8
- package/docs/sdks/assettypes/README.md +4 -4
- package/docs/sdks/attachments/README.md +12 -12
- package/docs/sdks/badges/README.md +12 -12
- package/docs/sdks/bundles/README.md +4 -4
- package/docs/sdks/categories/README.md +4 -4
- package/docs/sdks/clients/README.md +8 -8
- package/docs/sdks/companycontacts/README.md +8 -8
- package/docs/sdks/emailtemplates/README.md +4 -4
- package/docs/sdks/feedback/README.md +8 -8
- package/docs/sdks/formfields/README.md +8 -8
- package/docs/sdks/formresponses/README.md +28 -28
- package/docs/sdks/forms/README.md +8 -8
- package/docs/sdks/jobactivities/README.md +20 -20
- package/docs/sdks/joballocations/README.md +24 -24
- package/docs/sdks/jobchecklists/README.md +32 -32
- package/docs/sdks/jobcontacts/README.md +8 -8
- package/docs/sdks/jobmaterialbundles/README.md +12 -12
- package/docs/sdks/jobmaterials/README.md +20 -20
- package/docs/sdks/jobpayments/README.md +16 -16
- package/docs/sdks/jobqueues/README.md +4 -4
- package/docs/sdks/jobs/README.md +32 -32
- package/docs/sdks/jobtemplates/README.md +0 -431
- package/docs/sdks/knowledgearticles/README.md +4 -4
- package/docs/sdks/locations/README.md +4 -4
- package/docs/sdks/materials/README.md +8 -8
- package/docs/sdks/notes/README.md +12 -12
- package/docs/sdks/securityroles/README.md +4 -4
- package/docs/sdks/smstemplates/README.md +4 -4
- package/docs/sdks/staffmembers/README.md +12 -12
- package/docs/sdks/staffmessages/README.md +16 -16
- package/docs/sdks/tasks/README.md +20 -20
- package/docs/sdks/taxrates/README.md +4 -4
- package/docs/sdks/vendors/README.md +2 -2
- package/examples/package-lock.json +1 -1
- package/jsr.json +1 -1
- package/package.json +1 -1
- package/src/lib/config.ts +3 -3
- package/src/mcp-server/mcp-server.ts +1 -1
- package/src/mcp-server/server.ts +10 -20
- package/src/models/components/index.ts +0 -1
- package/src/models/operations/index.ts +0 -5
- package/src/sdk/jobtemplates.ts +0 -107
- package/src/sdk/sdk.ts +10 -10
- package/dist/commonjs/funcs/jobTemplatesCreateJobTemplates.d.ts +0 -24
- package/dist/commonjs/funcs/jobTemplatesCreateJobTemplates.d.ts.map +0 -1
- package/dist/commonjs/funcs/jobTemplatesCreateJobTemplates.js +0 -138
- package/dist/commonjs/funcs/jobTemplatesCreateJobTemplates.js.map +0 -1
- package/dist/commonjs/funcs/jobTemplatesDeleteJobTemplates.d.ts +0 -22
- package/dist/commonjs/funcs/jobTemplatesDeleteJobTemplates.d.ts.map +0 -1
- package/dist/commonjs/funcs/jobTemplatesDeleteJobTemplates.js +0 -136
- package/dist/commonjs/funcs/jobTemplatesDeleteJobTemplates.js.map +0 -1
- package/dist/commonjs/funcs/jobTemplatesGetJobTemplates.d.ts +0 -20
- package/dist/commonjs/funcs/jobTemplatesGetJobTemplates.d.ts.map +0 -1
- package/dist/commonjs/funcs/jobTemplatesGetJobTemplates.js +0 -134
- package/dist/commonjs/funcs/jobTemplatesGetJobTemplates.js.map +0 -1
- package/dist/commonjs/funcs/jobTemplatesListJobTemplates.d.ts +0 -23
- package/dist/commonjs/funcs/jobTemplatesListJobTemplates.d.ts.map +0 -1
- package/dist/commonjs/funcs/jobTemplatesListJobTemplates.js +0 -122
- package/dist/commonjs/funcs/jobTemplatesListJobTemplates.js.map +0 -1
- package/dist/commonjs/funcs/jobTemplatesUpdateJobTemplates.d.ts +0 -20
- package/dist/commonjs/funcs/jobTemplatesUpdateJobTemplates.d.ts.map +0 -1
- package/dist/commonjs/funcs/jobTemplatesUpdateJobTemplates.js +0 -135
- package/dist/commonjs/funcs/jobTemplatesUpdateJobTemplates.js.map +0 -1
- package/dist/commonjs/mcp-server/tools/jobTemplatesCreateJobTemplates.d.ts +0 -8
- package/dist/commonjs/mcp-server/tools/jobTemplatesCreateJobTemplates.d.ts.map +0 -1
- package/dist/commonjs/mcp-server/tools/jobTemplatesCreateJobTemplates.js +0 -74
- package/dist/commonjs/mcp-server/tools/jobTemplatesCreateJobTemplates.js.map +0 -1
- package/dist/commonjs/mcp-server/tools/jobTemplatesDeleteJobTemplates.d.ts +0 -8
- package/dist/commonjs/mcp-server/tools/jobTemplatesDeleteJobTemplates.d.ts.map +0 -1
- package/dist/commonjs/mcp-server/tools/jobTemplatesDeleteJobTemplates.js +0 -73
- package/dist/commonjs/mcp-server/tools/jobTemplatesDeleteJobTemplates.js.map +0 -1
- package/dist/commonjs/mcp-server/tools/jobTemplatesGetJobTemplates.d.ts +0 -8
- package/dist/commonjs/mcp-server/tools/jobTemplatesGetJobTemplates.d.ts.map +0 -1
- package/dist/commonjs/mcp-server/tools/jobTemplatesGetJobTemplates.js +0 -69
- package/dist/commonjs/mcp-server/tools/jobTemplatesGetJobTemplates.js.map +0 -1
- package/dist/commonjs/mcp-server/tools/jobTemplatesListJobTemplates.d.ts +0 -3
- package/dist/commonjs/mcp-server/tools/jobTemplatesListJobTemplates.d.ts.map +0 -1
- package/dist/commonjs/mcp-server/tools/jobTemplatesListJobTemplates.js +0 -35
- package/dist/commonjs/mcp-server/tools/jobTemplatesListJobTemplates.js.map +0 -1
- package/dist/commonjs/mcp-server/tools/jobTemplatesUpdateJobTemplates.d.ts +0 -8
- package/dist/commonjs/mcp-server/tools/jobTemplatesUpdateJobTemplates.d.ts.map +0 -1
- package/dist/commonjs/mcp-server/tools/jobTemplatesUpdateJobTemplates.js +0 -69
- package/dist/commonjs/mcp-server/tools/jobTemplatesUpdateJobTemplates.js.map +0 -1
- package/dist/commonjs/models/components/jobtemplate.d.ts +0 -111
- package/dist/commonjs/models/components/jobtemplate.d.ts.map +0 -1
- package/dist/commonjs/models/components/jobtemplate.js +0 -137
- package/dist/commonjs/models/components/jobtemplate.js.map +0 -1
- package/dist/commonjs/models/operations/createjobtemplates.d.ts +0 -57
- package/dist/commonjs/models/operations/createjobtemplates.d.ts.map +0 -1
- package/dist/commonjs/models/operations/createjobtemplates.js +0 -115
- package/dist/commonjs/models/operations/createjobtemplates.js.map +0 -1
- package/dist/commonjs/models/operations/deletejobtemplates.d.ts +0 -54
- package/dist/commonjs/models/operations/deletejobtemplates.d.ts.map +0 -1
- package/dist/commonjs/models/operations/deletejobtemplates.js +0 -96
- package/dist/commonjs/models/operations/deletejobtemplates.js.map +0 -1
- package/dist/commonjs/models/operations/getjobtemplates.d.ts +0 -54
- package/dist/commonjs/models/operations/getjobtemplates.d.ts.map +0 -1
- package/dist/commonjs/models/operations/getjobtemplates.js +0 -99
- package/dist/commonjs/models/operations/getjobtemplates.js.map +0 -1
- package/dist/commonjs/models/operations/listjobtemplates.d.ts +0 -26
- package/dist/commonjs/models/operations/listjobtemplates.d.ts.map +0 -1
- package/dist/commonjs/models/operations/listjobtemplates.js +0 -72
- package/dist/commonjs/models/operations/listjobtemplates.js.map +0 -1
- package/dist/commonjs/models/operations/updatejobtemplates.d.ts +0 -59
- package/dist/commonjs/models/operations/updatejobtemplates.d.ts.map +0 -1
- package/dist/commonjs/models/operations/updatejobtemplates.js +0 -107
- package/dist/commonjs/models/operations/updatejobtemplates.js.map +0 -1
- package/dist/esm/funcs/jobTemplatesCreateJobTemplates.d.ts +0 -24
- package/dist/esm/funcs/jobTemplatesCreateJobTemplates.d.ts.map +0 -1
- package/dist/esm/funcs/jobTemplatesCreateJobTemplates.js +0 -102
- package/dist/esm/funcs/jobTemplatesCreateJobTemplates.js.map +0 -1
- package/dist/esm/funcs/jobTemplatesDeleteJobTemplates.d.ts +0 -22
- package/dist/esm/funcs/jobTemplatesDeleteJobTemplates.d.ts.map +0 -1
- package/dist/esm/funcs/jobTemplatesDeleteJobTemplates.js +0 -100
- package/dist/esm/funcs/jobTemplatesDeleteJobTemplates.js.map +0 -1
- package/dist/esm/funcs/jobTemplatesGetJobTemplates.d.ts +0 -20
- package/dist/esm/funcs/jobTemplatesGetJobTemplates.d.ts.map +0 -1
- package/dist/esm/funcs/jobTemplatesGetJobTemplates.js +0 -98
- package/dist/esm/funcs/jobTemplatesGetJobTemplates.js.map +0 -1
- package/dist/esm/funcs/jobTemplatesListJobTemplates.d.ts +0 -23
- package/dist/esm/funcs/jobTemplatesListJobTemplates.d.ts.map +0 -1
- package/dist/esm/funcs/jobTemplatesListJobTemplates.js +0 -86
- package/dist/esm/funcs/jobTemplatesListJobTemplates.js.map +0 -1
- package/dist/esm/funcs/jobTemplatesUpdateJobTemplates.d.ts +0 -20
- package/dist/esm/funcs/jobTemplatesUpdateJobTemplates.d.ts.map +0 -1
- package/dist/esm/funcs/jobTemplatesUpdateJobTemplates.js +0 -99
- package/dist/esm/funcs/jobTemplatesUpdateJobTemplates.js.map +0 -1
- package/dist/esm/mcp-server/tools/jobTemplatesCreateJobTemplates.d.ts +0 -8
- package/dist/esm/mcp-server/tools/jobTemplatesCreateJobTemplates.d.ts.map +0 -1
- package/dist/esm/mcp-server/tools/jobTemplatesCreateJobTemplates.js +0 -38
- package/dist/esm/mcp-server/tools/jobTemplatesCreateJobTemplates.js.map +0 -1
- package/dist/esm/mcp-server/tools/jobTemplatesDeleteJobTemplates.d.ts +0 -8
- package/dist/esm/mcp-server/tools/jobTemplatesDeleteJobTemplates.d.ts.map +0 -1
- package/dist/esm/mcp-server/tools/jobTemplatesDeleteJobTemplates.js +0 -37
- package/dist/esm/mcp-server/tools/jobTemplatesDeleteJobTemplates.js.map +0 -1
- package/dist/esm/mcp-server/tools/jobTemplatesGetJobTemplates.d.ts +0 -8
- package/dist/esm/mcp-server/tools/jobTemplatesGetJobTemplates.d.ts.map +0 -1
- package/dist/esm/mcp-server/tools/jobTemplatesGetJobTemplates.js +0 -33
- package/dist/esm/mcp-server/tools/jobTemplatesGetJobTemplates.js.map +0 -1
- package/dist/esm/mcp-server/tools/jobTemplatesListJobTemplates.d.ts +0 -3
- package/dist/esm/mcp-server/tools/jobTemplatesListJobTemplates.d.ts.map +0 -1
- package/dist/esm/mcp-server/tools/jobTemplatesListJobTemplates.js +0 -32
- package/dist/esm/mcp-server/tools/jobTemplatesListJobTemplates.js.map +0 -1
- package/dist/esm/mcp-server/tools/jobTemplatesUpdateJobTemplates.d.ts +0 -8
- package/dist/esm/mcp-server/tools/jobTemplatesUpdateJobTemplates.d.ts.map +0 -1
- package/dist/esm/mcp-server/tools/jobTemplatesUpdateJobTemplates.js +0 -33
- package/dist/esm/mcp-server/tools/jobTemplatesUpdateJobTemplates.js.map +0 -1
- package/dist/esm/models/components/jobtemplate.d.ts +0 -111
- package/dist/esm/models/components/jobtemplate.d.ts.map +0 -1
- package/dist/esm/models/components/jobtemplate.js +0 -97
- package/dist/esm/models/components/jobtemplate.js.map +0 -1
- package/dist/esm/models/operations/createjobtemplates.d.ts +0 -57
- package/dist/esm/models/operations/createjobtemplates.d.ts.map +0 -1
- package/dist/esm/models/operations/createjobtemplates.js +0 -75
- package/dist/esm/models/operations/createjobtemplates.js.map +0 -1
- package/dist/esm/models/operations/deletejobtemplates.d.ts +0 -54
- package/dist/esm/models/operations/deletejobtemplates.d.ts.map +0 -1
- package/dist/esm/models/operations/deletejobtemplates.js +0 -56
- package/dist/esm/models/operations/deletejobtemplates.js.map +0 -1
- package/dist/esm/models/operations/getjobtemplates.d.ts +0 -54
- package/dist/esm/models/operations/getjobtemplates.d.ts.map +0 -1
- package/dist/esm/models/operations/getjobtemplates.js +0 -59
- package/dist/esm/models/operations/getjobtemplates.js.map +0 -1
- package/dist/esm/models/operations/listjobtemplates.d.ts +0 -26
- package/dist/esm/models/operations/listjobtemplates.d.ts.map +0 -1
- package/dist/esm/models/operations/listjobtemplates.js +0 -34
- package/dist/esm/models/operations/listjobtemplates.js.map +0 -1
- package/dist/esm/models/operations/updatejobtemplates.d.ts +0 -59
- package/dist/esm/models/operations/updatejobtemplates.d.ts.map +0 -1
- package/dist/esm/models/operations/updatejobtemplates.js +0 -67
- package/dist/esm/models/operations/updatejobtemplates.js.map +0 -1
- package/src/funcs/jobTemplatesCreateJobTemplates.ts +0 -190
- package/src/funcs/jobTemplatesDeleteJobTemplates.ts +0 -189
- package/src/funcs/jobTemplatesGetJobTemplates.ts +0 -187
- package/src/funcs/jobTemplatesListJobTemplates.ts +0 -166
- package/src/funcs/jobTemplatesUpdateJobTemplates.ts +0 -188
- package/src/mcp-server/tools/jobTemplatesCreateJobTemplates.ts +0 -48
- package/src/mcp-server/tools/jobTemplatesDeleteJobTemplates.ts +0 -47
- package/src/mcp-server/tools/jobTemplatesGetJobTemplates.ts +0 -42
- package/src/mcp-server/tools/jobTemplatesListJobTemplates.ts +0 -39
- package/src/mcp-server/tools/jobTemplatesUpdateJobTemplates.ts +0 -43
- package/src/models/components/jobtemplate.ts +0 -198
- package/src/models/operations/createjobtemplates.ts +0 -147
- package/src/models/operations/deletejobtemplates.ts +0 -125
- package/src/models/operations/getjobtemplates.ts +0 -130
- package/src/models/operations/listjobtemplates.ts +0 -69
- package/src/models/operations/updatejobtemplates.ts +0 -141
package/api.json
CHANGED
|
@@ -51,7 +51,7 @@
|
|
|
51
51
|
"success": {
|
|
52
52
|
"value": [
|
|
53
53
|
{
|
|
54
|
-
"uuid": "123e4567-
|
|
54
|
+
"uuid": "123e4567-8a62-4e93-af1a-22fd88c5f7cb",
|
|
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-
|
|
223
|
+
"uuid": "123e4567-60ce-40ec-b2b2-22fd8821e2bb",
|
|
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-
|
|
463
|
+
"uuid": "123e4567-cc8a-4113-b2b5-22fd80ea01fb",
|
|
464
464
|
"active": 1,
|
|
465
465
|
"edit_date": "2025-07-01 12:00:00",
|
|
466
|
-
"company_uuid": "123e4567-
|
|
466
|
+
"company_uuid": "123e4567-4ca6-4055-8cc1-22fd8d3ac7db",
|
|
467
467
|
"asset_code": "string",
|
|
468
|
-
"asset_type_uuid": "123e4567-
|
|
468
|
+
"asset_type_uuid": "123e4567-dbf1-4e2f-84ab-22fd8f627e1b",
|
|
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-
|
|
562
|
+
"uuid": "123e4567-7ccb-4b6c-95f9-22fd8e3d4c4b",
|
|
563
563
|
"active": 1,
|
|
564
564
|
"edit_date": "2025-07-01 12:00:00",
|
|
565
|
-
"company_uuid": "123e4567-
|
|
565
|
+
"company_uuid": "123e4567-4de0-4162-90d2-22fd8315b9bb",
|
|
566
566
|
"asset_code": "string",
|
|
567
|
-
"asset_type_uuid": "123e4567-
|
|
567
|
+
"asset_type_uuid": "123e4567-9f20-426f-886c-22fd8dbcd9fb",
|
|
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-
|
|
819
|
+
"uuid": "123e4567-5e05-4d6d-a7bf-22fd88e6d95b",
|
|
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-
|
|
989
|
+
"uuid": "123e4567-eaea-4d4e-b1d5-22fd87803bbb",
|
|
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-
|
|
1230
|
+
"uuid": "123e4567-26d1-415e-a7ae-22fd83d770cb",
|
|
1231
1231
|
"active": 1,
|
|
1232
1232
|
"edit_date": "2025-07-01 12:00:00",
|
|
1233
|
-
"asset_type_uuid": "123e4567-
|
|
1233
|
+
"asset_type_uuid": "123e4567-0539-4bd0-ace2-22fd888bb7db",
|
|
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-
|
|
1409
|
+
"uuid": "123e4567-ea56-4631-9784-22fd862a1cbb",
|
|
1410
1410
|
"active": 1,
|
|
1411
1411
|
"edit_date": "2025-07-01 12:00:00",
|
|
1412
|
-
"asset_type_uuid": "123e4567-
|
|
1412
|
+
"asset_type_uuid": "123e4567-6e3b-4a78-a3ae-22fd8b304f2b",
|
|
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-
|
|
1657
|
+
"uuid": "123e4567-1662-4107-903e-22fd80098f2b",
|
|
1658
1658
|
"active": 1,
|
|
1659
1659
|
"edit_date": "2025-07-01 12:00:00",
|
|
1660
1660
|
"related_object": "string",
|
|
1661
|
-
"related_object_uuid": "123e4567-
|
|
1661
|
+
"related_object_uuid": "123e4567-062b-4087-b86a-22fd8475510b",
|
|
1662
1662
|
"attachment_name": "string",
|
|
1663
1663
|
"file_type": "string",
|
|
1664
|
-
"created_by_staff_uuid": "123e4567-
|
|
1664
|
+
"created_by_staff_uuid": "123e4567-385d-4288-9ec9-22fd8f105acb",
|
|
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-
|
|
1838
|
+
"uuid": "123e4567-cf25-4998-a0eb-22fd8aa3388b",
|
|
1839
1839
|
"active": 1,
|
|
1840
1840
|
"edit_date": "2025-07-01 12:00:00",
|
|
1841
1841
|
"related_object": "string",
|
|
1842
|
-
"related_object_uuid": "123e4567-
|
|
1842
|
+
"related_object_uuid": "123e4567-19bb-4651-b298-22fd84d4f25b",
|
|
1843
1843
|
"attachment_name": "string",
|
|
1844
1844
|
"file_type": "string",
|
|
1845
|
-
"created_by_staff_uuid": "123e4567-
|
|
1845
|
+
"created_by_staff_uuid": "123e4567-86f6-47c3-a061-22fd8ba66d9b",
|
|
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-
|
|
2090
|
+
"uuid": "123e4567-3ba2-4814-8792-22fd89db767b",
|
|
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-
|
|
2097
|
-
"regarding_asset_type_uuid": "123e4567-
|
|
2096
|
+
"regarding_form_uuid": "123e4567-cf8b-4bd7-b13f-22fd84c1437b",
|
|
2097
|
+
"regarding_asset_type_uuid": "123e4567-cd39-4760-99eb-22fd87eafc7b"
|
|
2098
2098
|
}
|
|
2099
2099
|
]
|
|
2100
2100
|
}
|
|
@@ -2261,14 +2261,14 @@
|
|
|
2261
2261
|
"examples": {
|
|
2262
2262
|
"success": {
|
|
2263
2263
|
"value": {
|
|
2264
|
-
"uuid": "123e4567-
|
|
2264
|
+
"uuid": "123e4567-7363-4578-b9df-22fd8d86b15b",
|
|
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-
|
|
2271
|
-
"regarding_asset_type_uuid": "123e4567-
|
|
2270
|
+
"regarding_form_uuid": "123e4567-1a8f-468f-abab-22fd8993d4eb",
|
|
2271
|
+
"regarding_asset_type_uuid": "123e4567-89ea-4a49-b427-22fd84585eeb"
|
|
2272
2272
|
}
|
|
2273
2273
|
}
|
|
2274
2274
|
}
|
|
@@ -2508,7 +2508,7 @@
|
|
|
2508
2508
|
{
|
|
2509
2509
|
"name": "string",
|
|
2510
2510
|
"colour": "string",
|
|
2511
|
-
"uuid": "123e4567-
|
|
2511
|
+
"uuid": "123e4567-0804-40cb-8ff1-22fd810792db",
|
|
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-
|
|
2682
|
+
"uuid": "123e4567-2cfc-4b12-8e34-22fd8eefdd4b",
|
|
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-
|
|
2927
|
+
"uuid": "123e4567-db9f-4564-9b67-22fd8532aa3b",
|
|
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-
|
|
2939
|
+
"tax_rate_uuid": "123e4567-970b-4fe9-b6cc-22fd8660e9fb",
|
|
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-
|
|
3113
|
+
"uuid": "123e4567-10f3-4958-a080-22fd81ff424b",
|
|
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-
|
|
3125
|
+
"tax_rate_uuid": "123e4567-1377-447d-9c98-22fd88f488ab",
|
|
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-
|
|
3365
|
+
"uuid": "123e4567-c80c-4e1c-ae35-22fd85ded6fb",
|
|
3366
3366
|
"active": 1,
|
|
3367
3367
|
"edit_date": "2025-07-01 12:00:00",
|
|
3368
|
-
"company_uuid": "123e4567-
|
|
3368
|
+
"company_uuid": "123e4567-89d4-45f7-a142-22fd8852fe4b",
|
|
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-
|
|
3542
|
+
"uuid": "123e4567-b6c3-47be-9b9b-22fd89a7f8eb",
|
|
3543
3543
|
"active": 1,
|
|
3544
3544
|
"edit_date": "2025-07-01 12:00:00",
|
|
3545
|
-
"company_uuid": "123e4567-
|
|
3545
|
+
"company_uuid": "123e4567-73dc-474d-943a-22fd8b9a92cb",
|
|
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-
|
|
3788
|
+
"uuid": "123e4567-c96e-47b3-8afd-22fd8c244d9b",
|
|
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-
|
|
3956
|
+
"uuid": "123e4567-9e6b-44dd-8286-22fd8bb9159b",
|
|
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-
|
|
4193
|
+
"uuid": "123e4567-cbcf-495a-900c-22fd89de296b",
|
|
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-
|
|
4198
|
+
"related_object_uuid": "123e4567-3e62-4e79-b569-22fd87e7dfeb",
|
|
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-
|
|
4363
|
+
"uuid": "123e4567-3b35-42b3-a935-22fd85c20c4b",
|
|
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-
|
|
4368
|
+
"related_object_uuid": "123e4567-1abb-4ff4-a996-22fd85cebb8b",
|
|
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-
|
|
4603
|
+
"document_template_uuid": "123e4567-6959-42d1-98a7-22fd89b8ed0b",
|
|
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-
|
|
4614
|
+
"uuid": "123e4567-a984-45d8-9da4-22fd8f3694db",
|
|
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-
|
|
4780
|
+
"document_template_uuid": "123e4567-0e39-4464-8caa-22fd873477cb",
|
|
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-
|
|
4791
|
+
"uuid": "123e4567-a592-4a62-853b-22fd81ea1c5b",
|
|
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-
|
|
5025
|
+
"uuid": "123e4567-d085-4c7e-ab27-22fd88f66c0b",
|
|
5026
5026
|
"active": 1,
|
|
5027
5027
|
"edit_date": "2025-07-01 12:00:00",
|
|
5028
|
-
"form_uuid": "123e4567-
|
|
5028
|
+
"form_uuid": "123e4567-8286-410c-a76d-22fd8f973bcb",
|
|
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-
|
|
5194
|
+
"uuid": "123e4567-5320-47d0-a83c-22fd813a455b",
|
|
5195
5195
|
"active": 1,
|
|
5196
5196
|
"edit_date": "2025-07-01 12:00:00",
|
|
5197
|
-
"form_uuid": "123e4567-
|
|
5197
|
+
"form_uuid": "123e4567-3c24-4709-84a6-22fd8385a75b",
|
|
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-
|
|
5432
|
+
"uuid": "123e4567-d293-4045-9d31-22fd8bf3220b",
|
|
5433
5433
|
"active": 1,
|
|
5434
5434
|
"edit_date": "2025-07-01 12:00:00",
|
|
5435
|
-
"form_uuid": "123e4567-
|
|
5436
|
-
"staff_uuid": "123e4567-
|
|
5435
|
+
"form_uuid": "123e4567-41e2-4335-9224-22fd868102bb",
|
|
5436
|
+
"staff_uuid": "123e4567-4b55-4a9e-ab81-22fd8fc188fb",
|
|
5437
5437
|
"regarding_object": "string",
|
|
5438
|
-
"regarding_object_uuid": "123e4567-
|
|
5438
|
+
"regarding_object_uuid": "123e4567-c330-4fe7-b0b3-22fd81e9fa1b",
|
|
5439
5439
|
"field_data": "string",
|
|
5440
5440
|
"timestamp": "2025-07-01 12:00:00",
|
|
5441
|
-
"form_by_staff_uuid": "123e4567-
|
|
5442
|
-
"document_attachment_uuid": "123e4567-
|
|
5443
|
-
"asset_uuid": "123e4567-
|
|
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"
|
|
5444
5444
|
}
|
|
5445
5445
|
]
|
|
5446
5446
|
}
|
|
@@ -5603,18 +5603,18 @@
|
|
|
5603
5603
|
"examples": {
|
|
5604
5604
|
"success": {
|
|
5605
5605
|
"value": {
|
|
5606
|
-
"uuid": "123e4567-
|
|
5606
|
+
"uuid": "123e4567-67c7-419e-a425-22fd845ab6bb",
|
|
5607
5607
|
"active": 1,
|
|
5608
5608
|
"edit_date": "2025-07-01 12:00:00",
|
|
5609
|
-
"form_uuid": "123e4567-
|
|
5610
|
-
"staff_uuid": "123e4567-
|
|
5609
|
+
"form_uuid": "123e4567-4c32-4887-a9ea-22fd8672240b",
|
|
5610
|
+
"staff_uuid": "123e4567-acc4-4c21-943d-22fd8917278b",
|
|
5611
5611
|
"regarding_object": "string",
|
|
5612
|
-
"regarding_object_uuid": "123e4567-
|
|
5612
|
+
"regarding_object_uuid": "123e4567-29b4-4ce0-ba8e-22fd835475ab",
|
|
5613
5613
|
"field_data": "string",
|
|
5614
5614
|
"timestamp": "2025-07-01 12:00:00",
|
|
5615
|
-
"form_by_staff_uuid": "123e4567-
|
|
5616
|
-
"document_attachment_uuid": "123e4567-
|
|
5617
|
-
"asset_uuid": "123e4567-
|
|
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"
|
|
5618
5618
|
}
|
|
5619
5619
|
}
|
|
5620
5620
|
}
|
|
@@ -5815,158 +5815,6 @@
|
|
|
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
|
-
},
|
|
5970
5818
|
"/job.json": {
|
|
5971
5819
|
"get": {
|
|
5972
5820
|
"tags": [
|
|
@@ -6000,18 +5848,18 @@
|
|
|
6000
5848
|
"success": {
|
|
6001
5849
|
"value": [
|
|
6002
5850
|
{
|
|
6003
|
-
"created_by_staff_uuid": "123e4567-
|
|
5851
|
+
"created_by_staff_uuid": "123e4567-3a91-40b9-9d66-22fd80e858eb",
|
|
6004
5852
|
"date": "YYYY-MM-DD",
|
|
6005
|
-
"company_uuid": "123e4567-
|
|
5853
|
+
"company_uuid": "123e4567-ef30-4583-8cf2-22fd8762424b",
|
|
6006
5854
|
"billing_address": "string",
|
|
6007
5855
|
"status": "string",
|
|
6008
5856
|
"lng": "number",
|
|
6009
5857
|
"lat": "number",
|
|
6010
5858
|
"payment_date": "2025-07-01 12:00:00",
|
|
6011
|
-
"payment_actioned_by_uuid": "123e4567-
|
|
5859
|
+
"payment_actioned_by_uuid": "123e4567-db47-4dc5-b5dc-22fd8daf883b",
|
|
6012
5860
|
"payment_method": "string",
|
|
6013
5861
|
"payment_amount": "string",
|
|
6014
|
-
"category_uuid": "123e4567-
|
|
5862
|
+
"category_uuid": "123e4567-6ad5-447a-b010-22fd8df616db",
|
|
6015
5863
|
"payment_note": "string",
|
|
6016
5864
|
"geo_is_valid": "string",
|
|
6017
5865
|
"purchase_order_number": "string",
|
|
@@ -6025,9 +5873,9 @@
|
|
|
6025
5873
|
"geo_city": "string",
|
|
6026
5874
|
"geo_street": "string",
|
|
6027
5875
|
"geo_number": "string",
|
|
6028
|
-
"queue_uuid": "123e4567-
|
|
5876
|
+
"queue_uuid": "123e4567-d26b-41a4-a606-22fd800fd50b",
|
|
6029
5877
|
"queue_expiry_date": "2025-07-01 12:00:00",
|
|
6030
|
-
"queue_assigned_staff_uuid": "123e4567-
|
|
5878
|
+
"queue_assigned_staff_uuid": "123e4567-d368-41e3-8c01-22fd86b6e0db",
|
|
6031
5879
|
"badges": "string",
|
|
6032
5880
|
"quote_date": "2025-07-01 12:00:00",
|
|
6033
5881
|
"quote_sent": "string",
|
|
@@ -6035,7 +5883,7 @@
|
|
|
6035
5883
|
"work_order_date": "2025-07-01 12:00:00",
|
|
6036
5884
|
"active_network_request_uuid": "string",
|
|
6037
5885
|
"related_knowledge_articles": "string",
|
|
6038
|
-
"uuid": "123e4567-
|
|
5886
|
+
"uuid": "123e4567-16bd-4510-afab-22fd8c5a6c2b",
|
|
6039
5887
|
"active": 1,
|
|
6040
5888
|
"edit_date": "2025-07-01 12:00:00",
|
|
6041
5889
|
"job_address": "string",
|
|
@@ -6048,7 +5896,7 @@
|
|
|
6048
5896
|
"payment_received": "string",
|
|
6049
5897
|
"payment_received_stamp": "2025-07-01 12:00:00",
|
|
6050
5898
|
"completion_date": "2025-07-01 12:00:00",
|
|
6051
|
-
"completion_actioned_by_uuid": "123e4567-
|
|
5899
|
+
"completion_actioned_by_uuid": "123e4567-41c9-43ec-8213-22fd8e6a054b",
|
|
6052
5900
|
"unsuccessful_date": "2025-07-01 12:00:00",
|
|
6053
5901
|
"job_is_scheduled_until_stamp": "2025-07-01 12:00:00"
|
|
6054
5902
|
}
|
|
@@ -6217,18 +6065,18 @@
|
|
|
6217
6065
|
"examples": {
|
|
6218
6066
|
"success": {
|
|
6219
6067
|
"value": {
|
|
6220
|
-
"created_by_staff_uuid": "123e4567-
|
|
6068
|
+
"created_by_staff_uuid": "123e4567-d4c6-43f3-b07b-22fd8d32bf4b",
|
|
6221
6069
|
"date": "YYYY-MM-DD",
|
|
6222
|
-
"company_uuid": "123e4567-
|
|
6070
|
+
"company_uuid": "123e4567-0081-47df-9e78-22fd8bf6018b",
|
|
6223
6071
|
"billing_address": "string",
|
|
6224
6072
|
"status": "string",
|
|
6225
6073
|
"lng": "number",
|
|
6226
6074
|
"lat": "number",
|
|
6227
6075
|
"payment_date": "2025-07-01 12:00:00",
|
|
6228
|
-
"payment_actioned_by_uuid": "123e4567-
|
|
6076
|
+
"payment_actioned_by_uuid": "123e4567-d7bc-436c-8709-22fd8972321b",
|
|
6229
6077
|
"payment_method": "string",
|
|
6230
6078
|
"payment_amount": "string",
|
|
6231
|
-
"category_uuid": "123e4567-
|
|
6079
|
+
"category_uuid": "123e4567-225a-465d-a72f-22fd85fa71bb",
|
|
6232
6080
|
"payment_note": "string",
|
|
6233
6081
|
"geo_is_valid": "string",
|
|
6234
6082
|
"purchase_order_number": "string",
|
|
@@ -6242,9 +6090,9 @@
|
|
|
6242
6090
|
"geo_city": "string",
|
|
6243
6091
|
"geo_street": "string",
|
|
6244
6092
|
"geo_number": "string",
|
|
6245
|
-
"queue_uuid": "123e4567-
|
|
6093
|
+
"queue_uuid": "123e4567-7b52-48e2-a4f4-22fd88eec20b",
|
|
6246
6094
|
"queue_expiry_date": "2025-07-01 12:00:00",
|
|
6247
|
-
"queue_assigned_staff_uuid": "123e4567-
|
|
6095
|
+
"queue_assigned_staff_uuid": "123e4567-45e4-4900-abcb-22fd8b4c81cb",
|
|
6248
6096
|
"badges": "string",
|
|
6249
6097
|
"quote_date": "2025-07-01 12:00:00",
|
|
6250
6098
|
"quote_sent": "string",
|
|
@@ -6252,7 +6100,7 @@
|
|
|
6252
6100
|
"work_order_date": "2025-07-01 12:00:00",
|
|
6253
6101
|
"active_network_request_uuid": "string",
|
|
6254
6102
|
"related_knowledge_articles": "string",
|
|
6255
|
-
"uuid": "123e4567-
|
|
6103
|
+
"uuid": "123e4567-9280-4e78-8099-22fd8c20976b",
|
|
6256
6104
|
"active": 1,
|
|
6257
6105
|
"edit_date": "2025-07-01 12:00:00",
|
|
6258
6106
|
"job_address": "string",
|
|
@@ -6265,7 +6113,7 @@
|
|
|
6265
6113
|
"payment_received": "string",
|
|
6266
6114
|
"payment_received_stamp": "2025-07-01 12:00:00",
|
|
6267
6115
|
"completion_date": "2025-07-01 12:00:00",
|
|
6268
|
-
"completion_actioned_by_uuid": "123e4567-
|
|
6116
|
+
"completion_actioned_by_uuid": "123e4567-a90b-489d-b833-22fd8fc3dcdb",
|
|
6269
6117
|
"unsuccessful_date": "2025-07-01 12:00:00",
|
|
6270
6118
|
"job_is_scheduled_until_stamp": "2025-07-01 12:00:00"
|
|
6271
6119
|
}
|
|
@@ -6505,11 +6353,11 @@
|
|
|
6505
6353
|
"success": {
|
|
6506
6354
|
"value": [
|
|
6507
6355
|
{
|
|
6508
|
-
"uuid": "123e4567-
|
|
6356
|
+
"uuid": "123e4567-bddf-41af-b83b-22fd85900edb",
|
|
6509
6357
|
"active": 1,
|
|
6510
6358
|
"edit_date": "2025-07-01 12:00:00",
|
|
6511
|
-
"job_uuid": "123e4567-
|
|
6512
|
-
"staff_uuid": "123e4567-
|
|
6359
|
+
"job_uuid": "123e4567-cf14-421e-934e-22fd84769dfb",
|
|
6360
|
+
"staff_uuid": "123e4567-b436-46b5-a02b-22fd808fe80b",
|
|
6513
6361
|
"start_date": "2025-07-01 12:00:00",
|
|
6514
6362
|
"end_date": "2025-07-01 12:00:00",
|
|
6515
6363
|
"activity_was_scheduled": "string",
|
|
@@ -6519,10 +6367,10 @@
|
|
|
6519
6367
|
"has_been_opened_timestamp": "2025-07-01 12:00:00",
|
|
6520
6368
|
"travel_time_in_seconds": "string",
|
|
6521
6369
|
"travel_distance_in_meters": "string",
|
|
6522
|
-
"allocated_by_staff_uuid": "123e4567-
|
|
6370
|
+
"allocated_by_staff_uuid": "123e4567-a5c8-439c-9e71-22fd8b9e901b",
|
|
6523
6371
|
"allocated_timestamp": "2025-07-01 12:00:00",
|
|
6524
|
-
"material_uuid": "123e4567-
|
|
6525
|
-
"edit_by_staff_uuid": "123e4567-
|
|
6372
|
+
"material_uuid": "123e4567-c0ee-46ff-9114-22fd875ebcdb",
|
|
6373
|
+
"edit_by_staff_uuid": "123e4567-e9e3-4a40-b848-22fd8b813ecb"
|
|
6526
6374
|
}
|
|
6527
6375
|
]
|
|
6528
6376
|
}
|
|
@@ -6689,11 +6537,11 @@
|
|
|
6689
6537
|
"examples": {
|
|
6690
6538
|
"success": {
|
|
6691
6539
|
"value": {
|
|
6692
|
-
"uuid": "123e4567-
|
|
6540
|
+
"uuid": "123e4567-a486-425e-862b-22fd85f8d98b",
|
|
6693
6541
|
"active": 1,
|
|
6694
6542
|
"edit_date": "2025-07-01 12:00:00",
|
|
6695
|
-
"job_uuid": "123e4567-
|
|
6696
|
-
"staff_uuid": "123e4567-
|
|
6543
|
+
"job_uuid": "123e4567-c355-4be6-8677-22fd8210f5ab",
|
|
6544
|
+
"staff_uuid": "123e4567-034b-4275-9a9d-22fd8095af9b",
|
|
6697
6545
|
"start_date": "2025-07-01 12:00:00",
|
|
6698
6546
|
"end_date": "2025-07-01 12:00:00",
|
|
6699
6547
|
"activity_was_scheduled": "string",
|
|
@@ -6703,10 +6551,10 @@
|
|
|
6703
6551
|
"has_been_opened_timestamp": "2025-07-01 12:00:00",
|
|
6704
6552
|
"travel_time_in_seconds": "string",
|
|
6705
6553
|
"travel_distance_in_meters": "string",
|
|
6706
|
-
"allocated_by_staff_uuid": "123e4567-
|
|
6554
|
+
"allocated_by_staff_uuid": "123e4567-9063-4b8d-a759-22fd80f16adb",
|
|
6707
6555
|
"allocated_timestamp": "2025-07-01 12:00:00",
|
|
6708
|
-
"material_uuid": "123e4567-
|
|
6709
|
-
"edit_by_staff_uuid": "123e4567-
|
|
6556
|
+
"material_uuid": "123e4567-7784-4e83-886c-22fd8052ed8b",
|
|
6557
|
+
"edit_by_staff_uuid": "123e4567-863e-4163-94af-22fd8b1ca2fb"
|
|
6710
6558
|
}
|
|
6711
6559
|
}
|
|
6712
6560
|
}
|
|
@@ -6944,15 +6792,15 @@
|
|
|
6944
6792
|
"success": {
|
|
6945
6793
|
"value": [
|
|
6946
6794
|
{
|
|
6947
|
-
"uuid": "123e4567-
|
|
6795
|
+
"uuid": "123e4567-4f4b-4559-b1a6-22fd8397543b",
|
|
6948
6796
|
"active": 1,
|
|
6949
6797
|
"edit_date": "2025-07-01 12:00:00",
|
|
6950
|
-
"job_uuid": "123e4567-
|
|
6951
|
-
"queue_uuid": "123e4567-
|
|
6952
|
-
"staff_uuid": "123e4567-
|
|
6798
|
+
"job_uuid": "123e4567-b547-4fdc-b79d-22fd832f000b",
|
|
6799
|
+
"queue_uuid": "123e4567-7fa4-4b2a-a45f-22fd84eba95b",
|
|
6800
|
+
"staff_uuid": "123e4567-702d-45e9-ac09-22fd8b1d175b",
|
|
6953
6801
|
"allocation_date": "2025-07-01 12:00:00",
|
|
6954
|
-
"allocation_window_uuid": "123e4567-
|
|
6955
|
-
"allocated_by_staff_uuid": "123e4567-
|
|
6802
|
+
"allocation_window_uuid": "123e4567-5231-4fa6-835f-22fd87a7539b",
|
|
6803
|
+
"allocated_by_staff_uuid": "123e4567-8957-4d42-96c0-22fd8d4f062b",
|
|
6956
6804
|
"allocated_timestamp": "2025-07-01 12:00:00",
|
|
6957
6805
|
"expiry_timestamp": "2025-07-01 12:00:00",
|
|
6958
6806
|
"read_timestamp": "2025-07-01 12:00:00",
|
|
@@ -7129,15 +6977,15 @@
|
|
|
7129
6977
|
"examples": {
|
|
7130
6978
|
"success": {
|
|
7131
6979
|
"value": {
|
|
7132
|
-
"uuid": "123e4567-
|
|
6980
|
+
"uuid": "123e4567-9ffb-4236-9f53-22fd8584b13b",
|
|
7133
6981
|
"active": 1,
|
|
7134
6982
|
"edit_date": "2025-07-01 12:00:00",
|
|
7135
|
-
"job_uuid": "123e4567-
|
|
7136
|
-
"queue_uuid": "123e4567-
|
|
7137
|
-
"staff_uuid": "123e4567-
|
|
6983
|
+
"job_uuid": "123e4567-3dae-4766-b2a1-22fd8b9369db",
|
|
6984
|
+
"queue_uuid": "123e4567-3e4e-4e26-8f69-22fd82b2f74b",
|
|
6985
|
+
"staff_uuid": "123e4567-c2e4-4cf4-8e7c-22fd8389410b",
|
|
7138
6986
|
"allocation_date": "2025-07-01 12:00:00",
|
|
7139
|
-
"allocation_window_uuid": "123e4567-
|
|
7140
|
-
"allocated_by_staff_uuid": "123e4567-
|
|
6987
|
+
"allocation_window_uuid": "123e4567-8b0d-4f2d-a0de-22fd8404c13b",
|
|
6988
|
+
"allocated_by_staff_uuid": "123e4567-7532-4cc7-b49e-22fd845761ab",
|
|
7141
6989
|
"allocated_timestamp": "2025-07-01 12:00:00",
|
|
7142
6990
|
"expiry_timestamp": "2025-07-01 12:00:00",
|
|
7143
6991
|
"read_timestamp": "2025-07-01 12:00:00",
|
|
@@ -7383,27 +7231,27 @@
|
|
|
7383
7231
|
"success": {
|
|
7384
7232
|
"value": [
|
|
7385
7233
|
{
|
|
7386
|
-
"uuid": "123e4567-
|
|
7234
|
+
"uuid": "123e4567-aa49-47ec-92eb-22fd811f8d6b",
|
|
7387
7235
|
"active": 1,
|
|
7388
7236
|
"edit_date": "2025-07-01 12:00:00",
|
|
7389
|
-
"job_uuid": "123e4567-
|
|
7237
|
+
"job_uuid": "123e4567-24d0-4d98-b8c8-22fd865af7eb",
|
|
7390
7238
|
"name": "string",
|
|
7391
7239
|
"section_name": "string",
|
|
7392
7240
|
"item_type": "string",
|
|
7393
7241
|
"sort_order": "string",
|
|
7394
7242
|
"completed_timestamp": "2025-07-01 12:00:00",
|
|
7395
|
-
"completed_by_staff_uuid": "123e4567-
|
|
7396
|
-
"completed_during_checkin_uuid": "123e4567-
|
|
7243
|
+
"completed_by_staff_uuid": "123e4567-4208-4172-b147-22fd85fd3e6b",
|
|
7244
|
+
"completed_during_checkin_uuid": "123e4567-3379-4499-a6e9-22fd8339a92b",
|
|
7397
7245
|
"reminder_type": "string",
|
|
7398
7246
|
"reminder_data": "string",
|
|
7399
7247
|
"regarding_object": "string",
|
|
7400
|
-
"regarding_object_uuid": "123e4567-
|
|
7248
|
+
"regarding_object_uuid": "123e4567-a364-4fdf-a4d5-22fd873eedbb",
|
|
7401
7249
|
"fulfilled_by_object_name": "string",
|
|
7402
|
-
"fulfilled_by_object_uuid": "123e4567-
|
|
7403
|
-
"assigned_to_staff_uuids": "123e4567-
|
|
7250
|
+
"fulfilled_by_object_uuid": "123e4567-f08f-4fb9-8420-22fd8709d01b",
|
|
7251
|
+
"assigned_to_staff_uuids": "123e4567-877a-4309-906f-22fd857a663b",
|
|
7404
7252
|
"is_locked": "string",
|
|
7405
7253
|
"assigned_timestamp": "2025-07-01 12:00:00",
|
|
7406
|
-
"assigned_by_staff_uuid": "123e4567-
|
|
7254
|
+
"assigned_by_staff_uuid": "123e4567-e33b-4d1e-97a0-22fd8eb5a4bb"
|
|
7407
7255
|
}
|
|
7408
7256
|
]
|
|
7409
7257
|
}
|
|
@@ -7566,27 +7414,27 @@
|
|
|
7566
7414
|
"examples": {
|
|
7567
7415
|
"success": {
|
|
7568
7416
|
"value": {
|
|
7569
|
-
"uuid": "123e4567-
|
|
7417
|
+
"uuid": "123e4567-6c23-4293-8375-22fd81c0650b",
|
|
7570
7418
|
"active": 1,
|
|
7571
7419
|
"edit_date": "2025-07-01 12:00:00",
|
|
7572
|
-
"job_uuid": "123e4567-
|
|
7420
|
+
"job_uuid": "123e4567-3816-4e1f-9e82-22fd89605f5b",
|
|
7573
7421
|
"name": "string",
|
|
7574
7422
|
"section_name": "string",
|
|
7575
7423
|
"item_type": "string",
|
|
7576
7424
|
"sort_order": "string",
|
|
7577
7425
|
"completed_timestamp": "2025-07-01 12:00:00",
|
|
7578
|
-
"completed_by_staff_uuid": "123e4567-
|
|
7579
|
-
"completed_during_checkin_uuid": "123e4567-
|
|
7426
|
+
"completed_by_staff_uuid": "123e4567-f474-49a6-aed4-22fd82d2ea9b",
|
|
7427
|
+
"completed_during_checkin_uuid": "123e4567-fbf1-40bf-9fb0-22fd8a6759bb",
|
|
7580
7428
|
"reminder_type": "string",
|
|
7581
7429
|
"reminder_data": "string",
|
|
7582
7430
|
"regarding_object": "string",
|
|
7583
|
-
"regarding_object_uuid": "123e4567-
|
|
7431
|
+
"regarding_object_uuid": "123e4567-778d-4da5-9ecd-22fd84ea4e6b",
|
|
7584
7432
|
"fulfilled_by_object_name": "string",
|
|
7585
|
-
"fulfilled_by_object_uuid": "123e4567-
|
|
7586
|
-
"assigned_to_staff_uuids": "123e4567-
|
|
7433
|
+
"fulfilled_by_object_uuid": "123e4567-b02c-4503-b0dc-22fd8d068fdb",
|
|
7434
|
+
"assigned_to_staff_uuids": "123e4567-f335-449f-813d-22fd8caa2feb",
|
|
7587
7435
|
"is_locked": "string",
|
|
7588
7436
|
"assigned_timestamp": "2025-07-01 12:00:00",
|
|
7589
|
-
"assigned_by_staff_uuid": "123e4567-
|
|
7437
|
+
"assigned_by_staff_uuid": "123e4567-a1f2-4019-9faa-22fd8e6b1e8b"
|
|
7590
7438
|
}
|
|
7591
7439
|
}
|
|
7592
7440
|
}
|
|
@@ -7820,10 +7668,10 @@
|
|
|
7820
7668
|
"success": {
|
|
7821
7669
|
"value": [
|
|
7822
7670
|
{
|
|
7823
|
-
"uuid": "123e4567-
|
|
7671
|
+
"uuid": "123e4567-2c70-4da5-a55f-22fd8e970efb",
|
|
7824
7672
|
"active": 1,
|
|
7825
7673
|
"edit_date": "2025-07-01 12:00:00",
|
|
7826
|
-
"job_uuid": "123e4567-
|
|
7674
|
+
"job_uuid": "123e4567-ece7-4658-9a35-22fd820b69db",
|
|
7827
7675
|
"first": "string",
|
|
7828
7676
|
"last": "string",
|
|
7829
7677
|
"phone": "string",
|
|
@@ -7997,10 +7845,10 @@
|
|
|
7997
7845
|
"examples": {
|
|
7998
7846
|
"success": {
|
|
7999
7847
|
"value": {
|
|
8000
|
-
"uuid": "123e4567-
|
|
7848
|
+
"uuid": "123e4567-7b02-4dea-ac87-22fd806d190b",
|
|
8001
7849
|
"active": 1,
|
|
8002
7850
|
"edit_date": "2025-07-01 12:00:00",
|
|
8003
|
-
"job_uuid": "123e4567-
|
|
7851
|
+
"job_uuid": "123e4567-9f96-4e24-92fe-22fd8a95768b",
|
|
8004
7852
|
"first": "string",
|
|
8005
7853
|
"last": "string",
|
|
8006
7854
|
"phone": "string",
|
|
@@ -8245,21 +8093,21 @@
|
|
|
8245
8093
|
"success": {
|
|
8246
8094
|
"value": [
|
|
8247
8095
|
{
|
|
8248
|
-
"uuid": "123e4567-
|
|
8096
|
+
"uuid": "123e4567-0596-47e8-b12b-22fd8f0d746b",
|
|
8249
8097
|
"active": 1,
|
|
8250
8098
|
"edit_date": "2025-07-01 12:00:00",
|
|
8251
|
-
"job_uuid": "123e4567-
|
|
8252
|
-
"material_uuid": "123e4567-
|
|
8099
|
+
"job_uuid": "123e4567-2759-4d31-9b8b-22fd8564bebb",
|
|
8100
|
+
"material_uuid": "123e4567-53d5-411a-b03b-22fd881743cb",
|
|
8253
8101
|
"name": "string",
|
|
8254
8102
|
"quantity": "string",
|
|
8255
8103
|
"price": "string",
|
|
8256
8104
|
"displayed_amount": "string",
|
|
8257
8105
|
"displayed_amount_is_tax_inclusive": "string",
|
|
8258
|
-
"tax_rate_uuid": "123e4567-
|
|
8106
|
+
"tax_rate_uuid": "123e4567-288c-47a4-af24-22fd85ea99ab",
|
|
8259
8107
|
"sort_order": "string",
|
|
8260
8108
|
"cost": "string",
|
|
8261
8109
|
"displayed_cost": "string",
|
|
8262
|
-
"job_material_bundle_uuid": "123e4567-
|
|
8110
|
+
"job_material_bundle_uuid": "123e4567-78b5-447d-a39a-22fd872184fb"
|
|
8263
8111
|
}
|
|
8264
8112
|
]
|
|
8265
8113
|
}
|
|
@@ -8426,21 +8274,21 @@
|
|
|
8426
8274
|
"examples": {
|
|
8427
8275
|
"success": {
|
|
8428
8276
|
"value": {
|
|
8429
|
-
"uuid": "123e4567-
|
|
8277
|
+
"uuid": "123e4567-bc2a-4a90-a136-22fd813386bb",
|
|
8430
8278
|
"active": 1,
|
|
8431
8279
|
"edit_date": "2025-07-01 12:00:00",
|
|
8432
|
-
"job_uuid": "123e4567-
|
|
8433
|
-
"material_uuid": "123e4567-
|
|
8280
|
+
"job_uuid": "123e4567-27ee-4d40-a509-22fd82d7b65b",
|
|
8281
|
+
"material_uuid": "123e4567-e840-440a-ad2e-22fd848b8e9b",
|
|
8434
8282
|
"name": "string",
|
|
8435
8283
|
"quantity": "string",
|
|
8436
8284
|
"price": "string",
|
|
8437
8285
|
"displayed_amount": "string",
|
|
8438
8286
|
"displayed_amount_is_tax_inclusive": "string",
|
|
8439
|
-
"tax_rate_uuid": "123e4567-
|
|
8287
|
+
"tax_rate_uuid": "123e4567-11de-4b12-89e4-22fd85bb05cb",
|
|
8440
8288
|
"sort_order": "string",
|
|
8441
8289
|
"cost": "string",
|
|
8442
8290
|
"displayed_cost": "string",
|
|
8443
|
-
"job_material_bundle_uuid": "123e4567-
|
|
8291
|
+
"job_material_bundle_uuid": "123e4567-bc0c-41fc-b463-22fd8743c70b"
|
|
8444
8292
|
}
|
|
8445
8293
|
}
|
|
8446
8294
|
}
|
|
@@ -8676,15 +8524,15 @@
|
|
|
8676
8524
|
"success": {
|
|
8677
8525
|
"value": [
|
|
8678
8526
|
{
|
|
8679
|
-
"uuid": "123e4567-
|
|
8527
|
+
"uuid": "123e4567-797c-481f-8351-22fd839cc88b",
|
|
8680
8528
|
"active": 1,
|
|
8681
8529
|
"edit_date": "2025-07-01 12:00:00",
|
|
8682
8530
|
"item_number": "string",
|
|
8683
8531
|
"name": "string",
|
|
8684
8532
|
"quantity": "string",
|
|
8685
8533
|
"sort_order": "string",
|
|
8686
|
-
"material_bundle_uuid": "123e4567-
|
|
8687
|
-
"job_uuid": "123e4567-
|
|
8534
|
+
"material_bundle_uuid": "123e4567-1948-4d94-9da8-22fd8326406b",
|
|
8535
|
+
"job_uuid": "123e4567-bf88-4f9f-b9ae-22fd8ef9e2bb"
|
|
8688
8536
|
}
|
|
8689
8537
|
]
|
|
8690
8538
|
}
|
|
@@ -8847,430 +8695,15 @@
|
|
|
8847
8695
|
"examples": {
|
|
8848
8696
|
"success": {
|
|
8849
8697
|
"value": {
|
|
8850
|
-
"uuid": "123e4567-
|
|
8698
|
+
"uuid": "123e4567-c7f3-458c-b37e-22fd8b68fb3b",
|
|
8851
8699
|
"active": 1,
|
|
8852
8700
|
"edit_date": "2025-07-01 12:00:00",
|
|
8853
8701
|
"item_number": "string",
|
|
8854
8702
|
"name": "string",
|
|
8855
8703
|
"quantity": "string",
|
|
8856
8704
|
"sort_order": "string",
|
|
8857
|
-
"material_bundle_uuid": "123e4567-
|
|
8858
|
-
"job_uuid": "123e4567-
|
|
8859
|
-
}
|
|
8860
|
-
}
|
|
8861
|
-
}
|
|
8862
|
-
}
|
|
8863
|
-
}
|
|
8864
|
-
},
|
|
8865
|
-
"400": {
|
|
8866
|
-
"description": "Bad Request",
|
|
8867
|
-
"content": {
|
|
8868
|
-
"application/json": {
|
|
8869
|
-
"schema": {
|
|
8870
|
-
"$ref": "#/components/schemas/Error"
|
|
8871
|
-
},
|
|
8872
|
-
"examples": {
|
|
8873
|
-
"badRequest": {
|
|
8874
|
-
"value": {
|
|
8875
|
-
"errorCode": "1000",
|
|
8876
|
-
"message": "An error occurred completing your request"
|
|
8877
|
-
}
|
|
8878
|
-
}
|
|
8879
|
-
}
|
|
8880
|
-
}
|
|
8881
|
-
}
|
|
8882
|
-
},
|
|
8883
|
-
"default": {
|
|
8884
|
-
"description": "Unexpected error",
|
|
8885
|
-
"content": {
|
|
8886
|
-
"application/json": {
|
|
8887
|
-
"schema": {
|
|
8888
|
-
"$ref": "#/components/schemas/Error"
|
|
8889
|
-
}
|
|
8890
|
-
}
|
|
8891
|
-
}
|
|
8892
|
-
}
|
|
8893
|
-
}
|
|
8894
|
-
},
|
|
8895
|
-
"post": {
|
|
8896
|
-
"tags": [
|
|
8897
|
-
"Job Material Bundles"
|
|
8898
|
-
],
|
|
8899
|
-
"operationId": "updateJobMaterialBundles",
|
|
8900
|
-
"summary": "Update a Job Material Bundle",
|
|
8901
|
-
"description": "",
|
|
8902
|
-
"security": [
|
|
8903
|
-
{
|
|
8904
|
-
"apiKey": []
|
|
8905
|
-
},
|
|
8906
|
-
{
|
|
8907
|
-
"oauth2": []
|
|
8908
|
-
}
|
|
8909
|
-
],
|
|
8910
|
-
"parameters": [
|
|
8911
|
-
{
|
|
8912
|
-
"name": "uuid",
|
|
8913
|
-
"in": "path",
|
|
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-047f-4d89-9f42-22fc07b07ccb",
|
|
9091
|
-
"active": 1,
|
|
9092
|
-
"edit_date": "2025-07-01 12:00:00",
|
|
9093
|
-
"job_uuid": "123e4567-dee3-4d04-859a-22fc088adefb",
|
|
9094
|
-
"actioned_by_uuid": "123e4567-ef8e-4b16-822b-22fc0ea0b5cb",
|
|
9095
|
-
"timestamp": "string",
|
|
9096
|
-
"amount": "string",
|
|
9097
|
-
"method": "string",
|
|
9098
|
-
"note": "string",
|
|
9099
|
-
"attachment_uuid": "123e4567-f77c-42bb-b9af-22fc0fe406fb",
|
|
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-a131-4c2c-bf06-22fc0da8126b",
|
|
9264
|
-
"active": 1,
|
|
9265
|
-
"edit_date": "2025-07-01 12:00:00",
|
|
9266
|
-
"job_uuid": "123e4567-f379-43fa-b518-22fc01c7c83b",
|
|
9267
|
-
"actioned_by_uuid": "123e4567-b976-4606-97ae-22fc022bbf4b",
|
|
9268
|
-
"timestamp": "string",
|
|
9269
|
-
"amount": "string",
|
|
9270
|
-
"method": "string",
|
|
9271
|
-
"note": "string",
|
|
9272
|
-
"attachment_uuid": "123e4567-af6e-4739-a91c-22fc024e2c5b",
|
|
9273
|
-
"is_deposit": "string"
|
|
8705
|
+
"material_bundle_uuid": "123e4567-c218-40a1-a566-22fd883e4d0b",
|
|
8706
|
+
"job_uuid": "123e4567-b4bc-4287-9692-22fd857e31bb"
|
|
9274
8707
|
}
|
|
9275
8708
|
}
|
|
9276
8709
|
}
|
|
@@ -9309,10 +8742,10 @@
|
|
|
9309
8742
|
},
|
|
9310
8743
|
"post": {
|
|
9311
8744
|
"tags": [
|
|
9312
|
-
"Job
|
|
8745
|
+
"Job Material Bundles"
|
|
9313
8746
|
],
|
|
9314
|
-
"operationId": "
|
|
9315
|
-
"summary": "Update a Job
|
|
8747
|
+
"operationId": "updateJobMaterialBundles",
|
|
8748
|
+
"summary": "Update a Job Material Bundle",
|
|
9316
8749
|
"description": "",
|
|
9317
8750
|
"security": [
|
|
9318
8751
|
{
|
|
@@ -9326,7 +8759,7 @@
|
|
|
9326
8759
|
{
|
|
9327
8760
|
"name": "uuid",
|
|
9328
8761
|
"in": "path",
|
|
9329
|
-
"description": "UUID of the Job
|
|
8762
|
+
"description": "UUID of the Job Material Bundle",
|
|
9330
8763
|
"required": true,
|
|
9331
8764
|
"schema": {
|
|
9332
8765
|
"type": "string",
|
|
@@ -9335,12 +8768,12 @@
|
|
|
9335
8768
|
}
|
|
9336
8769
|
],
|
|
9337
8770
|
"requestBody": {
|
|
9338
|
-
"description": "Job
|
|
8771
|
+
"description": "Job Material Bundle fields to update",
|
|
9339
8772
|
"required": true,
|
|
9340
8773
|
"content": {
|
|
9341
8774
|
"application/json": {
|
|
9342
8775
|
"schema": {
|
|
9343
|
-
"$ref": "#/components/schemas/
|
|
8776
|
+
"$ref": "#/components/schemas/JobMaterialBundle"
|
|
9344
8777
|
}
|
|
9345
8778
|
}
|
|
9346
8779
|
}
|
|
@@ -9396,10 +8829,10 @@
|
|
|
9396
8829
|
},
|
|
9397
8830
|
"delete": {
|
|
9398
8831
|
"tags": [
|
|
9399
|
-
"Job
|
|
8832
|
+
"Job Material Bundles"
|
|
9400
8833
|
],
|
|
9401
|
-
"operationId": "
|
|
9402
|
-
"summary": "Delete a Job
|
|
8834
|
+
"operationId": "deleteJobMaterialBundles",
|
|
8835
|
+
"summary": "Delete a Job Material Bundle",
|
|
9403
8836
|
"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",
|
|
9404
8837
|
"security": [
|
|
9405
8838
|
{
|
|
@@ -9413,7 +8846,7 @@
|
|
|
9413
8846
|
{
|
|
9414
8847
|
"name": "uuid",
|
|
9415
8848
|
"in": "path",
|
|
9416
|
-
"description": "UUID of the Job
|
|
8849
|
+
"description": "UUID of the Job Material Bundle",
|
|
9417
8850
|
"required": true,
|
|
9418
8851
|
"schema": {
|
|
9419
8852
|
"type": "string",
|
|
@@ -9423,7 +8856,7 @@
|
|
|
9423
8856
|
],
|
|
9424
8857
|
"responses": {
|
|
9425
8858
|
"200": {
|
|
9426
|
-
"description": "Job
|
|
8859
|
+
"description": "Job Material Bundle successfully archived",
|
|
9427
8860
|
"content": {
|
|
9428
8861
|
"application/json": {
|
|
9429
8862
|
"schema": {
|
|
@@ -9471,43 +8904,48 @@
|
|
|
9471
8904
|
}
|
|
9472
8905
|
}
|
|
9473
8906
|
},
|
|
9474
|
-
"/
|
|
8907
|
+
"/jobpayment.json": {
|
|
9475
8908
|
"get": {
|
|
9476
8909
|
"tags": [
|
|
9477
|
-
"Job
|
|
8910
|
+
"Job Payments"
|
|
9478
8911
|
],
|
|
9479
|
-
"operationId": "
|
|
9480
|
-
"summary": "List all Job
|
|
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
|
|
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",
|
|
9482
8915
|
"security": [
|
|
9483
8916
|
{
|
|
9484
8917
|
"apiKey": []
|
|
9485
8918
|
},
|
|
9486
8919
|
{
|
|
9487
|
-
"oauth2": [
|
|
9488
|
-
"read_jobs"
|
|
9489
|
-
]
|
|
8920
|
+
"oauth2": []
|
|
9490
8921
|
}
|
|
9491
8922
|
],
|
|
9492
8923
|
"responses": {
|
|
9493
8924
|
"200": {
|
|
9494
|
-
"description": "An array of Job
|
|
8925
|
+
"description": "An array of Job Payments",
|
|
9495
8926
|
"content": {
|
|
9496
8927
|
"application/json": {
|
|
9497
8928
|
"schema": {
|
|
9498
8929
|
"type": "array",
|
|
9499
8930
|
"items": {
|
|
9500
|
-
"$ref": "#/components/schemas/
|
|
8931
|
+
"$ref": "#/components/schemas/JobPayment"
|
|
9501
8932
|
}
|
|
9502
8933
|
},
|
|
9503
8934
|
"examples": {
|
|
9504
8935
|
"success": {
|
|
9505
8936
|
"value": [
|
|
9506
8937
|
{
|
|
9507
|
-
"uuid": "123e4567-
|
|
8938
|
+
"uuid": "123e4567-3736-4603-9dd7-22fd88e7061b",
|
|
9508
8939
|
"active": 1,
|
|
9509
8940
|
"edit_date": "2025-07-01 12:00:00",
|
|
9510
|
-
"
|
|
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"
|
|
9511
8949
|
}
|
|
9512
8950
|
]
|
|
9513
8951
|
}
|
|
@@ -9547,29 +8985,27 @@
|
|
|
9547
8985
|
},
|
|
9548
8986
|
"post": {
|
|
9549
8987
|
"tags": [
|
|
9550
|
-
"Job
|
|
8988
|
+
"Job Payments"
|
|
9551
8989
|
],
|
|
9552
|
-
"operationId": "
|
|
9553
|
-
"summary": "Create a new Job
|
|
9554
|
-
"description": "\n\t\t\t\n####
|
|
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",
|
|
9555
8993
|
"security": [
|
|
9556
8994
|
{
|
|
9557
8995
|
"apiKey": []
|
|
9558
8996
|
},
|
|
9559
8997
|
{
|
|
9560
|
-
"oauth2": [
|
|
9561
|
-
"manage_jobs"
|
|
9562
|
-
]
|
|
8998
|
+
"oauth2": []
|
|
9563
8999
|
}
|
|
9564
9000
|
],
|
|
9565
9001
|
"parameters": [],
|
|
9566
9002
|
"requestBody": {
|
|
9567
|
-
"description": "Job
|
|
9003
|
+
"description": "Job Payment record to create",
|
|
9568
9004
|
"required": true,
|
|
9569
9005
|
"content": {
|
|
9570
9006
|
"application/json": {
|
|
9571
9007
|
"schema": {
|
|
9572
|
-
"$ref": "#/components/schemas/
|
|
9008
|
+
"$ref": "#/components/schemas/JobPayment"
|
|
9573
9009
|
}
|
|
9574
9010
|
}
|
|
9575
9011
|
}
|
|
@@ -9578,7 +9014,7 @@
|
|
|
9578
9014
|
"200": {
|
|
9579
9015
|
"headers": {
|
|
9580
9016
|
"x-record-uuid": {
|
|
9581
|
-
"description": "UUID of newly created Job
|
|
9017
|
+
"description": "UUID of newly created Job Payment record",
|
|
9582
9018
|
"schema": {
|
|
9583
9019
|
"type": "string",
|
|
9584
9020
|
"format": "uuid"
|
|
@@ -9633,29 +9069,27 @@
|
|
|
9633
9069
|
}
|
|
9634
9070
|
}
|
|
9635
9071
|
},
|
|
9636
|
-
"/
|
|
9072
|
+
"/jobpayment/{uuid}.json": {
|
|
9637
9073
|
"get": {
|
|
9638
9074
|
"tags": [
|
|
9639
|
-
"Job
|
|
9075
|
+
"Job Payments"
|
|
9640
9076
|
],
|
|
9641
|
-
"operationId": "
|
|
9642
|
-
"summary": "Retrieve a Job
|
|
9643
|
-
"description": "
|
|
9077
|
+
"operationId": "getJobPayments",
|
|
9078
|
+
"summary": "Retrieve a Job Payment",
|
|
9079
|
+
"description": "",
|
|
9644
9080
|
"security": [
|
|
9645
9081
|
{
|
|
9646
9082
|
"apiKey": []
|
|
9647
9083
|
},
|
|
9648
9084
|
{
|
|
9649
|
-
"oauth2": [
|
|
9650
|
-
"read_jobs"
|
|
9651
|
-
]
|
|
9085
|
+
"oauth2": []
|
|
9652
9086
|
}
|
|
9653
9087
|
],
|
|
9654
9088
|
"parameters": [
|
|
9655
9089
|
{
|
|
9656
9090
|
"name": "uuid",
|
|
9657
9091
|
"in": "path",
|
|
9658
|
-
"description": "UUID of the Job
|
|
9092
|
+
"description": "UUID of the Job Payment",
|
|
9659
9093
|
"required": true,
|
|
9660
9094
|
"schema": {
|
|
9661
9095
|
"type": "string",
|
|
@@ -9665,19 +9099,26 @@
|
|
|
9665
9099
|
],
|
|
9666
9100
|
"responses": {
|
|
9667
9101
|
"200": {
|
|
9668
|
-
"description": "Job
|
|
9102
|
+
"description": "Job Payment record",
|
|
9669
9103
|
"content": {
|
|
9670
9104
|
"application/json": {
|
|
9671
9105
|
"schema": {
|
|
9672
|
-
"$ref": "#/components/schemas/
|
|
9106
|
+
"$ref": "#/components/schemas/JobPayment"
|
|
9673
9107
|
},
|
|
9674
9108
|
"examples": {
|
|
9675
9109
|
"success": {
|
|
9676
9110
|
"value": {
|
|
9677
|
-
"uuid": "123e4567-
|
|
9111
|
+
"uuid": "123e4567-82d2-4ad2-8313-22fd815360eb",
|
|
9678
9112
|
"active": 1,
|
|
9679
9113
|
"edit_date": "2025-07-01 12:00:00",
|
|
9680
|
-
"
|
|
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"
|
|
9681
9122
|
}
|
|
9682
9123
|
}
|
|
9683
9124
|
}
|
|
@@ -9716,26 +9157,24 @@
|
|
|
9716
9157
|
},
|
|
9717
9158
|
"post": {
|
|
9718
9159
|
"tags": [
|
|
9719
|
-
"Job
|
|
9160
|
+
"Job Payments"
|
|
9720
9161
|
],
|
|
9721
|
-
"operationId": "
|
|
9722
|
-
"summary": "Update a Job
|
|
9723
|
-
"description": "
|
|
9162
|
+
"operationId": "updateJobPayments",
|
|
9163
|
+
"summary": "Update a Job Payment",
|
|
9164
|
+
"description": "",
|
|
9724
9165
|
"security": [
|
|
9725
9166
|
{
|
|
9726
9167
|
"apiKey": []
|
|
9727
9168
|
},
|
|
9728
9169
|
{
|
|
9729
|
-
"oauth2": [
|
|
9730
|
-
"manage_jobs"
|
|
9731
|
-
]
|
|
9170
|
+
"oauth2": []
|
|
9732
9171
|
}
|
|
9733
9172
|
],
|
|
9734
9173
|
"parameters": [
|
|
9735
9174
|
{
|
|
9736
9175
|
"name": "uuid",
|
|
9737
9176
|
"in": "path",
|
|
9738
|
-
"description": "UUID of the Job
|
|
9177
|
+
"description": "UUID of the Job Payment",
|
|
9739
9178
|
"required": true,
|
|
9740
9179
|
"schema": {
|
|
9741
9180
|
"type": "string",
|
|
@@ -9744,12 +9183,12 @@
|
|
|
9744
9183
|
}
|
|
9745
9184
|
],
|
|
9746
9185
|
"requestBody": {
|
|
9747
|
-
"description": "Job
|
|
9186
|
+
"description": "Job Payment fields to update",
|
|
9748
9187
|
"required": true,
|
|
9749
9188
|
"content": {
|
|
9750
9189
|
"application/json": {
|
|
9751
9190
|
"schema": {
|
|
9752
|
-
"$ref": "#/components/schemas/
|
|
9191
|
+
"$ref": "#/components/schemas/JobPayment"
|
|
9753
9192
|
}
|
|
9754
9193
|
}
|
|
9755
9194
|
}
|
|
@@ -9805,26 +9244,24 @@
|
|
|
9805
9244
|
},
|
|
9806
9245
|
"delete": {
|
|
9807
9246
|
"tags": [
|
|
9808
|
-
"Job
|
|
9247
|
+
"Job Payments"
|
|
9809
9248
|
],
|
|
9810
|
-
"operationId": "
|
|
9811
|
-
"summary": "Delete a Job
|
|
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
|
|
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",
|
|
9813
9252
|
"security": [
|
|
9814
9253
|
{
|
|
9815
9254
|
"apiKey": []
|
|
9816
9255
|
},
|
|
9817
9256
|
{
|
|
9818
|
-
"oauth2": [
|
|
9819
|
-
"manage_jobs"
|
|
9820
|
-
]
|
|
9257
|
+
"oauth2": []
|
|
9821
9258
|
}
|
|
9822
9259
|
],
|
|
9823
9260
|
"parameters": [
|
|
9824
9261
|
{
|
|
9825
9262
|
"name": "uuid",
|
|
9826
9263
|
"in": "path",
|
|
9827
|
-
"description": "UUID of the Job
|
|
9264
|
+
"description": "UUID of the Job Payment",
|
|
9828
9265
|
"required": true,
|
|
9829
9266
|
"schema": {
|
|
9830
9267
|
"type": "string",
|
|
@@ -9834,7 +9271,7 @@
|
|
|
9834
9271
|
],
|
|
9835
9272
|
"responses": {
|
|
9836
9273
|
"200": {
|
|
9837
|
-
"description": "Job
|
|
9274
|
+
"description": "Job Payment successfully archived",
|
|
9838
9275
|
"content": {
|
|
9839
9276
|
"application/json": {
|
|
9840
9277
|
"schema": {
|
|
@@ -9915,7 +9352,7 @@
|
|
|
9915
9352
|
"success": {
|
|
9916
9353
|
"value": [
|
|
9917
9354
|
{
|
|
9918
|
-
"uuid": "123e4567-
|
|
9355
|
+
"uuid": "123e4567-8dec-4be8-a8fa-22fd812b808b",
|
|
9919
9356
|
"active": 1,
|
|
9920
9357
|
"edit_date": "2025-07-01 12:00:00",
|
|
9921
9358
|
"name": "string",
|
|
@@ -10096,7 +9533,7 @@
|
|
|
10096
9533
|
"examples": {
|
|
10097
9534
|
"success": {
|
|
10098
9535
|
"value": {
|
|
10099
|
-
"uuid": "123e4567-
|
|
9536
|
+
"uuid": "123e4567-0ca9-4c34-b670-22fd89f0d05b",
|
|
10100
9537
|
"active": 1,
|
|
10101
9538
|
"edit_date": "2025-07-01 12:00:00",
|
|
10102
9539
|
"name": "string",
|
|
@@ -10359,7 +9796,7 @@
|
|
|
10359
9796
|
"state": "string",
|
|
10360
9797
|
"lng": "number",
|
|
10361
9798
|
"lat": "number",
|
|
10362
|
-
"uuid": "123e4567-
|
|
9799
|
+
"uuid": "123e4567-3977-4e1c-9e82-22fd8df6a92b",
|
|
10363
9800
|
"active": 1,
|
|
10364
9801
|
"edit_date": "2025-07-01 12:00:00"
|
|
10365
9802
|
}
|
|
@@ -10539,7 +9976,7 @@
|
|
|
10539
9976
|
"state": "string",
|
|
10540
9977
|
"lng": "number",
|
|
10541
9978
|
"lat": "number",
|
|
10542
|
-
"uuid": "123e4567-
|
|
9979
|
+
"uuid": "123e4567-2c1f-4ae9-ab4e-22fd8d05a55b",
|
|
10543
9980
|
"active": 1,
|
|
10544
9981
|
"edit_date": "2025-07-01 12:00:00"
|
|
10545
9982
|
}
|
|
@@ -10787,12 +10224,12 @@
|
|
|
10787
10224
|
"price_includes_taxes": "string",
|
|
10788
10225
|
"barcode": "string",
|
|
10789
10226
|
"item_is_inventoried": "string",
|
|
10790
|
-
"uuid": "123e4567-
|
|
10227
|
+
"uuid": "123e4567-0add-4a15-b39b-22fd87d8877b",
|
|
10791
10228
|
"active": 1,
|
|
10792
10229
|
"edit_date": "2025-07-01 12:00:00",
|
|
10793
10230
|
"item_description": "string",
|
|
10794
10231
|
"use_description_for_invoicing": "string",
|
|
10795
|
-
"tax_rate_uuid": "123e4567-
|
|
10232
|
+
"tax_rate_uuid": "123e4567-f70a-4798-b77e-22fd8611824b"
|
|
10796
10233
|
}
|
|
10797
10234
|
]
|
|
10798
10235
|
}
|
|
@@ -10967,12 +10404,12 @@
|
|
|
10967
10404
|
"price_includes_taxes": "string",
|
|
10968
10405
|
"barcode": "string",
|
|
10969
10406
|
"item_is_inventoried": "string",
|
|
10970
|
-
"uuid": "123e4567-
|
|
10407
|
+
"uuid": "123e4567-fc44-4c3c-bbe3-22fd8d31e99b",
|
|
10971
10408
|
"active": 1,
|
|
10972
10409
|
"edit_date": "2025-07-01 12:00:00",
|
|
10973
10410
|
"item_description": "string",
|
|
10974
10411
|
"use_description_for_invoicing": "string",
|
|
10975
|
-
"tax_rate_uuid": "123e4567-
|
|
10412
|
+
"tax_rate_uuid": "123e4567-e9bf-4b70-9dd2-22fd8d9cc22b"
|
|
10976
10413
|
}
|
|
10977
10414
|
}
|
|
10978
10415
|
}
|
|
@@ -11208,7 +10645,7 @@
|
|
|
11208
10645
|
"success": {
|
|
11209
10646
|
"value": [
|
|
11210
10647
|
{
|
|
11211
|
-
"uuid": "123e4567-
|
|
10648
|
+
"uuid": "123e4567-bc8a-42ea-b7be-22fd895a599b",
|
|
11212
10649
|
"active": 1,
|
|
11213
10650
|
"edit_date": "2025-07-01 12:00:00",
|
|
11214
10651
|
"item_number": "string",
|
|
@@ -11381,7 +10818,7 @@
|
|
|
11381
10818
|
"examples": {
|
|
11382
10819
|
"success": {
|
|
11383
10820
|
"value": {
|
|
11384
|
-
"uuid": "123e4567-
|
|
10821
|
+
"uuid": "123e4567-21de-48ef-b6d9-22fd8359d81b",
|
|
11385
10822
|
"active": 1,
|
|
11386
10823
|
"edit_date": "2025-07-01 12:00:00",
|
|
11387
10824
|
"item_number": "string",
|
|
@@ -11623,15 +11060,15 @@
|
|
|
11623
11060
|
"success": {
|
|
11624
11061
|
"value": [
|
|
11625
11062
|
{
|
|
11626
|
-
"uuid": "123e4567-
|
|
11063
|
+
"uuid": "123e4567-86cf-4b0d-ae12-22fd8a20944b",
|
|
11627
11064
|
"active": 1,
|
|
11628
11065
|
"edit_date": "2025-07-01 12:00:00",
|
|
11629
11066
|
"related_object": "string",
|
|
11630
|
-
"related_object_uuid": "123e4567-
|
|
11067
|
+
"related_object_uuid": "123e4567-7786-49fb-9de0-22fd8a5152eb",
|
|
11631
11068
|
"note": "string",
|
|
11632
11069
|
"action_required": "string",
|
|
11633
|
-
"action_completed_by_staff_uuid": "123e4567-
|
|
11634
|
-
"edit_by_staff_uuid": "123e4567-
|
|
11070
|
+
"action_completed_by_staff_uuid": "123e4567-ae01-4895-bd06-22fd8d2dd23b",
|
|
11071
|
+
"edit_by_staff_uuid": "123e4567-253e-4348-a8c5-22fd80da95fb",
|
|
11635
11072
|
"create_date": "2025-07-01 12:00:00"
|
|
11636
11073
|
}
|
|
11637
11074
|
]
|
|
@@ -11795,15 +11232,15 @@
|
|
|
11795
11232
|
"examples": {
|
|
11796
11233
|
"success": {
|
|
11797
11234
|
"value": {
|
|
11798
|
-
"uuid": "123e4567-
|
|
11235
|
+
"uuid": "123e4567-178a-4315-bb22-22fd8596521b",
|
|
11799
11236
|
"active": 1,
|
|
11800
11237
|
"edit_date": "2025-07-01 12:00:00",
|
|
11801
11238
|
"related_object": "string",
|
|
11802
|
-
"related_object_uuid": "123e4567-
|
|
11239
|
+
"related_object_uuid": "123e4567-d9bf-4c8b-89e0-22fd8e52c65b",
|
|
11803
11240
|
"note": "string",
|
|
11804
11241
|
"action_required": "string",
|
|
11805
|
-
"action_completed_by_staff_uuid": "123e4567-
|
|
11806
|
-
"edit_by_staff_uuid": "123e4567-
|
|
11242
|
+
"action_completed_by_staff_uuid": "123e4567-5193-4c8e-89a8-22fd8a5a3e4b",
|
|
11243
|
+
"edit_by_staff_uuid": "123e4567-a352-418a-bbe1-22fd8260d3cb",
|
|
11807
11244
|
"create_date": "2025-07-01 12:00:00"
|
|
11808
11245
|
}
|
|
11809
11246
|
}
|
|
@@ -12038,7 +11475,7 @@
|
|
|
12038
11475
|
"success": {
|
|
12039
11476
|
"value": [
|
|
12040
11477
|
{
|
|
12041
|
-
"uuid": "123e4567-
|
|
11478
|
+
"uuid": "123e4567-ac3e-4054-8294-22fd85a32a2b",
|
|
12042
11479
|
"active": 1,
|
|
12043
11480
|
"edit_date": "2025-07-01 12:00:00",
|
|
12044
11481
|
"name": "string",
|
|
@@ -12211,7 +11648,7 @@
|
|
|
12211
11648
|
"examples": {
|
|
12212
11649
|
"success": {
|
|
12213
11650
|
"value": {
|
|
12214
|
-
"uuid": "123e4567-
|
|
11651
|
+
"uuid": "123e4567-c387-4e08-b19d-22fd80dc567b",
|
|
12215
11652
|
"active": 1,
|
|
12216
11653
|
"edit_date": "2025-07-01 12:00:00",
|
|
12217
11654
|
"name": "string",
|
|
@@ -12455,7 +11892,7 @@
|
|
|
12455
11892
|
{
|
|
12456
11893
|
"name": "string",
|
|
12457
11894
|
"role_description": "string",
|
|
12458
|
-
"uuid": "123e4567-
|
|
11895
|
+
"uuid": "123e4567-6ee3-41f9-bc2b-22fd869ff04b",
|
|
12459
11896
|
"active": 1,
|
|
12460
11897
|
"edit_date": "2025-07-01 12:00:00"
|
|
12461
11898
|
}
|
|
@@ -12622,7 +12059,7 @@
|
|
|
12622
12059
|
"value": {
|
|
12623
12060
|
"name": "string",
|
|
12624
12061
|
"role_description": "string",
|
|
12625
|
-
"uuid": "123e4567-
|
|
12062
|
+
"uuid": "123e4567-25a2-4ded-95f2-22fd8454150b",
|
|
12626
12063
|
"active": 1,
|
|
12627
12064
|
"edit_date": "2025-07-01 12:00:00"
|
|
12628
12065
|
}
|
|
@@ -12856,7 +12293,7 @@
|
|
|
12856
12293
|
"success": {
|
|
12857
12294
|
"value": [
|
|
12858
12295
|
{
|
|
12859
|
-
"uuid": "123e4567-
|
|
12296
|
+
"uuid": "123e4567-659d-47f2-94fe-22fd89628d3b",
|
|
12860
12297
|
"active": 1,
|
|
12861
12298
|
"edit_date": "2025-07-01 12:00:00",
|
|
12862
12299
|
"name": "string",
|
|
@@ -13023,7 +12460,7 @@
|
|
|
13023
12460
|
"examples": {
|
|
13024
12461
|
"success": {
|
|
13025
12462
|
"value": {
|
|
13026
|
-
"uuid": "123e4567-
|
|
12463
|
+
"uuid": "123e4567-9481-4d27-9689-22fd8031595b",
|
|
13027
12464
|
"active": 1,
|
|
13028
12465
|
"edit_date": "2025-07-01 12:00:00",
|
|
13029
12466
|
"name": "string",
|
|
@@ -13269,7 +12706,7 @@
|
|
|
13269
12706
|
"lat": "number",
|
|
13270
12707
|
"geo_timestamp": "2025-07-01 12:00:00",
|
|
13271
12708
|
"job_title": "string",
|
|
13272
|
-
"navigating_to_job_uuid": "123e4567-
|
|
12709
|
+
"navigating_to_job_uuid": "123e4567-630d-41e1-b9ef-22fd82eab32b",
|
|
13273
12710
|
"navigating_timestamp": "2025-07-01 12:00:00",
|
|
13274
12711
|
"navigating_expiry_timestamp": "2025-07-01 12:00:00",
|
|
13275
12712
|
"color": "string",
|
|
@@ -13277,8 +12714,8 @@
|
|
|
13277
12714
|
"status_message": "string",
|
|
13278
12715
|
"status_message_timestamp": "2025-07-01 12:00:00",
|
|
13279
12716
|
"hide_from_schedule": "string",
|
|
13280
|
-
"security_role_uuid": "123e4567-
|
|
13281
|
-
"uuid": "123e4567-
|
|
12717
|
+
"security_role_uuid": "123e4567-95f4-4b8b-b20e-22fd87741d2b",
|
|
12718
|
+
"uuid": "123e4567-74db-4bd0-b96c-22fd8d335feb",
|
|
13282
12719
|
"active": 1,
|
|
13283
12720
|
"edit_date": "2025-07-01 12:00:00",
|
|
13284
12721
|
"can_receive_push_notification": "string"
|
|
@@ -13456,7 +12893,7 @@
|
|
|
13456
12893
|
"lat": "number",
|
|
13457
12894
|
"geo_timestamp": "2025-07-01 12:00:00",
|
|
13458
12895
|
"job_title": "string",
|
|
13459
|
-
"navigating_to_job_uuid": "123e4567-
|
|
12896
|
+
"navigating_to_job_uuid": "123e4567-d786-43b4-8dd2-22fd874195db",
|
|
13460
12897
|
"navigating_timestamp": "2025-07-01 12:00:00",
|
|
13461
12898
|
"navigating_expiry_timestamp": "2025-07-01 12:00:00",
|
|
13462
12899
|
"color": "string",
|
|
@@ -13464,8 +12901,8 @@
|
|
|
13464
12901
|
"status_message": "string",
|
|
13465
12902
|
"status_message_timestamp": "2025-07-01 12:00:00",
|
|
13466
12903
|
"hide_from_schedule": "string",
|
|
13467
|
-
"security_role_uuid": "123e4567-
|
|
13468
|
-
"uuid": "123e4567-
|
|
12904
|
+
"security_role_uuid": "123e4567-25e0-4dca-b8dc-22fd818a8beb",
|
|
12905
|
+
"uuid": "123e4567-3968-41e3-a624-22fd8219455b",
|
|
13469
12906
|
"active": 1,
|
|
13470
12907
|
"edit_date": "2025-07-01 12:00:00",
|
|
13471
12908
|
"can_receive_push_notification": "string"
|
|
@@ -13704,16 +13141,16 @@
|
|
|
13704
13141
|
"success": {
|
|
13705
13142
|
"value": [
|
|
13706
13143
|
{
|
|
13707
|
-
"uuid": "123e4567-
|
|
13144
|
+
"uuid": "123e4567-2b4a-458d-a26b-22fd8abf417b",
|
|
13708
13145
|
"active": 1,
|
|
13709
13146
|
"edit_date": "2025-07-01 12:00:00",
|
|
13710
|
-
"from_staff_uuid": "123e4567-
|
|
13711
|
-
"to_staff_uuid": "123e4567-
|
|
13147
|
+
"from_staff_uuid": "123e4567-c205-436f-a1f4-22fd810b227b",
|
|
13148
|
+
"to_staff_uuid": "123e4567-0c7d-4517-8785-22fd83465beb",
|
|
13712
13149
|
"sent_timestamp": "2025-07-01 12:00:00",
|
|
13713
13150
|
"delivered_timestamp": "2025-07-01 12:00:00",
|
|
13714
13151
|
"read_timestamp": "2025-07-01 12:00:00",
|
|
13715
13152
|
"message": "string",
|
|
13716
|
-
"regarding_job_uuid": "123e4567-
|
|
13153
|
+
"regarding_job_uuid": "123e4567-b81c-46fc-9bf6-22fd84b9f3fb",
|
|
13717
13154
|
"attached_json": "string"
|
|
13718
13155
|
}
|
|
13719
13156
|
]
|
|
@@ -13877,16 +13314,16 @@
|
|
|
13877
13314
|
"examples": {
|
|
13878
13315
|
"success": {
|
|
13879
13316
|
"value": {
|
|
13880
|
-
"uuid": "123e4567-
|
|
13317
|
+
"uuid": "123e4567-dd75-4b21-b927-22fd858dc39b",
|
|
13881
13318
|
"active": 1,
|
|
13882
13319
|
"edit_date": "2025-07-01 12:00:00",
|
|
13883
|
-
"from_staff_uuid": "123e4567-
|
|
13884
|
-
"to_staff_uuid": "123e4567-
|
|
13320
|
+
"from_staff_uuid": "123e4567-3282-48e5-ba33-22fd847d574b",
|
|
13321
|
+
"to_staff_uuid": "123e4567-8843-41b8-a31f-22fd851a40ab",
|
|
13885
13322
|
"sent_timestamp": "2025-07-01 12:00:00",
|
|
13886
13323
|
"delivered_timestamp": "2025-07-01 12:00:00",
|
|
13887
13324
|
"read_timestamp": "2025-07-01 12:00:00",
|
|
13888
13325
|
"message": "string",
|
|
13889
|
-
"regarding_job_uuid": "123e4567-
|
|
13326
|
+
"regarding_job_uuid": "123e4567-6675-4ea8-a7d7-22fd8389fffb",
|
|
13890
13327
|
"attached_json": "string"
|
|
13891
13328
|
}
|
|
13892
13329
|
}
|
|
@@ -14125,17 +13562,17 @@
|
|
|
14125
13562
|
"task_details": "string",
|
|
14126
13563
|
"name": "string",
|
|
14127
13564
|
"related_object": "string",
|
|
14128
|
-
"related_object_uuid": "123e4567-
|
|
13565
|
+
"related_object_uuid": "123e4567-af00-407e-acd1-22fd8534b93b",
|
|
14129
13566
|
"task_complete": "string",
|
|
14130
13567
|
"completed_timestamp": "2025-07-01 12:00:00",
|
|
14131
|
-
"completed_by_staff_uuid": "123e4567-
|
|
14132
|
-
"assigned_to_staff_uuid": "123e4567-
|
|
13568
|
+
"completed_by_staff_uuid": "123e4567-aa74-45f7-87dd-22fd87972f9b",
|
|
13569
|
+
"assigned_to_staff_uuid": "123e4567-59c3-4d64-8487-22fd820859eb",
|
|
14133
13570
|
"lng": "string",
|
|
14134
13571
|
"lat": "string",
|
|
14135
|
-
"uuid": "123e4567-
|
|
13572
|
+
"uuid": "123e4567-2980-4366-9b27-22fd8805e41b",
|
|
14136
13573
|
"active": 1,
|
|
14137
13574
|
"edit_date": "2025-07-01 12:00:00",
|
|
14138
|
-
"created_by_staff_uuid": "123e4567-
|
|
13575
|
+
"created_by_staff_uuid": "123e4567-0bdb-4f38-a879-22fd8d04dd4b",
|
|
14139
13576
|
"create_date": "2025-07-01 12:00:00"
|
|
14140
13577
|
}
|
|
14141
13578
|
]
|
|
@@ -14307,17 +13744,17 @@
|
|
|
14307
13744
|
"task_details": "string",
|
|
14308
13745
|
"name": "string",
|
|
14309
13746
|
"related_object": "string",
|
|
14310
|
-
"related_object_uuid": "123e4567-
|
|
13747
|
+
"related_object_uuid": "123e4567-d178-46c6-b5ee-22fd8ff5e77b",
|
|
14311
13748
|
"task_complete": "string",
|
|
14312
13749
|
"completed_timestamp": "2025-07-01 12:00:00",
|
|
14313
|
-
"completed_by_staff_uuid": "123e4567-
|
|
14314
|
-
"assigned_to_staff_uuid": "123e4567-
|
|
13750
|
+
"completed_by_staff_uuid": "123e4567-b6b3-43ee-b687-22fd84d6db7b",
|
|
13751
|
+
"assigned_to_staff_uuid": "123e4567-5532-476c-ad1a-22fd8573741b",
|
|
14315
13752
|
"lng": "string",
|
|
14316
13753
|
"lat": "string",
|
|
14317
|
-
"uuid": "123e4567-
|
|
13754
|
+
"uuid": "123e4567-832a-4758-8647-22fd8b151cbb",
|
|
14318
13755
|
"active": 1,
|
|
14319
13756
|
"edit_date": "2025-07-01 12:00:00",
|
|
14320
|
-
"created_by_staff_uuid": "123e4567-
|
|
13757
|
+
"created_by_staff_uuid": "123e4567-301b-4730-9c0c-22fd8e38a58b",
|
|
14321
13758
|
"create_date": "2025-07-01 12:00:00"
|
|
14322
13759
|
}
|
|
14323
13760
|
}
|
|
@@ -14554,7 +13991,7 @@
|
|
|
14554
13991
|
"success": {
|
|
14555
13992
|
"value": [
|
|
14556
13993
|
{
|
|
14557
|
-
"uuid": "123e4567-
|
|
13994
|
+
"uuid": "123e4567-49d8-4408-9fe4-22fd8941381b",
|
|
14558
13995
|
"active": 1,
|
|
14559
13996
|
"edit_date": "2025-07-01 12:00:00",
|
|
14560
13997
|
"name": "string",
|
|
@@ -14722,7 +14159,7 @@
|
|
|
14722
14159
|
"examples": {
|
|
14723
14160
|
"success": {
|
|
14724
14161
|
"value": {
|
|
14725
|
-
"uuid": "123e4567-
|
|
14162
|
+
"uuid": "123e4567-f19d-47a1-82e4-22fd8a8fce8b",
|
|
14726
14163
|
"active": 1,
|
|
14727
14164
|
"edit_date": "2025-07-01 12:00:00",
|
|
14728
14165
|
"name": "string",
|
|
@@ -14961,7 +14398,7 @@
|
|
|
14961
14398
|
"success": {
|
|
14962
14399
|
"value": [
|
|
14963
14400
|
{
|
|
14964
|
-
"uuid": "123e4567-
|
|
14401
|
+
"uuid": "123e4567-302b-421c-862f-22fd842c1acb",
|
|
14965
14402
|
"active": 1,
|
|
14966
14403
|
"edit_date": "2025-07-01 12:00:00",
|
|
14967
14404
|
"name": "string",
|
|
@@ -15070,7 +14507,7 @@
|
|
|
15070
14507
|
"examples": {
|
|
15071
14508
|
"success": {
|
|
15072
14509
|
"value": {
|
|
15073
|
-
"uuid": "123e4567-
|
|
14510
|
+
"uuid": "123e4567-cc83-47e5-a7ac-22fd850ba79b",
|
|
15074
14511
|
"active": 1,
|
|
15075
14512
|
"edit_date": "2025-07-01 12:00:00",
|
|
15076
14513
|
"name": "string",
|
|
@@ -15192,27 +14629,179 @@
|
|
|
15192
14629
|
}
|
|
15193
14630
|
}
|
|
15194
14631
|
}
|
|
15195
|
-
},
|
|
15196
|
-
"400": {
|
|
15197
|
-
"description": "Bad Request",
|
|
14632
|
+
},
|
|
14633
|
+
"400": {
|
|
14634
|
+
"description": "Bad Request",
|
|
14635
|
+
"content": {
|
|
14636
|
+
"application/json": {
|
|
14637
|
+
"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",
|
|
15198
14795
|
"content": {
|
|
15199
14796
|
"application/json": {
|
|
15200
14797
|
"schema": {
|
|
15201
|
-
"$ref": "#/components/schemas/
|
|
15202
|
-
},
|
|
15203
|
-
"examples": {
|
|
15204
|
-
"badRequest": {
|
|
15205
|
-
"value": {
|
|
15206
|
-
"errorCode": "1000",
|
|
15207
|
-
"message": "An error occurred completing your request"
|
|
15208
|
-
}
|
|
15209
|
-
}
|
|
14798
|
+
"$ref": "#/components/schemas/InboxMessageDetail"
|
|
15210
14799
|
}
|
|
15211
14800
|
}
|
|
15212
14801
|
}
|
|
15213
14802
|
},
|
|
15214
|
-
"
|
|
15215
|
-
"description": "
|
|
14803
|
+
"404": {
|
|
14804
|
+
"description": "Message not found",
|
|
15216
14805
|
"content": {
|
|
15217
14806
|
"application/json": {
|
|
15218
14807
|
"schema": {
|
|
@@ -16185,7 +15774,7 @@
|
|
|
16185
15774
|
"uuid": {
|
|
16186
15775
|
"format": "uuid",
|
|
16187
15776
|
"description": "Unique identifier for this record",
|
|
16188
|
-
"example": "123e4567-
|
|
15777
|
+
"example": "123e4567-5899-4b7f-9274-22fd8d10965b",
|
|
16189
15778
|
"type": "string"
|
|
16190
15779
|
},
|
|
16191
15780
|
"active": {
|
|
@@ -16222,7 +15811,7 @@
|
|
|
16222
15811
|
"uuid": {
|
|
16223
15812
|
"format": "uuid",
|
|
16224
15813
|
"description": "Unique identifier for this record",
|
|
16225
|
-
"example": "123e4567-
|
|
15814
|
+
"example": "123e4567-22fe-44e4-8b3d-22fd892a941b",
|
|
16226
15815
|
"type": "string"
|
|
16227
15816
|
},
|
|
16228
15817
|
"active": {
|
|
@@ -16241,7 +15830,7 @@
|
|
|
16241
15830
|
},
|
|
16242
15831
|
"company_uuid": {
|
|
16243
15832
|
"format": "uuid",
|
|
16244
|
-
"example": "123e4567-
|
|
15833
|
+
"example": "123e4567-0dc2-46fc-9a56-22fd80999a8b",
|
|
16245
15834
|
"type": "string",
|
|
16246
15835
|
"description": "UUID of the Client to which this Asset is attached"
|
|
16247
15836
|
},
|
|
@@ -16251,7 +15840,7 @@
|
|
|
16251
15840
|
},
|
|
16252
15841
|
"asset_type_uuid": {
|
|
16253
15842
|
"format": "uuid",
|
|
16254
|
-
"example": "123e4567-
|
|
15843
|
+
"example": "123e4567-f6ce-4e58-94de-22fd8c66f08b",
|
|
16255
15844
|
"type": "string",
|
|
16256
15845
|
"description": "UUID of an Asset Type which defines the fields that can be stored for this Asset (read only)"
|
|
16257
15846
|
},
|
|
@@ -16321,7 +15910,7 @@
|
|
|
16321
15910
|
"uuid": {
|
|
16322
15911
|
"format": "uuid",
|
|
16323
15912
|
"description": "Unique identifier for this record",
|
|
16324
|
-
"example": "123e4567-
|
|
15913
|
+
"example": "123e4567-2207-4183-bbe3-22fd8725fd6b",
|
|
16325
15914
|
"type": "string"
|
|
16326
15915
|
},
|
|
16327
15916
|
"active": {
|
|
@@ -16350,7 +15939,7 @@
|
|
|
16350
15939
|
"uuid": {
|
|
16351
15940
|
"format": "uuid",
|
|
16352
15941
|
"description": "Unique identifier for this record",
|
|
16353
|
-
"example": "123e4567-
|
|
15942
|
+
"example": "123e4567-7d7a-47c7-914b-22fd839db70b",
|
|
16354
15943
|
"type": "string"
|
|
16355
15944
|
},
|
|
16356
15945
|
"active": {
|
|
@@ -16369,7 +15958,7 @@
|
|
|
16369
15958
|
},
|
|
16370
15959
|
"asset_type_uuid": {
|
|
16371
15960
|
"format": "uuid",
|
|
16372
|
-
"example": "123e4567-
|
|
15961
|
+
"example": "123e4567-e073-429c-a2da-22fd8220480b",
|
|
16373
15962
|
"type": "string",
|
|
16374
15963
|
"description": "UUID of the Asset Type to which this field belongs. This field is read-only in the API. (Read only)"
|
|
16375
15964
|
},
|
|
@@ -16420,7 +16009,7 @@
|
|
|
16420
16009
|
"uuid": {
|
|
16421
16010
|
"format": "uuid",
|
|
16422
16011
|
"description": "Unique identifier for this record",
|
|
16423
|
-
"example": "123e4567-
|
|
16012
|
+
"example": "123e4567-e173-4475-b566-22fd82d91c9b",
|
|
16424
16013
|
"type": "string"
|
|
16425
16014
|
},
|
|
16426
16015
|
"active": {
|
|
@@ -16442,7 +16031,7 @@
|
|
|
16442
16031
|
},
|
|
16443
16032
|
"related_object_uuid": {
|
|
16444
16033
|
"format": "uuid",
|
|
16445
|
-
"example": "123e4567-
|
|
16034
|
+
"example": "123e4567-6c07-45f7-8f40-22fd8cde8b0b",
|
|
16446
16035
|
"type": "string"
|
|
16447
16036
|
},
|
|
16448
16037
|
"attachment_name": {
|
|
@@ -16457,7 +16046,7 @@
|
|
|
16457
16046
|
},
|
|
16458
16047
|
"created_by_staff_uuid": {
|
|
16459
16048
|
"format": "uuid",
|
|
16460
|
-
"example": "123e4567-
|
|
16049
|
+
"example": "123e4567-3ec8-4a6b-bc54-22fd81e8fefb",
|
|
16461
16050
|
"type": "string"
|
|
16462
16051
|
},
|
|
16463
16052
|
"timestamp": {
|
|
@@ -16503,7 +16092,7 @@
|
|
|
16503
16092
|
"uuid": {
|
|
16504
16093
|
"format": "uuid",
|
|
16505
16094
|
"description": "Unique identifier for this record",
|
|
16506
|
-
"example": "123e4567-
|
|
16095
|
+
"example": "123e4567-2f00-44a1-a84f-22fd8169ed2b",
|
|
16507
16096
|
"type": "string"
|
|
16508
16097
|
},
|
|
16509
16098
|
"active": {
|
|
@@ -16533,12 +16122,12 @@
|
|
|
16533
16122
|
},
|
|
16534
16123
|
"regarding_form_uuid": {
|
|
16535
16124
|
"format": "uuid",
|
|
16536
|
-
"example": "123e4567-
|
|
16125
|
+
"example": "123e4567-a935-44a6-904d-22fd8a5f0afb",
|
|
16537
16126
|
"type": "string"
|
|
16538
16127
|
},
|
|
16539
16128
|
"regarding_asset_type_uuid": {
|
|
16540
16129
|
"format": "uuid",
|
|
16541
|
-
"example": "123e4567-
|
|
16130
|
+
"example": "123e4567-ae26-4408-aed5-22fd829a00cb",
|
|
16542
16131
|
"type": "string",
|
|
16543
16132
|
"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."
|
|
16544
16133
|
}
|
|
@@ -16561,7 +16150,7 @@
|
|
|
16561
16150
|
"uuid": {
|
|
16562
16151
|
"format": "uuid",
|
|
16563
16152
|
"description": "Unique identifier for this record",
|
|
16564
|
-
"example": "123e4567-
|
|
16153
|
+
"example": "123e4567-30c6-49d9-a6e6-22fd85821e3b",
|
|
16565
16154
|
"type": "string"
|
|
16566
16155
|
},
|
|
16567
16156
|
"active": {
|
|
@@ -16611,7 +16200,7 @@
|
|
|
16611
16200
|
"uuid": {
|
|
16612
16201
|
"format": "uuid",
|
|
16613
16202
|
"description": "Unique identifier for this record",
|
|
16614
|
-
"example": "123e4567-
|
|
16203
|
+
"example": "123e4567-0792-4abc-a9a0-22fd8bd5e04b",
|
|
16615
16204
|
"type": "string"
|
|
16616
16205
|
},
|
|
16617
16206
|
"active": {
|
|
@@ -16658,7 +16247,7 @@
|
|
|
16658
16247
|
},
|
|
16659
16248
|
"tax_rate_uuid": {
|
|
16660
16249
|
"format": "uuid",
|
|
16661
|
-
"example": "123e4567-
|
|
16250
|
+
"example": "123e4567-d02c-4d30-823f-22fd8497f6cb",
|
|
16662
16251
|
"type": "string"
|
|
16663
16252
|
},
|
|
16664
16253
|
"billing_attention": {
|
|
@@ -16678,7 +16267,7 @@
|
|
|
16678
16267
|
"uuid": {
|
|
16679
16268
|
"format": "uuid",
|
|
16680
16269
|
"description": "Unique identifier for this record",
|
|
16681
|
-
"example": "123e4567-
|
|
16270
|
+
"example": "123e4567-c6eb-4b10-9f15-22fd88ec684b",
|
|
16682
16271
|
"type": "string"
|
|
16683
16272
|
},
|
|
16684
16273
|
"active": {
|
|
@@ -16697,7 +16286,7 @@
|
|
|
16697
16286
|
},
|
|
16698
16287
|
"company_uuid": {
|
|
16699
16288
|
"format": "uuid",
|
|
16700
|
-
"example": "123e4567-
|
|
16289
|
+
"example": "123e4567-5878-45ea-bd2b-22fd882ceb2b",
|
|
16701
16290
|
"type": "string"
|
|
16702
16291
|
},
|
|
16703
16292
|
"first": {
|
|
@@ -16730,7 +16319,7 @@
|
|
|
16730
16319
|
"uuid": {
|
|
16731
16320
|
"format": "uuid",
|
|
16732
16321
|
"description": "Unique identifier for this record",
|
|
16733
|
-
"example": "123e4567-
|
|
16322
|
+
"example": "123e4567-c5dc-443a-8e61-22fd8c6c20cb",
|
|
16734
16323
|
"type": "string"
|
|
16735
16324
|
},
|
|
16736
16325
|
"active": {
|
|
@@ -16770,7 +16359,7 @@
|
|
|
16770
16359
|
"uuid": {
|
|
16771
16360
|
"format": "uuid",
|
|
16772
16361
|
"description": "Unique identifier for this record",
|
|
16773
|
-
"example": "123e4567-
|
|
16362
|
+
"example": "123e4567-711a-4b5e-b117-22fd89dbcf6b",
|
|
16774
16363
|
"type": "string"
|
|
16775
16364
|
},
|
|
16776
16365
|
"active": {
|
|
@@ -16795,7 +16384,7 @@
|
|
|
16795
16384
|
},
|
|
16796
16385
|
"related_object_uuid": {
|
|
16797
16386
|
"format": "uuid",
|
|
16798
|
-
"example": "123e4567-
|
|
16387
|
+
"example": "123e4567-41d1-41f5-958a-22fd8694994b",
|
|
16799
16388
|
"type": "string"
|
|
16800
16389
|
},
|
|
16801
16390
|
"rating": {
|
|
@@ -16816,7 +16405,7 @@
|
|
|
16816
16405
|
"document_template_uuid": {
|
|
16817
16406
|
"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.",
|
|
16818
16407
|
"format": "uuid",
|
|
16819
|
-
"example": "123e4567-
|
|
16408
|
+
"example": "123e4567-b69d-4cbd-bcab-22fd83c64ccb",
|
|
16820
16409
|
"type": "string"
|
|
16821
16410
|
},
|
|
16822
16411
|
"can_be_used_independently": {
|
|
@@ -16862,7 +16451,7 @@
|
|
|
16862
16451
|
"uuid": {
|
|
16863
16452
|
"format": "uuid",
|
|
16864
16453
|
"description": "Unique identifier for this record",
|
|
16865
|
-
"example": "123e4567-
|
|
16454
|
+
"example": "123e4567-75e7-422d-9c67-22fd88d3f01b",
|
|
16866
16455
|
"type": "string"
|
|
16867
16456
|
},
|
|
16868
16457
|
"active": {
|
|
@@ -16887,7 +16476,7 @@
|
|
|
16887
16476
|
"uuid": {
|
|
16888
16477
|
"format": "uuid",
|
|
16889
16478
|
"description": "Unique identifier for this record",
|
|
16890
|
-
"example": "123e4567-
|
|
16479
|
+
"example": "123e4567-c402-4a91-b9fa-22fd8f76f64b",
|
|
16891
16480
|
"type": "string"
|
|
16892
16481
|
},
|
|
16893
16482
|
"active": {
|
|
@@ -16906,7 +16495,7 @@
|
|
|
16906
16495
|
},
|
|
16907
16496
|
"form_uuid": {
|
|
16908
16497
|
"format": "uuid",
|
|
16909
|
-
"example": "123e4567-
|
|
16498
|
+
"example": "123e4567-9a02-427b-93b3-22fd8f77b24b",
|
|
16910
16499
|
"type": "string"
|
|
16911
16500
|
},
|
|
16912
16501
|
"name": {
|
|
@@ -16926,7 +16515,7 @@
|
|
|
16926
16515
|
"uuid": {
|
|
16927
16516
|
"format": "uuid",
|
|
16928
16517
|
"description": "Unique identifier for this record",
|
|
16929
|
-
"example": "123e4567-
|
|
16518
|
+
"example": "123e4567-77fe-4689-ae8e-22fd807ca85b",
|
|
16930
16519
|
"type": "string"
|
|
16931
16520
|
},
|
|
16932
16521
|
"active": {
|
|
@@ -16945,12 +16534,12 @@
|
|
|
16945
16534
|
},
|
|
16946
16535
|
"form_uuid": {
|
|
16947
16536
|
"format": "uuid",
|
|
16948
|
-
"example": "123e4567-
|
|
16537
|
+
"example": "123e4567-6af1-49fd-91ea-22fd84644d6b",
|
|
16949
16538
|
"type": "string"
|
|
16950
16539
|
},
|
|
16951
16540
|
"staff_uuid": {
|
|
16952
16541
|
"format": "uuid",
|
|
16953
|
-
"example": "123e4567-
|
|
16542
|
+
"example": "123e4567-62d5-4a3b-aa55-22fd81f148eb",
|
|
16954
16543
|
"type": "string"
|
|
16955
16544
|
},
|
|
16956
16545
|
"regarding_object": {
|
|
@@ -16958,7 +16547,7 @@
|
|
|
16958
16547
|
},
|
|
16959
16548
|
"regarding_object_uuid": {
|
|
16960
16549
|
"format": "uuid",
|
|
16961
|
-
"example": "123e4567-
|
|
16550
|
+
"example": "123e4567-0a81-47a5-89da-22fd812769db",
|
|
16962
16551
|
"type": "string"
|
|
16963
16552
|
},
|
|
16964
16553
|
"field_data": {
|
|
@@ -16970,120 +16559,18 @@
|
|
|
16970
16559
|
},
|
|
16971
16560
|
"form_by_staff_uuid": {
|
|
16972
16561
|
"format": "uuid",
|
|
16973
|
-
"example": "123e4567-
|
|
16562
|
+
"example": "123e4567-ac3e-4a2d-8e0e-22fd8c08ab9b",
|
|
16974
16563
|
"type": "string"
|
|
16975
16564
|
},
|
|
16976
16565
|
"document_attachment_uuid": {
|
|
16977
16566
|
"format": "uuid",
|
|
16978
|
-
"example": "123e4567-
|
|
16567
|
+
"example": "123e4567-8a3e-4ad2-82ff-22fd8626814b",
|
|
16979
16568
|
"type": "string"
|
|
16980
16569
|
},
|
|
16981
16570
|
"asset_uuid": {
|
|
16982
16571
|
"format": "uuid",
|
|
16983
|
-
"example": "123e4567-
|
|
16984
|
-
"type": "string"
|
|
16985
|
-
}
|
|
16986
|
-
}
|
|
16987
|
-
},
|
|
16988
|
-
"InboxMessage": {
|
|
16989
|
-
"type": "object",
|
|
16990
|
-
"properties": {
|
|
16991
|
-
"uuid": {
|
|
16992
|
-
"type": "string",
|
|
16993
|
-
"format": "uuid"
|
|
16994
|
-
},
|
|
16995
|
-
"active": {
|
|
16996
|
-
"type": "boolean"
|
|
16997
|
-
},
|
|
16998
|
-
"edit_date": {
|
|
16999
|
-
"type": "string",
|
|
17000
|
-
"format": "date-time"
|
|
17001
|
-
},
|
|
17002
|
-
"timestamp": {
|
|
17003
|
-
"type": "string",
|
|
17004
|
-
"format": "date-time"
|
|
17005
|
-
},
|
|
17006
|
-
"read_timestamp": {
|
|
17007
|
-
"type": "string",
|
|
17008
|
-
"format": "date-time",
|
|
17009
|
-
"nullable": true
|
|
17010
|
-
},
|
|
17011
|
-
"last_reply_timestamp": {
|
|
17012
|
-
"type": "string",
|
|
17013
|
-
"format": "date-time",
|
|
17014
|
-
"nullable": true
|
|
17015
|
-
},
|
|
17016
|
-
"snooze_until_timestamp": {
|
|
17017
|
-
"type": "string",
|
|
17018
|
-
"format": "date-time",
|
|
17019
|
-
"nullable": true
|
|
17020
|
-
},
|
|
17021
|
-
"read_by_staff_uuid": {
|
|
17022
|
-
"type": "string",
|
|
17023
|
-
"format": "uuid",
|
|
17024
|
-
"nullable": true
|
|
17025
|
-
},
|
|
17026
|
-
"from_name": {
|
|
17027
|
-
"type": "string"
|
|
17028
|
-
},
|
|
17029
|
-
"from_email": {
|
|
17030
|
-
"type": "string"
|
|
17031
|
-
},
|
|
17032
|
-
"to_email": {
|
|
17033
|
-
"type": "string"
|
|
17034
|
-
},
|
|
17035
|
-
"subject": {
|
|
17036
|
-
"type": "string"
|
|
17037
|
-
},
|
|
17038
|
-
"message_text": {
|
|
17039
|
-
"type": "string"
|
|
17040
|
-
},
|
|
17041
|
-
"message_html": {
|
|
16572
|
+
"example": "123e4567-0877-437a-8186-22fd82ea81db",
|
|
17042
16573
|
"type": "string"
|
|
17043
|
-
},
|
|
17044
|
-
"is_archived": {
|
|
17045
|
-
"type": "boolean"
|
|
17046
|
-
},
|
|
17047
|
-
"archived_timestamp": {
|
|
17048
|
-
"type": "string",
|
|
17049
|
-
"format": "date-time",
|
|
17050
|
-
"nullable": true
|
|
17051
|
-
},
|
|
17052
|
-
"archived_by_staff_uuid": {
|
|
17053
|
-
"type": "string",
|
|
17054
|
-
"format": "uuid",
|
|
17055
|
-
"nullable": true
|
|
17056
|
-
},
|
|
17057
|
-
"regarding_company_uuid": {
|
|
17058
|
-
"type": "string",
|
|
17059
|
-
"format": "uuid",
|
|
17060
|
-
"nullable": true
|
|
17061
|
-
},
|
|
17062
|
-
"converted_to_job_uuid": {
|
|
17063
|
-
"type": "string",
|
|
17064
|
-
"format": "uuid",
|
|
17065
|
-
"nullable": true
|
|
17066
|
-
},
|
|
17067
|
-
"job_template_uuid": {
|
|
17068
|
-
"type": "string",
|
|
17069
|
-
"format": "uuid",
|
|
17070
|
-
"nullable": true
|
|
17071
|
-
},
|
|
17072
|
-
"message_type": {
|
|
17073
|
-
"type": "string",
|
|
17074
|
-
"enum": [
|
|
17075
|
-
"email",
|
|
17076
|
-
"sms",
|
|
17077
|
-
"online_booking",
|
|
17078
|
-
"phone_call",
|
|
17079
|
-
"reminder",
|
|
17080
|
-
"form",
|
|
17081
|
-
"network_request",
|
|
17082
|
-
"supplier_invoice",
|
|
17083
|
-
"asset",
|
|
17084
|
-
"partner_lead",
|
|
17085
|
-
"automation"
|
|
17086
|
-
]
|
|
17087
16574
|
}
|
|
17088
16575
|
}
|
|
17089
16576
|
},
|
|
@@ -17093,7 +16580,7 @@
|
|
|
17093
16580
|
"created_by_staff_uuid": {
|
|
17094
16581
|
"description": "UUID of the staff member who created this job. Records which staff member initially added the job to the system.",
|
|
17095
16582
|
"format": "uuid",
|
|
17096
|
-
"example": "123e4567-
|
|
16583
|
+
"example": "123e4567-17ed-499e-b5cc-22fd8922cb5b",
|
|
17097
16584
|
"type": "string"
|
|
17098
16585
|
},
|
|
17099
16586
|
"date": {
|
|
@@ -17104,7 +16591,7 @@
|
|
|
17104
16591
|
"company_uuid": {
|
|
17105
16592
|
"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.",
|
|
17106
16593
|
"format": "uuid",
|
|
17107
|
-
"example": "123e4567-
|
|
16594
|
+
"example": "123e4567-9737-4bff-bead-22fd8f6ea44b",
|
|
17108
16595
|
"type": "string"
|
|
17109
16596
|
},
|
|
17110
16597
|
"billing_address": {
|
|
@@ -17141,7 +16628,7 @@
|
|
|
17141
16628
|
"payment_actioned_by_uuid": {
|
|
17142
16629
|
"description": "Not used. Refer to JobPayment endpoint.",
|
|
17143
16630
|
"format": "uuid",
|
|
17144
|
-
"example": "123e4567-
|
|
16631
|
+
"example": "123e4567-5ce8-4ed9-8d01-22fd8715648b",
|
|
17145
16632
|
"type": "string"
|
|
17146
16633
|
},
|
|
17147
16634
|
"payment_method": {
|
|
@@ -17155,7 +16642,7 @@
|
|
|
17155
16642
|
"category_uuid": {
|
|
17156
16643
|
"description": "UUID reference to the job category this job belongs to. Categories help organize jobs by type of work or department.",
|
|
17157
16644
|
"format": "uuid",
|
|
17158
|
-
"example": "123e4567-
|
|
16645
|
+
"example": "123e4567-442a-41cd-8595-22fd8ce7341b",
|
|
17159
16646
|
"type": "string"
|
|
17160
16647
|
},
|
|
17161
16648
|
"payment_note": {
|
|
@@ -17213,7 +16700,7 @@
|
|
|
17213
16700
|
"queue_uuid": {
|
|
17214
16701
|
"description": "UUID reference to the queue this job is assigned to. Jobs can be organized into queues for workflow management.",
|
|
17215
16702
|
"format": "uuid",
|
|
17216
|
-
"example": "123e4567-
|
|
16703
|
+
"example": "123e4567-d015-4766-9b61-22fd88eedb5b",
|
|
17217
16704
|
"type": "string"
|
|
17218
16705
|
},
|
|
17219
16706
|
"queue_expiry_date": {
|
|
@@ -17224,7 +16711,7 @@
|
|
|
17224
16711
|
"queue_assigned_staff_uuid": {
|
|
17225
16712
|
"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.",
|
|
17226
16713
|
"format": "uuid",
|
|
17227
|
-
"example": "123e4567-
|
|
16714
|
+
"example": "123e4567-ba50-40b3-afd9-22fd87c1ccab",
|
|
17228
16715
|
"type": "string"
|
|
17229
16716
|
},
|
|
17230
16717
|
"badges": {
|
|
@@ -17263,7 +16750,7 @@
|
|
|
17263
16750
|
"uuid": {
|
|
17264
16751
|
"format": "uuid",
|
|
17265
16752
|
"description": "Unique identifier for this record",
|
|
17266
|
-
"example": "123e4567-
|
|
16753
|
+
"example": "123e4567-9ddd-4a1f-a368-22fd8fb2797b",
|
|
17267
16754
|
"type": "string"
|
|
17268
16755
|
},
|
|
17269
16756
|
"active": {
|
|
@@ -17319,7 +16806,7 @@
|
|
|
17319
16806
|
},
|
|
17320
16807
|
"completion_actioned_by_uuid": {
|
|
17321
16808
|
"format": "uuid",
|
|
17322
|
-
"example": "123e4567-
|
|
16809
|
+
"example": "123e4567-b501-4400-be53-22fd83e6a36b",
|
|
17323
16810
|
"type": "string",
|
|
17324
16811
|
"description": "UUID of the staff member who marked this job as completed. References a staff record in the system."
|
|
17325
16812
|
},
|
|
@@ -17342,7 +16829,7 @@
|
|
|
17342
16829
|
"uuid": {
|
|
17343
16830
|
"format": "uuid",
|
|
17344
16831
|
"description": "Unique identifier for this record",
|
|
17345
|
-
"example": "123e4567-
|
|
16832
|
+
"example": "123e4567-fae4-491f-9672-22fd8f61f39b",
|
|
17346
16833
|
"type": "string"
|
|
17347
16834
|
},
|
|
17348
16835
|
"active": {
|
|
@@ -17361,12 +16848,12 @@
|
|
|
17361
16848
|
},
|
|
17362
16849
|
"job_uuid": {
|
|
17363
16850
|
"format": "uuid",
|
|
17364
|
-
"example": "123e4567-
|
|
16851
|
+
"example": "123e4567-8036-4dbd-b374-22fd86a950db",
|
|
17365
16852
|
"type": "string"
|
|
17366
16853
|
},
|
|
17367
16854
|
"staff_uuid": {
|
|
17368
16855
|
"format": "uuid",
|
|
17369
|
-
"example": "123e4567-
|
|
16856
|
+
"example": "123e4567-e760-45e4-beab-22fd877ef1cb",
|
|
17370
16857
|
"type": "string"
|
|
17371
16858
|
},
|
|
17372
16859
|
"start_date": {
|
|
@@ -17401,7 +16888,7 @@
|
|
|
17401
16888
|
},
|
|
17402
16889
|
"allocated_by_staff_uuid": {
|
|
17403
16890
|
"format": "uuid",
|
|
17404
|
-
"example": "123e4567-
|
|
16891
|
+
"example": "123e4567-d7dc-4af3-afe3-22fd8b4b594b",
|
|
17405
16892
|
"type": "string"
|
|
17406
16893
|
},
|
|
17407
16894
|
"allocated_timestamp": {
|
|
@@ -17410,12 +16897,12 @@
|
|
|
17410
16897
|
},
|
|
17411
16898
|
"material_uuid": {
|
|
17412
16899
|
"format": "uuid",
|
|
17413
|
-
"example": "123e4567-
|
|
16900
|
+
"example": "123e4567-a31c-4d0b-9943-22fd847e165b",
|
|
17414
16901
|
"type": "string"
|
|
17415
16902
|
},
|
|
17416
16903
|
"edit_by_staff_uuid": {
|
|
17417
16904
|
"format": "uuid",
|
|
17418
|
-
"example": "123e4567-
|
|
16905
|
+
"example": "123e4567-bf64-432f-8466-22fd87323d6b",
|
|
17419
16906
|
"readOnly": true,
|
|
17420
16907
|
"description": "UUID of Staff Member who last modified record"
|
|
17421
16908
|
}
|
|
@@ -17427,7 +16914,7 @@
|
|
|
17427
16914
|
"uuid": {
|
|
17428
16915
|
"format": "uuid",
|
|
17429
16916
|
"description": "Unique identifier for this record",
|
|
17430
|
-
"example": "123e4567-
|
|
16917
|
+
"example": "123e4567-3c8f-4a45-9295-22fd8b29f5eb",
|
|
17431
16918
|
"type": "string"
|
|
17432
16919
|
},
|
|
17433
16920
|
"active": {
|
|
@@ -17446,17 +16933,17 @@
|
|
|
17446
16933
|
},
|
|
17447
16934
|
"job_uuid": {
|
|
17448
16935
|
"format": "uuid",
|
|
17449
|
-
"example": "123e4567-
|
|
16936
|
+
"example": "123e4567-1f69-4e8c-8dfc-22fd84444ebb",
|
|
17450
16937
|
"type": "string"
|
|
17451
16938
|
},
|
|
17452
16939
|
"queue_uuid": {
|
|
17453
16940
|
"format": "uuid",
|
|
17454
|
-
"example": "123e4567-
|
|
16941
|
+
"example": "123e4567-53ab-4a1c-b0e8-22fd856c78db",
|
|
17455
16942
|
"type": "string"
|
|
17456
16943
|
},
|
|
17457
16944
|
"staff_uuid": {
|
|
17458
16945
|
"format": "uuid",
|
|
17459
|
-
"example": "123e4567-
|
|
16946
|
+
"example": "123e4567-e72d-425c-bd5d-22fd87f185bb",
|
|
17460
16947
|
"type": "string"
|
|
17461
16948
|
},
|
|
17462
16949
|
"allocation_date": {
|
|
@@ -17465,12 +16952,12 @@
|
|
|
17465
16952
|
},
|
|
17466
16953
|
"allocation_window_uuid": {
|
|
17467
16954
|
"format": "uuid",
|
|
17468
|
-
"example": "123e4567-
|
|
16955
|
+
"example": "123e4567-cf65-4fec-8a01-22fd8417e3cb",
|
|
17469
16956
|
"type": "string"
|
|
17470
16957
|
},
|
|
17471
16958
|
"allocated_by_staff_uuid": {
|
|
17472
16959
|
"format": "uuid",
|
|
17473
|
-
"example": "123e4567-
|
|
16960
|
+
"example": "123e4567-ffe7-4648-83d4-22fd8c34eaab",
|
|
17474
16961
|
"type": "string"
|
|
17475
16962
|
},
|
|
17476
16963
|
"allocated_timestamp": {
|
|
@@ -17516,7 +17003,7 @@
|
|
|
17516
17003
|
"uuid": {
|
|
17517
17004
|
"format": "uuid",
|
|
17518
17005
|
"description": "Unique identifier for this record",
|
|
17519
|
-
"example": "123e4567-
|
|
17006
|
+
"example": "123e4567-f617-4e18-87f1-22fd81c5ee7b",
|
|
17520
17007
|
"type": "string"
|
|
17521
17008
|
},
|
|
17522
17009
|
"active": {
|
|
@@ -17535,7 +17022,7 @@
|
|
|
17535
17022
|
},
|
|
17536
17023
|
"job_uuid": {
|
|
17537
17024
|
"format": "uuid",
|
|
17538
|
-
"example": "123e4567-
|
|
17025
|
+
"example": "123e4567-ee87-4cf0-9aa1-22fd8cfec26b",
|
|
17539
17026
|
"type": "string",
|
|
17540
17027
|
"description": "UUID of the job this checklist item belongs to. This links the checklist item to a specific job in the system."
|
|
17541
17028
|
},
|
|
@@ -17564,13 +17051,13 @@
|
|
|
17564
17051
|
},
|
|
17565
17052
|
"completed_by_staff_uuid": {
|
|
17566
17053
|
"format": "uuid",
|
|
17567
|
-
"example": "123e4567-
|
|
17054
|
+
"example": "123e4567-25ac-40d3-b05c-22fd8e6f2f1b",
|
|
17568
17055
|
"type": "string",
|
|
17569
17056
|
"description": "UUID of the staff member who completed this checklist item. References a Staff object. Empty if the item is not completed."
|
|
17570
17057
|
},
|
|
17571
17058
|
"completed_during_checkin_uuid": {
|
|
17572
17059
|
"format": "uuid",
|
|
17573
|
-
"example": "123e4567-
|
|
17060
|
+
"example": "123e4567-6bbc-420a-95d0-22fd85dd957b",
|
|
17574
17061
|
"type": "string",
|
|
17575
17062
|
"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."
|
|
17576
17063
|
},
|
|
@@ -17641,7 +17128,7 @@
|
|
|
17641
17128
|
},
|
|
17642
17129
|
"regarding_object_uuid": {
|
|
17643
17130
|
"format": "uuid",
|
|
17644
|
-
"example": "123e4567-
|
|
17131
|
+
"example": "123e4567-3280-419a-b05c-22fd8dec44fb",
|
|
17645
17132
|
"type": "string",
|
|
17646
17133
|
"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."
|
|
17647
17134
|
},
|
|
@@ -17651,13 +17138,13 @@
|
|
|
17651
17138
|
},
|
|
17652
17139
|
"fulfilled_by_object_uuid": {
|
|
17653
17140
|
"format": "uuid",
|
|
17654
|
-
"example": "123e4567-
|
|
17141
|
+
"example": "123e4567-393b-45f4-8a90-22fd8b68a4ab",
|
|
17655
17142
|
"type": "string",
|
|
17656
17143
|
"description": "The UUID of the object which completes this checklist item. For example, for Form checklists, this references the UUID of a FormResponse record."
|
|
17657
17144
|
},
|
|
17658
17145
|
"assigned_to_staff_uuids": {
|
|
17659
17146
|
"format": "uuid",
|
|
17660
|
-
"example": "123e4567-
|
|
17147
|
+
"example": "123e4567-2888-410d-b6b8-22fd803b0afb",
|
|
17661
17148
|
"type": "array",
|
|
17662
17149
|
"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.",
|
|
17663
17150
|
"items": {
|
|
@@ -17682,7 +17169,7 @@
|
|
|
17682
17169
|
},
|
|
17683
17170
|
"assigned_by_staff_uuid": {
|
|
17684
17171
|
"format": "uuid",
|
|
17685
|
-
"example": "123e4567-
|
|
17172
|
+
"example": "123e4567-a7a7-49c2-b438-22fd8501ec4b",
|
|
17686
17173
|
"type": "string",
|
|
17687
17174
|
"description": "The UUID of the staff member who assigned the checklist item to the staff member. (Read only)"
|
|
17688
17175
|
}
|
|
@@ -17694,7 +17181,7 @@
|
|
|
17694
17181
|
"uuid": {
|
|
17695
17182
|
"format": "uuid",
|
|
17696
17183
|
"description": "Unique identifier for this record",
|
|
17697
|
-
"example": "123e4567-
|
|
17184
|
+
"example": "123e4567-138a-482b-a56e-22fd86bf5eeb",
|
|
17698
17185
|
"type": "string"
|
|
17699
17186
|
},
|
|
17700
17187
|
"active": {
|
|
@@ -17713,7 +17200,7 @@
|
|
|
17713
17200
|
},
|
|
17714
17201
|
"job_uuid": {
|
|
17715
17202
|
"format": "uuid",
|
|
17716
|
-
"example": "123e4567-
|
|
17203
|
+
"example": "123e4567-645e-4fca-a0bd-22fd8bcc720b",
|
|
17717
17204
|
"type": "string"
|
|
17718
17205
|
},
|
|
17719
17206
|
"first": {
|
|
@@ -17746,7 +17233,7 @@
|
|
|
17746
17233
|
"uuid": {
|
|
17747
17234
|
"format": "uuid",
|
|
17748
17235
|
"description": "Unique identifier for this record",
|
|
17749
|
-
"example": "123e4567-
|
|
17236
|
+
"example": "123e4567-5290-4ee6-a52b-22fd8a2e20fb",
|
|
17750
17237
|
"type": "string"
|
|
17751
17238
|
},
|
|
17752
17239
|
"active": {
|
|
@@ -17765,12 +17252,12 @@
|
|
|
17765
17252
|
},
|
|
17766
17253
|
"job_uuid": {
|
|
17767
17254
|
"format": "uuid",
|
|
17768
|
-
"example": "123e4567-
|
|
17255
|
+
"example": "123e4567-f617-47ca-90dd-22fd887ec26b",
|
|
17769
17256
|
"type": "string"
|
|
17770
17257
|
},
|
|
17771
17258
|
"material_uuid": {
|
|
17772
17259
|
"format": "uuid",
|
|
17773
|
-
"example": "123e4567-
|
|
17260
|
+
"example": "123e4567-8151-4183-aefa-22fd8c44dcfb",
|
|
17774
17261
|
"type": "string"
|
|
17775
17262
|
},
|
|
17776
17263
|
"name": {
|
|
@@ -17792,7 +17279,7 @@
|
|
|
17792
17279
|
},
|
|
17793
17280
|
"tax_rate_uuid": {
|
|
17794
17281
|
"format": "uuid",
|
|
17795
|
-
"example": "123e4567-
|
|
17282
|
+
"example": "123e4567-38b1-41d0-ad2c-22fd823d2ecb",
|
|
17796
17283
|
"type": "string"
|
|
17797
17284
|
},
|
|
17798
17285
|
"sort_order": {
|
|
@@ -17806,7 +17293,7 @@
|
|
|
17806
17293
|
},
|
|
17807
17294
|
"job_material_bundle_uuid": {
|
|
17808
17295
|
"format": "uuid",
|
|
17809
|
-
"example": "123e4567-
|
|
17296
|
+
"example": "123e4567-843f-44aa-9898-22fd8cc0977b",
|
|
17810
17297
|
"type": "string",
|
|
17811
17298
|
"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."
|
|
17812
17299
|
}
|
|
@@ -17821,7 +17308,7 @@
|
|
|
17821
17308
|
"uuid": {
|
|
17822
17309
|
"format": "uuid",
|
|
17823
17310
|
"description": "Unique identifier for this record",
|
|
17824
|
-
"example": "123e4567-
|
|
17311
|
+
"example": "123e4567-f628-4565-9e30-22fd8ba4e1cb",
|
|
17825
17312
|
"type": "string"
|
|
17826
17313
|
},
|
|
17827
17314
|
"active": {
|
|
@@ -17856,13 +17343,13 @@
|
|
|
17856
17343
|
},
|
|
17857
17344
|
"material_bundle_uuid": {
|
|
17858
17345
|
"format": "uuid",
|
|
17859
|
-
"example": "123e4567-
|
|
17346
|
+
"example": "123e4567-fc08-4532-89af-22fd8f812f4b",
|
|
17860
17347
|
"type": "string",
|
|
17861
17348
|
"description": "UUID of the MaterialBundle which this JobMaterialBundle was originally created from."
|
|
17862
17349
|
},
|
|
17863
17350
|
"job_uuid": {
|
|
17864
17351
|
"format": "uuid",
|
|
17865
|
-
"example": "123e4567-
|
|
17352
|
+
"example": "123e4567-6d2e-4346-8add-22fd8e18287b",
|
|
17866
17353
|
"type": "string",
|
|
17867
17354
|
"description": "UUID of the job that this material bundle is associated with. Links the bundle to a specific job record."
|
|
17868
17355
|
}
|
|
@@ -17874,7 +17361,7 @@
|
|
|
17874
17361
|
"uuid": {
|
|
17875
17362
|
"format": "uuid",
|
|
17876
17363
|
"description": "Unique identifier for this record",
|
|
17877
|
-
"example": "123e4567-
|
|
17364
|
+
"example": "123e4567-a2e4-4ea3-b925-22fd8c2071cb",
|
|
17878
17365
|
"type": "string"
|
|
17879
17366
|
},
|
|
17880
17367
|
"active": {
|
|
@@ -17893,12 +17380,12 @@
|
|
|
17893
17380
|
},
|
|
17894
17381
|
"job_uuid": {
|
|
17895
17382
|
"format": "uuid",
|
|
17896
|
-
"example": "123e4567-
|
|
17383
|
+
"example": "123e4567-c9ed-4f25-be7c-22fd8a3cfaab",
|
|
17897
17384
|
"type": "string"
|
|
17898
17385
|
},
|
|
17899
17386
|
"actioned_by_uuid": {
|
|
17900
17387
|
"format": "uuid",
|
|
17901
|
-
"example": "123e4567-
|
|
17388
|
+
"example": "123e4567-509b-4e16-ad3f-22fd8d3ecf0b",
|
|
17902
17389
|
"type": "string"
|
|
17903
17390
|
},
|
|
17904
17391
|
"timestamp": {
|
|
@@ -17915,7 +17402,7 @@
|
|
|
17915
17402
|
},
|
|
17916
17403
|
"attachment_uuid": {
|
|
17917
17404
|
"format": "uuid",
|
|
17918
|
-
"example": "123e4567-
|
|
17405
|
+
"example": "123e4567-4fe4-4e5b-8cf4-22fd889cdf3b",
|
|
17919
17406
|
"type": "string"
|
|
17920
17407
|
},
|
|
17921
17408
|
"is_deposit": {
|
|
@@ -17928,41 +17415,13 @@
|
|
|
17928
17415
|
}
|
|
17929
17416
|
}
|
|
17930
17417
|
},
|
|
17931
|
-
"JobTemplate": {
|
|
17932
|
-
"type": "object",
|
|
17933
|
-
"properties": {
|
|
17934
|
-
"uuid": {
|
|
17935
|
-
"format": "uuid",
|
|
17936
|
-
"description": "Unique identifier for this record",
|
|
17937
|
-
"example": "123e4567-92df-4f73-b4a2-22fc0bccb61b",
|
|
17938
|
-
"type": "string"
|
|
17939
|
-
},
|
|
17940
|
-
"active": {
|
|
17941
|
-
"enum": [
|
|
17942
|
-
0,
|
|
17943
|
-
1
|
|
17944
|
-
],
|
|
17945
|
-
"type": "integer",
|
|
17946
|
-
"default": 1,
|
|
17947
|
-
"description": "Record active/deleted flag. Valid values are [0,1]"
|
|
17948
|
-
},
|
|
17949
|
-
"edit_date": {
|
|
17950
|
-
"example": "2025-07-01 12:00:00",
|
|
17951
|
-
"readOnly": true,
|
|
17952
|
-
"description": "Timestamp at which record was last modified"
|
|
17953
|
-
},
|
|
17954
|
-
"name": {
|
|
17955
|
-
"type": "string"
|
|
17956
|
-
}
|
|
17957
|
-
}
|
|
17958
|
-
},
|
|
17959
17418
|
"KnowledgeArticle": {
|
|
17960
17419
|
"type": "object",
|
|
17961
17420
|
"properties": {
|
|
17962
17421
|
"uuid": {
|
|
17963
17422
|
"format": "uuid",
|
|
17964
17423
|
"description": "Unique identifier for this record",
|
|
17965
|
-
"example": "123e4567-
|
|
17424
|
+
"example": "123e4567-02ce-47cc-a353-22fd851ac5ab",
|
|
17966
17425
|
"type": "string"
|
|
17967
17426
|
},
|
|
17968
17427
|
"active": {
|
|
@@ -18092,7 +17551,7 @@
|
|
|
18092
17551
|
"uuid": {
|
|
18093
17552
|
"format": "uuid",
|
|
18094
17553
|
"description": "Unique identifier for this record",
|
|
18095
|
-
"example": "123e4567-
|
|
17554
|
+
"example": "123e4567-50ec-4117-b93f-22fd86574f2b",
|
|
18096
17555
|
"type": "string"
|
|
18097
17556
|
},
|
|
18098
17557
|
"active": {
|
|
@@ -18162,7 +17621,7 @@
|
|
|
18162
17621
|
"uuid": {
|
|
18163
17622
|
"format": "uuid",
|
|
18164
17623
|
"description": "Unique identifier for this record",
|
|
18165
|
-
"example": "123e4567-
|
|
17624
|
+
"example": "123e4567-e9cf-4eab-97b5-22fd84f1aa9b",
|
|
18166
17625
|
"type": "string"
|
|
18167
17626
|
},
|
|
18168
17627
|
"active": {
|
|
@@ -18187,7 +17646,7 @@
|
|
|
18187
17646
|
},
|
|
18188
17647
|
"tax_rate_uuid": {
|
|
18189
17648
|
"format": "uuid",
|
|
18190
|
-
"example": "123e4567-
|
|
17649
|
+
"example": "123e4567-eddf-4538-b5b7-22fd807ae23b",
|
|
18191
17650
|
"type": "string"
|
|
18192
17651
|
}
|
|
18193
17652
|
},
|
|
@@ -18201,7 +17660,7 @@
|
|
|
18201
17660
|
"uuid": {
|
|
18202
17661
|
"format": "uuid",
|
|
18203
17662
|
"description": "Unique identifier for this record",
|
|
18204
|
-
"example": "123e4567-
|
|
17663
|
+
"example": "123e4567-b1b8-4845-a136-22fd8874bafb",
|
|
18205
17664
|
"type": "string"
|
|
18206
17665
|
},
|
|
18207
17666
|
"active": {
|
|
@@ -18262,7 +17721,7 @@
|
|
|
18262
17721
|
"uuid": {
|
|
18263
17722
|
"format": "uuid",
|
|
18264
17723
|
"description": "Unique identifier for this record",
|
|
18265
|
-
"example": "123e4567-
|
|
17724
|
+
"example": "123e4567-1f95-4ea2-b9d8-22fd8f59c73b",
|
|
18266
17725
|
"type": "string"
|
|
18267
17726
|
},
|
|
18268
17727
|
"active": {
|
|
@@ -18284,7 +17743,7 @@
|
|
|
18284
17743
|
},
|
|
18285
17744
|
"related_object_uuid": {
|
|
18286
17745
|
"format": "uuid",
|
|
18287
|
-
"example": "123e4567-
|
|
17746
|
+
"example": "123e4567-c873-425f-ae77-22fd8305f44b",
|
|
18288
17747
|
"type": "string"
|
|
18289
17748
|
},
|
|
18290
17749
|
"note": {
|
|
@@ -18295,12 +17754,12 @@
|
|
|
18295
17754
|
},
|
|
18296
17755
|
"action_completed_by_staff_uuid": {
|
|
18297
17756
|
"format": "uuid",
|
|
18298
|
-
"example": "123e4567-
|
|
17757
|
+
"example": "123e4567-2350-4f3f-b5c4-22fd86c2948b",
|
|
18299
17758
|
"type": "string"
|
|
18300
17759
|
},
|
|
18301
17760
|
"edit_by_staff_uuid": {
|
|
18302
17761
|
"format": "uuid",
|
|
18303
|
-
"example": "123e4567-
|
|
17762
|
+
"example": "123e4567-d39e-425c-aa81-22fd887281fb",
|
|
18304
17763
|
"readOnly": true,
|
|
18305
17764
|
"description": "UUID of Staff Member who last modified record"
|
|
18306
17765
|
},
|
|
@@ -18316,7 +17775,7 @@
|
|
|
18316
17775
|
"uuid": {
|
|
18317
17776
|
"format": "uuid",
|
|
18318
17777
|
"description": "Unique identifier for this record",
|
|
18319
|
-
"example": "123e4567-
|
|
17778
|
+
"example": "123e4567-f846-4a6c-914f-22fd8e81b42b",
|
|
18320
17779
|
"type": "string"
|
|
18321
17780
|
},
|
|
18322
17781
|
"active": {
|
|
@@ -18370,7 +17829,7 @@
|
|
|
18370
17829
|
"uuid": {
|
|
18371
17830
|
"format": "uuid",
|
|
18372
17831
|
"description": "Unique identifier for this record",
|
|
18373
|
-
"example": "123e4567-
|
|
17832
|
+
"example": "123e4567-f9c9-4602-a526-22fd8d74199b",
|
|
18374
17833
|
"type": "string"
|
|
18375
17834
|
},
|
|
18376
17835
|
"active": {
|
|
@@ -18398,7 +17857,7 @@
|
|
|
18398
17857
|
"uuid": {
|
|
18399
17858
|
"format": "uuid",
|
|
18400
17859
|
"description": "Unique identifier for this record",
|
|
18401
|
-
"example": "123e4567-
|
|
17860
|
+
"example": "123e4567-558b-49f7-8d59-22fd89e659fb",
|
|
18402
17861
|
"type": "string"
|
|
18403
17862
|
},
|
|
18404
17863
|
"active": {
|
|
@@ -18472,7 +17931,7 @@
|
|
|
18472
17931
|
"navigating_to_job_uuid": {
|
|
18473
17932
|
"description": "UUID of the job the staff member is currently navigating to. Used to track which job a staff member is traveling toward.",
|
|
18474
17933
|
"format": "uuid",
|
|
18475
|
-
"example": "123e4567-
|
|
17934
|
+
"example": "123e4567-a2fb-4b60-846f-22fd80de6d9b",
|
|
18476
17935
|
"type": "string"
|
|
18477
17936
|
},
|
|
18478
17937
|
"navigating_timestamp": {
|
|
@@ -18512,13 +17971,13 @@
|
|
|
18512
17971
|
"security_role_uuid": {
|
|
18513
17972
|
"description": "UUID of the primary security role assigned to this staff member. Controls the staff member's permissions and access levels throughout the system.",
|
|
18514
17973
|
"format": "uuid",
|
|
18515
|
-
"example": "123e4567-
|
|
17974
|
+
"example": "123e4567-ae75-4eae-adef-22fd802aca3b",
|
|
18516
17975
|
"type": "string"
|
|
18517
17976
|
},
|
|
18518
17977
|
"uuid": {
|
|
18519
17978
|
"format": "uuid",
|
|
18520
17979
|
"description": "Unique identifier for this record",
|
|
18521
|
-
"example": "123e4567-
|
|
17980
|
+
"example": "123e4567-d3d1-4eef-934d-22fd8277a70b",
|
|
18522
17981
|
"type": "string"
|
|
18523
17982
|
},
|
|
18524
17983
|
"active": {
|
|
@@ -18551,7 +18010,7 @@
|
|
|
18551
18010
|
"uuid": {
|
|
18552
18011
|
"format": "uuid",
|
|
18553
18012
|
"description": "Unique identifier for this record",
|
|
18554
|
-
"example": "123e4567-
|
|
18013
|
+
"example": "123e4567-322b-4c7b-a9c8-22fd89b40dcb",
|
|
18555
18014
|
"type": "string"
|
|
18556
18015
|
},
|
|
18557
18016
|
"active": {
|
|
@@ -18570,12 +18029,12 @@
|
|
|
18570
18029
|
},
|
|
18571
18030
|
"from_staff_uuid": {
|
|
18572
18031
|
"format": "uuid",
|
|
18573
|
-
"example": "123e4567-
|
|
18032
|
+
"example": "123e4567-0a6d-4b9e-8b0e-22fd8c5ece9b",
|
|
18574
18033
|
"type": "string"
|
|
18575
18034
|
},
|
|
18576
18035
|
"to_staff_uuid": {
|
|
18577
18036
|
"format": "uuid",
|
|
18578
|
-
"example": "123e4567-
|
|
18037
|
+
"example": "123e4567-3773-43eb-9c06-22fd87851adb",
|
|
18579
18038
|
"type": "string"
|
|
18580
18039
|
},
|
|
18581
18040
|
"sent_timestamp": {
|
|
@@ -18595,7 +18054,7 @@
|
|
|
18595
18054
|
},
|
|
18596
18055
|
"regarding_job_uuid": {
|
|
18597
18056
|
"format": "uuid",
|
|
18598
|
-
"example": "123e4567-
|
|
18057
|
+
"example": "123e4567-fa1c-43e1-8216-22fd8d0c365b",
|
|
18599
18058
|
"type": "string"
|
|
18600
18059
|
},
|
|
18601
18060
|
"attached_json": {
|
|
@@ -18626,7 +18085,7 @@
|
|
|
18626
18085
|
"related_object_uuid": {
|
|
18627
18086
|
"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.",
|
|
18628
18087
|
"format": "uuid",
|
|
18629
|
-
"example": "123e4567-
|
|
18088
|
+
"example": "123e4567-2c9f-44a5-8470-22fd84c6d6eb",
|
|
18630
18089
|
"type": "string"
|
|
18631
18090
|
},
|
|
18632
18091
|
"task_complete": {
|
|
@@ -18641,13 +18100,13 @@
|
|
|
18641
18100
|
"completed_by_staff_uuid": {
|
|
18642
18101
|
"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.",
|
|
18643
18102
|
"format": "uuid",
|
|
18644
|
-
"example": "123e4567-
|
|
18103
|
+
"example": "123e4567-a11a-40b5-aa7a-22fd82f14c1b",
|
|
18645
18104
|
"type": "string"
|
|
18646
18105
|
},
|
|
18647
18106
|
"assigned_to_staff_uuid": {
|
|
18648
18107
|
"description": "UUID of the staff member assigned to complete this task. Must be a valid staff UUID in the system.",
|
|
18649
18108
|
"format": "uuid",
|
|
18650
|
-
"example": "123e4567-
|
|
18109
|
+
"example": "123e4567-5d96-4504-9341-22fd8df7b39b",
|
|
18651
18110
|
"type": "string"
|
|
18652
18111
|
},
|
|
18653
18112
|
"lng": {
|
|
@@ -18659,7 +18118,7 @@
|
|
|
18659
18118
|
"uuid": {
|
|
18660
18119
|
"format": "uuid",
|
|
18661
18120
|
"description": "Unique identifier for this record",
|
|
18662
|
-
"example": "123e4567-
|
|
18121
|
+
"example": "123e4567-00c3-4b07-9b6a-22fd888a902b",
|
|
18663
18122
|
"type": "string"
|
|
18664
18123
|
},
|
|
18665
18124
|
"active": {
|
|
@@ -18678,7 +18137,7 @@
|
|
|
18678
18137
|
},
|
|
18679
18138
|
"created_by_staff_uuid": {
|
|
18680
18139
|
"format": "uuid",
|
|
18681
|
-
"example": "123e4567-
|
|
18140
|
+
"example": "123e4567-0a30-4625-ad38-22fd80ab7f0b",
|
|
18682
18141
|
"type": "string"
|
|
18683
18142
|
},
|
|
18684
18143
|
"create_date": {
|
|
@@ -18696,7 +18155,7 @@
|
|
|
18696
18155
|
"uuid": {
|
|
18697
18156
|
"format": "uuid",
|
|
18698
18157
|
"description": "Unique identifier for this record",
|
|
18699
|
-
"example": "123e4567-
|
|
18158
|
+
"example": "123e4567-3172-431f-bea4-22fd84e8991b",
|
|
18700
18159
|
"type": "string"
|
|
18701
18160
|
},
|
|
18702
18161
|
"active": {
|
|
@@ -18739,7 +18198,7 @@
|
|
|
18739
18198
|
"uuid": {
|
|
18740
18199
|
"format": "uuid",
|
|
18741
18200
|
"description": "Unique identifier for this record",
|
|
18742
|
-
"example": "123e4567-
|
|
18201
|
+
"example": "123e4567-b82c-4c1e-bd63-22fd85cd889b",
|
|
18743
18202
|
"type": "string"
|
|
18744
18203
|
},
|
|
18745
18204
|
"active": {
|
|
@@ -18848,6 +18307,108 @@
|
|
|
18848
18307
|
"name"
|
|
18849
18308
|
]
|
|
18850
18309
|
},
|
|
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
|
+
},
|
|
18851
18412
|
"InboxMessageDetail": {
|
|
18852
18413
|
"allOf": [
|
|
18853
18414
|
{
|
|
@@ -19267,10 +18828,6 @@
|
|
|
19267
18828
|
"name": "Form Responses",
|
|
19268
18829
|
"description": "Operations related to Form Responses"
|
|
19269
18830
|
},
|
|
19270
|
-
{
|
|
19271
|
-
"name": "",
|
|
19272
|
-
"description": "Operations related to "
|
|
19273
|
-
},
|
|
19274
18831
|
{
|
|
19275
18832
|
"name": "Jobs",
|
|
19276
18833
|
"description": "Operations related to Jobs"
|
|
@@ -19303,10 +18860,6 @@
|
|
|
19303
18860
|
"name": "Job Payments",
|
|
19304
18861
|
"description": "Operations related to Job Payments"
|
|
19305
18862
|
},
|
|
19306
|
-
{
|
|
19307
|
-
"name": "Job Templates",
|
|
19308
|
-
"description": "Operations related to Job Templates"
|
|
19309
|
-
},
|
|
19310
18863
|
{
|
|
19311
18864
|
"name": "Knowledge Articles",
|
|
19312
18865
|
"description": "Operations related to Knowledge Articles"
|