Inventory Labor

WIP: A summary needs to be written for Inventory Labor

GET/v3/inventory_labor/:id

Find Inventory Labor

Find one Inventory Labor by id

URL parameters

  • Name
    id
    Type
    string Required
    Description
    the id for the object to retrieve

Produces

The response content type: application/json

200 Response

  • Name
    data
    Type
    object Required
    Description
    InventoryLabor schema
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

Properties for data object

  • Name
    id
    Type
    string Required
    Description
  • Name
    meta
    Type
    object Required
    Description
    the metadata about the most recent change to the row
  • Name
    metadata
    Type
    object
    Description
    metadata reserved for customers to control
  • Name
    createdDate
    Type
    string Required
    Description
  • Name
    updatedDate
    Type
    string Required
    Description
  • Name
    companyId
    Type
    string Required
    Description
  • Name
    locationId
    Type
    string Required
    Description
  • Name
    name
    Type
    string Required
    Description
  • Name
    note
    Type
    string Required
    Description
  • Name
    showHours
    Type
    boolean Required
    Description
  • Name
    showNote
    Type
    boolean Required
    Description
  • Name
    discountCents
    Type
    integer Required
    Description
  • Name
    discountPercent
    Type
    number Required
    Description
  • Name
    discountValueType
    Type
    one of: Percent, FixedCents Required
    Description
  • Name
    hours
    Type
    number Required
    Description
  • Name
    rateCents
    Type
    integer Required
    Description
  • Name
    costHours
    Type
    number Required
    Description
  • Name
    costRateCents
    Type
    integer Required
    Description
  • Name
    multiplier
    Type
    number Required
    Description
  • Name
    multiplierType
    Type
    one of: Hours, Rate Required
    Description
  • Name
    categoryId
    Type
    string Required
    Description
  • Name
    rateId
    Type
    string Required
    Description
  • Name
    skillRequired
    Type
    one of: General, Maintenance, Precision Required
    Description
  • Name
    skillRequiredDescription
    Type
    string Required
    Description
  • Name
    totalCostCents
    Type
    integer Required
    Description
  • Name
    taxable
    Type
    boolean Required
    Description
    US specific
  • Name
    taxableGST
    Type
    boolean Required
    Description
    CA specific
  • Name
    taxableHST
    Type
    boolean Required
    Description
    CA specific
  • Name
    taxablePST
    Type
    boolean Required
    Description
    CA specific
  • Name
    laborMatrixId
    Type
    string Required
    Description
  • Name
    laborMatrixDate
    Type
    string Required
    Description
    datetime when laborMatrixId was set, for determining if matrix has been changed
  • Name
    deleted
    Type
    boolean Required
    Description
    if the record has been deleted
  • Name
    deletedUserId
    Type
    string Required
    Description
    the user that deleted the record or null if not deleted
  • Name
    deletedDate
    Type
    string Required
    Description
    the date that the record was deleted or null if not deleted
  • Name
    deletedReason
    Type
    string Required
    Description
    the reason that the record was deleted
  • Name
    userId
    Type
    string Required
    Description
  • Name
    category
    Type
    object Required
    Description
  • Name
    rate
    Type
    object Required
    Description
    LaborRate schema

Properties for meta object

  • Name
    userId
    Type
    string
    Description
    the user id that made the most recent change
  • Name
    sessionId
    Type
    string
    Description
    the session id for the most recent change
  • Name
    version
    Type
    number
    Description
    a monotonically increasing number for the most recent change

Properties for category object

  • Name
    id
    Type
    string Required
    Description
    the id for the category
  • Name
    name
    Type
    string Required
    Description
    the category name
  • Name
    parent
    Type
    object Required
    Description

Properties for parent object

  • Name
    id
    Type
    string Required
    Description
    the id for the parent category
  • Name
    name
    Type
    string Required
    Description
    the name of the parent category

Properties for rate object

  • Name
    id
    Type
    string Required
    Description
  • Name
    name
    Type
    string Required
    Description
  • Name
    valueCents
    Type
    integer Required
    Description

4xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

5xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

Example Request

GET
/v3/inventory_labor/:id
curl https://api.shopmonkey.cloud/v3/inventory_labor/:id \
  -H "Authorization: Bearer ${SM_TOKEN}"

Example Response
application/json

