Skimmer.PublicApi.Host | v1

WorkOrders

Endpointhttps://publicapi.getskimmer.com

Retrieve a Work Order details.

GET

https://publicapi.getskimmer.com

/WorkOrders/{id}

Retrieve a Work Order details. › path Parameters

id

string · required

Retrieve a Work Order details. › Headers

skimmer-api-key

string · required

The skimmer-api-key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Retrieve a Work Order details. › Responses

id

string · required

Work Order identifier.

object · required

Work Order Type details.

customerId

string · required

The customer identifier.

serviceLocationId

string · required

The Service Location identifier.

object

The Lead Tech account details.

workNeeded

string | null

A description of work needed as part of service.

serviceDate

string | null · date

The service date of the work order.

estimatedMinutes

integer | null · int32

Estimated minutes required to complete work.

scheduledTime

string | null

Time scheduled to start work at specified service date.

laborCost

number | null · double

Labor Cost for work order.

price

number | null · double

The price of the work order. Independent of installed items or dosages.

workPerformed

string | null

A description of work performed.

GET/WorkOrders/{id}

curl --request GET \
  --url https://publicapi.getskimmer.com/WorkOrders/:id \
  --header 'skimmer-api-key: <string>'

shell

Example Responses

{
  "id": "id",
  "workOrderType": {
    "id": "id",
    "description": {},
    "defaultPrice": 0,
    "priceIsTaxable": true,
    "deleted": true,
    "colorCode": {}
  },
  "customerId": "customerId",
  "serviceLocationId": "serviceLocationId",
  "leadTech": {
    "id": "id",
    "firstName": {},
    "lastName": {},
    "pinColor": {}
  },
  "workNeeded": {},
  "serviceDate": "2024-08-25",
  "estimatedMinutes": {},
  "scheduledTime": {},
  "laborCost": {},
  "price": {},
  "workPerformed": {}
}

plain

Updates an existing Work Order.

PUT

https://publicapi.getskimmer.com

/WorkOrders

Updates an existing Work Order. › Headers

skimmer-api-key

string · required

The skimmer-api-key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Updates an existing Work Order. › Request Body

id

string · required

Work Order identifier.

leadTechId

string | null

The technician identifier. Null = no change, empty string = clear assignment.

workNeeded

string | null

A description of work needed as part of service.

serviceDate

string | null · date

The service date of the work order.

estimatedMinutes

integer | null · int32

Estimated minutes required to complete work.

scheduledTime

string | null

Time scheduled to start work at specified service date.

laborCost

number | null · double

Labor Cost for work order.

price

number | null · double

The price of the work order. Independent of installed items or dosages.

workPerformed

string | null

A description of work performed.

Updates an existing Work Order. › Responses

id

string · required

Work Order identifier.

object · required

Work Order Type details.

customerId

string · required

The customer identifier.

serviceLocationId

string · required

The Service Location identifier.

object

The Lead Tech account details.

workNeeded

string | null

A description of work needed as part of service.

serviceDate

string | null · date

The service date of the work order.

estimatedMinutes

integer | null · int32

Estimated minutes required to complete work.

scheduledTime

string | null

Time scheduled to start work at specified service date.

laborCost

number | null · double

Labor Cost for work order.

price

number | null · double

The price of the work order. Independent of installed items or dosages.

workPerformed

string | null

A description of work performed.

PUT/WorkOrders

curl --request PUT \
  --url https://publicapi.getskimmer.com/WorkOrders \
  --header 'Content-Type: application/json' \
  --header 'skimmer-api-key: <string>' \
  --data '
{
  "id": "id",
  "leadTechId": {},
  "workNeeded": {},
  "serviceDate": "2024-08-25",
  "estimatedMinutes": {},
  "scheduledTime": {},
  "laborCost": {},
  "price": {},
  "workPerformed": {}
}
'

shell

Example Request Body

{
  "id": "id",
  "leadTechId": {},
  "workNeeded": {},
  "serviceDate": "2024-08-25",
  "estimatedMinutes": {},
  "scheduledTime": {},
  "laborCost": {},
  "price": {},
  "workPerformed": {}
}

json

Example Responses

{
  "id": "id",
  "workOrderType": {
    "id": "id",
    "description": {},
    "defaultPrice": 0,
    "priceIsTaxable": true,
    "deleted": true,
    "colorCode": {}
  },
  "customerId": "customerId",
  "serviceLocationId": "serviceLocationId",
  "leadTech": {
    "id": "id",
    "firstName": {},
    "lastName": {},
    "pinColor": {}
  },
  "workNeeded": {},
  "serviceDate": "2024-08-25",
  "estimatedMinutes": {},
  "scheduledTime": {},
  "laborCost": {},
  "price": {},
  "workPerformed": {}
}

