Add "cost" return to API endpoints

Author: AlbertMN

source/includes/_files.md

@@ -38,7 +38,7 @@ curl https://api.simplyprint.io/{id}/files/GetFiles?f=123&search=benchy \
       "id": "e82ab9e1cc3c20850d94d5cf539390c0",
       "name": "3DBenchy",
       "ext": "gcode",
-      "type": "model",
+      "type": "printable",
       "size": 1285384,
       "created": "December 23, 2022, 18:00",
       "createdint": 1671813330,
@@ -69,6 +69,37 @@ curl https://api.simplyprint.io/{id}/files/GetFiles?f=123&search=benchy \
           }
         ],
         "custom": [1, 2, 3]
+      },
+      "cost": {
+        "estimate": false,
+        "total_cost": 150,
+        "lines":[
+            {
+              "id": 1,
+              "label": "Material usage (account default)",
+              "cost": 0.02
+            },
+            {
+              "id": 2,
+              "label":"Material markup",
+              "cost": null
+            },
+            {
+              "id": 3,
+              "label":"Machine run time cost",
+              "cost": null
+            },
+            {
+              "id": 4,
+              "label": "Energy cost",
+              "cost": null
+            },
+            {
+              "id": 5,
+              "label": "Labor cost",
+              "cost": 1000
+            }
+        ]
       }
     }
   ],
@@ -109,6 +140,7 @@ This endpoint returns a list of files and folders in a given folder. If no folde
 | `f` | integer | no | Folder ID to get files for. **Defaults to 0 (root folder)** |
 | `search` | string | no | Search string to filter files by. |
 | `global_search` | boolean | no | If true, search all files in the account, not just the folder specified by `f`. |
+| `pid` | integer | no | For print cost calculation, if you want the files to use the material of a printer, request with the ID of the printer - don't include the `pid` argument otherwise |
 
 ### Response
 

source/includes/_jobs.md

@@ -29,21 +29,52 @@ curl https://api.simplyprint.io/{id}/jobs/GetPaginatedPrintJobs \
   "message": null,
   "data": [
     {
-        "id": 549145,
-        "uid": "7df103aa-b12c-4b33-8305-b55f91c11a4d",
-        "status": "cancelled",
-        "cancelReasonType": "5",
-        "rating": -2,
-        "filename": "Benchy.gcode",
-        "startDate": "2023-02-28T21:05:50+00:00",
-        "endDate": "2023-02-28T21:06:07+00:00",
-        "user": 5933,
-        "printer": 385,
-        "filament": "{\"e0\": {\"usage\": 60}}",
-        "filUsage": 60,
-        "filUsageGram": 0,
-        "currentPercentage": 48,
-        "printTime": 17
+      "id": 549145,
+      "uid": "7df103aa-b12c-4b33-8305-b55f91c11a4d",
+      "status": "cancelled",
+      "cancelReasonType": "5",
+      "rating": -2,
+      "filename": "Benchy.gcode",
+      "startDate": "2023-02-28T21:05:50+00:00",
+      "endDate": "2023-02-28T21:06:07+00:00",
+      "user": 5933,
+      "printer": 385,
+      "filament": "{\"e0\": {\"usage\": 60}}",
+      "filUsage": 60,
+      "filUsageGram": 0,
+      "currentPercentage": 48,
+      "printTime": 17,
+      "cost": {
+        "estimate": false,
+        "total_cost": 150,
+        "lines": [
+            {
+              "id": 1,
+              "label": "Material usage (account default)",
+              "cost": 0.02
+            },
+            {
+              "id": 2,
+              "label":"Material markup",
+              "cost": null
+            },
+            {
+              "id": 3,
+              "label":"Machine run time cost",
+              "cost": null
+            },
+            {
+              "id": 4,
+              "label": "Energy cost",
+              "cost": null
+            },
+            {
+              "id": 5,
+              "label": "Labor cost",
+              "cost": 1000
+            }
+          ]
+        }
     },
     ...
   ],
@@ -82,11 +113,12 @@ Get paginated data about ongoing or finished print jobs.
 | `data[].rating` | integer | The job rating. |
 | `data[].filename` | string | The job filename. |
 | `data[].startDate` | string | The job start date. |
-| `data[].endDate` | string/null | The job end date. Is null if the job is ongoing. |
+| `data[].endDate` | string|nullable | The job end date. Is null if the job is ongoing. |
 | `data[].user` | integer | The user id of the user who started the job. |
 | `data[].printer` | integer | The printer id that was used to print the job. |
 | `data[].filament` | string | The filament usage. JSON encoded string with usage per extruder. |
 | `data[].filUsage` | integer | The filament usage in mm. |
 | `data[].filUsageGram` | integer | The filament usage in grams. |
 | `data[].currentPercentage` | integer | The current percentage of the job. |
+| `data[].cost` | object|nullable | Potential calculated cost of job. |
 | `page_amount` | integer | The total number of pages for the given parameters. |

source/includes/_printers.md

@@ -280,7 +280,40 @@ curl https://api.simplyprint.io/{id}/printers/actions/CreateJob?pid=1234&filesys
         1234,
         1235        
       ],
-      "queued": false
+      "queued": false,
+      "cost": [
+        {
+          "estimate": false,
+          "total_cost": 1006.76,
+          "lines": [
+            {
+              "id": 1,
+              "label": "HIPS Material usage",
+              "cost": 0.05
+            },
+            {
+              "id": 2,
+              "label": "Material markup",
+              "cost": 0.03
+            },
+            {
+              "id": 3,
+              "label": "Machine run time cost",
+              "cost": 6.67
+            },
+            {
+              "id": 4,
+              "label": "Energy cost",
+              "cost": 0.01
+            },
+            {
+              "id": 5,
+              "label": "Labor cost",
+              "cost": 1000
+            }
+          ]
+        }
+      ]
     }
   ],
   "jobIds": [
@@ -329,6 +362,7 @@ You can specify these parameters if `next_queue_item` is `true`. Note that you c
 | `files[].analysis` | object | The analysis of the file. This has been documented in the [Get queue items endpoint](#get-queue-items). |
 | `files[].printers` | integer[] | The IDs of the printers that the print job was started on. |
 | `files[].queued` | boolean | Whether the print job was from print queue. |
+| `files[].cost` | object[]|nullable | Potential calculated cost of job. Potential of multiple costs if job is created for different printers with different material types assigned. |
 | `jobIds` | integer[] | The IDs of the print jobs that were started. |
 
 ## Pause print job