{
  "success": true,
  "data": {
    "id": "id",
    "meta": {
      "userId": "userId",
      "sessionId": "sessionId",
      "version": 1
    },
    "createdDate": "createdDate",
    "updatedDate": null,
    "companyId": "companyId",
    "locationId": "locationId",
    "name": "name",
    "note": "note",
    "showHours": true,
    "showNote": true,
    "discountCents": 1,
    "discountPercent": 1,
    "discountValueType": "discountValueType",
    "hours": 1,
    "rateCents": 1,
    "costHours": null,
    "costRateCents": null,
    "multiplier": 1,
    "multiplierType": "multiplierType",
    "categoryId": null,
    "rateId": null,
    "skillRequired": null,
    "skillRequiredDescription": null,
    "totalCostCents": null,
    "taxable": true,
    "laborMatrixId": null,
    "laborMatrixDate": null,
    "deleted": true,
    "deletedUserId": null,
    "deletedDate": null,
    "deletedReason": null,
    "userId": null
  }
}
GET/v3/inventory_labor

List Inventory Labors

Find all Inventory Labors

Query String parameters

  • Name
    ids
    Type
    array
    Description
  • Name
    limit
    Type
    number
    Description
    the limit on the number of records to return
  • Name
    orderby
    Type
    string
    Description
    the order instructions for the result
  • Name
    params
    Type
    string
    Description
    additional request specific params
  • Name
    skip
    Type
    number
    Description
    the number of records to skip for a paginated result
  • Name
    where
    Type
    string
    Description
    an object to use for filtering the results

Produces

The response content type: application/json

200 Response

  • Name
    data
    Type
    array Required
    Description
    an array of items
  • Name
    meta
    Type
    object
    Description
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

Properties for meta object

  • Name
    hasMore
    Type
    boolean Required
    Description
    if there are more records available
  • Name
    total
    Type
    number Required
    Description
    the total number of records

4xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

5xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

Example Request

GET
/v3/inventory_labor
curl https://api.shopmonkey.cloud/v3/inventory_labor \
  -H "Authorization: Bearer ${SM_TOKEN}"

Example Response
application/json

{
  "success": true,
  "data": [
    {
      "id": "id",
      "createdDate": "createdDate",
      "updatedDate": null,
      "companyId": "companyId",
      "locationId": "locationId",
      "name": "name",
      "note": "note",
      "showHours": true,
      "showNote": true,
      "discountCents": 1,
      "discountPercent": 1,
      "discountValueType": "discountValueType",
      "hours": 1,
      "rateCents": 1,
      "costHours": null,
      "costRateCents": null,
      "multiplier": 1,
      "multiplierType": "multiplierType",
      "categoryId": null,
      "rateId": null,
      "skillRequired": null,
      "skillRequiredDescription": null,
      "totalCostCents": null,
      "taxable": true,
      "laborMatrixId": null,
      "laborMatrixDate": null,
      "deleted": true,
      "deletedUserId": null,
      "deletedDate": null,
      "deletedReason": null,
      "userId": null
    }
  ]
}
POST/v3/inventory_labor/search

Search Inventory Labor entities

Search for Inventory Labor Entries

Produces

The response content type: application/json

200 Response

  • Name
    data
    Type
    array Required
    Description
    an array of items
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

4xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

5xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

Example Request
application/json

POST
/v3/inventory_labor/search
curl https://api.shopmonkey.cloud/v3/inventory_labor/search \
  -H "Authorization: Bearer ${SM_TOKEN}" \
  -H 'Content-Type: application/json' \
  --data '{}'

Example Response
application/json

{
  "data": [
    {
      "id": "id",
      "createdDate": "createdDate",
      "updatedDate": null,
      "companyId": "companyId",
      "locationId": "locationId",
      "name": "name",
      "note": "note",
      "showHours": true,
      "showNote": true,
      "discountCents": 1,
      "discountPercent": 1,
      "discountValueType": "discountValueType",
      "hours": 1,
      "rateCents": 1,
      "costHours": null,
      "costRateCents": null,
      "multiplier": 1,
      "multiplierType": "multiplierType",
      "categoryId": null,
      "rateId": null,
      "skillRequired": null,
      "skillRequiredDescription": null,
      "totalCostCents": null,
      "taxable": true,
      "taxableGST": true,
      "taxableHST": true,
      "taxablePST": true,
      "laborMatrixId": null,
      "laborMatrixDate": null,
      "deleted": true,
      "deletedUserId": null,
      "deletedDate": null,
      "deletedReason": null,
      "userId": null,
      "category": {
        "id": "id",
        "name": "name",
        "parent": {
          "id": "id",
          "name": "name"
        }
      },
      "rate": {
        "id": "id",
        "name": "name",
        "valueCents": 1
      }
    }
  ],
  "success": true
}
PUT/v3/inventory_labor/:id

