servicem8 0.9.42 → 0.9.44
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 +9 -1
- package/api.json +1002 -318
- package/bin/mcp-server.js +1483 -741
- package/bin/mcp-server.js.map +23 -11
- package/dist/commonjs/funcs/formResponsesCreateFormResponses.d.ts +24 -0
- package/dist/commonjs/funcs/formResponsesCreateFormResponses.d.ts.map +1 -0
- package/dist/commonjs/funcs/formResponsesCreateFormResponses.js +136 -0
- package/dist/commonjs/funcs/formResponsesCreateFormResponses.js.map +1 -0
- package/dist/commonjs/funcs/formResponsesDeleteFormResponses.d.ts +23 -0
- package/dist/commonjs/funcs/formResponsesDeleteFormResponses.d.ts.map +1 -0
- package/dist/commonjs/funcs/formResponsesDeleteFormResponses.js +137 -0
- package/dist/commonjs/funcs/formResponsesDeleteFormResponses.js.map +1 -0
- package/dist/commonjs/funcs/formResponsesUpdateFormResponses.d.ts +21 -0
- package/dist/commonjs/funcs/formResponsesUpdateFormResponses.d.ts.map +1 -0
- package/dist/commonjs/funcs/formResponsesUpdateFormResponses.js +136 -0
- package/dist/commonjs/funcs/formResponsesUpdateFormResponses.js.map +1 -0
- package/dist/commonjs/funcs/inboxCreateInboxMessage.d.ts +18 -0
- package/dist/commonjs/funcs/inboxCreateInboxMessage.d.ts.map +1 -0
- package/dist/commonjs/funcs/inboxCreateInboxMessage.js +127 -0
- package/dist/commonjs/funcs/inboxCreateInboxMessage.js.map +1 -0
- 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 +9 -1
- package/dist/commonjs/mcp-server/server.js.map +1 -1
- package/dist/commonjs/mcp-server/tools/formResponsesCreateFormResponses.d.ts +8 -0
- package/dist/commonjs/mcp-server/tools/formResponsesCreateFormResponses.d.ts.map +1 -0
- package/dist/commonjs/mcp-server/tools/formResponsesCreateFormResponses.js +74 -0
- package/dist/commonjs/mcp-server/tools/formResponsesCreateFormResponses.js.map +1 -0
- package/dist/commonjs/mcp-server/tools/formResponsesDeleteFormResponses.d.ts +8 -0
- package/dist/commonjs/mcp-server/tools/formResponsesDeleteFormResponses.d.ts.map +1 -0
- package/dist/commonjs/mcp-server/tools/formResponsesDeleteFormResponses.js +73 -0
- package/dist/commonjs/mcp-server/tools/formResponsesDeleteFormResponses.js.map +1 -0
- package/dist/commonjs/mcp-server/tools/formResponsesUpdateFormResponses.d.ts +8 -0
- package/dist/commonjs/mcp-server/tools/formResponsesUpdateFormResponses.d.ts.map +1 -0
- package/dist/commonjs/mcp-server/tools/formResponsesUpdateFormResponses.js +69 -0
- package/dist/commonjs/mcp-server/tools/formResponsesUpdateFormResponses.js.map +1 -0
- package/dist/commonjs/mcp-server/tools/inboxCreateInboxMessage.d.ts +8 -0
- package/dist/commonjs/mcp-server/tools/inboxCreateInboxMessage.d.ts.map +1 -0
- package/dist/commonjs/mcp-server/tools/inboxCreateInboxMessage.js +64 -0
- package/dist/commonjs/mcp-server/tools/inboxCreateInboxMessage.js.map +1 -0
- package/dist/commonjs/models/components/createinboxmessagerequest.d.ts +172 -0
- package/dist/commonjs/models/components/createinboxmessagerequest.d.ts.map +1 -0
- package/dist/commonjs/models/components/createinboxmessagerequest.js +189 -0
- package/dist/commonjs/models/components/createinboxmessagerequest.js.map +1 -0
- package/dist/commonjs/models/components/formresponse.d.ts +57 -0
- package/dist/commonjs/models/components/formresponse.d.ts.map +1 -1
- package/dist/commonjs/models/components/formresponse.js +70 -1
- package/dist/commonjs/models/components/formresponse.js.map +1 -1
- package/dist/commonjs/models/components/index.d.ts +1 -0
- package/dist/commonjs/models/components/index.d.ts.map +1 -1
- package/dist/commonjs/models/components/index.js +1 -0
- package/dist/commonjs/models/components/index.js.map +1 -1
- package/dist/commonjs/models/components/job.d.ts +22 -22
- package/dist/commonjs/models/components/job.js +2 -2
- package/dist/commonjs/models/components/vendor.d.ts +2 -2
- package/dist/commonjs/models/components/vendor.d.ts.map +1 -1
- package/dist/commonjs/models/operations/createformresponses.d.ts +36 -0
- package/dist/commonjs/models/operations/createformresponses.d.ts.map +1 -0
- package/dist/commonjs/models/operations/createformresponses.js +83 -0
- package/dist/commonjs/models/operations/createformresponses.js.map +1 -0
- package/dist/commonjs/models/operations/deleteformresponses.d.ts +32 -0
- package/dist/commonjs/models/operations/deleteformresponses.d.ts.map +1 -0
- package/dist/commonjs/models/operations/deleteformresponses.js +69 -0
- package/dist/commonjs/models/operations/deleteformresponses.js.map +1 -0
- package/dist/commonjs/models/operations/index.d.ts +3 -0
- package/dist/commonjs/models/operations/index.d.ts.map +1 -1
- package/dist/commonjs/models/operations/index.js +3 -0
- package/dist/commonjs/models/operations/index.js.map +1 -1
- package/dist/commonjs/models/operations/updateformresponses.d.ts +38 -0
- package/dist/commonjs/models/operations/updateformresponses.d.ts.map +1 -0
- package/dist/commonjs/models/operations/updateformresponses.js +81 -0
- package/dist/commonjs/models/operations/updateformresponses.js.map +1 -0
- package/dist/commonjs/sdk/formresponses.d.ts +32 -0
- package/dist/commonjs/sdk/formresponses.d.ts.map +1 -1
- package/dist/commonjs/sdk/formresponses.js +41 -0
- package/dist/commonjs/sdk/formresponses.js.map +1 -1
- package/dist/commonjs/sdk/inbox.d.ts +7 -0
- package/dist/commonjs/sdk/inbox.d.ts.map +1 -1
- package/dist/commonjs/sdk/inbox.js +10 -0
- package/dist/commonjs/sdk/inbox.js.map +1 -1
- package/dist/esm/funcs/formResponsesCreateFormResponses.d.ts +24 -0
- package/dist/esm/funcs/formResponsesCreateFormResponses.d.ts.map +1 -0
- package/dist/esm/funcs/formResponsesCreateFormResponses.js +100 -0
- package/dist/esm/funcs/formResponsesCreateFormResponses.js.map +1 -0
- package/dist/esm/funcs/formResponsesDeleteFormResponses.d.ts +23 -0
- package/dist/esm/funcs/formResponsesDeleteFormResponses.d.ts.map +1 -0
- package/dist/esm/funcs/formResponsesDeleteFormResponses.js +101 -0
- package/dist/esm/funcs/formResponsesDeleteFormResponses.js.map +1 -0
- package/dist/esm/funcs/formResponsesUpdateFormResponses.d.ts +21 -0
- package/dist/esm/funcs/formResponsesUpdateFormResponses.d.ts.map +1 -0
- package/dist/esm/funcs/formResponsesUpdateFormResponses.js +100 -0
- package/dist/esm/funcs/formResponsesUpdateFormResponses.js.map +1 -0
- package/dist/esm/funcs/inboxCreateInboxMessage.d.ts +18 -0
- package/dist/esm/funcs/inboxCreateInboxMessage.d.ts.map +1 -0
- package/dist/esm/funcs/inboxCreateInboxMessage.js +91 -0
- package/dist/esm/funcs/inboxCreateInboxMessage.js.map +1 -0
- 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 +9 -1
- package/dist/esm/mcp-server/server.js.map +1 -1
- package/dist/esm/mcp-server/tools/formResponsesCreateFormResponses.d.ts +8 -0
- package/dist/esm/mcp-server/tools/formResponsesCreateFormResponses.d.ts.map +1 -0
- package/dist/esm/mcp-server/tools/formResponsesCreateFormResponses.js +38 -0
- package/dist/esm/mcp-server/tools/formResponsesCreateFormResponses.js.map +1 -0
- package/dist/esm/mcp-server/tools/formResponsesDeleteFormResponses.d.ts +8 -0
- package/dist/esm/mcp-server/tools/formResponsesDeleteFormResponses.d.ts.map +1 -0
- package/dist/esm/mcp-server/tools/formResponsesDeleteFormResponses.js +37 -0
- package/dist/esm/mcp-server/tools/formResponsesDeleteFormResponses.js.map +1 -0
- package/dist/esm/mcp-server/tools/formResponsesUpdateFormResponses.d.ts +8 -0
- package/dist/esm/mcp-server/tools/formResponsesUpdateFormResponses.d.ts.map +1 -0
- package/dist/esm/mcp-server/tools/formResponsesUpdateFormResponses.js +33 -0
- package/dist/esm/mcp-server/tools/formResponsesUpdateFormResponses.js.map +1 -0
- package/dist/esm/mcp-server/tools/inboxCreateInboxMessage.d.ts +8 -0
- package/dist/esm/mcp-server/tools/inboxCreateInboxMessage.d.ts.map +1 -0
- package/dist/esm/mcp-server/tools/inboxCreateInboxMessage.js +28 -0
- package/dist/esm/mcp-server/tools/inboxCreateInboxMessage.js.map +1 -0
- package/dist/esm/models/components/createinboxmessagerequest.d.ts +172 -0
- package/dist/esm/models/components/createinboxmessagerequest.d.ts.map +1 -0
- package/dist/esm/models/components/createinboxmessagerequest.js +149 -0
- package/dist/esm/models/components/createinboxmessagerequest.js.map +1 -0
- package/dist/esm/models/components/formresponse.d.ts +57 -0
- package/dist/esm/models/components/formresponse.d.ts.map +1 -1
- package/dist/esm/models/components/formresponse.js +67 -0
- package/dist/esm/models/components/formresponse.js.map +1 -1
- package/dist/esm/models/components/index.d.ts +1 -0
- package/dist/esm/models/components/index.d.ts.map +1 -1
- package/dist/esm/models/components/index.js +1 -0
- package/dist/esm/models/components/index.js.map +1 -1
- package/dist/esm/models/components/job.d.ts +22 -22
- package/dist/esm/models/components/job.js +2 -2
- package/dist/esm/models/components/vendor.d.ts +2 -2
- package/dist/esm/models/components/vendor.d.ts.map +1 -1
- package/dist/esm/models/operations/createformresponses.d.ts +36 -0
- package/dist/esm/models/operations/createformresponses.d.ts.map +1 -0
- package/dist/esm/models/operations/createformresponses.js +45 -0
- package/dist/esm/models/operations/createformresponses.js.map +1 -0
- package/dist/esm/models/operations/deleteformresponses.d.ts +32 -0
- package/dist/esm/models/operations/deleteformresponses.d.ts.map +1 -0
- package/dist/esm/models/operations/deleteformresponses.js +31 -0
- package/dist/esm/models/operations/deleteformresponses.js.map +1 -0
- package/dist/esm/models/operations/index.d.ts +3 -0
- package/dist/esm/models/operations/index.d.ts.map +1 -1
- package/dist/esm/models/operations/index.js +3 -0
- package/dist/esm/models/operations/index.js.map +1 -1
- package/dist/esm/models/operations/updateformresponses.d.ts +38 -0
- package/dist/esm/models/operations/updateformresponses.d.ts.map +1 -0
- package/dist/esm/models/operations/updateformresponses.js +43 -0
- package/dist/esm/models/operations/updateformresponses.js.map +1 -0
- package/dist/esm/sdk/formresponses.d.ts +32 -0
- package/dist/esm/sdk/formresponses.d.ts.map +1 -1
- package/dist/esm/sdk/formresponses.js +41 -0
- package/dist/esm/sdk/formresponses.js.map +1 -1
- package/dist/esm/sdk/inbox.d.ts +7 -0
- package/dist/esm/sdk/inbox.d.ts.map +1 -1
- package/dist/esm/sdk/inbox.js +10 -0
- package/dist/esm/sdk/inbox.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/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/documenttemplates/README.md +4 -4
- 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 +309 -0
- package/docs/sdks/forms/README.md +8 -8
- package/docs/sdks/inbox/README.md +82 -0
- 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/knowledgearticles/README.md +4 -4
- package/docs/sdks/locations/README.md +4 -4
- package/docs/sdks/materials/README.md +8 -8
- 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/examples/package-lock.json +1 -1
- package/jsr.json +1 -1
- package/package.json +1 -1
- package/src/funcs/formResponsesCreateFormResponses.ts +200 -0
- package/src/funcs/formResponsesDeleteFormResponses.ts +207 -0
- package/src/funcs/formResponsesUpdateFormResponses.ts +206 -0
- package/src/funcs/inboxCreateInboxMessage.ts +179 -0
- package/src/lib/config.ts +3 -3
- package/src/mcp-server/mcp-server.ts +1 -1
- package/src/mcp-server/server.ts +9 -1
- package/src/mcp-server/tools/formResponsesCreateFormResponses.ts +49 -0
- package/src/mcp-server/tools/formResponsesDeleteFormResponses.ts +48 -0
- package/src/mcp-server/tools/formResponsesUpdateFormResponses.ts +44 -0
- package/src/mcp-server/tools/inboxCreateInboxMessage.ts +37 -0
- package/src/models/components/createinboxmessagerequest.ts +324 -0
- package/src/models/components/formresponse.ts +132 -0
- package/src/models/components/index.ts +1 -0
- package/src/models/components/job.ts +22 -22
- package/src/models/components/vendor.ts +2 -2
- package/src/models/operations/createformresponses.ts +84 -0
- package/src/models/operations/deleteformresponses.ts +69 -0
- package/src/models/operations/index.ts +3 -0
- package/src/models/operations/updateformresponses.ts +86 -0
- package/src/sdk/formresponses.ts +65 -0
- package/src/sdk/inbox.ts +18 -0
package/api.json
CHANGED
|
@@ -53,7 +53,7 @@
|
|
|
53
53
|
"success": {
|
|
54
54
|
"value": [
|
|
55
55
|
{
|
|
56
|
-
"uuid": "123e4567-
|
|
56
|
+
"uuid": "123e4567-db9a-4b4b-97d6-2329b1d899cb",
|
|
57
57
|
"active": 1,
|
|
58
58
|
"edit_date": "2025-08-01 12:00:00",
|
|
59
59
|
"name": "string",
|
|
@@ -362,7 +362,7 @@
|
|
|
362
362
|
"examples": {
|
|
363
363
|
"success": {
|
|
364
364
|
"value": {
|
|
365
|
-
"uuid": "123e4567-
|
|
365
|
+
"uuid": "123e4567-356b-4fce-9332-2329b8a2b92b",
|
|
366
366
|
"active": 1,
|
|
367
367
|
"edit_date": "2025-08-01 12:00:00",
|
|
368
368
|
"name": "string",
|
|
@@ -864,12 +864,12 @@
|
|
|
864
864
|
"success": {
|
|
865
865
|
"value": [
|
|
866
866
|
{
|
|
867
|
-
"uuid": "123e4567-
|
|
867
|
+
"uuid": "123e4567-fb3a-4705-b37e-2329bfc1c1fb",
|
|
868
868
|
"active": 1,
|
|
869
869
|
"edit_date": "2025-08-01 12:00:00",
|
|
870
|
-
"company_uuid": "123e4567-
|
|
870
|
+
"company_uuid": "123e4567-2eee-42bc-beed-2329b61407cb",
|
|
871
871
|
"asset_code": "string",
|
|
872
|
-
"asset_type_uuid": "123e4567-
|
|
872
|
+
"asset_type_uuid": "123e4567-7e05-46a7-922c-2329b5820deb",
|
|
873
873
|
"name": "string",
|
|
874
874
|
"lat": "number",
|
|
875
875
|
"lng": "number",
|
|
@@ -1031,12 +1031,12 @@
|
|
|
1031
1031
|
"examples": {
|
|
1032
1032
|
"success": {
|
|
1033
1033
|
"value": {
|
|
1034
|
-
"uuid": "123e4567-
|
|
1034
|
+
"uuid": "123e4567-739b-4577-b243-2329bae137cb",
|
|
1035
1035
|
"active": 1,
|
|
1036
1036
|
"edit_date": "2025-08-01 12:00:00",
|
|
1037
|
-
"company_uuid": "123e4567-
|
|
1037
|
+
"company_uuid": "123e4567-9713-467b-bae5-2329beb7e3eb",
|
|
1038
1038
|
"asset_code": "string",
|
|
1039
|
-
"asset_type_uuid": "123e4567-
|
|
1039
|
+
"asset_type_uuid": "123e4567-5577-4839-833d-2329b1eda7bb",
|
|
1040
1040
|
"name": "string",
|
|
1041
1041
|
"lat": "number",
|
|
1042
1042
|
"lng": "number",
|
|
@@ -1546,7 +1546,7 @@
|
|
|
1546
1546
|
"success": {
|
|
1547
1547
|
"value": [
|
|
1548
1548
|
{
|
|
1549
|
-
"uuid": "123e4567-
|
|
1549
|
+
"uuid": "123e4567-0d05-4580-a50b-2329ba446f5b",
|
|
1550
1550
|
"active": 1,
|
|
1551
1551
|
"edit_date": "2025-08-01 12:00:00",
|
|
1552
1552
|
"name": "string"
|
|
@@ -1852,7 +1852,7 @@
|
|
|
1852
1852
|
"examples": {
|
|
1853
1853
|
"success": {
|
|
1854
1854
|
"value": {
|
|
1855
|
-
"uuid": "123e4567-
|
|
1855
|
+
"uuid": "123e4567-d84b-4021-a1f2-2329b6e5f28b",
|
|
1856
1856
|
"active": 1,
|
|
1857
1857
|
"edit_date": "2025-08-01 12:00:00",
|
|
1858
1858
|
"name": "string"
|
|
@@ -2351,10 +2351,10 @@
|
|
|
2351
2351
|
"success": {
|
|
2352
2352
|
"value": [
|
|
2353
2353
|
{
|
|
2354
|
-
"uuid": "123e4567-
|
|
2354
|
+
"uuid": "123e4567-ee34-4082-8769-2329b394aa6b",
|
|
2355
2355
|
"active": 1,
|
|
2356
2356
|
"edit_date": "2025-08-01 12:00:00",
|
|
2357
|
-
"asset_type_uuid": "123e4567-
|
|
2357
|
+
"asset_type_uuid": "123e4567-bf13-4112-91d2-2329b8fa544b",
|
|
2358
2358
|
"name": "string",
|
|
2359
2359
|
"field_data": {
|
|
2360
2360
|
"fieldType": "string",
|
|
@@ -2666,10 +2666,10 @@
|
|
|
2666
2666
|
"examples": {
|
|
2667
2667
|
"success": {
|
|
2668
2668
|
"value": {
|
|
2669
|
-
"uuid": "123e4567-
|
|
2669
|
+
"uuid": "123e4567-0ba9-49d4-80e1-2329b8999f6b",
|
|
2670
2670
|
"active": 1,
|
|
2671
2671
|
"edit_date": "2025-08-01 12:00:00",
|
|
2672
|
-
"asset_type_uuid": "123e4567-
|
|
2672
|
+
"asset_type_uuid": "123e4567-dfcc-4e36-af9b-2329bdf9a2fb",
|
|
2673
2673
|
"name": "string",
|
|
2674
2674
|
"field_data": {
|
|
2675
2675
|
"fieldType": "string",
|
|
@@ -3174,14 +3174,14 @@
|
|
|
3174
3174
|
"success": {
|
|
3175
3175
|
"value": [
|
|
3176
3176
|
{
|
|
3177
|
-
"uuid": "123e4567-
|
|
3177
|
+
"uuid": "123e4567-8526-40a5-87ae-2329b04a1dcb",
|
|
3178
3178
|
"active": 1,
|
|
3179
3179
|
"edit_date": "2025-08-01 12:00:00",
|
|
3180
3180
|
"name": "string",
|
|
3181
3181
|
"automatically_allocated": "string",
|
|
3182
3182
|
"file_name": "string",
|
|
3183
|
-
"regarding_form_uuid": "123e4567-
|
|
3184
|
-
"regarding_asset_type_uuid": "123e4567-
|
|
3183
|
+
"regarding_form_uuid": "123e4567-85ca-438c-884f-2329b28d631b",
|
|
3184
|
+
"regarding_asset_type_uuid": "123e4567-7867-4ec0-870d-2329b5e1611b"
|
|
3185
3185
|
}
|
|
3186
3186
|
]
|
|
3187
3187
|
}
|
|
@@ -3484,14 +3484,14 @@
|
|
|
3484
3484
|
"examples": {
|
|
3485
3485
|
"success": {
|
|
3486
3486
|
"value": {
|
|
3487
|
-
"uuid": "123e4567-
|
|
3487
|
+
"uuid": "123e4567-20be-45ce-b271-2329b0bc858b",
|
|
3488
3488
|
"active": 1,
|
|
3489
3489
|
"edit_date": "2025-08-01 12:00:00",
|
|
3490
3490
|
"name": "string",
|
|
3491
3491
|
"automatically_allocated": "string",
|
|
3492
3492
|
"file_name": "string",
|
|
3493
|
-
"regarding_form_uuid": "123e4567-
|
|
3494
|
-
"regarding_asset_type_uuid": "123e4567-
|
|
3493
|
+
"regarding_form_uuid": "123e4567-739c-4638-913b-2329b0309a9b",
|
|
3494
|
+
"regarding_asset_type_uuid": "123e4567-dec0-4d91-a48c-2329b69fa58b"
|
|
3495
3495
|
}
|
|
3496
3496
|
}
|
|
3497
3497
|
}
|
|
@@ -3989,7 +3989,7 @@
|
|
|
3989
3989
|
{
|
|
3990
3990
|
"name": "string",
|
|
3991
3991
|
"colour": "string",
|
|
3992
|
-
"uuid": "123e4567-
|
|
3992
|
+
"uuid": "123e4567-8a92-4317-89be-2329bdf8d2ab",
|
|
3993
3993
|
"active": 1,
|
|
3994
3994
|
"edit_date": "2025-08-01 12:00:00"
|
|
3995
3995
|
}
|
|
@@ -4296,7 +4296,7 @@
|
|
|
4296
4296
|
"value": {
|
|
4297
4297
|
"name": "string",
|
|
4298
4298
|
"colour": "string",
|
|
4299
|
-
"uuid": "123e4567-
|
|
4299
|
+
"uuid": "123e4567-a072-4d0f-8853-2329ba2a07ab",
|
|
4300
4300
|
"active": 1,
|
|
4301
4301
|
"edit_date": "2025-08-01 12:00:00"
|
|
4302
4302
|
}
|
|
@@ -4799,7 +4799,7 @@
|
|
|
4799
4799
|
"address": "string",
|
|
4800
4800
|
"billing_address": "string",
|
|
4801
4801
|
"parent_company_uuid": "string",
|
|
4802
|
-
"uuid": "123e4567-
|
|
4802
|
+
"uuid": "123e4567-4459-4657-bb6a-2329bac3086b",
|
|
4803
4803
|
"active": 1,
|
|
4804
4804
|
"edit_date": "2025-08-01 12:00:00",
|
|
4805
4805
|
"website": "string",
|
|
@@ -4811,7 +4811,7 @@
|
|
|
4811
4811
|
"address_country": "string",
|
|
4812
4812
|
"fax_number": "string",
|
|
4813
4813
|
"badges": "string",
|
|
4814
|
-
"tax_rate_uuid": "123e4567-
|
|
4814
|
+
"tax_rate_uuid": "123e4567-018b-4845-b973-2329b6e4103b",
|
|
4815
4815
|
"billing_attention": "string",
|
|
4816
4816
|
"payment_terms": "string"
|
|
4817
4817
|
}
|
|
@@ -5121,7 +5121,7 @@
|
|
|
5121
5121
|
"address": "string",
|
|
5122
5122
|
"billing_address": "string",
|
|
5123
5123
|
"parent_company_uuid": "string",
|
|
5124
|
-
"uuid": "123e4567-
|
|
5124
|
+
"uuid": "123e4567-52e9-4909-87b4-2329b36967ab",
|
|
5125
5125
|
"active": 1,
|
|
5126
5126
|
"edit_date": "2025-08-01 12:00:00",
|
|
5127
5127
|
"website": "string",
|
|
@@ -5133,7 +5133,7 @@
|
|
|
5133
5133
|
"address_country": "string",
|
|
5134
5134
|
"fax_number": "string",
|
|
5135
5135
|
"badges": "string",
|
|
5136
|
-
"tax_rate_uuid": "123e4567-
|
|
5136
|
+
"tax_rate_uuid": "123e4567-896e-4541-b86a-2329bcb05abb",
|
|
5137
5137
|
"billing_attention": "string",
|
|
5138
5138
|
"payment_terms": "string"
|
|
5139
5139
|
}
|
|
@@ -5631,10 +5631,10 @@
|
|
|
5631
5631
|
"success": {
|
|
5632
5632
|
"value": [
|
|
5633
5633
|
{
|
|
5634
|
-
"uuid": "123e4567-
|
|
5634
|
+
"uuid": "123e4567-553c-4de6-95c0-2329b53edc4b",
|
|
5635
5635
|
"active": 1,
|
|
5636
5636
|
"edit_date": "2025-08-01 12:00:00",
|
|
5637
|
-
"company_uuid": "123e4567-
|
|
5637
|
+
"company_uuid": "123e4567-cf4e-4c49-b32a-2329beeb0c2b",
|
|
5638
5638
|
"first": "string",
|
|
5639
5639
|
"last": "string",
|
|
5640
5640
|
"phone": "string",
|
|
@@ -5944,10 +5944,10 @@
|
|
|
5944
5944
|
"examples": {
|
|
5945
5945
|
"success": {
|
|
5946
5946
|
"value": {
|
|
5947
|
-
"uuid": "123e4567-
|
|
5947
|
+
"uuid": "123e4567-ed81-4a3b-bc18-2329b338a74b",
|
|
5948
5948
|
"active": 1,
|
|
5949
5949
|
"edit_date": "2025-08-01 12:00:00",
|
|
5950
|
-
"company_uuid": "123e4567-
|
|
5950
|
+
"company_uuid": "123e4567-28de-479f-ba02-2329b3724b9b",
|
|
5951
5951
|
"first": "string",
|
|
5952
5952
|
"last": "string",
|
|
5953
5953
|
"phone": "string",
|
|
@@ -6450,7 +6450,7 @@
|
|
|
6450
6450
|
"success": {
|
|
6451
6451
|
"value": [
|
|
6452
6452
|
{
|
|
6453
|
-
"uuid": "123e4567-
|
|
6453
|
+
"uuid": "123e4567-190c-4f64-a0b3-2329bce8adfb",
|
|
6454
6454
|
"active": 1,
|
|
6455
6455
|
"edit_date": "2025-08-01 12:00:00",
|
|
6456
6456
|
"template_type": "string",
|
|
@@ -6758,7 +6758,7 @@
|
|
|
6758
6758
|
"examples": {
|
|
6759
6759
|
"success": {
|
|
6760
6760
|
"value": {
|
|
6761
|
-
"uuid": "123e4567-
|
|
6761
|
+
"uuid": "123e4567-c9a5-4cfb-8005-2329bc18309b",
|
|
6762
6762
|
"active": 1,
|
|
6763
6763
|
"edit_date": "2025-08-01 12:00:00",
|
|
6764
6764
|
"template_type": "string",
|
|
@@ -7259,7 +7259,7 @@
|
|
|
7259
7259
|
"success": {
|
|
7260
7260
|
"value": [
|
|
7261
7261
|
{
|
|
7262
|
-
"uuid": "123e4567-
|
|
7262
|
+
"uuid": "123e4567-5203-433c-9517-2329bead477b",
|
|
7263
7263
|
"active": 1,
|
|
7264
7264
|
"edit_date": "2025-08-01 12:00:00",
|
|
7265
7265
|
"name": "string",
|
|
@@ -7567,7 +7567,7 @@
|
|
|
7567
7567
|
"examples": {
|
|
7568
7568
|
"success": {
|
|
7569
7569
|
"value": {
|
|
7570
|
-
"uuid": "123e4567-
|
|
7570
|
+
"uuid": "123e4567-ec4b-4531-b741-2329b0296eeb",
|
|
7571
7571
|
"active": 1,
|
|
7572
7572
|
"edit_date": "2025-08-01 12:00:00",
|
|
7573
7573
|
"name": "string",
|
|
@@ -8068,12 +8068,12 @@
|
|
|
8068
8068
|
"success": {
|
|
8069
8069
|
"value": [
|
|
8070
8070
|
{
|
|
8071
|
-
"uuid": "123e4567-
|
|
8071
|
+
"uuid": "123e4567-c7b7-4d17-9bd2-2329b457e64b",
|
|
8072
8072
|
"active": 1,
|
|
8073
8073
|
"edit_date": "2025-08-01 12:00:00",
|
|
8074
8074
|
"timestamp": "string",
|
|
8075
8075
|
"related_object": "string",
|
|
8076
|
-
"related_object_uuid": "123e4567-
|
|
8076
|
+
"related_object_uuid": "123e4567-3865-49d1-bbdd-2329b0bcb54b",
|
|
8077
8077
|
"rating": "string",
|
|
8078
8078
|
"comment": "string"
|
|
8079
8079
|
}
|
|
@@ -8378,12 +8378,12 @@
|
|
|
8378
8378
|
"examples": {
|
|
8379
8379
|
"success": {
|
|
8380
8380
|
"value": {
|
|
8381
|
-
"uuid": "123e4567-
|
|
8381
|
+
"uuid": "123e4567-8925-4f57-9d72-2329b59c82cb",
|
|
8382
8382
|
"active": 1,
|
|
8383
8383
|
"edit_date": "2025-08-01 12:00:00",
|
|
8384
8384
|
"timestamp": "string",
|
|
8385
8385
|
"related_object": "string",
|
|
8386
|
-
"related_object_uuid": "123e4567-
|
|
8386
|
+
"related_object_uuid": "123e4567-fbe1-4f41-85c6-2329bcb674cb",
|
|
8387
8387
|
"rating": "string",
|
|
8388
8388
|
"comment": "string"
|
|
8389
8389
|
}
|
|
@@ -8882,7 +8882,7 @@
|
|
|
8882
8882
|
"value": [
|
|
8883
8883
|
{
|
|
8884
8884
|
"name": "string",
|
|
8885
|
-
"document_template_uuid": "123e4567-
|
|
8885
|
+
"document_template_uuid": "123e4567-090b-46e9-b484-2329b5b0a69b",
|
|
8886
8886
|
"can_be_used_independently": "string",
|
|
8887
8887
|
"badge_mandatory_state": "string",
|
|
8888
8888
|
"template_fields": [
|
|
@@ -8893,7 +8893,7 @@
|
|
|
8893
8893
|
"sortOrder": "string"
|
|
8894
8894
|
}
|
|
8895
8895
|
],
|
|
8896
|
-
"uuid": "123e4567-
|
|
8896
|
+
"uuid": "123e4567-3c6b-4696-97e0-2329b620d1ab",
|
|
8897
8897
|
"active": 1,
|
|
8898
8898
|
"edit_date": "2025-08-01 12:00:00",
|
|
8899
8899
|
"badge_name": "string"
|
|
@@ -9200,7 +9200,7 @@
|
|
|
9200
9200
|
"success": {
|
|
9201
9201
|
"value": {
|
|
9202
9202
|
"name": "string",
|
|
9203
|
-
"document_template_uuid": "123e4567-
|
|
9203
|
+
"document_template_uuid": "123e4567-df55-49fe-8f7c-2329bd93e2eb",
|
|
9204
9204
|
"can_be_used_independently": "string",
|
|
9205
9205
|
"badge_mandatory_state": "string",
|
|
9206
9206
|
"template_fields": [
|
|
@@ -9211,7 +9211,7 @@
|
|
|
9211
9211
|
"sortOrder": "string"
|
|
9212
9212
|
}
|
|
9213
9213
|
],
|
|
9214
|
-
"uuid": "123e4567-
|
|
9214
|
+
"uuid": "123e4567-7471-432d-b36f-2329bd2a2fab",
|
|
9215
9215
|
"active": 1,
|
|
9216
9216
|
"edit_date": "2025-08-01 12:00:00",
|
|
9217
9217
|
"badge_name": "string"
|
|
@@ -9710,10 +9710,10 @@
|
|
|
9710
9710
|
"success": {
|
|
9711
9711
|
"value": [
|
|
9712
9712
|
{
|
|
9713
|
-
"uuid": "123e4567-
|
|
9713
|
+
"uuid": "123e4567-ef83-4f44-9962-2329b7b600cb",
|
|
9714
9714
|
"active": 1,
|
|
9715
9715
|
"edit_date": "2025-08-01 12:00:00",
|
|
9716
|
-
"form_uuid": "123e4567-
|
|
9716
|
+
"form_uuid": "123e4567-07f7-4314-ac14-2329bc6fe47b",
|
|
9717
9717
|
"name": "string",
|
|
9718
9718
|
"field_data_json": "string",
|
|
9719
9719
|
"sort_order": "string"
|
|
@@ -10019,10 +10019,10 @@
|
|
|
10019
10019
|
"examples": {
|
|
10020
10020
|
"success": {
|
|
10021
10021
|
"value": {
|
|
10022
|
-
"uuid": "123e4567-
|
|
10022
|
+
"uuid": "123e4567-4dfb-492b-94ff-2329b61b09fb",
|
|
10023
10023
|
"active": 1,
|
|
10024
10024
|
"edit_date": "2025-08-01 12:00:00",
|
|
10025
|
-
"form_uuid": "123e4567-
|
|
10025
|
+
"form_uuid": "123e4567-3e73-429f-af11-2329b9686ceb",
|
|
10026
10026
|
"name": "string",
|
|
10027
10027
|
"field_data_json": "string",
|
|
10028
10028
|
"sort_order": "string"
|
|
@@ -10521,18 +10521,18 @@
|
|
|
10521
10521
|
"success": {
|
|
10522
10522
|
"value": [
|
|
10523
10523
|
{
|
|
10524
|
-
"uuid": "123e4567-
|
|
10524
|
+
"uuid": "123e4567-c0e9-4429-9717-2329b3048c9b",
|
|
10525
10525
|
"active": 1,
|
|
10526
10526
|
"edit_date": "2025-08-01 12:00:00",
|
|
10527
|
-
"form_uuid": "123e4567-
|
|
10528
|
-
"staff_uuid": "123e4567-
|
|
10527
|
+
"form_uuid": "123e4567-a8d2-438a-b279-2329be4596ab",
|
|
10528
|
+
"staff_uuid": "123e4567-629c-4399-907c-2329bca11dab",
|
|
10529
10529
|
"regarding_object": "string",
|
|
10530
|
-
"regarding_object_uuid": "123e4567-
|
|
10530
|
+
"regarding_object_uuid": "123e4567-e7db-4ed7-aecc-2329bef14a1b",
|
|
10531
10531
|
"field_data": "string",
|
|
10532
10532
|
"timestamp": "2025-08-01 12:00:00",
|
|
10533
|
-
"form_by_staff_uuid": "123e4567-
|
|
10534
|
-
"document_attachment_uuid": "123e4567-
|
|
10535
|
-
"asset_uuid": "123e4567-
|
|
10533
|
+
"form_by_staff_uuid": "123e4567-52e9-4164-b1fc-2329b2878dbb",
|
|
10534
|
+
"document_attachment_uuid": "123e4567-f5f2-46cc-9868-2329b0c09d5b",
|
|
10535
|
+
"asset_uuid": "123e4567-3668-47d0-a8ca-2329bcca2b9b"
|
|
10536
10536
|
}
|
|
10537
10537
|
]
|
|
10538
10538
|
}
|
|
@@ -10637,6 +10637,161 @@
|
|
|
10637
10637
|
}
|
|
10638
10638
|
}
|
|
10639
10639
|
}
|
|
10640
|
+
},
|
|
10641
|
+
"post": {
|
|
10642
|
+
"tags": [
|
|
10643
|
+
"Form Responses"
|
|
10644
|
+
],
|
|
10645
|
+
"operationId": "createFormResponses",
|
|
10646
|
+
"summary": "Create a new Form Response",
|
|
10647
|
+
"description": "\n\t\t\t\n#### OAuth Scope\nThis endpoint requires the following OAuth scope **manage_forms**.\n\n\t\t\t\n\t\t\t\n#### Record UUID\nUUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the `x-record-uuid` response header.\n\n\t\t\t",
|
|
10648
|
+
"security": [
|
|
10649
|
+
{
|
|
10650
|
+
"apiKey": []
|
|
10651
|
+
},
|
|
10652
|
+
{
|
|
10653
|
+
"oauth2": [
|
|
10654
|
+
"manage_forms"
|
|
10655
|
+
]
|
|
10656
|
+
}
|
|
10657
|
+
],
|
|
10658
|
+
"parameters": [],
|
|
10659
|
+
"requestBody": {
|
|
10660
|
+
"description": "Form Response record to create",
|
|
10661
|
+
"required": true,
|
|
10662
|
+
"content": {
|
|
10663
|
+
"application/json": {
|
|
10664
|
+
"schema": {
|
|
10665
|
+
"$ref": "#/components/schemas/FormResponse"
|
|
10666
|
+
}
|
|
10667
|
+
}
|
|
10668
|
+
}
|
|
10669
|
+
},
|
|
10670
|
+
"responses": {
|
|
10671
|
+
"200": {
|
|
10672
|
+
"headers": {
|
|
10673
|
+
"x-record-uuid": {
|
|
10674
|
+
"description": "UUID of newly created Form Response record",
|
|
10675
|
+
"schema": {
|
|
10676
|
+
"type": "string",
|
|
10677
|
+
"format": "uuid"
|
|
10678
|
+
}
|
|
10679
|
+
}
|
|
10680
|
+
},
|
|
10681
|
+
"description": "Success",
|
|
10682
|
+
"content": {
|
|
10683
|
+
"application/json": {
|
|
10684
|
+
"schema": {
|
|
10685
|
+
"$ref": "#/components/schemas/Result"
|
|
10686
|
+
},
|
|
10687
|
+
"examples": {
|
|
10688
|
+
"success": {
|
|
10689
|
+
"value": {
|
|
10690
|
+
"errorCode": "0",
|
|
10691
|
+
"message": "OK"
|
|
10692
|
+
}
|
|
10693
|
+
}
|
|
10694
|
+
}
|
|
10695
|
+
}
|
|
10696
|
+
}
|
|
10697
|
+
},
|
|
10698
|
+
"400": {
|
|
10699
|
+
"description": "Bad Request - The request is malformed or contains invalid parameters",
|
|
10700
|
+
"content": {
|
|
10701
|
+
"application/json": {
|
|
10702
|
+
"schema": {
|
|
10703
|
+
"$ref": "#/components/schemas/Error"
|
|
10704
|
+
},
|
|
10705
|
+
"examples": {
|
|
10706
|
+
"badRequest": {
|
|
10707
|
+
"value": {
|
|
10708
|
+
"errorCode": "1000",
|
|
10709
|
+
"message": "An error occurred completing your request"
|
|
10710
|
+
}
|
|
10711
|
+
}
|
|
10712
|
+
}
|
|
10713
|
+
}
|
|
10714
|
+
}
|
|
10715
|
+
},
|
|
10716
|
+
"401": {
|
|
10717
|
+
"description": "Unauthorized - Authentication credentials are missing or invalid",
|
|
10718
|
+
"content": {
|
|
10719
|
+
"application/json": {
|
|
10720
|
+
"schema": {
|
|
10721
|
+
"$ref": "#/components/schemas/AuthenticationError"
|
|
10722
|
+
},
|
|
10723
|
+
"examples": {
|
|
10724
|
+
"unauthorized": {
|
|
10725
|
+
"value": {
|
|
10726
|
+
"errorCode": "401",
|
|
10727
|
+
"message": "Authentication failed. Please check your API key or OAuth token."
|
|
10728
|
+
}
|
|
10729
|
+
}
|
|
10730
|
+
}
|
|
10731
|
+
}
|
|
10732
|
+
}
|
|
10733
|
+
},
|
|
10734
|
+
"403": {
|
|
10735
|
+
"description": "Forbidden - You don't have permission to create this resource",
|
|
10736
|
+
"content": {
|
|
10737
|
+
"application/json": {
|
|
10738
|
+
"schema": {
|
|
10739
|
+
"$ref": "#/components/schemas/ForbiddenError"
|
|
10740
|
+
},
|
|
10741
|
+
"examples": {
|
|
10742
|
+
"forbidden": {
|
|
10743
|
+
"value": {
|
|
10744
|
+
"errorCode": "403",
|
|
10745
|
+
"message": "Access forbidden. You don't have permission to access this resource."
|
|
10746
|
+
}
|
|
10747
|
+
}
|
|
10748
|
+
}
|
|
10749
|
+
}
|
|
10750
|
+
}
|
|
10751
|
+
},
|
|
10752
|
+
"429": {
|
|
10753
|
+
"description": "Too Many Requests - You have exceeded the rate limit",
|
|
10754
|
+
"content": {
|
|
10755
|
+
"application/json": {
|
|
10756
|
+
"schema": {
|
|
10757
|
+
"$ref": "#/components/schemas/RateLimitError"
|
|
10758
|
+
},
|
|
10759
|
+
"examples": {
|
|
10760
|
+
"rateLimitMinute": {
|
|
10761
|
+
"value": {
|
|
10762
|
+
"errorCode": 429,
|
|
10763
|
+
"message": "Number of allowed API requests per minute exceeded"
|
|
10764
|
+
}
|
|
10765
|
+
},
|
|
10766
|
+
"rateLimitDay": {
|
|
10767
|
+
"value": {
|
|
10768
|
+
"errorCode": 429,
|
|
10769
|
+
"message": "Number of allowed API requests per day exceeded"
|
|
10770
|
+
}
|
|
10771
|
+
}
|
|
10772
|
+
}
|
|
10773
|
+
}
|
|
10774
|
+
}
|
|
10775
|
+
},
|
|
10776
|
+
"500": {
|
|
10777
|
+
"description": "Internal Server Error - An unexpected error occurred on the server",
|
|
10778
|
+
"content": {
|
|
10779
|
+
"application/json": {
|
|
10780
|
+
"schema": {
|
|
10781
|
+
"$ref": "#/components/schemas/Error"
|
|
10782
|
+
},
|
|
10783
|
+
"examples": {
|
|
10784
|
+
"serverError": {
|
|
10785
|
+
"value": {
|
|
10786
|
+
"errorCode": 500,
|
|
10787
|
+
"message": "An unexpected error occurred. Please try again later."
|
|
10788
|
+
}
|
|
10789
|
+
}
|
|
10790
|
+
}
|
|
10791
|
+
}
|
|
10792
|
+
}
|
|
10793
|
+
}
|
|
10794
|
+
}
|
|
10640
10795
|
}
|
|
10641
10796
|
},
|
|
10642
10797
|
"/formresponse/{uuid}.json": {
|
|
@@ -10644,16 +10799,365 @@
|
|
|
10644
10799
|
"tags": [
|
|
10645
10800
|
"Form Responses"
|
|
10646
10801
|
],
|
|
10647
|
-
"operationId": "getFormResponses",
|
|
10648
|
-
"summary": "Retrieve a Form Response",
|
|
10649
|
-
"description": "\n\t\t\t\n#### OAuth Scope\nThis endpoint requires the following OAuth scope **read_forms**.\n\n\t\t\t",
|
|
10802
|
+
"operationId": "getFormResponses",
|
|
10803
|
+
"summary": "Retrieve a Form Response",
|
|
10804
|
+
"description": "\n\t\t\t\n#### OAuth Scope\nThis endpoint requires the following OAuth scope **read_forms**.\n\n\t\t\t",
|
|
10805
|
+
"security": [
|
|
10806
|
+
{
|
|
10807
|
+
"apiKey": []
|
|
10808
|
+
},
|
|
10809
|
+
{
|
|
10810
|
+
"oauth2": [
|
|
10811
|
+
"read_forms"
|
|
10812
|
+
]
|
|
10813
|
+
}
|
|
10814
|
+
],
|
|
10815
|
+
"parameters": [
|
|
10816
|
+
{
|
|
10817
|
+
"name": "uuid",
|
|
10818
|
+
"in": "path",
|
|
10819
|
+
"description": "UUID of the Form Response",
|
|
10820
|
+
"required": true,
|
|
10821
|
+
"schema": {
|
|
10822
|
+
"type": "string",
|
|
10823
|
+
"format": "uuid"
|
|
10824
|
+
}
|
|
10825
|
+
}
|
|
10826
|
+
],
|
|
10827
|
+
"responses": {
|
|
10828
|
+
"200": {
|
|
10829
|
+
"description": "Form Response record retrieved successfully",
|
|
10830
|
+
"content": {
|
|
10831
|
+
"application/json": {
|
|
10832
|
+
"schema": {
|
|
10833
|
+
"$ref": "#/components/schemas/FormResponse"
|
|
10834
|
+
},
|
|
10835
|
+
"examples": {
|
|
10836
|
+
"success": {
|
|
10837
|
+
"value": {
|
|
10838
|
+
"uuid": "123e4567-664d-466a-8787-2329b9c40b5b",
|
|
10839
|
+
"active": 1,
|
|
10840
|
+
"edit_date": "2025-08-01 12:00:00",
|
|
10841
|
+
"form_uuid": "123e4567-d565-47c2-9c8b-2329b1ce25cb",
|
|
10842
|
+
"staff_uuid": "123e4567-de4c-4494-9c6f-2329bca5025b",
|
|
10843
|
+
"regarding_object": "string",
|
|
10844
|
+
"regarding_object_uuid": "123e4567-9759-4271-973e-2329ba7118cb",
|
|
10845
|
+
"field_data": "string",
|
|
10846
|
+
"timestamp": "2025-08-01 12:00:00",
|
|
10847
|
+
"form_by_staff_uuid": "123e4567-966c-44c2-8bea-2329b205104b",
|
|
10848
|
+
"document_attachment_uuid": "123e4567-4af5-40ae-a513-2329bda6f9bb",
|
|
10849
|
+
"asset_uuid": "123e4567-151a-443d-ac72-2329b0c8735b"
|
|
10850
|
+
}
|
|
10851
|
+
}
|
|
10852
|
+
}
|
|
10853
|
+
}
|
|
10854
|
+
}
|
|
10855
|
+
},
|
|
10856
|
+
"400": {
|
|
10857
|
+
"description": "Bad Request - The request is malformed or contains invalid parameters",
|
|
10858
|
+
"content": {
|
|
10859
|
+
"application/json": {
|
|
10860
|
+
"schema": {
|
|
10861
|
+
"$ref": "#/components/schemas/Error"
|
|
10862
|
+
},
|
|
10863
|
+
"examples": {
|
|
10864
|
+
"badRequest": {
|
|
10865
|
+
"value": {
|
|
10866
|
+
"errorCode": "1000",
|
|
10867
|
+
"message": "An error occurred completing your request"
|
|
10868
|
+
}
|
|
10869
|
+
}
|
|
10870
|
+
}
|
|
10871
|
+
}
|
|
10872
|
+
}
|
|
10873
|
+
},
|
|
10874
|
+
"401": {
|
|
10875
|
+
"description": "Unauthorized - Authentication credentials are missing or invalid",
|
|
10876
|
+
"content": {
|
|
10877
|
+
"application/json": {
|
|
10878
|
+
"schema": {
|
|
10879
|
+
"$ref": "#/components/schemas/AuthenticationError"
|
|
10880
|
+
},
|
|
10881
|
+
"examples": {
|
|
10882
|
+
"unauthorized": {
|
|
10883
|
+
"value": {
|
|
10884
|
+
"errorCode": "401",
|
|
10885
|
+
"message": "Authentication failed. Please check your API key or OAuth token."
|
|
10886
|
+
}
|
|
10887
|
+
}
|
|
10888
|
+
}
|
|
10889
|
+
}
|
|
10890
|
+
}
|
|
10891
|
+
},
|
|
10892
|
+
"403": {
|
|
10893
|
+
"description": "Forbidden - You don't have permission to access this resource",
|
|
10894
|
+
"content": {
|
|
10895
|
+
"application/json": {
|
|
10896
|
+
"schema": {
|
|
10897
|
+
"$ref": "#/components/schemas/ForbiddenError"
|
|
10898
|
+
},
|
|
10899
|
+
"examples": {
|
|
10900
|
+
"forbidden": {
|
|
10901
|
+
"value": {
|
|
10902
|
+
"errorCode": "403",
|
|
10903
|
+
"message": "Access forbidden. You don't have permission to access this resource."
|
|
10904
|
+
}
|
|
10905
|
+
}
|
|
10906
|
+
}
|
|
10907
|
+
}
|
|
10908
|
+
}
|
|
10909
|
+
},
|
|
10910
|
+
"404": {
|
|
10911
|
+
"description": "Not Found - The requested record does not exist or has been deleted",
|
|
10912
|
+
"content": {
|
|
10913
|
+
"application/json": {
|
|
10914
|
+
"schema": {
|
|
10915
|
+
"$ref": "#/components/schemas/NotFoundError"
|
|
10916
|
+
},
|
|
10917
|
+
"examples": {
|
|
10918
|
+
"notFound": {
|
|
10919
|
+
"value": {
|
|
10920
|
+
"errorCode": "404",
|
|
10921
|
+
"message": "Resource not found. The requested record does not exist or has been deleted."
|
|
10922
|
+
}
|
|
10923
|
+
}
|
|
10924
|
+
}
|
|
10925
|
+
}
|
|
10926
|
+
}
|
|
10927
|
+
},
|
|
10928
|
+
"429": {
|
|
10929
|
+
"description": "Too Many Requests - You have exceeded the rate limit",
|
|
10930
|
+
"content": {
|
|
10931
|
+
"application/json": {
|
|
10932
|
+
"schema": {
|
|
10933
|
+
"$ref": "#/components/schemas/RateLimitError"
|
|
10934
|
+
},
|
|
10935
|
+
"examples": {
|
|
10936
|
+
"rateLimitMinute": {
|
|
10937
|
+
"value": {
|
|
10938
|
+
"errorCode": 429,
|
|
10939
|
+
"message": "Number of allowed API requests per minute exceeded"
|
|
10940
|
+
}
|
|
10941
|
+
},
|
|
10942
|
+
"rateLimitDay": {
|
|
10943
|
+
"value": {
|
|
10944
|
+
"errorCode": 429,
|
|
10945
|
+
"message": "Number of allowed API requests per day exceeded"
|
|
10946
|
+
}
|
|
10947
|
+
}
|
|
10948
|
+
}
|
|
10949
|
+
}
|
|
10950
|
+
}
|
|
10951
|
+
},
|
|
10952
|
+
"500": {
|
|
10953
|
+
"description": "Internal Server Error - An unexpected error occurred on the server",
|
|
10954
|
+
"content": {
|
|
10955
|
+
"application/json": {
|
|
10956
|
+
"schema": {
|
|
10957
|
+
"$ref": "#/components/schemas/Error"
|
|
10958
|
+
},
|
|
10959
|
+
"examples": {
|
|
10960
|
+
"serverError": {
|
|
10961
|
+
"value": {
|
|
10962
|
+
"errorCode": 500,
|
|
10963
|
+
"message": "An unexpected error occurred. Please try again later."
|
|
10964
|
+
}
|
|
10965
|
+
}
|
|
10966
|
+
}
|
|
10967
|
+
}
|
|
10968
|
+
}
|
|
10969
|
+
}
|
|
10970
|
+
}
|
|
10971
|
+
},
|
|
10972
|
+
"post": {
|
|
10973
|
+
"tags": [
|
|
10974
|
+
"Form Responses"
|
|
10975
|
+
],
|
|
10976
|
+
"operationId": "updateFormResponses",
|
|
10977
|
+
"summary": "Update a Form Response",
|
|
10978
|
+
"description": "\n\t\t\t\n#### OAuth Scope\nThis endpoint requires the following OAuth scope **manage_forms**.\n\n\t\t\t",
|
|
10979
|
+
"security": [
|
|
10980
|
+
{
|
|
10981
|
+
"apiKey": []
|
|
10982
|
+
},
|
|
10983
|
+
{
|
|
10984
|
+
"oauth2": [
|
|
10985
|
+
"manage_forms"
|
|
10986
|
+
]
|
|
10987
|
+
}
|
|
10988
|
+
],
|
|
10989
|
+
"parameters": [
|
|
10990
|
+
{
|
|
10991
|
+
"name": "uuid",
|
|
10992
|
+
"in": "path",
|
|
10993
|
+
"description": "UUID of the Form Response",
|
|
10994
|
+
"required": true,
|
|
10995
|
+
"schema": {
|
|
10996
|
+
"type": "string",
|
|
10997
|
+
"format": "uuid"
|
|
10998
|
+
}
|
|
10999
|
+
}
|
|
11000
|
+
],
|
|
11001
|
+
"requestBody": {
|
|
11002
|
+
"description": "Form Response fields to update",
|
|
11003
|
+
"required": true,
|
|
11004
|
+
"content": {
|
|
11005
|
+
"application/json": {
|
|
11006
|
+
"schema": {
|
|
11007
|
+
"$ref": "#/components/schemas/FormResponse"
|
|
11008
|
+
}
|
|
11009
|
+
}
|
|
11010
|
+
}
|
|
11011
|
+
},
|
|
11012
|
+
"responses": {
|
|
11013
|
+
"200": {
|
|
11014
|
+
"description": "Success - The record was updated successfully",
|
|
11015
|
+
"content": {
|
|
11016
|
+
"application/json": {
|
|
11017
|
+
"schema": {
|
|
11018
|
+
"$ref": "#/components/schemas/Result"
|
|
11019
|
+
},
|
|
11020
|
+
"examples": {
|
|
11021
|
+
"success": {
|
|
11022
|
+
"value": {
|
|
11023
|
+
"errorCode": "0",
|
|
11024
|
+
"message": "OK"
|
|
11025
|
+
}
|
|
11026
|
+
}
|
|
11027
|
+
}
|
|
11028
|
+
}
|
|
11029
|
+
}
|
|
11030
|
+
},
|
|
11031
|
+
"400": {
|
|
11032
|
+
"description": "Bad Request - The request is malformed or contains invalid parameters",
|
|
11033
|
+
"content": {
|
|
11034
|
+
"application/json": {
|
|
11035
|
+
"schema": {
|
|
11036
|
+
"$ref": "#/components/schemas/Error"
|
|
11037
|
+
},
|
|
11038
|
+
"examples": {
|
|
11039
|
+
"badRequest": {
|
|
11040
|
+
"value": {
|
|
11041
|
+
"errorCode": "1000",
|
|
11042
|
+
"message": "An error occurred completing your request"
|
|
11043
|
+
}
|
|
11044
|
+
}
|
|
11045
|
+
}
|
|
11046
|
+
}
|
|
11047
|
+
}
|
|
11048
|
+
},
|
|
11049
|
+
"401": {
|
|
11050
|
+
"description": "Unauthorized - Authentication credentials are missing or invalid",
|
|
11051
|
+
"content": {
|
|
11052
|
+
"application/json": {
|
|
11053
|
+
"schema": {
|
|
11054
|
+
"$ref": "#/components/schemas/AuthenticationError"
|
|
11055
|
+
},
|
|
11056
|
+
"examples": {
|
|
11057
|
+
"unauthorized": {
|
|
11058
|
+
"value": {
|
|
11059
|
+
"errorCode": "401",
|
|
11060
|
+
"message": "Authentication failed. Please check your API key or OAuth token."
|
|
11061
|
+
}
|
|
11062
|
+
}
|
|
11063
|
+
}
|
|
11064
|
+
}
|
|
11065
|
+
}
|
|
11066
|
+
},
|
|
11067
|
+
"403": {
|
|
11068
|
+
"description": "Forbidden - You don't have permission to update this resource",
|
|
11069
|
+
"content": {
|
|
11070
|
+
"application/json": {
|
|
11071
|
+
"schema": {
|
|
11072
|
+
"$ref": "#/components/schemas/ForbiddenError"
|
|
11073
|
+
},
|
|
11074
|
+
"examples": {
|
|
11075
|
+
"forbidden": {
|
|
11076
|
+
"value": {
|
|
11077
|
+
"errorCode": "403",
|
|
11078
|
+
"message": "Access forbidden. You don't have permission to access this resource."
|
|
11079
|
+
}
|
|
11080
|
+
}
|
|
11081
|
+
}
|
|
11082
|
+
}
|
|
11083
|
+
}
|
|
11084
|
+
},
|
|
11085
|
+
"404": {
|
|
11086
|
+
"description": "Not Found - The record to update does not exist or has been deleted",
|
|
11087
|
+
"content": {
|
|
11088
|
+
"application/json": {
|
|
11089
|
+
"schema": {
|
|
11090
|
+
"$ref": "#/components/schemas/NotFoundError"
|
|
11091
|
+
},
|
|
11092
|
+
"examples": {
|
|
11093
|
+
"notFound": {
|
|
11094
|
+
"value": {
|
|
11095
|
+
"errorCode": "404",
|
|
11096
|
+
"message": "Resource not found. The requested record does not exist or has been deleted."
|
|
11097
|
+
}
|
|
11098
|
+
}
|
|
11099
|
+
}
|
|
11100
|
+
}
|
|
11101
|
+
}
|
|
11102
|
+
},
|
|
11103
|
+
"429": {
|
|
11104
|
+
"description": "Too Many Requests - You have exceeded the rate limit",
|
|
11105
|
+
"content": {
|
|
11106
|
+
"application/json": {
|
|
11107
|
+
"schema": {
|
|
11108
|
+
"$ref": "#/components/schemas/RateLimitError"
|
|
11109
|
+
},
|
|
11110
|
+
"examples": {
|
|
11111
|
+
"rateLimitMinute": {
|
|
11112
|
+
"value": {
|
|
11113
|
+
"errorCode": 429,
|
|
11114
|
+
"message": "Number of allowed API requests per minute exceeded"
|
|
11115
|
+
}
|
|
11116
|
+
},
|
|
11117
|
+
"rateLimitDay": {
|
|
11118
|
+
"value": {
|
|
11119
|
+
"errorCode": 429,
|
|
11120
|
+
"message": "Number of allowed API requests per day exceeded"
|
|
11121
|
+
}
|
|
11122
|
+
}
|
|
11123
|
+
}
|
|
11124
|
+
}
|
|
11125
|
+
}
|
|
11126
|
+
},
|
|
11127
|
+
"500": {
|
|
11128
|
+
"description": "Internal Server Error - An unexpected error occurred on the server",
|
|
11129
|
+
"content": {
|
|
11130
|
+
"application/json": {
|
|
11131
|
+
"schema": {
|
|
11132
|
+
"$ref": "#/components/schemas/Error"
|
|
11133
|
+
},
|
|
11134
|
+
"examples": {
|
|
11135
|
+
"serverError": {
|
|
11136
|
+
"value": {
|
|
11137
|
+
"errorCode": 500,
|
|
11138
|
+
"message": "An unexpected error occurred. Please try again later."
|
|
11139
|
+
}
|
|
11140
|
+
}
|
|
11141
|
+
}
|
|
11142
|
+
}
|
|
11143
|
+
}
|
|
11144
|
+
}
|
|
11145
|
+
}
|
|
11146
|
+
},
|
|
11147
|
+
"delete": {
|
|
11148
|
+
"tags": [
|
|
11149
|
+
"Form Responses"
|
|
11150
|
+
],
|
|
11151
|
+
"operationId": "deleteFormResponses",
|
|
11152
|
+
"summary": "Delete a Form Response",
|
|
11153
|
+
"description": "\n\t\t\t\nIn ServiceM8, deleting a record sets its `active` field to `0`. Inactive records are still accessible on the API, but are hidden in the UI. Inactive records can be restored by setting their `active` field to `1`.\n\n\t\t\t\n\t\t\t\n#### OAuth Scope\nThis endpoint requires the following OAuth scope **manage_forms**.\n\n\t\t\t",
|
|
10650
11154
|
"security": [
|
|
10651
11155
|
{
|
|
10652
11156
|
"apiKey": []
|
|
10653
11157
|
},
|
|
10654
11158
|
{
|
|
10655
11159
|
"oauth2": [
|
|
10656
|
-
"
|
|
11160
|
+
"manage_forms"
|
|
10657
11161
|
]
|
|
10658
11162
|
}
|
|
10659
11163
|
],
|
|
@@ -10671,27 +11175,17 @@
|
|
|
10671
11175
|
],
|
|
10672
11176
|
"responses": {
|
|
10673
11177
|
"200": {
|
|
10674
|
-
"description": "Form Response
|
|
11178
|
+
"description": "Form Response successfully archived (soft deleted)",
|
|
10675
11179
|
"content": {
|
|
10676
11180
|
"application/json": {
|
|
10677
11181
|
"schema": {
|
|
10678
|
-
"$ref": "#/components/schemas/
|
|
11182
|
+
"$ref": "#/components/schemas/Result"
|
|
10679
11183
|
},
|
|
10680
11184
|
"examples": {
|
|
10681
11185
|
"success": {
|
|
10682
11186
|
"value": {
|
|
10683
|
-
"
|
|
10684
|
-
"
|
|
10685
|
-
"edit_date": "2025-08-01 12:00:00",
|
|
10686
|
-
"form_uuid": "123e4567-32ea-472b-857c-232171d7637b",
|
|
10687
|
-
"staff_uuid": "123e4567-3066-44a1-a359-23217a3efa4b",
|
|
10688
|
-
"regarding_object": "string",
|
|
10689
|
-
"regarding_object_uuid": "123e4567-750b-493d-ac1c-232173bb0b9b",
|
|
10690
|
-
"field_data": "string",
|
|
10691
|
-
"timestamp": "2025-08-01 12:00:00",
|
|
10692
|
-
"form_by_staff_uuid": "123e4567-ba07-42b5-9665-23217488ff9b",
|
|
10693
|
-
"document_attachment_uuid": "123e4567-25dc-4ca3-a6fd-23217c80aa1b",
|
|
10694
|
-
"asset_uuid": "123e4567-f096-4361-9003-232170d59dab"
|
|
11187
|
+
"errorCode": "0",
|
|
11188
|
+
"message": "OK"
|
|
10695
11189
|
}
|
|
10696
11190
|
}
|
|
10697
11191
|
}
|
|
@@ -10735,7 +11229,7 @@
|
|
|
10735
11229
|
}
|
|
10736
11230
|
},
|
|
10737
11231
|
"403": {
|
|
10738
|
-
"description": "Forbidden - You don't have permission to
|
|
11232
|
+
"description": "Forbidden - You don't have permission to delete this resource",
|
|
10739
11233
|
"content": {
|
|
10740
11234
|
"application/json": {
|
|
10741
11235
|
"schema": {
|
|
@@ -10753,7 +11247,7 @@
|
|
|
10753
11247
|
}
|
|
10754
11248
|
},
|
|
10755
11249
|
"404": {
|
|
10756
|
-
"description": "Not Found - The
|
|
11250
|
+
"description": "Not Found - The record to delete does not exist or has already been deleted",
|
|
10757
11251
|
"content": {
|
|
10758
11252
|
"application/json": {
|
|
10759
11253
|
"schema": {
|
|
@@ -10848,18 +11342,18 @@
|
|
|
10848
11342
|
"success": {
|
|
10849
11343
|
"value": [
|
|
10850
11344
|
{
|
|
10851
|
-
"created_by_staff_uuid": "123e4567-
|
|
11345
|
+
"created_by_staff_uuid": "123e4567-31be-408a-a837-2329b9c8d75b",
|
|
10852
11346
|
"date": "YYYY-MM-DD",
|
|
10853
|
-
"company_uuid": "123e4567-
|
|
11347
|
+
"company_uuid": "123e4567-9609-4597-a9b4-2329bafe502b",
|
|
10854
11348
|
"billing_address": "string",
|
|
10855
11349
|
"status": "string",
|
|
10856
11350
|
"lng": "number",
|
|
10857
11351
|
"lat": "number",
|
|
10858
11352
|
"payment_date": "2025-08-01 12:00:00",
|
|
10859
|
-
"payment_actioned_by_uuid": "123e4567-
|
|
11353
|
+
"payment_actioned_by_uuid": "123e4567-0655-4de8-a455-2329b8f6164b",
|
|
10860
11354
|
"payment_method": "string",
|
|
10861
11355
|
"payment_amount": "string",
|
|
10862
|
-
"category_uuid": "123e4567-
|
|
11356
|
+
"category_uuid": "123e4567-30ad-4d1f-88fb-2329b228c5cb",
|
|
10863
11357
|
"payment_note": "string",
|
|
10864
11358
|
"geo_is_valid": "string",
|
|
10865
11359
|
"purchase_order_number": "string",
|
|
@@ -10873,9 +11367,9 @@
|
|
|
10873
11367
|
"geo_city": "string",
|
|
10874
11368
|
"geo_street": "string",
|
|
10875
11369
|
"geo_number": "string",
|
|
10876
|
-
"queue_uuid": "123e4567-
|
|
11370
|
+
"queue_uuid": "123e4567-f432-4c6f-8306-2329b1cf846b",
|
|
10877
11371
|
"queue_expiry_date": "2025-08-01 12:00:00",
|
|
10878
|
-
"queue_assigned_staff_uuid": "123e4567-
|
|
11372
|
+
"queue_assigned_staff_uuid": "123e4567-231a-4318-9f4d-2329baf776eb",
|
|
10879
11373
|
"badges": "string",
|
|
10880
11374
|
"quote_date": "2025-08-01 12:00:00",
|
|
10881
11375
|
"quote_sent": "string",
|
|
@@ -10883,7 +11377,7 @@
|
|
|
10883
11377
|
"work_order_date": "2025-08-01 12:00:00",
|
|
10884
11378
|
"active_network_request_uuid": "string",
|
|
10885
11379
|
"related_knowledge_articles": "string",
|
|
10886
|
-
"uuid": "123e4567-
|
|
11380
|
+
"uuid": "123e4567-dfb5-47f9-8e07-2329b14d768b",
|
|
10887
11381
|
"active": 1,
|
|
10888
11382
|
"edit_date": "2025-08-01 12:00:00",
|
|
10889
11383
|
"job_address": "string",
|
|
@@ -10896,7 +11390,7 @@
|
|
|
10896
11390
|
"payment_received": "string",
|
|
10897
11391
|
"payment_received_stamp": "2025-08-01 12:00:00",
|
|
10898
11392
|
"completion_date": "2025-08-01 12:00:00",
|
|
10899
|
-
"completion_actioned_by_uuid": "123e4567-
|
|
11393
|
+
"completion_actioned_by_uuid": "123e4567-7f66-4909-97ba-2329b291de4b",
|
|
10900
11394
|
"unsuccessful_date": "2025-08-01 12:00:00",
|
|
10901
11395
|
"job_is_scheduled_until_stamp": "2025-08-01 12:00:00"
|
|
10902
11396
|
}
|
|
@@ -11201,18 +11695,18 @@
|
|
|
11201
11695
|
"examples": {
|
|
11202
11696
|
"success": {
|
|
11203
11697
|
"value": {
|
|
11204
|
-
"created_by_staff_uuid": "123e4567-
|
|
11698
|
+
"created_by_staff_uuid": "123e4567-e6d2-4970-a784-2329b59940fb",
|
|
11205
11699
|
"date": "YYYY-MM-DD",
|
|
11206
|
-
"company_uuid": "123e4567-
|
|
11700
|
+
"company_uuid": "123e4567-f515-4157-b049-2329bcb1f64b",
|
|
11207
11701
|
"billing_address": "string",
|
|
11208
11702
|
"status": "string",
|
|
11209
11703
|
"lng": "number",
|
|
11210
11704
|
"lat": "number",
|
|
11211
11705
|
"payment_date": "2025-08-01 12:00:00",
|
|
11212
|
-
"payment_actioned_by_uuid": "123e4567-
|
|
11706
|
+
"payment_actioned_by_uuid": "123e4567-35f8-4c34-b077-2329b5ddaabb",
|
|
11213
11707
|
"payment_method": "string",
|
|
11214
11708
|
"payment_amount": "string",
|
|
11215
|
-
"category_uuid": "123e4567-
|
|
11709
|
+
"category_uuid": "123e4567-d63d-465e-8170-2329bd12072b",
|
|
11216
11710
|
"payment_note": "string",
|
|
11217
11711
|
"geo_is_valid": "string",
|
|
11218
11712
|
"purchase_order_number": "string",
|
|
@@ -11226,9 +11720,9 @@
|
|
|
11226
11720
|
"geo_city": "string",
|
|
11227
11721
|
"geo_street": "string",
|
|
11228
11722
|
"geo_number": "string",
|
|
11229
|
-
"queue_uuid": "123e4567-
|
|
11723
|
+
"queue_uuid": "123e4567-6847-45a9-b2de-2329b18c120b",
|
|
11230
11724
|
"queue_expiry_date": "2025-08-01 12:00:00",
|
|
11231
|
-
"queue_assigned_staff_uuid": "123e4567-
|
|
11725
|
+
"queue_assigned_staff_uuid": "123e4567-fa95-4e3b-9511-2329bfd40f3b",
|
|
11232
11726
|
"badges": "string",
|
|
11233
11727
|
"quote_date": "2025-08-01 12:00:00",
|
|
11234
11728
|
"quote_sent": "string",
|
|
@@ -11236,7 +11730,7 @@
|
|
|
11236
11730
|
"work_order_date": "2025-08-01 12:00:00",
|
|
11237
11731
|
"active_network_request_uuid": "string",
|
|
11238
11732
|
"related_knowledge_articles": "string",
|
|
11239
|
-
"uuid": "123e4567-
|
|
11733
|
+
"uuid": "123e4567-32d8-4b3f-bfe5-2329bb2c30eb",
|
|
11240
11734
|
"active": 1,
|
|
11241
11735
|
"edit_date": "2025-08-01 12:00:00",
|
|
11242
11736
|
"job_address": "string",
|
|
@@ -11249,7 +11743,7 @@
|
|
|
11249
11743
|
"payment_received": "string",
|
|
11250
11744
|
"payment_received_stamp": "2025-08-01 12:00:00",
|
|
11251
11745
|
"completion_date": "2025-08-01 12:00:00",
|
|
11252
|
-
"completion_actioned_by_uuid": "123e4567-
|
|
11746
|
+
"completion_actioned_by_uuid": "123e4567-2612-49b0-bbfc-2329b8d40edb",
|
|
11253
11747
|
"unsuccessful_date": "2025-08-01 12:00:00",
|
|
11254
11748
|
"job_is_scheduled_until_stamp": "2025-08-01 12:00:00"
|
|
11255
11749
|
}
|
|
@@ -11747,11 +12241,11 @@
|
|
|
11747
12241
|
"success": {
|
|
11748
12242
|
"value": [
|
|
11749
12243
|
{
|
|
11750
|
-
"uuid": "123e4567-
|
|
12244
|
+
"uuid": "123e4567-90c8-4eb2-919e-2329b6a01bcb",
|
|
11751
12245
|
"active": 1,
|
|
11752
12246
|
"edit_date": "2025-08-01 12:00:00",
|
|
11753
|
-
"job_uuid": "123e4567-
|
|
11754
|
-
"staff_uuid": "123e4567-
|
|
12247
|
+
"job_uuid": "123e4567-edc0-48b5-b14c-2329b65d156b",
|
|
12248
|
+
"staff_uuid": "123e4567-049b-42d5-9bc6-2329b3f8906b",
|
|
11755
12249
|
"start_date": "2025-08-01 12:00:00",
|
|
11756
12250
|
"end_date": "2025-08-01 12:00:00",
|
|
11757
12251
|
"activity_was_scheduled": "string",
|
|
@@ -11761,10 +12255,10 @@
|
|
|
11761
12255
|
"has_been_opened_timestamp": "2025-08-01 12:00:00",
|
|
11762
12256
|
"travel_time_in_seconds": "string",
|
|
11763
12257
|
"travel_distance_in_meters": "string",
|
|
11764
|
-
"allocated_by_staff_uuid": "123e4567-
|
|
12258
|
+
"allocated_by_staff_uuid": "123e4567-d21c-4387-8221-2329b3cbf3fb",
|
|
11765
12259
|
"allocated_timestamp": "2025-08-01 12:00:00",
|
|
11766
|
-
"material_uuid": "123e4567-
|
|
11767
|
-
"edit_by_staff_uuid": "123e4567-
|
|
12260
|
+
"material_uuid": "123e4567-da15-49c7-a312-2329bbccae2b",
|
|
12261
|
+
"edit_by_staff_uuid": "123e4567-61cc-4d70-8954-2329b1b8f06b"
|
|
11768
12262
|
}
|
|
11769
12263
|
]
|
|
11770
12264
|
}
|
|
@@ -12067,11 +12561,11 @@
|
|
|
12067
12561
|
"examples": {
|
|
12068
12562
|
"success": {
|
|
12069
12563
|
"value": {
|
|
12070
|
-
"uuid": "123e4567-
|
|
12564
|
+
"uuid": "123e4567-8afc-4f2f-8de1-2329bc3ad86b",
|
|
12071
12565
|
"active": 1,
|
|
12072
12566
|
"edit_date": "2025-08-01 12:00:00",
|
|
12073
|
-
"job_uuid": "123e4567-
|
|
12074
|
-
"staff_uuid": "123e4567-
|
|
12567
|
+
"job_uuid": "123e4567-351f-4298-8c0f-2329b1732b2b",
|
|
12568
|
+
"staff_uuid": "123e4567-791d-4613-a036-2329b79d0f4b",
|
|
12075
12569
|
"start_date": "2025-08-01 12:00:00",
|
|
12076
12570
|
"end_date": "2025-08-01 12:00:00",
|
|
12077
12571
|
"activity_was_scheduled": "string",
|
|
@@ -12081,10 +12575,10 @@
|
|
|
12081
12575
|
"has_been_opened_timestamp": "2025-08-01 12:00:00",
|
|
12082
12576
|
"travel_time_in_seconds": "string",
|
|
12083
12577
|
"travel_distance_in_meters": "string",
|
|
12084
|
-
"allocated_by_staff_uuid": "123e4567-
|
|
12578
|
+
"allocated_by_staff_uuid": "123e4567-85d1-4c63-bcc0-2329bb22c8ab",
|
|
12085
12579
|
"allocated_timestamp": "2025-08-01 12:00:00",
|
|
12086
|
-
"material_uuid": "123e4567-
|
|
12087
|
-
"edit_by_staff_uuid": "123e4567-
|
|
12580
|
+
"material_uuid": "123e4567-dd34-4115-a27a-2329bd4d188b",
|
|
12581
|
+
"edit_by_staff_uuid": "123e4567-ab7b-4ac8-8d81-2329bddd159b"
|
|
12088
12582
|
}
|
|
12089
12583
|
}
|
|
12090
12584
|
}
|
|
@@ -12580,15 +13074,15 @@
|
|
|
12580
13074
|
"success": {
|
|
12581
13075
|
"value": [
|
|
12582
13076
|
{
|
|
12583
|
-
"uuid": "123e4567-
|
|
13077
|
+
"uuid": "123e4567-4bc2-453e-8754-2329b037a69b",
|
|
12584
13078
|
"active": 1,
|
|
12585
13079
|
"edit_date": "2025-08-01 12:00:00",
|
|
12586
|
-
"job_uuid": "123e4567-
|
|
12587
|
-
"queue_uuid": "123e4567-
|
|
12588
|
-
"staff_uuid": "123e4567-
|
|
13080
|
+
"job_uuid": "123e4567-0399-48e9-a6e9-2329b22f28eb",
|
|
13081
|
+
"queue_uuid": "123e4567-b87f-4c02-80b8-2329b573b48b",
|
|
13082
|
+
"staff_uuid": "123e4567-35c2-41ee-b8a1-2329b993621b",
|
|
12589
13083
|
"allocation_date": "2025-08-01 12:00:00",
|
|
12590
|
-
"allocation_window_uuid": "123e4567-
|
|
12591
|
-
"allocated_by_staff_uuid": "123e4567-
|
|
13084
|
+
"allocation_window_uuid": "123e4567-ff3c-450e-bdcc-2329b6aaefdb",
|
|
13085
|
+
"allocated_by_staff_uuid": "123e4567-4ec3-4983-b6fc-2329b6bac19b",
|
|
12592
13086
|
"allocated_timestamp": "2025-08-01 12:00:00",
|
|
12593
13087
|
"expiry_timestamp": "2025-08-01 12:00:00",
|
|
12594
13088
|
"read_timestamp": "2025-08-01 12:00:00",
|
|
@@ -12901,15 +13395,15 @@
|
|
|
12901
13395
|
"examples": {
|
|
12902
13396
|
"success": {
|
|
12903
13397
|
"value": {
|
|
12904
|
-
"uuid": "123e4567-
|
|
13398
|
+
"uuid": "123e4567-8596-43a7-927b-2329b2ad9bbb",
|
|
12905
13399
|
"active": 1,
|
|
12906
13400
|
"edit_date": "2025-08-01 12:00:00",
|
|
12907
|
-
"job_uuid": "123e4567-
|
|
12908
|
-
"queue_uuid": "123e4567-
|
|
12909
|
-
"staff_uuid": "123e4567-
|
|
13401
|
+
"job_uuid": "123e4567-2fdf-4f16-8967-2329bf4f13fb",
|
|
13402
|
+
"queue_uuid": "123e4567-e21b-4af3-8e1f-2329bdb93e7b",
|
|
13403
|
+
"staff_uuid": "123e4567-ce42-4ad4-af73-2329bf94d2bb",
|
|
12910
13404
|
"allocation_date": "2025-08-01 12:00:00",
|
|
12911
|
-
"allocation_window_uuid": "123e4567-
|
|
12912
|
-
"allocated_by_staff_uuid": "123e4567-
|
|
13405
|
+
"allocation_window_uuid": "123e4567-105c-4551-8edf-2329b969b93b",
|
|
13406
|
+
"allocated_by_staff_uuid": "123e4567-07eb-4854-aea0-2329b9c48afb",
|
|
12913
13407
|
"allocated_timestamp": "2025-08-01 12:00:00",
|
|
12914
13408
|
"expiry_timestamp": "2025-08-01 12:00:00",
|
|
12915
13409
|
"read_timestamp": "2025-08-01 12:00:00",
|
|
@@ -13415,27 +13909,27 @@
|
|
|
13415
13909
|
"success": {
|
|
13416
13910
|
"value": [
|
|
13417
13911
|
{
|
|
13418
|
-
"uuid": "123e4567-
|
|
13912
|
+
"uuid": "123e4567-5939-41ed-ab00-2329b2b2d4ab",
|
|
13419
13913
|
"active": 1,
|
|
13420
13914
|
"edit_date": "2025-08-01 12:00:00",
|
|
13421
|
-
"job_uuid": "123e4567-
|
|
13915
|
+
"job_uuid": "123e4567-4194-4a47-a708-2329bd367dfb",
|
|
13422
13916
|
"name": "string",
|
|
13423
13917
|
"section_name": "string",
|
|
13424
13918
|
"item_type": "string",
|
|
13425
13919
|
"sort_order": "string",
|
|
13426
13920
|
"completed_timestamp": "2025-08-01 12:00:00",
|
|
13427
|
-
"completed_by_staff_uuid": "123e4567-
|
|
13428
|
-
"completed_during_checkin_uuid": "123e4567-
|
|
13921
|
+
"completed_by_staff_uuid": "123e4567-7085-4305-b0b4-2329b60b056b",
|
|
13922
|
+
"completed_during_checkin_uuid": "123e4567-e445-457e-ba2d-2329b46b735b",
|
|
13429
13923
|
"reminder_type": "string",
|
|
13430
13924
|
"reminder_data": "string",
|
|
13431
13925
|
"regarding_object": "string",
|
|
13432
|
-
"regarding_object_uuid": "123e4567-
|
|
13926
|
+
"regarding_object_uuid": "123e4567-6f83-4ac5-8199-2329b6a99fab",
|
|
13433
13927
|
"fulfilled_by_object_name": "string",
|
|
13434
|
-
"fulfilled_by_object_uuid": "123e4567-
|
|
13435
|
-
"assigned_to_staff_uuids": "123e4567-
|
|
13928
|
+
"fulfilled_by_object_uuid": "123e4567-7fad-4e7e-bad0-2329bda3c76b",
|
|
13929
|
+
"assigned_to_staff_uuids": "123e4567-d942-4345-bc3e-2329b269b11b",
|
|
13436
13930
|
"is_locked": "string",
|
|
13437
13931
|
"assigned_timestamp": "2025-08-01 12:00:00",
|
|
13438
|
-
"assigned_by_staff_uuid": "123e4567-
|
|
13932
|
+
"assigned_by_staff_uuid": "123e4567-29e4-420b-a83d-2329bff5e2ab"
|
|
13439
13933
|
}
|
|
13440
13934
|
]
|
|
13441
13935
|
}
|
|
@@ -13738,27 +14232,27 @@
|
|
|
13738
14232
|
"examples": {
|
|
13739
14233
|
"success": {
|
|
13740
14234
|
"value": {
|
|
13741
|
-
"uuid": "123e4567-
|
|
14235
|
+
"uuid": "123e4567-83fe-4763-be8e-2329b5ab6e1b",
|
|
13742
14236
|
"active": 1,
|
|
13743
14237
|
"edit_date": "2025-08-01 12:00:00",
|
|
13744
|
-
"job_uuid": "123e4567-
|
|
14238
|
+
"job_uuid": "123e4567-bfa6-4a11-a733-2329b3a03c8b",
|
|
13745
14239
|
"name": "string",
|
|
13746
14240
|
"section_name": "string",
|
|
13747
14241
|
"item_type": "string",
|
|
13748
14242
|
"sort_order": "string",
|
|
13749
14243
|
"completed_timestamp": "2025-08-01 12:00:00",
|
|
13750
|
-
"completed_by_staff_uuid": "123e4567-
|
|
13751
|
-
"completed_during_checkin_uuid": "123e4567-
|
|
14244
|
+
"completed_by_staff_uuid": "123e4567-413d-4b17-b917-2329b7ed1b3b",
|
|
14245
|
+
"completed_during_checkin_uuid": "123e4567-7203-4c32-b894-2329b79522cb",
|
|
13752
14246
|
"reminder_type": "string",
|
|
13753
14247
|
"reminder_data": "string",
|
|
13754
14248
|
"regarding_object": "string",
|
|
13755
|
-
"regarding_object_uuid": "123e4567-
|
|
14249
|
+
"regarding_object_uuid": "123e4567-5336-489e-ac6f-2329b63f0ffb",
|
|
13756
14250
|
"fulfilled_by_object_name": "string",
|
|
13757
|
-
"fulfilled_by_object_uuid": "123e4567-
|
|
13758
|
-
"assigned_to_staff_uuids": "123e4567-
|
|
14251
|
+
"fulfilled_by_object_uuid": "123e4567-64c2-48d4-be45-2329b71427cb",
|
|
14252
|
+
"assigned_to_staff_uuids": "123e4567-8f1d-4ade-a414-2329bc0857cb",
|
|
13759
14253
|
"is_locked": "string",
|
|
13760
14254
|
"assigned_timestamp": "2025-08-01 12:00:00",
|
|
13761
|
-
"assigned_by_staff_uuid": "123e4567-
|
|
14255
|
+
"assigned_by_staff_uuid": "123e4567-e117-476b-92cf-2329bdc0ea0b"
|
|
13762
14256
|
}
|
|
13763
14257
|
}
|
|
13764
14258
|
}
|
|
@@ -14254,10 +14748,10 @@
|
|
|
14254
14748
|
"success": {
|
|
14255
14749
|
"value": [
|
|
14256
14750
|
{
|
|
14257
|
-
"uuid": "123e4567-
|
|
14751
|
+
"uuid": "123e4567-2c94-4f3c-b9c9-2329ba2902fb",
|
|
14258
14752
|
"active": 1,
|
|
14259
14753
|
"edit_date": "2025-08-01 12:00:00",
|
|
14260
|
-
"job_uuid": "123e4567-
|
|
14754
|
+
"job_uuid": "123e4567-4aa5-4cd6-8178-2329b67e73fb",
|
|
14261
14755
|
"first": "string",
|
|
14262
14756
|
"last": "string",
|
|
14263
14757
|
"phone": "string",
|
|
@@ -14567,10 +15061,10 @@
|
|
|
14567
15061
|
"examples": {
|
|
14568
15062
|
"success": {
|
|
14569
15063
|
"value": {
|
|
14570
|
-
"uuid": "123e4567-
|
|
15064
|
+
"uuid": "123e4567-b89b-4b0a-8043-2329b0404e0b",
|
|
14571
15065
|
"active": 1,
|
|
14572
15066
|
"edit_date": "2025-08-01 12:00:00",
|
|
14573
|
-
"job_uuid": "123e4567-
|
|
15067
|
+
"job_uuid": "123e4567-8032-4da6-bae2-2329bd0e04ab",
|
|
14574
15068
|
"first": "string",
|
|
14575
15069
|
"last": "string",
|
|
14576
15070
|
"phone": "string",
|
|
@@ -15073,21 +15567,21 @@
|
|
|
15073
15567
|
"success": {
|
|
15074
15568
|
"value": [
|
|
15075
15569
|
{
|
|
15076
|
-
"uuid": "123e4567-
|
|
15570
|
+
"uuid": "123e4567-f699-4cc7-a4c1-2329ba3c93eb",
|
|
15077
15571
|
"active": 1,
|
|
15078
15572
|
"edit_date": "2025-08-01 12:00:00",
|
|
15079
|
-
"job_uuid": "123e4567-
|
|
15080
|
-
"material_uuid": "123e4567-
|
|
15573
|
+
"job_uuid": "123e4567-6c6c-4fd2-afc1-2329bce221bb",
|
|
15574
|
+
"material_uuid": "123e4567-e84b-4bf6-b90b-2329bd78aabb",
|
|
15081
15575
|
"name": "string",
|
|
15082
15576
|
"quantity": "string",
|
|
15083
15577
|
"price": "string",
|
|
15084
15578
|
"displayed_amount": "string",
|
|
15085
15579
|
"displayed_amount_is_tax_inclusive": "string",
|
|
15086
|
-
"tax_rate_uuid": "123e4567-
|
|
15580
|
+
"tax_rate_uuid": "123e4567-aa40-4297-97ac-2329bc9476cb",
|
|
15087
15581
|
"sort_order": "string",
|
|
15088
15582
|
"cost": "string",
|
|
15089
15583
|
"displayed_cost": "string",
|
|
15090
|
-
"job_material_bundle_uuid": "123e4567-
|
|
15584
|
+
"job_material_bundle_uuid": "123e4567-bfd3-4b21-8f7d-2329baeecefb"
|
|
15091
15585
|
}
|
|
15092
15586
|
]
|
|
15093
15587
|
}
|
|
@@ -15390,21 +15884,21 @@
|
|
|
15390
15884
|
"examples": {
|
|
15391
15885
|
"success": {
|
|
15392
15886
|
"value": {
|
|
15393
|
-
"uuid": "123e4567-
|
|
15887
|
+
"uuid": "123e4567-9070-41f3-bcfb-2329bd4aaeab",
|
|
15394
15888
|
"active": 1,
|
|
15395
15889
|
"edit_date": "2025-08-01 12:00:00",
|
|
15396
|
-
"job_uuid": "123e4567-
|
|
15397
|
-
"material_uuid": "123e4567-
|
|
15890
|
+
"job_uuid": "123e4567-15b2-400e-8114-2329b4e6da4b",
|
|
15891
|
+
"material_uuid": "123e4567-5d73-4fcd-ba8e-2329bd689bab",
|
|
15398
15892
|
"name": "string",
|
|
15399
15893
|
"quantity": "string",
|
|
15400
15894
|
"price": "string",
|
|
15401
15895
|
"displayed_amount": "string",
|
|
15402
15896
|
"displayed_amount_is_tax_inclusive": "string",
|
|
15403
|
-
"tax_rate_uuid": "123e4567-
|
|
15897
|
+
"tax_rate_uuid": "123e4567-73dc-4e12-adf8-2329b476b52b",
|
|
15404
15898
|
"sort_order": "string",
|
|
15405
15899
|
"cost": "string",
|
|
15406
15900
|
"displayed_cost": "string",
|
|
15407
|
-
"job_material_bundle_uuid": "123e4567-
|
|
15901
|
+
"job_material_bundle_uuid": "123e4567-1db4-47a8-b581-2329b484556b"
|
|
15408
15902
|
}
|
|
15409
15903
|
}
|
|
15410
15904
|
}
|
|
@@ -15900,15 +16394,15 @@
|
|
|
15900
16394
|
"success": {
|
|
15901
16395
|
"value": [
|
|
15902
16396
|
{
|
|
15903
|
-
"uuid": "123e4567-
|
|
16397
|
+
"uuid": "123e4567-0939-4c69-8d45-2329b5b8a6ab",
|
|
15904
16398
|
"active": 1,
|
|
15905
16399
|
"edit_date": "2025-08-01 12:00:00",
|
|
15906
16400
|
"item_number": "string",
|
|
15907
16401
|
"name": "string",
|
|
15908
16402
|
"quantity": "string",
|
|
15909
16403
|
"sort_order": "string",
|
|
15910
|
-
"material_bundle_uuid": "123e4567-
|
|
15911
|
-
"job_uuid": "123e4567-
|
|
16404
|
+
"material_bundle_uuid": "123e4567-ac41-452d-b5cd-2329bb4bfeeb",
|
|
16405
|
+
"job_uuid": "123e4567-d8a2-489c-b84a-2329bb4bd50b"
|
|
15912
16406
|
}
|
|
15913
16407
|
]
|
|
15914
16408
|
}
|
|
@@ -16211,15 +16705,15 @@
|
|
|
16211
16705
|
"examples": {
|
|
16212
16706
|
"success": {
|
|
16213
16707
|
"value": {
|
|
16214
|
-
"uuid": "123e4567-
|
|
16708
|
+
"uuid": "123e4567-1ea2-4162-b751-2329b9af987b",
|
|
16215
16709
|
"active": 1,
|
|
16216
16710
|
"edit_date": "2025-08-01 12:00:00",
|
|
16217
16711
|
"item_number": "string",
|
|
16218
16712
|
"name": "string",
|
|
16219
16713
|
"quantity": "string",
|
|
16220
16714
|
"sort_order": "string",
|
|
16221
|
-
"material_bundle_uuid": "123e4567-
|
|
16222
|
-
"job_uuid": "123e4567-
|
|
16715
|
+
"material_bundle_uuid": "123e4567-df56-4020-a3fb-2329b7824edb",
|
|
16716
|
+
"job_uuid": "123e4567-6696-4637-ad4f-2329bea547db"
|
|
16223
16717
|
}
|
|
16224
16718
|
}
|
|
16225
16719
|
}
|
|
@@ -16715,16 +17209,16 @@
|
|
|
16715
17209
|
"success": {
|
|
16716
17210
|
"value": [
|
|
16717
17211
|
{
|
|
16718
|
-
"uuid": "123e4567-
|
|
17212
|
+
"uuid": "123e4567-d038-4936-8d4a-2329bc3f3bdb",
|
|
16719
17213
|
"active": 1,
|
|
16720
17214
|
"edit_date": "2025-08-01 12:00:00",
|
|
16721
|
-
"job_uuid": "123e4567-
|
|
16722
|
-
"actioned_by_uuid": "123e4567-
|
|
17215
|
+
"job_uuid": "123e4567-8678-424d-b231-2329b532df3b",
|
|
17216
|
+
"actioned_by_uuid": "123e4567-8c69-4c2b-85b8-2329b22cd3db",
|
|
16723
17217
|
"timestamp": "2025-08-01 12:00:00",
|
|
16724
17218
|
"amount": "string",
|
|
16725
17219
|
"method": "string",
|
|
16726
17220
|
"note": "string",
|
|
16727
|
-
"attachment_uuid": "123e4567-
|
|
17221
|
+
"attachment_uuid": "123e4567-8d63-4739-aa0f-2329b7eacf1b",
|
|
16728
17222
|
"is_deposit": "string"
|
|
16729
17223
|
}
|
|
16730
17224
|
]
|
|
@@ -17028,16 +17522,16 @@
|
|
|
17028
17522
|
"examples": {
|
|
17029
17523
|
"success": {
|
|
17030
17524
|
"value": {
|
|
17031
|
-
"uuid": "123e4567-
|
|
17525
|
+
"uuid": "123e4567-142c-4a6c-96f7-2329b4cd52db",
|
|
17032
17526
|
"active": 1,
|
|
17033
17527
|
"edit_date": "2025-08-01 12:00:00",
|
|
17034
|
-
"job_uuid": "123e4567-
|
|
17035
|
-
"actioned_by_uuid": "123e4567-
|
|
17528
|
+
"job_uuid": "123e4567-d907-40c7-9c50-2329ba9087bb",
|
|
17529
|
+
"actioned_by_uuid": "123e4567-4f81-4e96-9706-2329b40a69bb",
|
|
17036
17530
|
"timestamp": "2025-08-01 12:00:00",
|
|
17037
17531
|
"amount": "string",
|
|
17038
17532
|
"method": "string",
|
|
17039
17533
|
"note": "string",
|
|
17040
|
-
"attachment_uuid": "123e4567-
|
|
17534
|
+
"attachment_uuid": "123e4567-7355-4b74-80d2-2329bcf3ca0b",
|
|
17041
17535
|
"is_deposit": "string"
|
|
17042
17536
|
}
|
|
17043
17537
|
}
|
|
@@ -17534,7 +18028,7 @@
|
|
|
17534
18028
|
"success": {
|
|
17535
18029
|
"value": [
|
|
17536
18030
|
{
|
|
17537
|
-
"uuid": "123e4567-
|
|
18031
|
+
"uuid": "123e4567-9831-4c9a-ab2d-2329ba5bb36b",
|
|
17538
18032
|
"active": 1,
|
|
17539
18033
|
"edit_date": "2025-08-01 12:00:00",
|
|
17540
18034
|
"name": "string"
|
|
@@ -17685,7 +18179,7 @@
|
|
|
17685
18179
|
"examples": {
|
|
17686
18180
|
"success": {
|
|
17687
18181
|
"value": {
|
|
17688
|
-
"uuid": "123e4567-
|
|
18182
|
+
"uuid": "123e4567-3ada-4d6b-ae3b-2329bed9041b",
|
|
17689
18183
|
"active": 1,
|
|
17690
18184
|
"edit_date": "2025-08-01 12:00:00",
|
|
17691
18185
|
"name": "string"
|
|
@@ -17845,7 +18339,7 @@
|
|
|
17845
18339
|
"success": {
|
|
17846
18340
|
"value": [
|
|
17847
18341
|
{
|
|
17848
|
-
"uuid": "123e4567-
|
|
18342
|
+
"uuid": "123e4567-c8ff-4f8d-ab3a-2329b820250b",
|
|
17849
18343
|
"active": 1,
|
|
17850
18344
|
"edit_date": "2025-08-01 12:00:00",
|
|
17851
18345
|
"name": "string",
|
|
@@ -18162,7 +18656,7 @@
|
|
|
18162
18656
|
"examples": {
|
|
18163
18657
|
"success": {
|
|
18164
18658
|
"value": {
|
|
18165
|
-
"uuid": "123e4567-
|
|
18659
|
+
"uuid": "123e4567-3182-4c0e-a334-2329b67a6a0b",
|
|
18166
18660
|
"active": 1,
|
|
18167
18661
|
"edit_date": "2025-08-01 12:00:00",
|
|
18168
18662
|
"name": "string",
|
|
@@ -18683,7 +19177,7 @@
|
|
|
18683
19177
|
"state": "string",
|
|
18684
19178
|
"lng": "number",
|
|
18685
19179
|
"lat": "number",
|
|
18686
|
-
"uuid": "123e4567-
|
|
19180
|
+
"uuid": "123e4567-5c3e-4de6-892c-2329b4eee76b",
|
|
18687
19181
|
"active": 1,
|
|
18688
19182
|
"edit_date": "2025-08-01 12:00:00"
|
|
18689
19183
|
}
|
|
@@ -18999,7 +19493,7 @@
|
|
|
18999
19493
|
"state": "string",
|
|
19000
19494
|
"lng": "number",
|
|
19001
19495
|
"lat": "number",
|
|
19002
|
-
"uuid": "123e4567-
|
|
19496
|
+
"uuid": "123e4567-bcc8-40cb-a346-2329b9e086cb",
|
|
19003
19497
|
"active": 1,
|
|
19004
19498
|
"edit_date": "2025-08-01 12:00:00"
|
|
19005
19499
|
}
|
|
@@ -19505,12 +19999,12 @@
|
|
|
19505
19999
|
"price_includes_taxes": "string",
|
|
19506
20000
|
"barcode": "string",
|
|
19507
20001
|
"item_is_inventoried": "string",
|
|
19508
|
-
"uuid": "123e4567-
|
|
20002
|
+
"uuid": "123e4567-c54f-4034-af5d-2329b5bb902b",
|
|
19509
20003
|
"active": 1,
|
|
19510
20004
|
"edit_date": "2025-08-01 12:00:00",
|
|
19511
20005
|
"item_description": "string",
|
|
19512
20006
|
"use_description_for_invoicing": "string",
|
|
19513
|
-
"tax_rate_uuid": "123e4567-
|
|
20007
|
+
"tax_rate_uuid": "123e4567-86f9-4c32-b308-2329ba3a38bb"
|
|
19514
20008
|
}
|
|
19515
20009
|
]
|
|
19516
20010
|
}
|
|
@@ -19821,12 +20315,12 @@
|
|
|
19821
20315
|
"price_includes_taxes": "string",
|
|
19822
20316
|
"barcode": "string",
|
|
19823
20317
|
"item_is_inventoried": "string",
|
|
19824
|
-
"uuid": "123e4567-
|
|
20318
|
+
"uuid": "123e4567-558b-4d16-b8aa-2329b414966b",
|
|
19825
20319
|
"active": 1,
|
|
19826
20320
|
"edit_date": "2025-08-01 12:00:00",
|
|
19827
20321
|
"item_description": "string",
|
|
19828
20322
|
"use_description_for_invoicing": "string",
|
|
19829
|
-
"tax_rate_uuid": "123e4567-
|
|
20323
|
+
"tax_rate_uuid": "123e4567-71ac-4de1-b634-2329b0122cbb"
|
|
19830
20324
|
}
|
|
19831
20325
|
}
|
|
19832
20326
|
}
|
|
@@ -20322,7 +20816,7 @@
|
|
|
20322
20816
|
"success": {
|
|
20323
20817
|
"value": [
|
|
20324
20818
|
{
|
|
20325
|
-
"uuid": "123e4567-
|
|
20819
|
+
"uuid": "123e4567-de9c-4693-8974-2329b35eab5b",
|
|
20326
20820
|
"active": 1,
|
|
20327
20821
|
"edit_date": "2025-08-01 12:00:00",
|
|
20328
20822
|
"item_number": "string",
|
|
@@ -20635,7 +21129,7 @@
|
|
|
20635
21129
|
"examples": {
|
|
20636
21130
|
"success": {
|
|
20637
21131
|
"value": {
|
|
20638
|
-
"uuid": "123e4567-
|
|
21132
|
+
"uuid": "123e4567-a257-45ed-96a4-2329bf69ee1b",
|
|
20639
21133
|
"active": 1,
|
|
20640
21134
|
"edit_date": "2025-08-01 12:00:00",
|
|
20641
21135
|
"item_number": "string",
|
|
@@ -21141,7 +21635,7 @@
|
|
|
21141
21635
|
"success": {
|
|
21142
21636
|
"value": [
|
|
21143
21637
|
{
|
|
21144
|
-
"uuid": "123e4567-
|
|
21638
|
+
"uuid": "123e4567-8376-4898-8aee-2329b0d9503b",
|
|
21145
21639
|
"active": 1,
|
|
21146
21640
|
"edit_date": "2025-08-01 12:00:00",
|
|
21147
21641
|
"name": "string",
|
|
@@ -21450,7 +21944,7 @@
|
|
|
21450
21944
|
"examples": {
|
|
21451
21945
|
"success": {
|
|
21452
21946
|
"value": {
|
|
21453
|
-
"uuid": "123e4567-
|
|
21947
|
+
"uuid": "123e4567-b9e3-47c8-bb29-2329b21c5f7b",
|
|
21454
21948
|
"active": 1,
|
|
21455
21949
|
"edit_date": "2025-08-01 12:00:00",
|
|
21456
21950
|
"name": "string",
|
|
@@ -21954,7 +22448,7 @@
|
|
|
21954
22448
|
{
|
|
21955
22449
|
"name": "string",
|
|
21956
22450
|
"role_description": "string",
|
|
21957
|
-
"uuid": "123e4567-
|
|
22451
|
+
"uuid": "123e4567-566b-4b18-ac63-2329b53936db",
|
|
21958
22452
|
"active": 1,
|
|
21959
22453
|
"edit_date": "2025-08-01 12:00:00"
|
|
21960
22454
|
}
|
|
@@ -22106,7 +22600,7 @@
|
|
|
22106
22600
|
"value": {
|
|
22107
22601
|
"name": "string",
|
|
22108
22602
|
"role_description": "string",
|
|
22109
|
-
"uuid": "123e4567-
|
|
22603
|
+
"uuid": "123e4567-fc67-490e-a41a-2329b9f65c1b",
|
|
22110
22604
|
"active": 1,
|
|
22111
22605
|
"edit_date": "2025-08-01 12:00:00"
|
|
22112
22606
|
}
|
|
@@ -22265,7 +22759,7 @@
|
|
|
22265
22759
|
"success": {
|
|
22266
22760
|
"value": [
|
|
22267
22761
|
{
|
|
22268
|
-
"uuid": "123e4567-
|
|
22762
|
+
"uuid": "123e4567-8e73-4ccd-b5ff-2329bb1c001b",
|
|
22269
22763
|
"active": 1,
|
|
22270
22764
|
"edit_date": "2025-08-01 12:00:00",
|
|
22271
22765
|
"name": "string",
|
|
@@ -22572,7 +23066,7 @@
|
|
|
22572
23066
|
"examples": {
|
|
22573
23067
|
"success": {
|
|
22574
23068
|
"value": {
|
|
22575
|
-
"uuid": "123e4567-
|
|
23069
|
+
"uuid": "123e4567-8209-41a4-a1e8-2329baf7cc6b",
|
|
22576
23070
|
"active": 1,
|
|
22577
23071
|
"edit_date": "2025-08-01 12:00:00",
|
|
22578
23072
|
"name": "string",
|
|
@@ -23080,7 +23574,7 @@
|
|
|
23080
23574
|
"lat": "number",
|
|
23081
23575
|
"geo_timestamp": "2025-08-01 12:00:00",
|
|
23082
23576
|
"job_title": "string",
|
|
23083
|
-
"navigating_to_job_uuid": "123e4567-
|
|
23577
|
+
"navigating_to_job_uuid": "123e4567-2d61-43fc-a9e9-2329bd52087b",
|
|
23084
23578
|
"navigating_timestamp": "2025-08-01 12:00:00",
|
|
23085
23579
|
"navigating_expiry_timestamp": "2025-08-01 12:00:00",
|
|
23086
23580
|
"color": "string",
|
|
@@ -23088,8 +23582,8 @@
|
|
|
23088
23582
|
"status_message": "string",
|
|
23089
23583
|
"status_message_timestamp": "2025-08-01 12:00:00",
|
|
23090
23584
|
"hide_from_schedule": "string",
|
|
23091
|
-
"security_role_uuid": "123e4567-
|
|
23092
|
-
"uuid": "123e4567-
|
|
23585
|
+
"security_role_uuid": "123e4567-ee5d-4871-b62b-2329b03fc51b",
|
|
23586
|
+
"uuid": "123e4567-cdfe-454e-9973-2329b086984b",
|
|
23093
23587
|
"active": 1,
|
|
23094
23588
|
"edit_date": "2025-08-01 12:00:00",
|
|
23095
23589
|
"can_receive_push_notification": "string"
|
|
@@ -23403,7 +23897,7 @@
|
|
|
23403
23897
|
"lat": "number",
|
|
23404
23898
|
"geo_timestamp": "2025-08-01 12:00:00",
|
|
23405
23899
|
"job_title": "string",
|
|
23406
|
-
"navigating_to_job_uuid": "123e4567-
|
|
23900
|
+
"navigating_to_job_uuid": "123e4567-8f03-4812-b232-2329bcd5006b",
|
|
23407
23901
|
"navigating_timestamp": "2025-08-01 12:00:00",
|
|
23408
23902
|
"navigating_expiry_timestamp": "2025-08-01 12:00:00",
|
|
23409
23903
|
"color": "string",
|
|
@@ -23411,8 +23905,8 @@
|
|
|
23411
23905
|
"status_message": "string",
|
|
23412
23906
|
"status_message_timestamp": "2025-08-01 12:00:00",
|
|
23413
23907
|
"hide_from_schedule": "string",
|
|
23414
|
-
"security_role_uuid": "123e4567-
|
|
23415
|
-
"uuid": "123e4567-
|
|
23908
|
+
"security_role_uuid": "123e4567-c019-46d7-bcda-2329b71f442b",
|
|
23909
|
+
"uuid": "123e4567-5305-40e5-9a8b-2329bd4586fb",
|
|
23416
23910
|
"active": 1,
|
|
23417
23911
|
"edit_date": "2025-08-01 12:00:00",
|
|
23418
23912
|
"can_receive_push_notification": "string"
|
|
@@ -23911,16 +24405,16 @@
|
|
|
23911
24405
|
"success": {
|
|
23912
24406
|
"value": [
|
|
23913
24407
|
{
|
|
23914
|
-
"uuid": "123e4567-
|
|
24408
|
+
"uuid": "123e4567-9abf-45ac-b49e-2329bea83b5b",
|
|
23915
24409
|
"active": 1,
|
|
23916
24410
|
"edit_date": "2025-08-01 12:00:00",
|
|
23917
|
-
"from_staff_uuid": "123e4567-
|
|
23918
|
-
"to_staff_uuid": "123e4567-
|
|
24411
|
+
"from_staff_uuid": "123e4567-d102-402b-9310-2329b5c8415b",
|
|
24412
|
+
"to_staff_uuid": "123e4567-9603-47b6-8513-2329bccc41fb",
|
|
23919
24413
|
"sent_timestamp": "2025-08-01 12:00:00",
|
|
23920
24414
|
"delivered_timestamp": "2025-08-01 12:00:00",
|
|
23921
24415
|
"read_timestamp": "2025-08-01 12:00:00",
|
|
23922
24416
|
"message": "string",
|
|
23923
|
-
"regarding_job_uuid": "123e4567-
|
|
24417
|
+
"regarding_job_uuid": "123e4567-7964-4d15-8e22-2329bf14e28b",
|
|
23924
24418
|
"attached_json": "string"
|
|
23925
24419
|
}
|
|
23926
24420
|
]
|
|
@@ -24224,16 +24718,16 @@
|
|
|
24224
24718
|
"examples": {
|
|
24225
24719
|
"success": {
|
|
24226
24720
|
"value": {
|
|
24227
|
-
"uuid": "123e4567-
|
|
24721
|
+
"uuid": "123e4567-8972-4205-b1aa-2329b644100b",
|
|
24228
24722
|
"active": 1,
|
|
24229
24723
|
"edit_date": "2025-08-01 12:00:00",
|
|
24230
|
-
"from_staff_uuid": "123e4567-
|
|
24231
|
-
"to_staff_uuid": "123e4567-
|
|
24724
|
+
"from_staff_uuid": "123e4567-2826-4912-9536-2329b6deb28b",
|
|
24725
|
+
"to_staff_uuid": "123e4567-f36d-44af-9601-2329beace54b",
|
|
24232
24726
|
"sent_timestamp": "2025-08-01 12:00:00",
|
|
24233
24727
|
"delivered_timestamp": "2025-08-01 12:00:00",
|
|
24234
24728
|
"read_timestamp": "2025-08-01 12:00:00",
|
|
24235
24729
|
"message": "string",
|
|
24236
|
-
"regarding_job_uuid": "123e4567-
|
|
24730
|
+
"regarding_job_uuid": "123e4567-90f2-4025-b8a7-2329bc82233b",
|
|
24237
24731
|
"attached_json": "string"
|
|
24238
24732
|
}
|
|
24239
24733
|
}
|
|
@@ -24734,17 +25228,17 @@
|
|
|
24734
25228
|
"task_details": "string",
|
|
24735
25229
|
"name": "string",
|
|
24736
25230
|
"related_object": "string",
|
|
24737
|
-
"related_object_uuid": "123e4567-
|
|
25231
|
+
"related_object_uuid": "123e4567-a4b8-4478-93bc-2329b545f45b",
|
|
24738
25232
|
"task_complete": "string",
|
|
24739
25233
|
"completed_timestamp": "2025-08-01 12:00:00",
|
|
24740
|
-
"completed_by_staff_uuid": "123e4567-
|
|
24741
|
-
"assigned_to_staff_uuid": "123e4567-
|
|
25234
|
+
"completed_by_staff_uuid": "123e4567-6bdb-4ce4-9a55-2329bac793fb",
|
|
25235
|
+
"assigned_to_staff_uuid": "123e4567-fc60-4e9d-a376-2329b515263b",
|
|
24742
25236
|
"lng": "string",
|
|
24743
25237
|
"lat": "string",
|
|
24744
|
-
"uuid": "123e4567-
|
|
25238
|
+
"uuid": "123e4567-7309-410c-9e63-2329bf2b70fb",
|
|
24745
25239
|
"active": 1,
|
|
24746
25240
|
"edit_date": "2025-08-01 12:00:00",
|
|
24747
|
-
"created_by_staff_uuid": "123e4567-
|
|
25241
|
+
"created_by_staff_uuid": "123e4567-d5ac-499a-a863-2329b5f5792b",
|
|
24748
25242
|
"create_date": "2025-08-01 12:00:00"
|
|
24749
25243
|
}
|
|
24750
25244
|
]
|
|
@@ -25052,17 +25546,17 @@
|
|
|
25052
25546
|
"task_details": "string",
|
|
25053
25547
|
"name": "string",
|
|
25054
25548
|
"related_object": "string",
|
|
25055
|
-
"related_object_uuid": "123e4567-
|
|
25549
|
+
"related_object_uuid": "123e4567-23b4-4c88-8ceb-2329b30825fb",
|
|
25056
25550
|
"task_complete": "string",
|
|
25057
25551
|
"completed_timestamp": "2025-08-01 12:00:00",
|
|
25058
|
-
"completed_by_staff_uuid": "123e4567-
|
|
25059
|
-
"assigned_to_staff_uuid": "123e4567-
|
|
25552
|
+
"completed_by_staff_uuid": "123e4567-d9fe-4b31-9310-2329b1bed08b",
|
|
25553
|
+
"assigned_to_staff_uuid": "123e4567-a3dd-4762-979a-2329bc54a7db",
|
|
25060
25554
|
"lng": "string",
|
|
25061
25555
|
"lat": "string",
|
|
25062
|
-
"uuid": "123e4567-
|
|
25556
|
+
"uuid": "123e4567-ef3a-4abe-94b8-2329bf80750b",
|
|
25063
25557
|
"active": 1,
|
|
25064
25558
|
"edit_date": "2025-08-01 12:00:00",
|
|
25065
|
-
"created_by_staff_uuid": "123e4567-
|
|
25559
|
+
"created_by_staff_uuid": "123e4567-b45c-42e9-a405-2329be2e2ebb",
|
|
25066
25560
|
"create_date": "2025-08-01 12:00:00"
|
|
25067
25561
|
}
|
|
25068
25562
|
}
|
|
@@ -25559,7 +26053,7 @@
|
|
|
25559
26053
|
"success": {
|
|
25560
26054
|
"value": [
|
|
25561
26055
|
{
|
|
25562
|
-
"uuid": "123e4567-
|
|
26056
|
+
"uuid": "123e4567-142f-4aa1-bb13-2329bb20d87b",
|
|
25563
26057
|
"active": 1,
|
|
25564
26058
|
"edit_date": "2025-08-01 12:00:00",
|
|
25565
26059
|
"name": "string",
|
|
@@ -25867,7 +26361,7 @@
|
|
|
25867
26361
|
"examples": {
|
|
25868
26362
|
"success": {
|
|
25869
26363
|
"value": {
|
|
25870
|
-
"uuid": "123e4567-
|
|
26364
|
+
"uuid": "123e4567-caed-4fe6-87e0-2329ba8aea2b",
|
|
25871
26365
|
"active": 1,
|
|
25872
26366
|
"edit_date": "2025-08-01 12:00:00",
|
|
25873
26367
|
"name": "string",
|
|
@@ -26368,7 +26862,7 @@
|
|
|
26368
26862
|
"success": {
|
|
26369
26863
|
"value": [
|
|
26370
26864
|
{
|
|
26371
|
-
"uuid": "123e4567-
|
|
26865
|
+
"uuid": "123e4567-3a92-4185-b445-2329bec2eb5b",
|
|
26372
26866
|
"active": 1,
|
|
26373
26867
|
"edit_date": "2025-08-01 12:00:00",
|
|
26374
26868
|
"name": "string",
|
|
@@ -26545,7 +27039,7 @@
|
|
|
26545
27039
|
"examples": {
|
|
26546
27040
|
"success": {
|
|
26547
27041
|
"value": {
|
|
26548
|
-
"uuid": "123e4567-
|
|
27042
|
+
"uuid": "123e4567-c429-44d7-9e4c-2329b3e15b7b",
|
|
26549
27043
|
"active": 1,
|
|
26550
27044
|
"edit_date": "2025-08-01 12:00:00",
|
|
26551
27045
|
"name": "string",
|
|
@@ -26794,6 +27288,86 @@
|
|
|
26794
27288
|
}
|
|
26795
27289
|
}
|
|
26796
27290
|
}
|
|
27291
|
+
},
|
|
27292
|
+
"post": {
|
|
27293
|
+
"tags": [
|
|
27294
|
+
"Inbox"
|
|
27295
|
+
],
|
|
27296
|
+
"operationId": "createInboxMessage",
|
|
27297
|
+
"summary": "Create a new inbox message",
|
|
27298
|
+
"description": "Creates a new inbox message that will appear in the inbox",
|
|
27299
|
+
"security": [
|
|
27300
|
+
{
|
|
27301
|
+
"apiKey": []
|
|
27302
|
+
},
|
|
27303
|
+
{
|
|
27304
|
+
"oauth2": [
|
|
27305
|
+
"manage_inbox"
|
|
27306
|
+
]
|
|
27307
|
+
}
|
|
27308
|
+
],
|
|
27309
|
+
"requestBody": {
|
|
27310
|
+
"required": true,
|
|
27311
|
+
"content": {
|
|
27312
|
+
"application/json": {
|
|
27313
|
+
"schema": {
|
|
27314
|
+
"$ref": "#/components/schemas/CreateInboxMessageRequest"
|
|
27315
|
+
}
|
|
27316
|
+
}
|
|
27317
|
+
}
|
|
27318
|
+
},
|
|
27319
|
+
"responses": {
|
|
27320
|
+
"201": {
|
|
27321
|
+
"description": "Message created successfully",
|
|
27322
|
+
"content": {
|
|
27323
|
+
"application/json": {
|
|
27324
|
+
"schema": {
|
|
27325
|
+
"$ref": "#/components/schemas/InboxMessageDetail"
|
|
27326
|
+
}
|
|
27327
|
+
}
|
|
27328
|
+
}
|
|
27329
|
+
},
|
|
27330
|
+
"400": {
|
|
27331
|
+
"description": "Bad request - Invalid input",
|
|
27332
|
+
"content": {
|
|
27333
|
+
"application/json": {
|
|
27334
|
+
"schema": {
|
|
27335
|
+
"$ref": "#/components/schemas/Error"
|
|
27336
|
+
}
|
|
27337
|
+
}
|
|
27338
|
+
}
|
|
27339
|
+
},
|
|
27340
|
+
"403": {
|
|
27341
|
+
"description": "Forbidden - Missing permission or OAuth scope",
|
|
27342
|
+
"content": {
|
|
27343
|
+
"application/json": {
|
|
27344
|
+
"schema": {
|
|
27345
|
+
"$ref": "#/components/schemas/Error"
|
|
27346
|
+
}
|
|
27347
|
+
}
|
|
27348
|
+
}
|
|
27349
|
+
},
|
|
27350
|
+
"404": {
|
|
27351
|
+
"description": "Not found - Related entity not found",
|
|
27352
|
+
"content": {
|
|
27353
|
+
"application/json": {
|
|
27354
|
+
"schema": {
|
|
27355
|
+
"$ref": "#/components/schemas/Error"
|
|
27356
|
+
}
|
|
27357
|
+
}
|
|
27358
|
+
}
|
|
27359
|
+
},
|
|
27360
|
+
"500": {
|
|
27361
|
+
"description": "Internal server error",
|
|
27362
|
+
"content": {
|
|
27363
|
+
"application/json": {
|
|
27364
|
+
"schema": {
|
|
27365
|
+
"$ref": "#/components/schemas/Error"
|
|
27366
|
+
}
|
|
27367
|
+
}
|
|
27368
|
+
}
|
|
27369
|
+
}
|
|
27370
|
+
}
|
|
26797
27371
|
}
|
|
26798
27372
|
},
|
|
26799
27373
|
"/inboxmessage/{uuid}.json": {
|
|
@@ -27881,7 +28455,7 @@
|
|
|
27881
28455
|
"uuid": {
|
|
27882
28456
|
"format": "uuid",
|
|
27883
28457
|
"description": "Unique identifier for this record",
|
|
27884
|
-
"example": "123e4567-
|
|
28458
|
+
"example": "123e4567-f2cf-4383-80f6-2329b39c427b",
|
|
27885
28459
|
"type": "string"
|
|
27886
28460
|
},
|
|
27887
28461
|
"active": {
|
|
@@ -27918,7 +28492,7 @@
|
|
|
27918
28492
|
"uuid": {
|
|
27919
28493
|
"format": "uuid",
|
|
27920
28494
|
"description": "Unique identifier for this record",
|
|
27921
|
-
"example": "123e4567-
|
|
28495
|
+
"example": "123e4567-e200-4911-a9ff-2329bd157e5b",
|
|
27922
28496
|
"type": "string"
|
|
27923
28497
|
},
|
|
27924
28498
|
"active": {
|
|
@@ -27937,7 +28511,7 @@
|
|
|
27937
28511
|
},
|
|
27938
28512
|
"company_uuid": {
|
|
27939
28513
|
"format": "uuid",
|
|
27940
|
-
"example": "123e4567-
|
|
28514
|
+
"example": "123e4567-d43d-4b47-bb4a-2329bd17e35b",
|
|
27941
28515
|
"type": "string",
|
|
27942
28516
|
"description": "UUID of the Client to which this Asset is attached"
|
|
27943
28517
|
},
|
|
@@ -27947,7 +28521,7 @@
|
|
|
27947
28521
|
},
|
|
27948
28522
|
"asset_type_uuid": {
|
|
27949
28523
|
"format": "uuid",
|
|
27950
|
-
"example": "123e4567-
|
|
28524
|
+
"example": "123e4567-3e5b-46f3-a62e-2329bb58befb",
|
|
27951
28525
|
"type": "string",
|
|
27952
28526
|
"description": "UUID of an Asset Type which defines the fields that can be stored for this Asset (read only)"
|
|
27953
28527
|
},
|
|
@@ -28017,7 +28591,7 @@
|
|
|
28017
28591
|
"uuid": {
|
|
28018
28592
|
"format": "uuid",
|
|
28019
28593
|
"description": "Unique identifier for this record",
|
|
28020
|
-
"example": "123e4567-
|
|
28594
|
+
"example": "123e4567-c58f-4a1a-a110-2329b0435f0b",
|
|
28021
28595
|
"type": "string"
|
|
28022
28596
|
},
|
|
28023
28597
|
"active": {
|
|
@@ -28046,7 +28620,7 @@
|
|
|
28046
28620
|
"uuid": {
|
|
28047
28621
|
"format": "uuid",
|
|
28048
28622
|
"description": "Unique identifier for this record",
|
|
28049
|
-
"example": "123e4567-
|
|
28623
|
+
"example": "123e4567-bd20-4284-9fbc-2329b5a5b3cb",
|
|
28050
28624
|
"type": "string"
|
|
28051
28625
|
},
|
|
28052
28626
|
"active": {
|
|
@@ -28065,7 +28639,7 @@
|
|
|
28065
28639
|
},
|
|
28066
28640
|
"asset_type_uuid": {
|
|
28067
28641
|
"format": "uuid",
|
|
28068
|
-
"example": "123e4567-
|
|
28642
|
+
"example": "123e4567-7c30-419a-a9ad-2329bf70f67b",
|
|
28069
28643
|
"type": "string",
|
|
28070
28644
|
"description": "UUID of the Asset Type to which this field belongs. This field is read-only in the API. (Read only)"
|
|
28071
28645
|
},
|
|
@@ -28116,7 +28690,7 @@
|
|
|
28116
28690
|
"uuid": {
|
|
28117
28691
|
"format": "uuid",
|
|
28118
28692
|
"description": "Unique identifier for this record",
|
|
28119
|
-
"example": "123e4567-
|
|
28693
|
+
"example": "123e4567-a9c5-4378-9bb9-2329bf1dbf3b",
|
|
28120
28694
|
"type": "string"
|
|
28121
28695
|
},
|
|
28122
28696
|
"active": {
|
|
@@ -28138,7 +28712,7 @@
|
|
|
28138
28712
|
},
|
|
28139
28713
|
"related_object_uuid": {
|
|
28140
28714
|
"format": "uuid",
|
|
28141
|
-
"example": "123e4567-
|
|
28715
|
+
"example": "123e4567-4f32-4b8b-8466-2329b9411e1b",
|
|
28142
28716
|
"type": "string"
|
|
28143
28717
|
},
|
|
28144
28718
|
"attachment_name": {
|
|
@@ -28153,7 +28727,7 @@
|
|
|
28153
28727
|
},
|
|
28154
28728
|
"created_by_staff_uuid": {
|
|
28155
28729
|
"format": "uuid",
|
|
28156
|
-
"example": "123e4567-
|
|
28730
|
+
"example": "123e4567-6c68-451c-9f55-2329b60d776b",
|
|
28157
28731
|
"type": "string"
|
|
28158
28732
|
},
|
|
28159
28733
|
"timestamp": {
|
|
@@ -28199,7 +28773,7 @@
|
|
|
28199
28773
|
"uuid": {
|
|
28200
28774
|
"format": "uuid",
|
|
28201
28775
|
"description": "Unique identifier for this record",
|
|
28202
|
-
"example": "123e4567-
|
|
28776
|
+
"example": "123e4567-79f7-4789-9d4c-2329b6b3678b",
|
|
28203
28777
|
"type": "string"
|
|
28204
28778
|
},
|
|
28205
28779
|
"active": {
|
|
@@ -28229,12 +28803,12 @@
|
|
|
28229
28803
|
},
|
|
28230
28804
|
"regarding_form_uuid": {
|
|
28231
28805
|
"format": "uuid",
|
|
28232
|
-
"example": "123e4567-
|
|
28806
|
+
"example": "123e4567-0f66-41ca-893e-2329b3d8398b",
|
|
28233
28807
|
"type": "string"
|
|
28234
28808
|
},
|
|
28235
28809
|
"regarding_asset_type_uuid": {
|
|
28236
28810
|
"format": "uuid",
|
|
28237
|
-
"example": "123e4567-
|
|
28811
|
+
"example": "123e4567-1959-4fe7-8940-2329b49d6c3b",
|
|
28238
28812
|
"type": "string",
|
|
28239
28813
|
"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."
|
|
28240
28814
|
}
|
|
@@ -28257,7 +28831,7 @@
|
|
|
28257
28831
|
"uuid": {
|
|
28258
28832
|
"format": "uuid",
|
|
28259
28833
|
"description": "Unique identifier for this record",
|
|
28260
|
-
"example": "123e4567-
|
|
28834
|
+
"example": "123e4567-7ac7-463d-ab60-2329bb0c150b",
|
|
28261
28835
|
"type": "string"
|
|
28262
28836
|
},
|
|
28263
28837
|
"active": {
|
|
@@ -28307,7 +28881,7 @@
|
|
|
28307
28881
|
"uuid": {
|
|
28308
28882
|
"format": "uuid",
|
|
28309
28883
|
"description": "Unique identifier for this record",
|
|
28310
|
-
"example": "123e4567-
|
|
28884
|
+
"example": "123e4567-5003-48ac-91c7-2329b99172eb",
|
|
28311
28885
|
"type": "string"
|
|
28312
28886
|
},
|
|
28313
28887
|
"active": {
|
|
@@ -28355,7 +28929,7 @@
|
|
|
28355
28929
|
},
|
|
28356
28930
|
"tax_rate_uuid": {
|
|
28357
28931
|
"format": "uuid",
|
|
28358
|
-
"example": "123e4567-
|
|
28932
|
+
"example": "123e4567-1509-4730-a3a9-2329b0d4f65b",
|
|
28359
28933
|
"type": "string"
|
|
28360
28934
|
},
|
|
28361
28935
|
"billing_attention": {
|
|
@@ -28375,7 +28949,7 @@
|
|
|
28375
28949
|
"uuid": {
|
|
28376
28950
|
"format": "uuid",
|
|
28377
28951
|
"description": "Unique identifier for this record",
|
|
28378
|
-
"example": "123e4567-
|
|
28952
|
+
"example": "123e4567-5157-40ee-9b26-2329b2a8252b",
|
|
28379
28953
|
"type": "string"
|
|
28380
28954
|
},
|
|
28381
28955
|
"active": {
|
|
@@ -28394,7 +28968,7 @@
|
|
|
28394
28968
|
},
|
|
28395
28969
|
"company_uuid": {
|
|
28396
28970
|
"format": "uuid",
|
|
28397
|
-
"example": "123e4567-
|
|
28971
|
+
"example": "123e4567-f8a2-4b33-9a2a-2329bba388db",
|
|
28398
28972
|
"type": "string",
|
|
28399
28973
|
"description": "The UUID of the company this contact belongs to"
|
|
28400
28974
|
},
|
|
@@ -28428,7 +29002,7 @@
|
|
|
28428
29002
|
"uuid": {
|
|
28429
29003
|
"format": "uuid",
|
|
28430
29004
|
"description": "Unique identifier for this record",
|
|
28431
|
-
"example": "123e4567-
|
|
29005
|
+
"example": "123e4567-3438-45de-bafd-2329bc4ba00b",
|
|
28432
29006
|
"type": "string"
|
|
28433
29007
|
},
|
|
28434
29008
|
"active": {
|
|
@@ -28464,7 +29038,7 @@
|
|
|
28464
29038
|
"uuid": {
|
|
28465
29039
|
"format": "uuid",
|
|
28466
29040
|
"description": "Unique identifier for this record",
|
|
28467
|
-
"example": "123e4567-
|
|
29041
|
+
"example": "123e4567-40ea-4d61-9e61-2329b06aeceb",
|
|
28468
29042
|
"type": "string"
|
|
28469
29043
|
},
|
|
28470
29044
|
"active": {
|
|
@@ -28504,7 +29078,7 @@
|
|
|
28504
29078
|
"uuid": {
|
|
28505
29079
|
"format": "uuid",
|
|
28506
29080
|
"description": "Unique identifier for this record",
|
|
28507
|
-
"example": "123e4567-
|
|
29081
|
+
"example": "123e4567-8ac5-4f6d-9518-2329bac131eb",
|
|
28508
29082
|
"type": "string"
|
|
28509
29083
|
},
|
|
28510
29084
|
"active": {
|
|
@@ -28529,7 +29103,7 @@
|
|
|
28529
29103
|
},
|
|
28530
29104
|
"related_object_uuid": {
|
|
28531
29105
|
"format": "uuid",
|
|
28532
|
-
"example": "123e4567-
|
|
29106
|
+
"example": "123e4567-8099-4fdd-8e90-2329b76eab3b",
|
|
28533
29107
|
"type": "string"
|
|
28534
29108
|
},
|
|
28535
29109
|
"rating": {
|
|
@@ -28550,7 +29124,7 @@
|
|
|
28550
29124
|
"document_template_uuid": {
|
|
28551
29125
|
"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.",
|
|
28552
29126
|
"format": "uuid",
|
|
28553
|
-
"example": "123e4567-
|
|
29127
|
+
"example": "123e4567-7f29-4105-bf2a-2329bd1872db",
|
|
28554
29128
|
"type": "string"
|
|
28555
29129
|
},
|
|
28556
29130
|
"can_be_used_independently": {
|
|
@@ -28596,7 +29170,7 @@
|
|
|
28596
29170
|
"uuid": {
|
|
28597
29171
|
"format": "uuid",
|
|
28598
29172
|
"description": "Unique identifier for this record",
|
|
28599
|
-
"example": "123e4567-
|
|
29173
|
+
"example": "123e4567-2c64-4d43-aa06-2329b69c933b",
|
|
28600
29174
|
"type": "string"
|
|
28601
29175
|
},
|
|
28602
29176
|
"active": {
|
|
@@ -28625,7 +29199,7 @@
|
|
|
28625
29199
|
"uuid": {
|
|
28626
29200
|
"format": "uuid",
|
|
28627
29201
|
"description": "Unique identifier for this record",
|
|
28628
|
-
"example": "123e4567-
|
|
29202
|
+
"example": "123e4567-4839-4c1b-b5c8-2329bc0989bb",
|
|
28629
29203
|
"type": "string"
|
|
28630
29204
|
},
|
|
28631
29205
|
"active": {
|
|
@@ -28644,7 +29218,7 @@
|
|
|
28644
29218
|
},
|
|
28645
29219
|
"form_uuid": {
|
|
28646
29220
|
"format": "uuid",
|
|
28647
|
-
"example": "123e4567-
|
|
29221
|
+
"example": "123e4567-5996-45d9-9804-2329ba56fcdb",
|
|
28648
29222
|
"type": "string",
|
|
28649
29223
|
"description": "The UUID of the form this field belongs to."
|
|
28650
29224
|
},
|
|
@@ -28668,7 +29242,7 @@
|
|
|
28668
29242
|
"uuid": {
|
|
28669
29243
|
"format": "uuid",
|
|
28670
29244
|
"description": "Unique identifier for this record",
|
|
28671
|
-
"example": "123e4567-
|
|
29245
|
+
"example": "123e4567-178a-4fa4-a1bb-2329bd3bc29b",
|
|
28672
29246
|
"type": "string"
|
|
28673
29247
|
},
|
|
28674
29248
|
"active": {
|
|
@@ -28687,12 +29261,12 @@
|
|
|
28687
29261
|
},
|
|
28688
29262
|
"form_uuid": {
|
|
28689
29263
|
"format": "uuid",
|
|
28690
|
-
"example": "123e4567-
|
|
29264
|
+
"example": "123e4567-0db8-4602-b04f-2329b9b2d90b",
|
|
28691
29265
|
"type": "string"
|
|
28692
29266
|
},
|
|
28693
29267
|
"staff_uuid": {
|
|
28694
29268
|
"format": "uuid",
|
|
28695
|
-
"example": "123e4567-
|
|
29269
|
+
"example": "123e4567-721a-4295-82dc-2329bfa38f9b",
|
|
28696
29270
|
"type": "string"
|
|
28697
29271
|
},
|
|
28698
29272
|
"regarding_object": {
|
|
@@ -28700,11 +29274,12 @@
|
|
|
28700
29274
|
},
|
|
28701
29275
|
"regarding_object_uuid": {
|
|
28702
29276
|
"format": "uuid",
|
|
28703
|
-
"example": "123e4567-
|
|
29277
|
+
"example": "123e4567-d4a5-4382-94f8-2329bdb8d27b",
|
|
28704
29278
|
"type": "string"
|
|
28705
29279
|
},
|
|
28706
29280
|
"field_data": {
|
|
28707
|
-
"type": "string"
|
|
29281
|
+
"type": "string",
|
|
29282
|
+
"description": "JSON array of form answers captured at submission time."
|
|
28708
29283
|
},
|
|
28709
29284
|
"timestamp": {
|
|
28710
29285
|
"type": "string",
|
|
@@ -28712,17 +29287,17 @@
|
|
|
28712
29287
|
},
|
|
28713
29288
|
"form_by_staff_uuid": {
|
|
28714
29289
|
"format": "uuid",
|
|
28715
|
-
"example": "123e4567-
|
|
29290
|
+
"example": "123e4567-c7eb-4b86-9853-2329bcc0713b",
|
|
28716
29291
|
"type": "string"
|
|
28717
29292
|
},
|
|
28718
29293
|
"document_attachment_uuid": {
|
|
28719
29294
|
"format": "uuid",
|
|
28720
|
-
"example": "123e4567-
|
|
29295
|
+
"example": "123e4567-7e82-42cb-861a-2329b4d22dbb",
|
|
28721
29296
|
"type": "string"
|
|
28722
29297
|
},
|
|
28723
29298
|
"asset_uuid": {
|
|
28724
29299
|
"format": "uuid",
|
|
28725
|
-
"example": "123e4567-
|
|
29300
|
+
"example": "123e4567-c58c-40cf-8836-2329be5e6fab",
|
|
28726
29301
|
"type": "string"
|
|
28727
29302
|
}
|
|
28728
29303
|
}
|
|
@@ -28835,7 +29410,7 @@
|
|
|
28835
29410
|
"created_by_staff_uuid": {
|
|
28836
29411
|
"description": "UUID of the staff member who created this job. Records which staff member initially added the job to the system.",
|
|
28837
29412
|
"format": "uuid",
|
|
28838
|
-
"example": "123e4567-
|
|
29413
|
+
"example": "123e4567-112d-493c-8e86-2329b97c2cbb",
|
|
28839
29414
|
"type": "string"
|
|
28840
29415
|
},
|
|
28841
29416
|
"date": {
|
|
@@ -28846,7 +29421,7 @@
|
|
|
28846
29421
|
"company_uuid": {
|
|
28847
29422
|
"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.",
|
|
28848
29423
|
"format": "uuid",
|
|
28849
|
-
"example": "123e4567-
|
|
29424
|
+
"example": "123e4567-b7b6-49ff-ad51-2329b561f55b",
|
|
28850
29425
|
"type": "string"
|
|
28851
29426
|
},
|
|
28852
29427
|
"billing_address": {
|
|
@@ -28866,12 +29441,12 @@
|
|
|
28866
29441
|
"maxLength": 20
|
|
28867
29442
|
},
|
|
28868
29443
|
"lng": {
|
|
28869
|
-
"description": "The longitude coordinate of the job location.",
|
|
29444
|
+
"description": "The longitude coordinate of the job location. (Read only)",
|
|
28870
29445
|
"type": "number",
|
|
28871
29446
|
"format": "float"
|
|
28872
29447
|
},
|
|
28873
29448
|
"lat": {
|
|
28874
|
-
"description": "The latitude coordinate of the job location.",
|
|
29449
|
+
"description": "The latitude coordinate of the job location. (Read only)",
|
|
28875
29450
|
"type": "number",
|
|
28876
29451
|
"format": "float"
|
|
28877
29452
|
},
|
|
@@ -28883,7 +29458,7 @@
|
|
|
28883
29458
|
"payment_actioned_by_uuid": {
|
|
28884
29459
|
"description": "Not used. Refer to JobPayment endpoint.",
|
|
28885
29460
|
"format": "uuid",
|
|
28886
|
-
"example": "123e4567-
|
|
29461
|
+
"example": "123e4567-a51f-4a39-8bd6-2329b4cbb36b",
|
|
28887
29462
|
"type": "string"
|
|
28888
29463
|
},
|
|
28889
29464
|
"payment_method": {
|
|
@@ -28897,7 +29472,7 @@
|
|
|
28897
29472
|
"category_uuid": {
|
|
28898
29473
|
"description": "UUID reference to the job category this job belongs to. Categories help organize jobs by type of work or department.",
|
|
28899
29474
|
"format": "uuid",
|
|
28900
|
-
"example": "123e4567-
|
|
29475
|
+
"example": "123e4567-157a-4633-aa01-2329bcfe936b",
|
|
28901
29476
|
"type": "string"
|
|
28902
29477
|
},
|
|
28903
29478
|
"payment_note": {
|
|
@@ -28918,7 +29493,7 @@
|
|
|
28918
29493
|
"maxLength": 100
|
|
28919
29494
|
},
|
|
28920
29495
|
"invoice_sent": {
|
|
28921
|
-
"description": "Indicates whether an invoice has been sent for this job
|
|
29496
|
+
"description": "Indicates whether an invoice has been sent for this job.. Valid values are [0,1]",
|
|
28922
29497
|
"type": "integer",
|
|
28923
29498
|
"enum": [
|
|
28924
29499
|
0,
|
|
@@ -28963,7 +29538,7 @@
|
|
|
28963
29538
|
"queue_uuid": {
|
|
28964
29539
|
"description": "The UUID of the queue this job belongs to.",
|
|
28965
29540
|
"format": "uuid",
|
|
28966
|
-
"example": "123e4567-
|
|
29541
|
+
"example": "123e4567-c023-4f9b-ac5d-2329b5a96d8b",
|
|
28967
29542
|
"type": "string"
|
|
28968
29543
|
},
|
|
28969
29544
|
"queue_expiry_date": {
|
|
@@ -28974,7 +29549,7 @@
|
|
|
28974
29549
|
"queue_assigned_staff_uuid": {
|
|
28975
29550
|
"description": "The UUID of the staff member assigned to this job in the queue.",
|
|
28976
29551
|
"format": "uuid",
|
|
28977
|
-
"example": "123e4567-
|
|
29552
|
+
"example": "123e4567-8763-44e4-b40b-2329b699b8ab",
|
|
28978
29553
|
"type": "string"
|
|
28979
29554
|
},
|
|
28980
29555
|
"badges": {
|
|
@@ -28987,7 +29562,7 @@
|
|
|
28987
29562
|
"type": "string"
|
|
28988
29563
|
},
|
|
28989
29564
|
"quote_sent": {
|
|
28990
|
-
"description": "Boolean flag indicating whether a quote has been sent to the client for this job
|
|
29565
|
+
"description": "Boolean flag indicating whether a quote has been sent to the client for this job.. Valid values are [0,1]",
|
|
28991
29566
|
"type": "integer",
|
|
28992
29567
|
"enum": [
|
|
28993
29568
|
0,
|
|
@@ -29013,7 +29588,7 @@
|
|
|
29013
29588
|
"uuid": {
|
|
29014
29589
|
"format": "uuid",
|
|
29015
29590
|
"description": "Unique identifier for this record",
|
|
29016
|
-
"example": "123e4567-
|
|
29591
|
+
"example": "123e4567-90a9-43c5-8676-2329b648021b",
|
|
29017
29592
|
"type": "string"
|
|
29018
29593
|
},
|
|
29019
29594
|
"active": {
|
|
@@ -29048,7 +29623,7 @@
|
|
|
29048
29623
|
},
|
|
29049
29624
|
"total_invoice_amount": {
|
|
29050
29625
|
"type": "string",
|
|
29051
|
-
"description": "The total amount to be invoiced for this job."
|
|
29626
|
+
"description": "The total amount to be invoiced for this job. (Read only)"
|
|
29052
29627
|
},
|
|
29053
29628
|
"payment_processed": {
|
|
29054
29629
|
"type": "integer",
|
|
@@ -29061,7 +29636,7 @@
|
|
|
29061
29636
|
"payment_processed_stamp": {
|
|
29062
29637
|
"example": "2025-08-01 12:00:00",
|
|
29063
29638
|
"type": "string",
|
|
29064
|
-
"description": "The date and time the job has been exported to the connected Accounting Package."
|
|
29639
|
+
"description": "The date and time the job has been exported to the connected Accounting Package. (Read only)"
|
|
29065
29640
|
},
|
|
29066
29641
|
"payment_received": {
|
|
29067
29642
|
"type": "integer",
|
|
@@ -29074,7 +29649,7 @@
|
|
|
29074
29649
|
"payment_received_stamp": {
|
|
29075
29650
|
"example": "2025-08-01 12:00:00",
|
|
29076
29651
|
"type": "string",
|
|
29077
|
-
"description": "The date and time when full payment was received."
|
|
29652
|
+
"description": "The date and time when full payment was received. (Read only)"
|
|
29078
29653
|
},
|
|
29079
29654
|
"completion_date": {
|
|
29080
29655
|
"example": "2025-08-01 12:00:00",
|
|
@@ -29083,9 +29658,9 @@
|
|
|
29083
29658
|
},
|
|
29084
29659
|
"completion_actioned_by_uuid": {
|
|
29085
29660
|
"format": "uuid",
|
|
29086
|
-
"example": "123e4567-
|
|
29661
|
+
"example": "123e4567-fc4e-42d1-aa87-2329b8d4a80b",
|
|
29087
29662
|
"type": "string",
|
|
29088
|
-
"description": "UUID of the staff member who marked this job as completed. References a staff record in the system."
|
|
29663
|
+
"description": "UUID of the staff member who marked this job as completed. References a staff record in the system. (Read only)"
|
|
29089
29664
|
},
|
|
29090
29665
|
"unsuccessful_date": {
|
|
29091
29666
|
"example": "2025-08-01 12:00:00",
|
|
@@ -29095,7 +29670,7 @@
|
|
|
29095
29670
|
"job_is_scheduled_until_stamp": {
|
|
29096
29671
|
"example": "2025-08-01 12:00:00",
|
|
29097
29672
|
"type": "string",
|
|
29098
|
-
"description": "The end date/time of the last scheduled activity for this job. After this date, the job is considered Unscheduled."
|
|
29673
|
+
"description": "The end date/time of the last scheduled activity for this job. After this date, the job is considered Unscheduled. (Read only)"
|
|
29099
29674
|
}
|
|
29100
29675
|
},
|
|
29101
29676
|
"required": [
|
|
@@ -29108,7 +29683,7 @@
|
|
|
29108
29683
|
"uuid": {
|
|
29109
29684
|
"format": "uuid",
|
|
29110
29685
|
"description": "Unique identifier for this record",
|
|
29111
|
-
"example": "123e4567-
|
|
29686
|
+
"example": "123e4567-825b-459e-b123-2329b922c33b",
|
|
29112
29687
|
"type": "string"
|
|
29113
29688
|
},
|
|
29114
29689
|
"active": {
|
|
@@ -29127,13 +29702,13 @@
|
|
|
29127
29702
|
},
|
|
29128
29703
|
"job_uuid": {
|
|
29129
29704
|
"format": "uuid",
|
|
29130
|
-
"example": "123e4567-
|
|
29705
|
+
"example": "123e4567-5903-4e68-b94c-2329b9cf1b1b",
|
|
29131
29706
|
"type": "string",
|
|
29132
29707
|
"description": "The UUID of the job this activity belongs to"
|
|
29133
29708
|
},
|
|
29134
29709
|
"staff_uuid": {
|
|
29135
29710
|
"format": "uuid",
|
|
29136
|
-
"example": "123e4567-
|
|
29711
|
+
"example": "123e4567-705d-406e-97dd-2329be0fdccb",
|
|
29137
29712
|
"type": "string",
|
|
29138
29713
|
"description": "The UUID of the staff member assigned to this activity"
|
|
29139
29714
|
},
|
|
@@ -29173,7 +29748,7 @@
|
|
|
29173
29748
|
},
|
|
29174
29749
|
"allocated_by_staff_uuid": {
|
|
29175
29750
|
"format": "uuid",
|
|
29176
|
-
"example": "123e4567-
|
|
29751
|
+
"example": "123e4567-d0fa-431e-b556-2329ba5b886b",
|
|
29177
29752
|
"type": "string"
|
|
29178
29753
|
},
|
|
29179
29754
|
"allocated_timestamp": {
|
|
@@ -29182,13 +29757,13 @@
|
|
|
29182
29757
|
},
|
|
29183
29758
|
"material_uuid": {
|
|
29184
29759
|
"format": "uuid",
|
|
29185
|
-
"example": "123e4567-
|
|
29760
|
+
"example": "123e4567-a899-4f07-a251-2329b60a7a8b",
|
|
29186
29761
|
"type": "string",
|
|
29187
29762
|
"description": "The UUID of the material associated with this activity. Used to determine the cost of the activity."
|
|
29188
29763
|
},
|
|
29189
29764
|
"edit_by_staff_uuid": {
|
|
29190
29765
|
"format": "uuid",
|
|
29191
|
-
"example": "123e4567-
|
|
29766
|
+
"example": "123e4567-8da6-4122-83c4-2329b05af9ab",
|
|
29192
29767
|
"readOnly": true,
|
|
29193
29768
|
"description": "UUID of Staff Member who last modified record"
|
|
29194
29769
|
}
|
|
@@ -29200,7 +29775,7 @@
|
|
|
29200
29775
|
"uuid": {
|
|
29201
29776
|
"format": "uuid",
|
|
29202
29777
|
"description": "Unique identifier for this record",
|
|
29203
|
-
"example": "123e4567-
|
|
29778
|
+
"example": "123e4567-1821-42b4-96c9-2329b8d1505b",
|
|
29204
29779
|
"type": "string"
|
|
29205
29780
|
},
|
|
29206
29781
|
"active": {
|
|
@@ -29219,17 +29794,17 @@
|
|
|
29219
29794
|
},
|
|
29220
29795
|
"job_uuid": {
|
|
29221
29796
|
"format": "uuid",
|
|
29222
|
-
"example": "123e4567-
|
|
29797
|
+
"example": "123e4567-5799-4bb4-85b1-2329befb431b",
|
|
29223
29798
|
"type": "string"
|
|
29224
29799
|
},
|
|
29225
29800
|
"queue_uuid": {
|
|
29226
29801
|
"format": "uuid",
|
|
29227
|
-
"example": "123e4567-
|
|
29802
|
+
"example": "123e4567-5f55-496a-abcd-2329ba5116bb",
|
|
29228
29803
|
"type": "string"
|
|
29229
29804
|
},
|
|
29230
29805
|
"staff_uuid": {
|
|
29231
29806
|
"format": "uuid",
|
|
29232
|
-
"example": "123e4567-
|
|
29807
|
+
"example": "123e4567-b51c-4c13-a9d5-2329b5b07bcb",
|
|
29233
29808
|
"type": "string"
|
|
29234
29809
|
},
|
|
29235
29810
|
"allocation_date": {
|
|
@@ -29238,12 +29813,12 @@
|
|
|
29238
29813
|
},
|
|
29239
29814
|
"allocation_window_uuid": {
|
|
29240
29815
|
"format": "uuid",
|
|
29241
|
-
"example": "123e4567-
|
|
29816
|
+
"example": "123e4567-c395-4744-b3f9-2329b9d10deb",
|
|
29242
29817
|
"type": "string"
|
|
29243
29818
|
},
|
|
29244
29819
|
"allocated_by_staff_uuid": {
|
|
29245
29820
|
"format": "uuid",
|
|
29246
|
-
"example": "123e4567-
|
|
29821
|
+
"example": "123e4567-8b9a-4a58-83e0-2329b4f49c2b",
|
|
29247
29822
|
"type": "string"
|
|
29248
29823
|
},
|
|
29249
29824
|
"allocated_timestamp": {
|
|
@@ -29289,7 +29864,7 @@
|
|
|
29289
29864
|
"uuid": {
|
|
29290
29865
|
"format": "uuid",
|
|
29291
29866
|
"description": "Unique identifier for this record",
|
|
29292
|
-
"example": "123e4567-
|
|
29867
|
+
"example": "123e4567-3c8c-4c9a-add9-2329b61ecb6b",
|
|
29293
29868
|
"type": "string"
|
|
29294
29869
|
},
|
|
29295
29870
|
"active": {
|
|
@@ -29308,7 +29883,7 @@
|
|
|
29308
29883
|
},
|
|
29309
29884
|
"job_uuid": {
|
|
29310
29885
|
"format": "uuid",
|
|
29311
|
-
"example": "123e4567-
|
|
29886
|
+
"example": "123e4567-64f2-4054-b87d-2329ba4914fb",
|
|
29312
29887
|
"type": "string",
|
|
29313
29888
|
"description": "UUID of the job this checklist item belongs to. This links the checklist item to a specific job in the system."
|
|
29314
29889
|
},
|
|
@@ -29337,13 +29912,13 @@
|
|
|
29337
29912
|
},
|
|
29338
29913
|
"completed_by_staff_uuid": {
|
|
29339
29914
|
"format": "uuid",
|
|
29340
|
-
"example": "123e4567-
|
|
29915
|
+
"example": "123e4567-c55a-40d7-ab08-2329be96f7ab",
|
|
29341
29916
|
"type": "string",
|
|
29342
29917
|
"description": "UUID of the staff member who completed this checklist item. References a Staff object. Empty if the item is not completed."
|
|
29343
29918
|
},
|
|
29344
29919
|
"completed_during_checkin_uuid": {
|
|
29345
29920
|
"format": "uuid",
|
|
29346
|
-
"example": "123e4567-
|
|
29921
|
+
"example": "123e4567-fd09-4ff9-ba4d-2329b42ebb7b",
|
|
29347
29922
|
"type": "string",
|
|
29348
29923
|
"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."
|
|
29349
29924
|
},
|
|
@@ -29414,7 +29989,7 @@
|
|
|
29414
29989
|
},
|
|
29415
29990
|
"regarding_object_uuid": {
|
|
29416
29991
|
"format": "uuid",
|
|
29417
|
-
"example": "123e4567-
|
|
29992
|
+
"example": "123e4567-0af8-4b3d-b965-2329b3b532eb",
|
|
29418
29993
|
"type": "string",
|
|
29419
29994
|
"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."
|
|
29420
29995
|
},
|
|
@@ -29424,13 +29999,13 @@
|
|
|
29424
29999
|
},
|
|
29425
30000
|
"fulfilled_by_object_uuid": {
|
|
29426
30001
|
"format": "uuid",
|
|
29427
|
-
"example": "123e4567-
|
|
30002
|
+
"example": "123e4567-f3b1-440f-9786-2329bef499fb",
|
|
29428
30003
|
"type": "string",
|
|
29429
30004
|
"description": "The UUID of the object which completes this checklist item. For example, for Form checklists, this references the UUID of a FormResponse record."
|
|
29430
30005
|
},
|
|
29431
30006
|
"assigned_to_staff_uuids": {
|
|
29432
30007
|
"format": "uuid",
|
|
29433
|
-
"example": "123e4567-
|
|
30008
|
+
"example": "123e4567-749c-4266-9e64-2329b54979db",
|
|
29434
30009
|
"type": "array",
|
|
29435
30010
|
"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.",
|
|
29436
30011
|
"items": {
|
|
@@ -29455,7 +30030,7 @@
|
|
|
29455
30030
|
},
|
|
29456
30031
|
"assigned_by_staff_uuid": {
|
|
29457
30032
|
"format": "uuid",
|
|
29458
|
-
"example": "123e4567-
|
|
30033
|
+
"example": "123e4567-7f41-4701-a203-2329bc7e21eb",
|
|
29459
30034
|
"type": "string",
|
|
29460
30035
|
"description": "The UUID of the staff member who assigned the checklist item to the staff member. (Read only)"
|
|
29461
30036
|
}
|
|
@@ -29467,7 +30042,7 @@
|
|
|
29467
30042
|
"uuid": {
|
|
29468
30043
|
"format": "uuid",
|
|
29469
30044
|
"description": "Unique identifier for this record",
|
|
29470
|
-
"example": "123e4567-
|
|
30045
|
+
"example": "123e4567-e2bd-4b4c-a62c-2329b2deb5cb",
|
|
29471
30046
|
"type": "string"
|
|
29472
30047
|
},
|
|
29473
30048
|
"active": {
|
|
@@ -29486,7 +30061,7 @@
|
|
|
29486
30061
|
},
|
|
29487
30062
|
"job_uuid": {
|
|
29488
30063
|
"format": "uuid",
|
|
29489
|
-
"example": "123e4567-
|
|
30064
|
+
"example": "123e4567-6d29-4471-8a10-2329b75a9a2b",
|
|
29490
30065
|
"type": "string"
|
|
29491
30066
|
},
|
|
29492
30067
|
"first": {
|
|
@@ -29519,7 +30094,7 @@
|
|
|
29519
30094
|
"uuid": {
|
|
29520
30095
|
"format": "uuid",
|
|
29521
30096
|
"description": "Unique identifier for this record",
|
|
29522
|
-
"example": "123e4567-
|
|
30097
|
+
"example": "123e4567-7463-4b23-a564-2329ba2d259b",
|
|
29523
30098
|
"type": "string"
|
|
29524
30099
|
},
|
|
29525
30100
|
"active": {
|
|
@@ -29538,12 +30113,12 @@
|
|
|
29538
30113
|
},
|
|
29539
30114
|
"job_uuid": {
|
|
29540
30115
|
"format": "uuid",
|
|
29541
|
-
"example": "123e4567-
|
|
30116
|
+
"example": "123e4567-696c-493c-a79e-2329bb8c81cb",
|
|
29542
30117
|
"type": "string"
|
|
29543
30118
|
},
|
|
29544
30119
|
"material_uuid": {
|
|
29545
30120
|
"format": "uuid",
|
|
29546
|
-
"example": "123e4567-
|
|
30121
|
+
"example": "123e4567-2a65-4928-aa0a-2329b51f990b",
|
|
29547
30122
|
"type": "string"
|
|
29548
30123
|
},
|
|
29549
30124
|
"name": {
|
|
@@ -29565,7 +30140,7 @@
|
|
|
29565
30140
|
},
|
|
29566
30141
|
"tax_rate_uuid": {
|
|
29567
30142
|
"format": "uuid",
|
|
29568
|
-
"example": "123e4567-
|
|
30143
|
+
"example": "123e4567-a4cc-40f8-88c5-2329b5756cfb",
|
|
29569
30144
|
"type": "string"
|
|
29570
30145
|
},
|
|
29571
30146
|
"sort_order": {
|
|
@@ -29581,7 +30156,7 @@
|
|
|
29581
30156
|
},
|
|
29582
30157
|
"job_material_bundle_uuid": {
|
|
29583
30158
|
"format": "uuid",
|
|
29584
|
-
"example": "123e4567-
|
|
30159
|
+
"example": "123e4567-c4d0-4eae-90d2-2329bed23f3b",
|
|
29585
30160
|
"type": "string",
|
|
29586
30161
|
"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."
|
|
29587
30162
|
}
|
|
@@ -29596,7 +30171,7 @@
|
|
|
29596
30171
|
"uuid": {
|
|
29597
30172
|
"format": "uuid",
|
|
29598
30173
|
"description": "Unique identifier for this record",
|
|
29599
|
-
"example": "123e4567-
|
|
30174
|
+
"example": "123e4567-4e2e-4ec0-ae38-2329b0e7d20b",
|
|
29600
30175
|
"type": "string"
|
|
29601
30176
|
},
|
|
29602
30177
|
"active": {
|
|
@@ -29631,13 +30206,13 @@
|
|
|
29631
30206
|
},
|
|
29632
30207
|
"material_bundle_uuid": {
|
|
29633
30208
|
"format": "uuid",
|
|
29634
|
-
"example": "123e4567-
|
|
30209
|
+
"example": "123e4567-64d7-4c98-847e-2329b6b9c48b",
|
|
29635
30210
|
"type": "string",
|
|
29636
30211
|
"description": "UUID of the MaterialBundle which this JobMaterialBundle was originally created from."
|
|
29637
30212
|
},
|
|
29638
30213
|
"job_uuid": {
|
|
29639
30214
|
"format": "uuid",
|
|
29640
|
-
"example": "123e4567-
|
|
30215
|
+
"example": "123e4567-4ff8-40c7-b595-2329b2fc209b",
|
|
29641
30216
|
"type": "string",
|
|
29642
30217
|
"description": "UUID of the job that this material bundle is associated with. Links the bundle to a specific job record."
|
|
29643
30218
|
}
|
|
@@ -29649,7 +30224,7 @@
|
|
|
29649
30224
|
"uuid": {
|
|
29650
30225
|
"format": "uuid",
|
|
29651
30226
|
"description": "Unique identifier for this record",
|
|
29652
|
-
"example": "123e4567-
|
|
30227
|
+
"example": "123e4567-098f-4703-af52-2329b805621b",
|
|
29653
30228
|
"type": "string"
|
|
29654
30229
|
},
|
|
29655
30230
|
"active": {
|
|
@@ -29668,12 +30243,12 @@
|
|
|
29668
30243
|
},
|
|
29669
30244
|
"job_uuid": {
|
|
29670
30245
|
"format": "uuid",
|
|
29671
|
-
"example": "123e4567-
|
|
30246
|
+
"example": "123e4567-a45c-4c44-8303-2329bb578bab",
|
|
29672
30247
|
"type": "string"
|
|
29673
30248
|
},
|
|
29674
30249
|
"actioned_by_uuid": {
|
|
29675
30250
|
"format": "uuid",
|
|
29676
|
-
"example": "123e4567-
|
|
30251
|
+
"example": "123e4567-111d-4a26-9bc2-2329bff5523b",
|
|
29677
30252
|
"type": "string"
|
|
29678
30253
|
},
|
|
29679
30254
|
"timestamp": {
|
|
@@ -29691,7 +30266,7 @@
|
|
|
29691
30266
|
},
|
|
29692
30267
|
"attachment_uuid": {
|
|
29693
30268
|
"format": "uuid",
|
|
29694
|
-
"example": "123e4567-
|
|
30269
|
+
"example": "123e4567-3424-473e-ad0d-2329be281a6b",
|
|
29695
30270
|
"type": "string"
|
|
29696
30271
|
},
|
|
29697
30272
|
"is_deposit": {
|
|
@@ -29710,7 +30285,7 @@
|
|
|
29710
30285
|
"uuid": {
|
|
29711
30286
|
"format": "uuid",
|
|
29712
30287
|
"description": "Unique identifier for this record",
|
|
29713
|
-
"example": "123e4567-
|
|
30288
|
+
"example": "123e4567-0c38-4199-a151-2329bc87f53b",
|
|
29714
30289
|
"type": "string"
|
|
29715
30290
|
},
|
|
29716
30291
|
"active": {
|
|
@@ -29738,7 +30313,7 @@
|
|
|
29738
30313
|
"uuid": {
|
|
29739
30314
|
"format": "uuid",
|
|
29740
30315
|
"description": "Unique identifier for this record",
|
|
29741
|
-
"example": "123e4567-
|
|
30316
|
+
"example": "123e4567-b8ce-457f-ae2a-2329be48795b",
|
|
29742
30317
|
"type": "string"
|
|
29743
30318
|
},
|
|
29744
30319
|
"active": {
|
|
@@ -29868,7 +30443,7 @@
|
|
|
29868
30443
|
"uuid": {
|
|
29869
30444
|
"format": "uuid",
|
|
29870
30445
|
"description": "Unique identifier for this record",
|
|
29871
|
-
"example": "123e4567-
|
|
30446
|
+
"example": "123e4567-dc72-4615-8d97-2329b25f170b",
|
|
29872
30447
|
"type": "string"
|
|
29873
30448
|
},
|
|
29874
30449
|
"active": {
|
|
@@ -29938,7 +30513,7 @@
|
|
|
29938
30513
|
"uuid": {
|
|
29939
30514
|
"format": "uuid",
|
|
29940
30515
|
"description": "Unique identifier for this record",
|
|
29941
|
-
"example": "123e4567-
|
|
30516
|
+
"example": "123e4567-4b23-46d7-b432-2329b80bf5cb",
|
|
29942
30517
|
"type": "string"
|
|
29943
30518
|
},
|
|
29944
30519
|
"active": {
|
|
@@ -29963,7 +30538,7 @@
|
|
|
29963
30538
|
},
|
|
29964
30539
|
"tax_rate_uuid": {
|
|
29965
30540
|
"format": "uuid",
|
|
29966
|
-
"example": "123e4567-
|
|
30541
|
+
"example": "123e4567-2d86-4737-8cb2-2329bd1983ab",
|
|
29967
30542
|
"type": "string"
|
|
29968
30543
|
}
|
|
29969
30544
|
},
|
|
@@ -29977,7 +30552,7 @@
|
|
|
29977
30552
|
"uuid": {
|
|
29978
30553
|
"format": "uuid",
|
|
29979
30554
|
"description": "Unique identifier for this record",
|
|
29980
|
-
"example": "123e4567-
|
|
30555
|
+
"example": "123e4567-9072-47c7-a80a-2329b605231b",
|
|
29981
30556
|
"type": "string"
|
|
29982
30557
|
},
|
|
29983
30558
|
"active": {
|
|
@@ -30038,7 +30613,7 @@
|
|
|
30038
30613
|
"uuid": {
|
|
30039
30614
|
"format": "uuid",
|
|
30040
30615
|
"description": "Unique identifier for this record",
|
|
30041
|
-
"example": "123e4567-
|
|
30616
|
+
"example": "123e4567-574d-4026-b78f-2329ba2d0d9b",
|
|
30042
30617
|
"type": "string"
|
|
30043
30618
|
},
|
|
30044
30619
|
"active": {
|
|
@@ -30060,7 +30635,7 @@
|
|
|
30060
30635
|
},
|
|
30061
30636
|
"related_object_uuid": {
|
|
30062
30637
|
"format": "uuid",
|
|
30063
|
-
"example": "123e4567-
|
|
30638
|
+
"example": "123e4567-f7e3-41c2-8b19-2329b46f962b",
|
|
30064
30639
|
"type": "string"
|
|
30065
30640
|
},
|
|
30066
30641
|
"note": {
|
|
@@ -30071,12 +30646,12 @@
|
|
|
30071
30646
|
},
|
|
30072
30647
|
"action_completed_by_staff_uuid": {
|
|
30073
30648
|
"format": "uuid",
|
|
30074
|
-
"example": "123e4567-
|
|
30649
|
+
"example": "123e4567-38c3-473d-b1d3-2329b2ab8b1b",
|
|
30075
30650
|
"type": "string"
|
|
30076
30651
|
},
|
|
30077
30652
|
"edit_by_staff_uuid": {
|
|
30078
30653
|
"format": "uuid",
|
|
30079
|
-
"example": "123e4567-
|
|
30654
|
+
"example": "123e4567-8531-4e63-81e7-2329be42238b",
|
|
30080
30655
|
"readOnly": true,
|
|
30081
30656
|
"description": "UUID of Staff Member who last modified record"
|
|
30082
30657
|
},
|
|
@@ -30092,7 +30667,7 @@
|
|
|
30092
30667
|
"uuid": {
|
|
30093
30668
|
"format": "uuid",
|
|
30094
30669
|
"description": "Unique identifier for this record",
|
|
30095
|
-
"example": "123e4567-
|
|
30670
|
+
"example": "123e4567-a31e-4c99-af71-2329bab7478b",
|
|
30096
30671
|
"type": "string"
|
|
30097
30672
|
},
|
|
30098
30673
|
"active": {
|
|
@@ -30146,7 +30721,7 @@
|
|
|
30146
30721
|
"uuid": {
|
|
30147
30722
|
"format": "uuid",
|
|
30148
30723
|
"description": "Unique identifier for this record",
|
|
30149
|
-
"example": "123e4567-
|
|
30724
|
+
"example": "123e4567-ec2f-4c69-939d-2329bbc9cd8b",
|
|
30150
30725
|
"type": "string"
|
|
30151
30726
|
},
|
|
30152
30727
|
"active": {
|
|
@@ -30174,7 +30749,7 @@
|
|
|
30174
30749
|
"uuid": {
|
|
30175
30750
|
"format": "uuid",
|
|
30176
30751
|
"description": "Unique identifier for this record",
|
|
30177
|
-
"example": "123e4567-
|
|
30752
|
+
"example": "123e4567-e469-4e2a-b8ac-2329bac51ebb",
|
|
30178
30753
|
"type": "string"
|
|
30179
30754
|
},
|
|
30180
30755
|
"active": {
|
|
@@ -30248,7 +30823,7 @@
|
|
|
30248
30823
|
"navigating_to_job_uuid": {
|
|
30249
30824
|
"description": "UUID of the job the staff member is currently navigating to. Used to track which job a staff member is traveling toward.",
|
|
30250
30825
|
"format": "uuid",
|
|
30251
|
-
"example": "123e4567-
|
|
30826
|
+
"example": "123e4567-ed72-41c2-bb03-2329b822212b",
|
|
30252
30827
|
"type": "string"
|
|
30253
30828
|
},
|
|
30254
30829
|
"navigating_timestamp": {
|
|
@@ -30288,13 +30863,13 @@
|
|
|
30288
30863
|
"security_role_uuid": {
|
|
30289
30864
|
"description": "UUID of the primary security role assigned to this staff member. Controls the staff member's permissions and access levels throughout the system.",
|
|
30290
30865
|
"format": "uuid",
|
|
30291
|
-
"example": "123e4567-
|
|
30866
|
+
"example": "123e4567-daf1-46ec-a1c9-2329bbda5a5b",
|
|
30292
30867
|
"type": "string"
|
|
30293
30868
|
},
|
|
30294
30869
|
"uuid": {
|
|
30295
30870
|
"format": "uuid",
|
|
30296
30871
|
"description": "Unique identifier for this record",
|
|
30297
|
-
"example": "123e4567-
|
|
30872
|
+
"example": "123e4567-35c9-467a-8f72-2329b2dadceb",
|
|
30298
30873
|
"type": "string"
|
|
30299
30874
|
},
|
|
30300
30875
|
"active": {
|
|
@@ -30327,7 +30902,7 @@
|
|
|
30327
30902
|
"uuid": {
|
|
30328
30903
|
"format": "uuid",
|
|
30329
30904
|
"description": "Unique identifier for this record",
|
|
30330
|
-
"example": "123e4567-
|
|
30905
|
+
"example": "123e4567-abdb-4322-a8df-2329b5ae407b",
|
|
30331
30906
|
"type": "string"
|
|
30332
30907
|
},
|
|
30333
30908
|
"active": {
|
|
@@ -30346,12 +30921,12 @@
|
|
|
30346
30921
|
},
|
|
30347
30922
|
"from_staff_uuid": {
|
|
30348
30923
|
"format": "uuid",
|
|
30349
|
-
"example": "123e4567-
|
|
30924
|
+
"example": "123e4567-b98e-4778-9bb6-2329bbb2e71b",
|
|
30350
30925
|
"type": "string"
|
|
30351
30926
|
},
|
|
30352
30927
|
"to_staff_uuid": {
|
|
30353
30928
|
"format": "uuid",
|
|
30354
|
-
"example": "123e4567-
|
|
30929
|
+
"example": "123e4567-3660-4750-950f-2329ba6dacab",
|
|
30355
30930
|
"type": "string"
|
|
30356
30931
|
},
|
|
30357
30932
|
"sent_timestamp": {
|
|
@@ -30371,7 +30946,7 @@
|
|
|
30371
30946
|
},
|
|
30372
30947
|
"regarding_job_uuid": {
|
|
30373
30948
|
"format": "uuid",
|
|
30374
|
-
"example": "123e4567-
|
|
30949
|
+
"example": "123e4567-33ad-4fc3-81e6-2329b4763b1b",
|
|
30375
30950
|
"type": "string"
|
|
30376
30951
|
},
|
|
30377
30952
|
"attached_json": {
|
|
@@ -30402,7 +30977,7 @@
|
|
|
30402
30977
|
"related_object_uuid": {
|
|
30403
30978
|
"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.",
|
|
30404
30979
|
"format": "uuid",
|
|
30405
|
-
"example": "123e4567-
|
|
30980
|
+
"example": "123e4567-8c04-40d6-9f92-2329bd805b5b",
|
|
30406
30981
|
"type": "string"
|
|
30407
30982
|
},
|
|
30408
30983
|
"task_complete": {
|
|
@@ -30417,13 +30992,13 @@
|
|
|
30417
30992
|
"completed_by_staff_uuid": {
|
|
30418
30993
|
"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.",
|
|
30419
30994
|
"format": "uuid",
|
|
30420
|
-
"example": "123e4567-
|
|
30995
|
+
"example": "123e4567-28af-4e1d-886d-2329b5ddbbeb",
|
|
30421
30996
|
"type": "string"
|
|
30422
30997
|
},
|
|
30423
30998
|
"assigned_to_staff_uuid": {
|
|
30424
30999
|
"description": "UUID of the staff member assigned to complete this task. Must be a valid staff UUID in the system.",
|
|
30425
31000
|
"format": "uuid",
|
|
30426
|
-
"example": "123e4567-
|
|
31001
|
+
"example": "123e4567-59a9-468b-98ae-2329baeb389b",
|
|
30427
31002
|
"type": "string"
|
|
30428
31003
|
},
|
|
30429
31004
|
"lng": {
|
|
@@ -30435,7 +31010,7 @@
|
|
|
30435
31010
|
"uuid": {
|
|
30436
31011
|
"format": "uuid",
|
|
30437
31012
|
"description": "Unique identifier for this record",
|
|
30438
|
-
"example": "123e4567-
|
|
31013
|
+
"example": "123e4567-bd10-40e1-adb9-2329bef06c0b",
|
|
30439
31014
|
"type": "string"
|
|
30440
31015
|
},
|
|
30441
31016
|
"active": {
|
|
@@ -30454,7 +31029,7 @@
|
|
|
30454
31029
|
},
|
|
30455
31030
|
"created_by_staff_uuid": {
|
|
30456
31031
|
"format": "uuid",
|
|
30457
|
-
"example": "123e4567-
|
|
31032
|
+
"example": "123e4567-40c6-4555-9c38-2329b2bfe28b",
|
|
30458
31033
|
"type": "string"
|
|
30459
31034
|
},
|
|
30460
31035
|
"create_date": {
|
|
@@ -30472,7 +31047,7 @@
|
|
|
30472
31047
|
"uuid": {
|
|
30473
31048
|
"format": "uuid",
|
|
30474
31049
|
"description": "Unique identifier for this record",
|
|
30475
|
-
"example": "123e4567-
|
|
31050
|
+
"example": "123e4567-3d90-404f-8a58-2329ba8f53fb",
|
|
30476
31051
|
"type": "string"
|
|
30477
31052
|
},
|
|
30478
31053
|
"active": {
|
|
@@ -30515,7 +31090,7 @@
|
|
|
30515
31090
|
"uuid": {
|
|
30516
31091
|
"format": "uuid",
|
|
30517
31092
|
"description": "Unique identifier for this record",
|
|
30518
|
-
"example": "123e4567-
|
|
31093
|
+
"example": "123e4567-fdca-4e7b-ab75-2329bc13c0cb",
|
|
30519
31094
|
"type": "string"
|
|
30520
31095
|
},
|
|
30521
31096
|
"active": {
|
|
@@ -30538,11 +31113,11 @@
|
|
|
30538
31113
|
"maxLength": 200
|
|
30539
31114
|
},
|
|
30540
31115
|
"abn_number": {
|
|
30541
|
-
"type": "string"
|
|
30542
|
-
"description": "Company ABN Number (Australian Accounts Only)"
|
|
31116
|
+
"type": "string"
|
|
30543
31117
|
},
|
|
30544
31118
|
"business_number": {
|
|
30545
|
-
"type": "string"
|
|
31119
|
+
"type": "string",
|
|
31120
|
+
"description": "Company Business Number"
|
|
30546
31121
|
},
|
|
30547
31122
|
"website": {
|
|
30548
31123
|
"type": "string",
|
|
@@ -30795,6 +31370,115 @@
|
|
|
30795
31370
|
}
|
|
30796
31371
|
}
|
|
30797
31372
|
},
|
|
31373
|
+
"CreateInboxMessageRequest": {
|
|
31374
|
+
"type": "object",
|
|
31375
|
+
"required": [
|
|
31376
|
+
"subject",
|
|
31377
|
+
"message_text"
|
|
31378
|
+
],
|
|
31379
|
+
"properties": {
|
|
31380
|
+
"subject": {
|
|
31381
|
+
"type": "string",
|
|
31382
|
+
"description": "Subject of the message"
|
|
31383
|
+
},
|
|
31384
|
+
"message_text": {
|
|
31385
|
+
"type": "string",
|
|
31386
|
+
"description": "Plain text content of the message"
|
|
31387
|
+
},
|
|
31388
|
+
"from_name": {
|
|
31389
|
+
"type": "string",
|
|
31390
|
+
"description": "Name of the sender"
|
|
31391
|
+
},
|
|
31392
|
+
"from_email": {
|
|
31393
|
+
"type": "string",
|
|
31394
|
+
"format": "email",
|
|
31395
|
+
"description": "Email address of the sender"
|
|
31396
|
+
},
|
|
31397
|
+
"json_data": {
|
|
31398
|
+
"type": "object",
|
|
31399
|
+
"description": "Additional data to be used when converting the message to a job",
|
|
31400
|
+
"additionalProperties": true
|
|
31401
|
+
},
|
|
31402
|
+
"jobData": {
|
|
31403
|
+
"type": "object",
|
|
31404
|
+
"description": "Structured job data that will be merged into json_data when converting the message to a job",
|
|
31405
|
+
"properties": {
|
|
31406
|
+
"contact_first": {
|
|
31407
|
+
"type": "string",
|
|
31408
|
+
"description": "Job contact first name"
|
|
31409
|
+
},
|
|
31410
|
+
"contact_last": {
|
|
31411
|
+
"type": "string",
|
|
31412
|
+
"description": "Job contact last name"
|
|
31413
|
+
},
|
|
31414
|
+
"company_name": {
|
|
31415
|
+
"type": "string",
|
|
31416
|
+
"description": "Company/customer name"
|
|
31417
|
+
},
|
|
31418
|
+
"email": {
|
|
31419
|
+
"type": "string",
|
|
31420
|
+
"format": "email",
|
|
31421
|
+
"description": "Primary email address"
|
|
31422
|
+
},
|
|
31423
|
+
"mobile": {
|
|
31424
|
+
"type": "string",
|
|
31425
|
+
"description": "Mobile phone number"
|
|
31426
|
+
},
|
|
31427
|
+
"phone_1": {
|
|
31428
|
+
"type": "string",
|
|
31429
|
+
"description": "Primary phone number"
|
|
31430
|
+
},
|
|
31431
|
+
"phone_2": {
|
|
31432
|
+
"type": "string",
|
|
31433
|
+
"description": "Secondary phone number"
|
|
31434
|
+
},
|
|
31435
|
+
"billing_contact_first": {
|
|
31436
|
+
"type": "string",
|
|
31437
|
+
"description": "Billing contact first name"
|
|
31438
|
+
},
|
|
31439
|
+
"billing_contact_last": {
|
|
31440
|
+
"type": "string",
|
|
31441
|
+
"description": "Billing contact last name"
|
|
31442
|
+
},
|
|
31443
|
+
"billing_email": {
|
|
31444
|
+
"type": "string",
|
|
31445
|
+
"format": "email",
|
|
31446
|
+
"description": "Billing email address"
|
|
31447
|
+
},
|
|
31448
|
+
"billing_mobile": {
|
|
31449
|
+
"type": "string",
|
|
31450
|
+
"description": "Billing mobile number"
|
|
31451
|
+
},
|
|
31452
|
+
"billing_attention": {
|
|
31453
|
+
"type": "string",
|
|
31454
|
+
"description": "Billing attention line"
|
|
31455
|
+
},
|
|
31456
|
+
"job_description": {
|
|
31457
|
+
"type": "string",
|
|
31458
|
+
"description": "Description of the job/work to be done"
|
|
31459
|
+
},
|
|
31460
|
+
"job_address": {
|
|
31461
|
+
"type": "string",
|
|
31462
|
+
"description": "Service location address"
|
|
31463
|
+
},
|
|
31464
|
+
"billing_address": {
|
|
31465
|
+
"type": "string",
|
|
31466
|
+
"description": "Billing address"
|
|
31467
|
+
},
|
|
31468
|
+
"work_done_description": {
|
|
31469
|
+
"type": "string",
|
|
31470
|
+
"description": "Description of completed work"
|
|
31471
|
+
}
|
|
31472
|
+
},
|
|
31473
|
+
"additionalProperties": false
|
|
31474
|
+
},
|
|
31475
|
+
"regarding_company_uuid": {
|
|
31476
|
+
"type": "string",
|
|
31477
|
+
"format": "uuid",
|
|
31478
|
+
"description": "UUID of the company this message is regarding"
|
|
31479
|
+
}
|
|
31480
|
+
}
|
|
31481
|
+
},
|
|
30798
31482
|
"JobTemplateOverrides": {
|
|
30799
31483
|
"type": "object",
|
|
30800
31484
|
"description": "Optional field overrides when creating a job from a template. Only the following fields can be overridden: job_description, company_uuid, company_name, and job_address. Note: You cannot specify both company_uuid and company_name.",
|