Skip to main content
PATCH
/
maintenance
/
work-orders
Updates a work order.
curl --request PATCH \
  --url https://api.samsara.com/maintenance/work-orders \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "5",
  "assignedUserId": "1234",
  "category": "PREVENTIVE",
  "closingNotes": "Everything was fixed without issues.",
  "completedAtTime": "2019-06-13T19:08:25Z",
  "description": "The vehicle is not starting.",
  "discount": {
    "basisPoints": 500
  },
  "dueAtTime": "2019-06-13T19:08:25Z",
  "engineHours": 91823,
  "invoiceNumber": "123456",
  "items": [
    {
      "id": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
      "type": "ISSUE"
    }
  ],
  "odometerMeters": 91823,
  "poNumber": "123456",
  "priority": "HIGH",
  "serviceTaskInstances": [
    {
      "serviceTaskId": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
      "status": "Unknown",
      "id": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
      "laborTimeMinutes": 60,
      "parts": [
        {
          "partId": "P0077",
          "quantity": 2.5,
          "costCentsOverride": 1000,
          "id": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7"
        }
      ]
    }
  ],
  "status": "OPEN",
  "tax": {
    "basisPoints": 700
  },
  "vendorUuid": "5523a39f-42ef-4820-83d0-dfe73dbe7853"
}
'
{
  "data": {
    "assetId": "12443",
    "createdAtTime": "2019-06-13T19:08:25Z",
    "id": "5",
    "status": "OPEN",
    "updatedAtTime": "2019-06-13T19:08:25Z",
    "archivedAtTime": "2019-06-13T19:08:25Z",
    "assignedUserId": "1234",
    "attachments": [
      {
        "id": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
        "processingStatus": "processing",
        "url": "https://samsara-forms-submission-media-uploads.s3.us-west-2.amazonaws.com/123456",
        "urlExpiresAt": "2019-06-13T19:08:25Z"
      }
    ],
    "category": "PREVENTIVE",
    "closingNotes": "Everything was fixed without issues.",
    "completedAtTime": "2019-06-13T19:08:25Z",
    "createdByUserId": "1234",
    "description": "The vehicle is not starting.",
    "discount": {
      "basisPoints": 500,
      "money": {
        "amount": "94.01",
        "currency": "usd"
      }
    },
    "dueAtTime": "2019-06-13T19:08:25Z",
    "engineHours": 91823,
    "invoiceNumber": "123456",
    "items": [
      {
        "id": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
        "type": "ISSUE"
      }
    ],
    "odometerMeters": 91823,
    "poNumber": "123456",
    "priority": "HIGH",
    "serviceTaskInstances": [
      {
        "id": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
        "serviceTaskId": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
        "status": "Unknown",
        "laborHourlyCost": {
          "amount": "94.01",
          "currency": "usd"
        },
        "laborTimeMinutes": 60,
        "parts": [
          {
            "id": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
            "partId": "P0077",
            "quantity": 2.5,
            "costCentsOverride": 1000
          }
        ],
        "partsCost": {
          "amount": "94.01",
          "currency": "usd"
        }
      }
    ],
    "tax": {
      "basisPoints": 700,
      "money": {
        "amount": "94.01",
        "currency": "usd"
      }
    },
    "unallocatedLabor": {
      "cost": {
        "amount": "94.01",
        "currency": "usd"
      },
      "timeMinutes": 60
    },
    "vendorUuid": "5523a39f-42ef-4820-83d0-dfe73dbe7853"
  }
}

Documentation Index

Fetch the complete documentation index at: https://samsara-showcase.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Work Order Request.

​
id
string
required

The unique id of the work order.

Example:

"5"

​
assignedUserId
string

The ID of the assigned mechanic.

Example:

"1234"

​
category
string

The category of the work order

Example:

"PREVENTIVE"

​
closingNotes
string

Notes on the work order.

Example:

"Everything was fixed without issues."

​
completedAtTime
string<date-time>

The time the work order was completed in RFC 3339 format. Is automatically set when the status changes and this field is not provided.

Example:

"2019-06-13T19:08:25Z"

​
description
string

A description of what needs to be fixed.

Example:

"The vehicle is not starting."

​
discount
object

How much a work order is discounted. Either money or basisPoints are specified.

​
dueAtTime
string<date-time>

The due date of the work order in RFC 3339 format.

Example:

"2019-06-13T19:08:25Z"

​
engineHours
integer<int64>

The engine hours at the time of the work order. Will default to current asset reading if unset.

Example:

91823

​
invoiceNumber
string

The invoice number for the work order.

Example:

"123456"

​
items
object[]

Items related to the work order.

​
odometerMeters
integer<int64>

The odometer reading at the time of the work order. Will default to current asset reading if unset.

Example:

91823

​
poNumber
string

The purchase order number for the work order.

Example:

"123456"

​
priority
enum<string>

The priority of the work order Valid values: High, Low, Medium, Urgent

Available options:
High,
Low,
Medium,
Urgent
Example:

"HIGH"

​
serviceTaskInstances
object[]

Service Tasks for the work order.

​
status
enum<string>

The status of the work order Valid values: Assigned, Cancelled, Closed, Completed, Estimate, In Progress, On Hold, Open, Pending Approval, Pending Parts

Available options:
Assigned,
Cancelled,
Closed,
Completed,
Estimate,
In Progress,
On Hold,
Open,
Pending Approval,
Pending Parts
Example:

"OPEN"

​
tax
object

How much tax is applied to a work order. Either money or basisPoints are specified.

​
vendorUuid
string

The vendor UUID for the work order.

Example:

"5523a39f-42ef-4820-83d0-dfe73dbe7853"

Response

OK response.

​
data
object
required

A work order object.