Update

Update one by id

URL parameters

  • Name
    id
    Type
    string Required
    Description
    the id for the object to update

Body parameters

Consumes

The following content type is required: application/json

  • Name
    name
    Type
    string
    Description
  • Name
    note
    Type
    string
    Description
  • Name
    showHours
    Type
    boolean
    Description
  • Name
    showNote
    Type
    boolean
    Description
  • Name
    discountCents
    Type
    integer
    Description
  • Name
    discountPercent
    Type
    number
    Description
  • Name
    discountValueType
    Type
    one of: Percent, FixedCents
    Description
  • Name
    hours
    Type
    number
    Description
  • Name
    rateCents
    Type
    integer
    Description
  • Name
    costHours
    Type
    number
    Description
  • Name
    costRateCents
    Type
    integer
    Description
  • Name
    multiplier
    Type
    number
    Description
  • Name
    multiplierType
    Type
    one of: Hours, Rate
    Description
  • Name
    categoryId
    Type
    string
    Description
  • Name
    rateId
    Type
    string
    Description
  • Name
    skillRequired
    Type
    one of: General, Maintenance, Precision
    Description
  • Name
    skillRequiredDescription
    Type
    string
    Description
  • Name
    totalCostCents
    Type
    integer
    Description
  • Name
    taxable
    Type
    boolean
    Description
    US specific
  • Name
    taxableGST
    Type
    boolean
    Description
    CA specific
  • Name
    taxableHST
    Type
    boolean
    Description
    CA specific
  • Name
    taxablePST
    Type
    boolean
    Description
    CA specific
  • Name
    laborMatrixId
    Type
    string
    Description
  • Name
    deleted
    Type
    boolean
    Description
    if the record has been deleted
  • Name
    deletedUserId
    Type
    string
    Description
    the user that deleted the record or null if not deleted
  • Name
    deletedReason
    Type
    string
    Description
    the reason that the record was deleted
  • Name
    userId
    Type
    string
    Description
  • Name
    activityNote
    Type
    string
    Description

Produces

The response content type: application/json

200 Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if success = false
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message
  • Name
    data
    Type
    object Required
    Description
    InventoryLabor schema

Properties for data object

  • Name
    id
    Type
    string Required
    Description
  • Name
    createdDate
    Type
    string Required
    Description
  • Name
    updatedDate
    Type
    string Required
    Description
  • Name
    companyId
    Type
    string Required
    Description
  • Name
    locationId
    Type
    string Required
    Description
  • Name
    name
    Type
    string Required
    Description
  • Name
    note
    Type
    string Required
    Description
  • Name
    showHours
    Type
    boolean Required
    Description
  • Name
    showNote
    Type
    boolean Required
    Description
  • Name
    discountCents
    Type
    integer Required
    Description
  • Name
    discountPercent
    Type
    number Required
    Description
  • Name
    discountValueType
    Type
    one of: Percent, FixedCents Required
    Description
  • Name
    hours
    Type
    number Required
    Description
  • Name
    rateCents
    Type
    integer Required
    Description
  • Name
    costHours
    Type
    number Required
    Description
  • Name
    costRateCents
    Type
    integer Required
    Description
  • Name
    multiplier
    Type
    number Required
    Description
  • Name
    multiplierType
    Type
    one of: Hours, Rate Required
    Description
  • Name
    categoryId
    Type
    string Required
    Description
  • Name
    rateId
    Type
    string Required
    Description
  • Name
    skillRequired
    Type
    one of: General, Maintenance, Precision Required
    Description
  • Name
    skillRequiredDescription
    Type
    string Required
    Description
  • Name
    totalCostCents
    Type
    integer Required
    Description
  • Name
    taxable
    Type
    boolean Required
    Description
    US specific
  • Name
    taxableGST
    Type
    boolean Required
    Description
    CA specific
  • Name
    taxableHST
    Type
    boolean Required
    Description
    CA specific
  • Name
    taxablePST
    Type
    boolean Required
    Description
    CA specific
  • Name
    laborMatrixId
    Type
    string Required
    Description
  • Name
    laborMatrixDate
    Type
    string Required
    Description
    datetime when laborMatrixId was set, for determining if matrix has been changed
  • Name
    deleted
    Type
    boolean Required
    Description
    if the record has been deleted
  • Name
    deletedUserId
    Type
    string Required
    Description
    the user that deleted the record or null if not deleted
  • Name
    deletedDate
    Type
    string Required
    Description
    the date that the record was deleted or null if not deleted
  • Name
    deletedReason
    Type
    string Required
    Description
    the reason that the record was deleted
  • Name
    userId
    Type
    string Required
    Description

4xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

5xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

Example Request
application/json

PUT
/v3/inventory_labor/:id
curl https://api.shopmonkey.cloud/v3/inventory_labor/:id \
  -H "Authorization: Bearer ${SM_TOKEN}" \
  -X PUT -H 'Content-Type: application/json' \
  --data '{}'

Example Response
application/json

{
  "success": true
}
POST/v3/inventory_labor

Create Inventory Labor

Create one Inventory Labor

Body parameters

Consumes

The following content type is required: application/json

  • Name
    name
    Type
    string Required
    Description
  • Name
    note
    Type
    string
    Description
  • Name
    showHours
    Type
    boolean
    Description
  • Name
    showNote
    Type
    boolean
    Description
  • Name
    discountCents
    Type
    integer
    Description
  • Name
    discountPercent
    Type
    number
    Description
  • Name
    discountValueType
    Type
    one of: Percent, FixedCents
    Description
  • Name
    hours
    Type
    number
    Description
  • Name
    rateCents
    Type
    integer Required
    Description
  • Name
    costHours
    Type
    number
    Description
  • Name
    costRateCents
    Type
    integer
    Description
  • Name
    multiplier
    Type
    number
    Description
  • Name
    multiplierType
    Type
    one of: Hours, Rate
    Description
  • Name
    categoryId
    Type
    string
    Description
  • Name
    rateId
    Type
    string
    Description
  • Name
    skillRequired
    Type
    one of: General, Maintenance, Precision
    Description
  • Name
    skillRequiredDescription
    Type
    string
    Description
  • Name
    totalCostCents
    Type
    integer
    Description
  • Name
    taxable
    Type
    boolean
    Description
    US specific
  • Name
    taxableGST
    Type
    boolean
    Description
    CA specific
  • Name
    taxableHST
    Type
    boolean
    Description
    CA specific
  • Name
    taxablePST
    Type
    boolean
    Description
    CA specific
  • Name
    laborMatrixId
    Type
    string
    Description
  • Name
    deleted
    Type
    boolean
    Description
    if the record has been deleted
  • Name
    deletedUserId
    Type
    string
    Description
    the user that deleted the record or null if not deleted
  • Name
    deletedReason
    Type
    string
    Description
    the reason that the record was deleted
  • Name
    userId
    Type
    string
    Description

Produces

The response content type: application/json

200 Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if success = false
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message
  • Name
    data
    Type
    object Required
    Description
    InventoryLabor schema