plain

Creates a new Work Order

POST

https://publicapi.getskimmer.com

/WorkOrders

Creates a new Work Order › Headers

skimmer-api-key

string · required

The skimmer-api-key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Creates a new Work Order › Request Body

workOrderTypeId

string · required

The WorkOrder type identifier.

customerId

string · required

The customer identifier.

serviceLocationId

string · required

The Service Location identifier.

leadTechId

string | null

The technician identifier.

workNeeded

string | null

A description of work needed as part of service.

serviceDate

string | null · date

The service date of the work order.

estimatedMinutes

integer | null · int32

Estimated minutes required to complete work.

scheduledTime

string | null

Time scheduled to start work at specified service date.

laborCost

number | null · double

Labor Cost for work order.

price

number | null · double

The price of the work order. Independent of installed items or dosages.

workPerformed

string | null

A description of work performed.

Creates a new Work Order › Responses

Created

id

string · required

Work Order identifier.

object · required

Work Order Type details.

customerId

string · required

The customer identifier.

serviceLocationId

string · required

The Service Location identifier.

object

The Lead Tech account details.

workNeeded

string | null

A description of work needed as part of service.

serviceDate

string | null · date

The service date of the work order.

estimatedMinutes

integer | null · int32

Estimated minutes required to complete work.

scheduledTime

string | null

Time scheduled to start work at specified service date.

laborCost

number | null · double

Labor Cost for work order.

price

number | null · double

The price of the work order. Independent of installed items or dosages.

workPerformed

string | null

A description of work performed.

POST/WorkOrders

curl --request POST \
  --url https://publicapi.getskimmer.com/WorkOrders \
  --header 'Content-Type: application/json' \
  --header 'skimmer-api-key: <string>' \
  --data '
{
  "workOrderTypeId": "workOrderTypeId",
  "customerId": "customerId",
  "serviceLocationId": "serviceLocationId",
  "leadTechId": {},
  "workNeeded": {},
  "serviceDate": "2024-08-25",
  "estimatedMinutes": {},
  "scheduledTime": {},
  "laborCost": {},
  "price": {},
  "workPerformed": {}
}
'

shell

Example Request Body

{
  "workOrderTypeId": "workOrderTypeId",
  "customerId": "customerId",
  "serviceLocationId": "serviceLocationId",
  "leadTechId": {},
  "workNeeded": {},
  "serviceDate": "2024-08-25",
  "estimatedMinutes": {},
  "scheduledTime": {},
  "laborCost": {},
  "price": {},
  "workPerformed": {}
}

json

Example Responses

{
  "id": "id",
  "workOrderType": {
    "id": "id",
    "description": {},
    "defaultPrice": 0,
    "priceIsTaxable": true,
    "deleted": true,
    "colorCode": {}
  },
  "customerId": "customerId",
  "serviceLocationId": "serviceLocationId",
  "leadTech": {
    "id": "id",
    "firstName": {},
    "lastName": {},
    "pinColor": {}
  },
  "workNeeded": {},
  "serviceDate": "2024-08-25",
  "estimatedMinutes": {},
  "scheduledTime": {},
  "laborCost": {},
  "price": {},
  "workPerformed": {}
}

plain

ServiceLocations

Retrieve a Work Order details.

GET

https://publicapi.getskimmer.com

/WorkOrders/{id}

Retrieve a Work Order details. › path Parameters

id

string · required

Retrieve a Work Order details. › Headers

skimmer-api-key

string · required

The skimmer-api-key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Retrieve a Work Order details. › Responses

id

string · required

Work Order identifier.

object · required

Work Order Type details.

customerId

string · required

The customer identifier.

serviceLocationId

string · required

The Service Location identifier.

object

The Lead Tech account details.

workNeeded

string | null

A description of work needed as part of service.

serviceDate

string | null · date

The service date of the work order.

estimatedMinutes

integer | null · int32

Estimated minutes required to complete work.

scheduledTime

string | null

Time scheduled to start work at specified service date.

laborCost

number | null · double

Labor Cost for work order.

price

number | null · double

The price of the work order. Independent of installed items or dosages.

workPerformed

string | null

A description of work performed.

Updates an existing Work Order.

PUT

https://publicapi.getskimmer.com

/WorkOrders

Updates an existing Work Order. › Headers

skimmer-api-key

string · required

The skimmer-api-key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Updates an existing Work Order. › Request Body

