Report

WIP: A summary needs to be written for Report

GET/v3/report/order

All Orders report

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
one of: any, any
Description
an object to use for filtering the results
Name
columns
Type
array
Description
Array of column names to export
Name
format
Type
string
Description

Produces

The response produces the following content types: application/json, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

`200` Response

Name
code
Type
string
Description
The error code
Name
data
Type
array Required
Description
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
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
Description
if there are more records available
Name
lastRefreshedAt
Type
string
Description
the last refreshed at timestamp
Name
sums
Type
object
Description
Name
total
Type
number
Description
the total number of records
Name
epaCents
Type
number
Description
Name
feesCents
Type
number
Description
Name
gstCents
Type
number
Description
Name
hstCents
Type
number
Description
Name
laborCostCents
Type
number
Description
Name
laborRetailCents
Type
number
Description
Name
laborWholesaleCents
Type
number
Description
Name
paidCostCents
Type
number
Description
Name
partsRetailCents
Type
number
Description
Name
partsWholesaleCents
Type
number
Description
Name
pstCents
Type
number
Description
Name
remainingCostCents
Type
number
Description
Name
shopSuppliesCents
Type
number
Description
Name
subcontractsRetailCents
Type
number
Description
Name
subcontractsWholesaleCents
Type
number
Description
Name
taxCents
Type
number
Description
Name
tiresRetailCents
Type
number
Description
Name
tiresWholesaleCents
Type
number
Description
Name
totalCostCents
Type
number
Description
Name
totalDiscountCents
Type
number
Description
Name
totalProfitCents
Type
number
Description
Name
totalRetailCents
Type
number
Description
Name
totalWholesaleCents
Type
number
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/report/order

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

Example Response
application/json

{
  "success": true,
  "data": [
    {
      "id": "id",
      "createdDate": "createdDate",
      "companyId": "companyId",
      "number": 1,
      "name": null,
      "purchaseOrderNumber": null,
      "generatedVehicleName": null,
      "archived": true,
      "authorized": true,
      "invoiced": true,
      "invoicedDate": null,
      "paid": true,
      "totalCostCents": 1,
      "paidCostCents": 1,
      "remainingCostCents": null,
      "partsCents": 1,
      "tiresCents": 1,
      "laborCents": 1,
      "epaCents": 1,
      "shopSuppliesCents": 1,
      "feesCents": 1,
      "taxCents": 1,
      "dueDate": null,
      "completedDate": null,
      "fullyPaidDate": null,
      "customer": {
        "id": "id",
        "firstName": null,
        "lastName": null,
        "companyName": null,
        "normalizedFirstName": null,
        "normalizedLastName": null
      },
      "laborHours": 1,
      "lastPaymentPosted": null,
      "location": {
        "id": "id",
        "name": "name"
      },
      "paymentTypes": [
        "paymentTypes"
      ],
      "paymentTerm": {
        "id": "id",
        "name": "name"
      },
      "serviceWriter": {
        "id": "id",
        "firstName": "firstName",
        "lastName": "lastName"
      },
      "workflowStatus": {
        "id": "id",
        "name": null
      },
      "vehicle": {
        "id": "id",
        "vin": null,
        "unit": null,
        "licensePlate": null,
        "licensePlateState": null,
        "licensePlateCountry": "licensePlateCountry"
      }
    }
  ]
}

Report

All Orders report

Query String parameters

Produces

200 Response

Properties for meta object

4xx Response