Properties for data object

  • Name
    id
    Type
    string Required
    Description
  • Name
    createdDate
    Type
    string Required
    Description
  • Name
    updatedDate
    Type
    string Required
    Description
  • Name
    companyId
    Type
    string Required
    Description
  • Name
    locationId
    Type
    string Required
    Description
  • Name
    name
    Type
    string Required
    Description
  • Name
    note
    Type
    string Required
    Description
  • Name
    showHours
    Type
    boolean Required
    Description
  • Name
    showNote
    Type
    boolean Required
    Description
  • Name
    discountCents
    Type
    integer Required
    Description
  • Name
    discountPercent
    Type
    number Required
    Description
  • Name
    discountValueType
    Type
    one of: Percent, FixedCents Required
    Description
  • Name
    hours
    Type
    number Required
    Description
  • Name
    rateCents
    Type
    integer Required
    Description
  • Name
    costHours
    Type
    number Required
    Description
  • Name
    costRateCents
    Type
    integer Required
    Description
  • Name
    multiplier
    Type
    number Required
    Description
  • Name
    multiplierType
    Type
    one of: Hours, Rate Required
    Description
  • Name
    categoryId
    Type
    string Required
    Description
  • Name
    rateId
    Type
    string Required
    Description
  • Name
    skillRequired
    Type
    one of: General, Maintenance, Precision Required
    Description
  • Name
    skillRequiredDescription
    Type
    string Required
    Description
  • Name
    totalCostCents
    Type
    integer Required
    Description
  • Name
    taxable
    Type
    boolean Required
    Description
    US specific
  • Name
    taxableGST
    Type
    boolean Required
    Description
    CA specific
  • Name
    taxableHST
    Type
    boolean Required
    Description
    CA specific
  • Name
    taxablePST
    Type
    boolean Required
    Description
    CA specific
  • Name
    laborMatrixId
    Type
    string Required
    Description
  • Name
    laborMatrixDate
    Type
    string Required
    Description
    datetime when laborMatrixId was set, for determining if matrix has been changed
  • Name
    deleted
    Type
    boolean Required
    Description
    if the record has been deleted
  • Name
    deletedUserId
    Type
    string Required
    Description
    the user that deleted the record or null if not deleted
  • Name
    deletedDate
    Type
    string Required
    Description
    the date that the record was deleted or null if not deleted
  • Name
    deletedReason
    Type
    string Required
    Description
    the reason that the record was deleted
  • Name
    userId
    Type
    string Required
    Description

4xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

5xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

Example Request
application/json

POST
/v3/inventory_labor
curl https://api.shopmonkey.cloud/v3/inventory_labor \
  -H "Authorization: Bearer ${SM_TOKEN}" \
  -H 'Content-Type: application/json' \
  --data '{ "name" : "value", "rateCents" : 0 }'

Example Response
application/json

{
  "success": true,
  "data": {
    "id": "id",
    "createdDate": "createdDate",
    "updatedDate": null,
    "companyId": "companyId",
    "locationId": "locationId",
    "name": "name",
    "note": "note",
    "showHours": true,
    "showNote": true,
    "discountCents": 1,
    "discountPercent": 1,
    "discountValueType": "discountValueType",
    "hours": 1,
    "rateCents": 1,
    "costHours": null,
    "costRateCents": null,
    "multiplier": 1,
    "multiplierType": "multiplierType",
    "categoryId": null,
    "rateId": null,
    "skillRequired": null,
    "skillRequiredDescription": null,
    "totalCostCents": null,
    "taxable": true,
    "laborMatrixId": null,
    "laborMatrixDate": null,
    "deleted": true,
    "deletedUserId": null,
    "deletedDate": null,
    "deletedReason": null,
    "userId": null
  }
}
DELETE/v3/inventory_labor/:id

Delete Inventory Labor

Delete one Inventory Labor by id

URL parameters

  • Name
    id
    Type
    string Required
    Description
    the id for the object to delete

Produces

The response content type: application/json

200 Response

  • Name
    data
    Type
    object
    Description
  • Name
    success
    Type
    boolean Required
    Description

Properties for data object

  • Name
    id
    Type
    string Required
    Description
    the id for the object

4xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

5xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

Example Request
application/json

DELETE
/v3/inventory_labor/:id
curl https://api.shopmonkey.cloud/v3/inventory_labor/:id \
  -H "Authorization: Bearer ${SM_TOKEN}" \
  -X DELETE -H 'Content-Type: application/json' \
  --data '{}'

Example Response
application/json

{
  "success": true
}
PATCH/v3/inventory_labor/:id/:action

Soft Delete Inventory Labor

Soft delete or undelete a Inventory Labor by id

URL parameters

  • Name
    action
    Type
    one of: 'delete', 'undelete' Required
    Description
    the action to take
  • Name
    id
    Type
    string Required
    Description
    primary key for the record

Body parameters

Consumes

The following content type is required: application/json

  • Name
    reason
    Type
    string Required
    Description
    the reason message if deleted

Produces

The response content type: application/json

200 Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if success = false
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message
  • Name
    data
    Type
    object Required
    Description
    InventoryLabor schema