id

string · required

Work Order identifier.

leadTechId

string | null

The technician identifier. Null = no change, empty string = clear assignment.

workNeeded

string | null

A description of work needed as part of service.

serviceDate

string | null · date

The service date of the work order.

estimatedMinutes

integer | null · int32

Estimated minutes required to complete work.

scheduledTime

string | null

Time scheduled to start work at specified service date.

laborCost

number | null · double

Labor Cost for work order.

price

number | null · double

The price of the work order. Independent of installed items or dosages.

workPerformed

string | null

A description of work performed.

Updates an existing Work Order. › Responses

id

string · required

Work Order identifier.

object · required

Work Order Type details.

customerId

string · required

The customer identifier.

serviceLocationId

string · required

The Service Location identifier.

object

The Lead Tech account details.

workNeeded

string | null

A description of work needed as part of service.

serviceDate

string | null · date

The service date of the work order.

estimatedMinutes

integer | null · int32

Estimated minutes required to complete work.

scheduledTime

string | null

Time scheduled to start work at specified service date.

laborCost

number | null · double

Labor Cost for work order.

price

number | null · double

The price of the work order. Independent of installed items or dosages.

workPerformed

string | null

A description of work performed.

curl --request PUT \ --url https://publicapi.getskimmer.com/WorkOrders \ --header 'Content-Type: application/json' \ --header 'skimmer-api-key: <string>' \ --data ' { "id": "id", "leadTechId": {}, "workNeeded": {}, "serviceDate": "2024-08-25", "estimatedMinutes": {}, "scheduledTime": {}, "laborCost": {}, "price": {}, "workPerformed": {} } '

{ "id": "id", "workOrderType": { "id": "id", "description": {}, "defaultPrice": 0, "priceIsTaxable": true, "deleted": true, "colorCode": {} }, "customerId": "customerId", "serviceLocationId": "serviceLocationId", "leadTech": { "id": "id", "firstName": {}, "lastName": {}, "pinColor": {} }, "workNeeded": {}, "serviceDate": "2024-08-25", "estimatedMinutes": {}, "scheduledTime": {}, "laborCost": {}, "price": {}, "workPerformed": {} }

Creates a new Work Order

POST

https://publicapi.getskimmer.com

/WorkOrders

Creates a new Work Order › Headers

skimmer-api-key

string · required

The skimmer-api-key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Creates a new Work Order › Request Body

workOrderTypeId

string · required

The WorkOrder type identifier.

customerId

string · required

The customer identifier.

serviceLocationId

string · required

The Service Location identifier.

leadTechId

string | null

The technician identifier.

workNeeded

string | null

A description of work needed as part of service.

serviceDate

string | null · date

The service date of the work order.

estimatedMinutes

integer | null · int32

Estimated minutes required to complete work.

scheduledTime

string | null

Time scheduled to start work at specified service date.

laborCost

number | null · double

Labor Cost for work order.

price

number | null · double

The price of the work order. Independent of installed items or dosages.

workPerformed

string | null

A description of work performed.

Creates a new Work Order › Responses

Created

id

string · required

Work Order identifier.

object · required

Work Order Type details.

customerId

string · required

The customer identifier.

serviceLocationId

string · required

The Service Location identifier.

object

The Lead Tech account details.

workNeeded

string | null

A description of work needed as part of service.

serviceDate

string | null · date

The service date of the work order.

estimatedMinutes

integer | null · int32

Estimated minutes required to complete work.

scheduledTime

string | null

Time scheduled to start work at specified service date.

laborCost

number | null · double

Labor Cost for work order.

price

number | null · double

The price of the work order. Independent of installed items or dosages.

workPerformed

string | null

A description of work performed.

curl --request POST \ --url https://publicapi.getskimmer.com/WorkOrders \ --header 'Content-Type: application/json' \ --header 'skimmer-api-key: <string>' \ --data ' { "workOrderTypeId": "workOrderTypeId", "customerId": "customerId", "serviceLocationId": "serviceLocationId", "leadTechId": {}, "workNeeded": {}, "serviceDate": "2024-08-25", "estimatedMinutes": {}, "scheduledTime": {}, "laborCost": {}, "price": {}, "workPerformed": {} } '

{ "workOrderTypeId": "workOrderTypeId", "customerId": "customerId", "serviceLocationId": "serviceLocationId", "leadTechId": {}, "workNeeded": {}, "serviceDate": "2024-08-25", "estimatedMinutes": {}, "scheduledTime": {}, "laborCost": {}, "price": {}, "workPerformed": {} }