Properties for data object

  • Name
    id
    Type
    string Required
    Description
  • Name
    createdDate
    Type
    string Required
    Description
  • Name
    updatedDate
    Type
    string Required
    Description
  • Name
    companyId
    Type
    string Required
    Description
  • Name
    locationId
    Type
    string Required
    Description
  • Name
    name
    Type
    string Required
    Description
  • Name
    note
    Type
    string Required
    Description
  • Name
    showHours
    Type
    boolean Required
    Description
  • Name
    showNote
    Type
    boolean Required
    Description
  • Name
    discountCents
    Type
    integer Required
    Description
  • Name
    discountPercent
    Type
    number Required
    Description
  • Name
    discountValueType
    Type
    one of: Percent, FixedCents Required
    Description
  • Name
    hours
    Type
    number Required
    Description
  • Name
    rateCents
    Type
    integer Required
    Description
  • Name
    costHours
    Type
    number Required
    Description
  • Name
    costRateCents
    Type
    integer Required
    Description
  • Name
    multiplier
    Type
    number Required
    Description
  • Name
    multiplierType
    Type
    one of: Hours, Rate Required
    Description
  • Name
    categoryId
    Type
    string Required
    Description
  • Name
    rateId
    Type
    string Required
    Description
  • Name
    skillRequired
    Type
    one of: General, Maintenance, Precision Required
    Description
  • Name
    skillRequiredDescription
    Type
    string Required
    Description
  • Name
    totalCostCents
    Type
    integer Required
    Description
  • Name
    taxable
    Type
    boolean Required
    Description
    US specific
  • Name
    taxableGST
    Type
    boolean Required
    Description
    CA specific
  • Name
    taxableHST
    Type
    boolean Required
    Description
    CA specific
  • Name
    taxablePST
    Type
    boolean Required
    Description
    CA specific
  • Name
    laborMatrixId
    Type
    string Required
    Description
  • Name
    laborMatrixDate
    Type
    string Required
    Description
    datetime when laborMatrixId was set, for determining if matrix has been changed
  • Name
    deleted
    Type
    boolean Required
    Description
    if the record has been deleted
  • Name
    deletedUserId
    Type
    string Required
    Description
    the user that deleted the record or null if not deleted
  • Name
    deletedDate
    Type
    string Required
    Description
    the date that the record was deleted or null if not deleted
  • Name
    deletedReason
    Type
    string Required
    Description
    the reason that the record was deleted
  • Name
    userId
    Type
    string Required
    Description

4xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

5xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

Example Request
application/json

PATCH
/v3/inventory_labor/:id/:action
curl https://api.shopmonkey.cloud/v3/inventory_labor/:id/:action \
  -H "Authorization: Bearer ${SM_TOKEN}" \
  -X PATCH -H 'Content-Type: application/json' \
  --data '{ "reason" : "value" }'

Example Response
application/json

{
  "success": true,
  "data": {
    "locationId": "locationId",
    "name": "name",
    "note": "note",
    "showHours": true,
    "showNote": true,
    "discountCents": 1,
    "discountPercent": 1,
    "discountValueType": "discountValueType",
    "hours": 1,
    "rateCents": 1,
    "costHours": null,
    "costRateCents": null,
    "multiplier": 1,
    "multiplierType": "multiplierType",
    "categoryId": null,
    "rateId": null,
    "skillRequired": null,
    "skillRequiredDescription": null,
    "totalCostCents": null,
    "taxable": true,
    "laborMatrixId": null,
    "deleted": true,
    "deletedUserId": null,
    "deletedDate": null,
    "deletedReason": null,
    "userId": null
  }
}
GET/v3/inventory_labor/export

Export Labor

Export Labor data as Excel spreadsheet

Produces

The response content type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

200 Response

the data in excel format

4xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

5xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

Example Request

GET
/v3/inventory_labor/export
curl https://api.shopmonkey.cloud/v3/inventory_labor/export \
  -H "Authorization: Bearer ${SM_TOKEN}"
POST/v3/inventory_labor/export

Export Labor

Export Labor data as Excel spreadsheet

Produces

The response content type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

200 Response

the data in excel format

4xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

5xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

Example Request
application/json

POST
/v3/inventory_labor/export
curl https://api.shopmonkey.cloud/v3/inventory_labor/export \
  -H "Authorization: Bearer ${SM_TOKEN}" \
  -H 'Content-Type: application/json' \
  --data '{}'