Report

WIP: A summary needs to be written for Report

GET/v3/report/payment

Payments report

All Payments report

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
    meta
    Type
    object
    Description
  • Name
    success
    Type
    boolean Required
    Description

Properties for meta object

  • Name
    hasMore
    Type
    boolean Required
    Description
    if there are more records available
  • Name
    sums
    Type
    one of: any, any
    Description
  • Name
    total
    Type
    number Required
    Description
    the total number of records

4xx 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 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
    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/payment
curl https://api.shopmonkey.cloud/v3/report/payment \ 
  -H "Authorization: Bearer ${SM_TOKEN}"

Example Response
application/json

{
  "success": true,
  "data": [
    {
      "id": "id",
      "orderId": "orderId",
      "recordedDate": null,
      "note": "note",
      "paymentType": "paymentType",
      "amountCents": 1,
      "cardType": null,
      "order": {
        "id": "id",
        "number": 1,
        "name": null,
        "generatedVehicleName": null,
        "totalCostCents": 1,
        "paidCostCents": 1,
        "remainingCostCents": null
      },
      "location": {
        "id": "id",
        "name": "name"
      },
      "payer": {
        "firstName": null,
        "lastName": null,
        "companyName": null,
        "normalizedFirstName": null,
        "normalizedLastName": null
      }
    }
  ]
}
GET/v3/report/payment/transaction

Payment Transactions report

Payment transactions report, for operations paid by card (using the payment provider)

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
    meta
    Type
    object
    Description
  • Name
    success
    Type
    boolean Required
    Description

Properties for meta object

  • Name
    hasMore
    Type
    boolean Required
    Description
    if there are more records available
  • Name
    sums
    Type
    object
    Description
  • Name
    total
    Type
    number Required
    Description
    the total number of records
  • Name
    totalAmount
    Type
    number
    Description
  • Name
    totalFee
    Type
    number
    Description
  • Name
    totalNet
    Type
    number
    Description

4xx 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 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
    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/payment/transaction
curl https://api.shopmonkey.cloud/v3/report/payment/transaction \ 
  -H "Authorization: Bearer ${SM_TOKEN}"

Example Response
application/json

{
  "success": true,
  "data": [
    {
      "id": "id",
      "createdDate": "createdDate",
      "paymentMode": "paymentMode",
      "amountCents": 1,
      "cardType": null,
      "cardDigits": null,
      "provider": null,
      "providerFee": null,
      "net": 1,
      "order": {
        "id": "id",
        "number": 1,
        "name": null
      },
      "location": {
        "id": "id",
        "name": "name"
      },
      "payer": {
        "id": "id",
        "firstName": null,
        "lastName": null,
        "normalizedFirstName": null,
        "normalizedLastName": null
      }
    }
  ]
}
GET/v3/report/payment/payout

Payouts report

Payouts from SM Payments to the Shop report

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
    meta
    Type
    object
    Description
  • Name
    success
    Type
    boolean Required
    Description

Properties for meta object

  • Name
    hasMore
    Type
    boolean Required
    Description
    if there are more records available
  • Name
    sums
    Type
    object
    Description
  • Name
    total
    Type
    number Required
    Description
    the total number of records
  • Name
    availableCents
    Type
    number
    Description
  • Name
    inTransitCents
    Type
    number
    Description
  • Name
    pendingCents
    Type
    number
    Description
  • Name
    totalCents
    Type
    number
    Description

4xx 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 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
    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/payment/payout
curl https://api.shopmonkey.cloud/v3/report/payment/payout \ 
  -H "Authorization: Bearer ${SM_TOKEN}"

Example Response
application/json

{
  "success": true,
  "data": [
    {
      "id": "id",
      "createdDate": "createdDate",
      "updatedDate": "updatedDate",
      "arrivalDate": null,
      "companyId": "companyId",
      "locationId": "locationId",
      "provider": "provider",
      "amountCents": 1,
      "status": "status",
      "description": null,
      "error": null,
      "location": {
        "id": "id",
        "name": "name"
      }
    }
  ]
}
GET/v3/report/order

All Orders report

All Orders report

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
    meta
    Type
    object
    Description
  • Name
    success
    Type
    boolean Required
    Description

Properties for meta object

  • Name
    hasMore
    Type
    boolean Required
    Description
    if there are more records available
  • Name
    sums
    Type
    object
    Description
  • Name
    total
    Type
    number Required
    Description
    the total number of records
  • Name
    epaCents
    Type
    number
    Description
  • Name
    feesCents
    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
    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
    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
    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"
      }
    }
  ]
}
GET/v3/report/end_of_day

End Of Day Report

End of Day

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
    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

Properties for data object

  • Name
    lineItems
    Type
    object
    Description
  • Name
    orders
    Type
    object
    Description
  • Name
    payments
    Type
    object
    Description
  • Name
    performance
    Type
    object
    Description
  • Name
    sales
    Type
    object
    Description

Properties for lineItems object

  • Name
    fees
    Type
    object Required
    Description
  • Name
    labors
    Type
    object Required
    Description
  • Name
    parts
    Type
    object Required
    Description
  • Name
    subcontracts
    Type
    object Required
    Description
  • Name
    tires
    Type
    object Required
    Description
  • Name
    totalsSum
    Type
    object Required
    Description

Properties for fees object

  • Name
    nonTaxable
    Type
    number Required
    Description
  • Name
    subtotal
    Type
    number Required
    Description
  • Name
    totalRetail
    Type
    number Required
    Description

Properties for labors object

  • Name
    discount
    Type
    number Required
    Description
  • Name
    nonTaxable
    Type
    number Required
    Description
  • Name
    subtotal
    Type
    number Required
    Description
  • Name
    taxExempt
    Type
    number Required
    Description
  • Name
    taxable
    Type
    number Required
    Description
  • Name
    totalCost
    Type
    number Required
    Description
  • Name
    totalProfit
    Type
    number Required
    Description
  • Name
    totalRetail
    Type
    number Required
    Description

Properties for parts object

  • Name
    discount
    Type
    number Required
    Description
  • Name
    nonTaxable
    Type
    number Required
    Description
  • Name
    subtotal
    Type
    number Required
    Description
  • Name
    taxExempt
    Type
    number Required
    Description
  • Name
    taxable
    Type
    number Required
    Description
  • Name
    totalCost
    Type
    number Required
    Description
  • Name
    totalProfit
    Type
    number Required
    Description
  • Name
    totalRetail
    Type
    number Required
    Description

Properties for subcontracts object

  • Name
    discount
    Type
    number Required
    Description
  • Name
    nonTaxable
    Type
    number Required
    Description
  • Name
    subtotal
    Type
    number Required
    Description
  • Name
    taxExempt
    Type
    number Required
    Description
  • Name
    taxable
    Type
    number Required
    Description
  • Name
    totalCost
    Type
    number Required
    Description
  • Name
    totalProfit
    Type
    number Required
    Description
  • Name
    totalRetail
    Type
    number Required
    Description

Properties for tires object

  • Name
    discount
    Type
    number Required
    Description
  • Name
    nonTaxable
    Type
    number Required
    Description
  • Name
    subtotal
    Type
    number Required
    Description
  • Name
    taxExempt
    Type
    number Required
    Description
  • Name
    taxable
    Type
    number Required
    Description
  • Name
    totalCost
    Type
    number Required
    Description
  • Name
    totalProfit
    Type
    number Required
    Description
  • Name
    totalRetail
    Type
    number Required
    Description

Properties for totalsSum object

  • Name
    discount
    Type
    number Required
    Description
  • Name
    nonTaxable
    Type
    number Required
    Description
  • Name
    subtotal
    Type
    number Required
    Description
  • Name
    taxExempt
    Type
    number Required
    Description
  • Name
    taxable
    Type
    number Required
    Description
  • Name
    totalCost
    Type
    number Required
    Description
  • Name
    totalProfit
    Type
    number Required
    Description
  • Name
    totalRetail
    Type
    number Required
    Description

Properties for orders object

  • Name
    discountTotal
    Type
    number Required
    Description
  • Name
    epaTotal
    Type
    number Required
    Description
  • Name
    feesSubtotal
    Type
    number Required
    Description
  • Name
    gstTotal
    Type
    number Required
    Description
  • Name
    hstTotal
    Type
    number Required
    Description
  • Name
    lineItemsSubtotal
    Type
    number Required
    Description
  • Name
    ordersTotal
    Type
    number Required
    Description
  • Name
    pstTotal
    Type
    number Required
    Description
  • Name
    shopSuppliesTotal
    Type
    number Required
    Description
  • Name
    taxesTotal
    Type
    number Required
    Description

Properties for payments object

  • Name
    amex
    Type
    object
    Description
  • Name
    card
    Type
    object
    Description
  • Name
    cash
    Type
    object
    Description
  • Name
    cashAndCheck
    Type
    object
    Description
  • Name
    check
    Type
    object
    Description
  • Name
    diners
    Type
    object
    Description
  • Name
    discover
    Type
    object
    Description
  • Name
    jcb
    Type
    object
    Description
  • Name
    mastercard
    Type
    object
    Description
  • Name
    other
    Type
    object
    Description
  • Name
    otherCards
    Type
    object
    Description
  • Name
    refunds
    Type
    object
    Description
  • Name
    total
    Type
    object
    Description
  • Name
    unionpay
    Type
    object
    Description
  • Name
    visa
    Type
    object
    Description

Properties for amex object

  • Name
    amount
    Type
    number Required
    Description
  • Name
    count
    Type
    number Required
    Description

Properties for card object

  • Name
    amount
    Type
    number Required
    Description
  • Name
    count
    Type
    number Required
    Description

Properties for cash object

  • Name
    amount
    Type
    number Required
    Description
  • Name
    count
    Type
    number Required
    Description

Properties for cashAndCheck object

  • Name
    amount
    Type
    number Required
    Description
  • Name
    count
    Type
    number Required
    Description

Properties for check object

  • Name
    amount
    Type
    number Required
    Description
  • Name
    count
    Type
    number Required
    Description

Properties for diners object

  • Name
    amount
    Type
    number Required
    Description
  • Name
    count
    Type
    number Required
    Description

Properties for discover object

  • Name
    amount
    Type
    number Required
    Description
  • Name
    count
    Type
    number Required
    Description

Properties for jcb object

  • Name
    amount
    Type
    number Required
    Description
  • Name
    count
    Type
    number Required
    Description

Properties for mastercard object

  • Name
    amount
    Type
    number Required
    Description
  • Name
    count
    Type
    number Required
    Description

Properties for other object

  • Name
    amount
    Type
    number Required
    Description
  • Name
    count
    Type
    number Required
    Description

Properties for otherCards object

  • Name
    amount
    Type
    number Required
    Description
  • Name
    count
    Type
    number Required
    Description

Properties for refunds object

  • Name
    amount
    Type
    number Required
    Description
  • Name
    count
    Type
    number Required
    Description

Properties for total object

  • Name
    amount
    Type
    number Required
    Description
  • Name
    count
    Type
    number Required
    Description

Properties for unionpay object

  • Name
    amount
    Type
    number Required
    Description
  • Name
    count
    Type
    number Required
    Description

Properties for visa object

  • Name
    amount
    Type
    number Required
    Description
  • Name
    count
    Type
    number Required
    Description

Properties for performance object

  • Name
    avgOrderProfit
    Type
    number Required
    Description
  • Name
    avgOrderProfitMargin
    Type
    number Required
    Description
  • Name
    avgSales
    Type
    number Required
    Description
  • Name
    effectiveLaborRate
    Type
    number Required
    Description
  • Name
    grossProfit
    Type
    number Required
    Description
  • Name
    grossSales
    Type
    number Required
    Description
  • Name
    totalLaborCost
    Type
    number Required
    Description

Properties for sales object

  • Name
    closeRate
    Type
    number Required
    Description
  • Name
    estimatedHours
    Type
    number Required
    Description
  • Name
    invoicedHours
    Type
    number Required
    Description
  • Name
    paidInvoices
    Type
    number Required
    Description
  • Name
    partialInvoices
    Type
    number Required
    Description
  • Name
    totalEstimates
    Type
    number Required
    Description
  • Name
    totalInvoices
    Type
    number Required
    Description
  • Name
    totalLaborsInvoiced
    Type
    number Required
    Description
  • Name
    totalOrders
    Type
    number Required
    Description

4xx 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 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
    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/end_of_day
curl https://api.shopmonkey.cloud/v3/report/end_of_day \ 
  -H "Authorization: Bearer ${SM_TOKEN}"

Example Response
application/json

{
  "success": true,
  "data": {
    "lineItems": {
      "fees": {
        "nonTaxable": 1,
        "subtotal": 1,
        "totalRetail": 1
      },
      "labors": {
        "discount": 1,
        "nonTaxable": 1,
        "subtotal": 1,
        "taxExempt": 1,
        "taxable": 1,
        "totalCost": 1,
        "totalProfit": 1,
        "totalRetail": 1
      },
      "parts": {
        "discount": 1,
        "nonTaxable": 1,
        "subtotal": 1,
        "taxExempt": 1,
        "taxable": 1,
        "totalCost": 1,
        "totalProfit": 1,
        "totalRetail": 1
      },
      "subcontracts": {
        "discount": 1,
        "nonTaxable": 1,
        "subtotal": 1,
        "taxExempt": 1,
        "taxable": 1,
        "totalCost": 1,
        "totalProfit": 1,
        "totalRetail": 1
      },
      "tires": {
        "discount": 1,
        "nonTaxable": 1,
        "subtotal": 1,
        "taxExempt": 1,
        "taxable": 1,
        "totalCost": 1,
        "totalProfit": 1,
        "totalRetail": 1
      },
      "totalsSum": {
        "discount": 1,
        "nonTaxable": 1,
        "subtotal": 1,
        "taxExempt": 1,
        "taxable": 1,
        "totalCost": 1,
        "totalProfit": 1,
        "totalRetail": 1
      }
    },
    "payments": {
      "cash": {
        "amount": 1,
        "count": 1
      },
      "check": {
        "amount": 1,
        "count": 1
      },
      "other": {
        "amount": 1,
        "count": 1
      },
      "visa": {
        "amount": 1,
        "count": 1
      },
      "mastercard": {
        "amount": 1,
        "count": 1
      },
      "amex": {
        "amount": 1,
        "count": 1
      },
      "discover": {
        "amount": 1,
        "count": 1
      },
      "diners": {
        "amount": 1,
        "count": 1
      },
      "jcb": {
        "amount": 1,
        "count": 1
      },
      "unionpay": {
        "amount": 1,
        "count": 1
      },
      "otherCards": {
        "amount": 1,
        "count": 1
      },
      "refunds": {
        "amount": 1,
        "count": 1
      },
      "card": {
        "amount": 1,
        "count": 1
      },
      "cashAndCheck": {
        "amount": 1,
        "count": 1
      },
      "total": {
        "amount": 1,
        "count": 1
      }
    },
    "performance": {
      "avgSales": 1,
      "avgOrderProfit": 1,
      "avgOrderProfitMargin": 1,
      "grossSales": 1,
      "grossProfit": 1,
      "totalLaborCost": 1,
      "effectiveLaborRate": 1
    },
    "orders": {
      "lineItemsSubtotal": 1,
      "ordersTotal": 1,
      "feesSubtotal": 1,
      "discountTotal": 1,
      "epaTotal": 1,
      "shopSuppliesTotal": 1,
      "taxesTotal": 1,
      "gstTotal": 1,
      "pstTotal": 1,
      "hstTotal": 1
    },
    "sales": {
      "totalEstimates": 1,
      "totalInvoices": 1,
      "totalOrders": 1,
      "partialInvoices": 1,
      "paidInvoices": 1,
      "estimatedHours": 1,
      "invoicedHours": 1,
      "closeRate": 1
    }
  }
}
GET/v3/report/sales

Sales Summary Report

Sales Summary

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
    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

Properties for data object

  • Name
    allInvoices
    Type
    object
    Description
  • Name
    invoiced
    Type
    object
    Description
  • Name
    lostSales
    Type
    object
    Description
  • Name
    paidInvoices
    Type
    object
    Description
  • Name
    payments
    Type
    object
    Description

Properties for allInvoices object

  • Name
    discountTotal
    Type
    number Required
    Description
  • Name
    epaTotal
    Type
    number Required
    Description
  • Name
    feesSubtotalWithoutDiscount
    Type
    number Required
    Description
  • Name
    gstTotal
    Type
    number Required
    Description
  • Name
    hstTotal
    Type
    number Required
    Description
  • Name
    laborsSubtotalWithoutDiscount
    Type
    number Required
    Description
  • Name
    partsSubtotalWithoutDiscount
    Type
    number Required
    Description
  • Name
    postDiscountSubtotal
    Type
    number Required
    Description
  • Name
    pstTotal
    Type
    number Required
    Description
  • Name
    shopSuppliesTotal
    Type
    number Required
    Description
  • Name
    subcontractsSubtotalWithoutDiscount
    Type
    number Required
    Description
  • Name
    subtotal
    Type
    number Required
    Description
  • Name
    taxesTotal
    Type
    number Required
    Description
  • Name
    tiresSubtotalWithoutDiscount
    Type
    number Required
    Description
  • Name
    total
    Type
    number Required
    Description

Properties for invoiced object

  • Name
    data
    Type
    array Required
    Description
  • Name
    totals
    Type
    object Required
    Description

Properties for totals object

  • Name
    amount
    Type
    number Required
    Description
    Total amount of cost for invoiced orders
  • Name
    avgPartsMargin
    Type
    number Required
    Description
    Average parts margin of invoiced orders
  • Name
    avgRepairOrderCost
    Type
    number Required
    Description
    Average repair cost of invoiced orders

Properties for lostSales object

  • Name
    data
    Type
    array Required
    Description
  • Name
    totals
    Type
    object Required
    Description

Properties for totals object

  • Name
    amount
    Type
    number Required
    Description
    Total amount of deferred cost

Properties for paidInvoices object

  • Name
    discountTotal
    Type
    number Required
    Description
  • Name
    epaTotal
    Type
    number Required
    Description
  • Name
    feesSubtotalWithoutDiscount
    Type
    number Required
    Description
  • Name
    gstTotal
    Type
    number Required
    Description
  • Name
    hstTotal
    Type
    number Required
    Description
  • Name
    laborsSubtotalWithoutDiscount
    Type
    number Required
    Description
  • Name
    partsSubtotalWithoutDiscount
    Type
    number Required
    Description
  • Name
    postDiscountSubtotal
    Type
    number Required
    Description
  • Name
    pstTotal
    Type
    number Required
    Description
  • Name
    shopSuppliesTotal
    Type
    number Required
    Description
  • Name
    subcontractsSubtotalWithoutDiscount
    Type
    number Required
    Description
  • Name
    subtotal
    Type
    number Required
    Description
  • Name
    taxesTotal
    Type
    number Required
    Description
  • Name
    tiresSubtotalWithoutDiscount
    Type
    number Required
    Description
  • Name
    total
    Type
    number Required
    Description

Properties for payments object

  • Name
    data
    Type
    array Required
    Description
  • Name
    totals
    Type
    object Required
    Description

Properties for totals object

  • Name
    amount
    Type
    number Required
    Description
    Total amount of payments
  • Name
    customerCount
    Type
    number Required
    Description
    Total number of unique paying customers

4xx 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 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
    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/sales
curl https://api.shopmonkey.cloud/v3/report/sales \ 
  -H "Authorization: Bearer ${SM_TOKEN}"

Example Response
application/json

{
  "success": true,
  "data": {
    "payments": {
      "data": [
        {
          "paidAmountPerDay": 1,
          "paymentDate": "paymentDate",
          "customerIds": [
            "customerIds"
          ]
        }
      ],
      "totals": {
        "amount": 1,
        "customerCount": 1
      }
    },
    "invoiced": {
      "data": [
        {
          "totalCostPerDay": 1,
          "invoicedDate": "invoicedDate",
          "ordersCountPerDay": 1
        }
      ],
      "totals": {
        "amount": 1,
        "avgRepairOrderCost": 1,
        "avgPartsMargin": 1
      }
    },
    "lostSales": {
      "data": [
        {
          "deferredTotalPerDay": 1,
          "invoicedDate": "invoicedDate",
          "ordersCountPerDay": 1
        }
      ],
      "totals": {
        "amount": 1
      }
    },
    "allInvoices": {
      "laborsSubtotalWithoutDiscount": 1,
      "partsSubtotalWithoutDiscount": 1,
      "tiresSubtotalWithoutDiscount": 1,
      "subcontractsSubtotalWithoutDiscount": 1,
      "epaTotal": 1,
      "shopSuppliesTotal": 1,
      "feesSubtotalWithoutDiscount": 1,
      "subtotal": 1,
      "discountTotal": 1,
      "postDiscountSubtotal": 1,
      "taxesTotal": 1,
      "gstTotal": 1,
      "pstTotal": 1,
      "hstTotal": 1,
      "total": 1
    },
    "paidInvoices": {
      "laborsSubtotalWithoutDiscount": 1,
      "partsSubtotalWithoutDiscount": 1,
      "tiresSubtotalWithoutDiscount": 1,
      "subcontractsSubtotalWithoutDiscount": 1,
      "epaTotal": 1,
      "shopSuppliesTotal": 1,
      "feesSubtotalWithoutDiscount": 1,
      "subtotal": 1,
      "discountTotal": 1,
      "postDiscountSubtotal": 1,
      "taxesTotal": 1,
      "gstTotal": 1,
      "pstTotal": 1,
      "hstTotal": 1,
      "total": 1
    }
  }
}
GET/v3/report/customer_aging

Customer Aging report

Customer Aging report

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
    meta
    Type
    object
    Description
  • Name
    success
    Type
    boolean Required
    Description

Properties for meta object

  • Name
    hasMore
    Type
    boolean Required
    Description
    if there are more records available
  • Name
    sums
    Type
    object
    Description
  • Name
    total
    Type
    number Required
    Description
    the total number of records
  • Name
    totalCredits
    Type
    number
    Description
  • Name
    totalFrom0to30
    Type
    number
    Description
  • Name
    totalFrom31to60
    Type
    number
    Description
  • Name
    totalFrom61to90
    Type
    number
    Description
  • Name
    totalFrom91orMore
    Type
    number
    Description
  • Name
    totalTotalDue
    Type
    number
    Description

4xx 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 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
    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/customer_aging
curl https://api.shopmonkey.cloud/v3/report/customer_aging \ 
  -H "Authorization: Bearer ${SM_TOKEN}"

Example Response
application/json

{
  "success": true,
  "data": [
    {
      "id": "id",
      "firstName": null,
      "lastName": null,
      "companyName": null,
      "normalizedFirstName": null,
      "normalizedLastName": null,
      "credits": 1,
      "from0to30": 1,
      "from31to60": 1,
      "from61to90": 1,
      "from91orMore": 1,
      "totalDue": 1
    }
  ]
}
GET/v3/report/line_item_sales_tax

Sales Tax Report

Line Items Sales Tax Report

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
    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

Properties for data object

  • Name
    epa
    Type
    object
    Description
  • Name
    fees
    Type
    object
    Description
  • Name
    gstOwed
    Type
    number
    Description
  • Name
    gstTotal
    Type
    number
    Description
  • Name
    hstOwed
    Type
    number
    Description
  • Name
    hstTotal
    Type
    number
    Description
  • Name
    labors
    Type
    object
    Description
  • Name
    parts
    Type
    object
    Description
  • Name
    pstOwed
    Type
    number
    Description
  • Name
    pstTotal
    Type
    number
    Description
  • Name
    shopSupplies
    Type
    object
    Description
  • Name
    subcontracts
    Type
    object
    Description
  • Name
    taxesOwed
    Type
    number
    Description
  • Name
    taxesTotal
    Type
    number
    Description
  • Name
    tires
    Type
    object
    Description

Properties for epa object

  • Name
    exempt
    Type
    number Required
    Description
  • Name
    nonTaxable
    Type
    number Required
    Description
  • Name
    taxable
    Type
    number Required
    Description

Properties for fees object

  • Name
    nonTaxable
    Type
    number Required
    Description

Properties for labors object

  • Name
    exempt
    Type
    number Required
    Description
  • Name
    nonTaxable
    Type
    number Required
    Description
  • Name
    taxable
    Type
    number Required
    Description
  • Name
    discount
    Type
    number Required
    Description

Properties for parts object

  • Name
    exempt
    Type
    number Required
    Description
  • Name
    nonTaxable
    Type
    number Required
    Description
  • Name
    taxable
    Type
    number Required
    Description
  • Name
    discount
    Type
    number Required
    Description

Properties for shopSupplies object

  • Name
    exempt
    Type
    number Required
    Description
  • Name
    nonTaxable
    Type
    number Required
    Description
  • Name
    taxable
    Type
    number Required
    Description

Properties for subcontracts object

  • Name
    exempt
    Type
    number Required
    Description
  • Name
    nonTaxable
    Type
    number Required
    Description
  • Name
    taxable
    Type
    number Required
    Description
  • Name
    discount
    Type
    number Required
    Description

Properties for tires object

  • Name
    exempt
    Type
    number Required
    Description
  • Name
    nonTaxable
    Type
    number Required
    Description
  • Name
    taxable
    Type
    number Required
    Description
  • Name
    discount
    Type
    number Required
    Description

4xx 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 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
    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/line_item_sales_tax
curl https://api.shopmonkey.cloud/v3/report/line_item_sales_tax \ 
  -H "Authorization: Bearer ${SM_TOKEN}"

Example Response
application/json

{
  "success": true,
  "data": {
    "parts": {
      "taxable": 1,
      "nonTaxable": 1,
      "exempt": 1,
      "discount": 1
    },
    "labors": {
      "taxable": 1,
      "nonTaxable": 1,
      "exempt": 1,
      "discount": 1
    },
    "tires": {
      "taxable": 1,
      "nonTaxable": 1,
      "exempt": 1,
      "discount": 1
    },
    "subcontracts": {
      "taxable": 1,
      "nonTaxable": 1,
      "exempt": 1,
      "discount": 1
    },
    "fees": {
      "nonTaxable": 1
    },
    "epa": {
      "taxable": 1,
      "nonTaxable": 1,
      "exempt": 1
    },
    "shopSupplies": {
      "taxable": 1,
      "nonTaxable": 1,
      "exempt": 1
    },
    "taxesTotal": 1,
    "gstTotal": 1,
    "pstTotal": 1,
    "hstTotal": 1,
    "taxesOwed": 1,
    "gstOwed": 1,
    "pstOwed": 1,
    "hstOwed": 1
  }
}
POST/v3/report/technicians/summary

Summary By Tech Report

Summary By Tech Report

Body parameters

  • Name
    locationIds
    Type
    array
    Description
  • Name
    orderBy
    Type
    one of: any, any
    Description
    the order instructions for the result
  • Name
    where
    Type
    object Required
    Description

Properties for where object

  • Name
    customerIds
    Type
    array
    Description
  • Name
    date_field
    Type
    object Required
    Description
  • Name
    date_field_identifier
    Type
    string
    Description
    Date Field Identifier (Invoiced or Completed)
  • Name
    order_paid_statuses
    Type
    array
    Description
  • Name
    order_status
    Type
    string
    Description
    Order Status (Estimate or Invoice)
  • Name
    technicianIds
    Type
    array
    Description
  • Name
    timesheetIds
    Type
    array
    Description

Properties for date_field object

  • Name
    gte
    Type
    string
    Description
    optional greaterThanEqual date param
  • Name
    lte
    Type
    string
    Description
    optional lessThanEqual date param
  • Name
    period
    Type
    one of: 'allTime', 'before', 'custom', 'lastMonth', 'lastWeek', 'nextMonth', 'nextWeek', 'thisMonth', 'thisWeek', 'today', 'tomorrow', 'yearToDate', 'yesterday' Required
    Description

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
    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
    array Required
    Description

4xx 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 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
    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/report/technicians/summary
curl https://api.shopmonkey.cloud/v3/report/technicians/summary \ 
  -H "Authorization: Bearer ${SM_TOKEN}" \ 
  -X POST -H 'Content-Type: application/json' \ 
  --data '{ "where" : {} }'

Example Response
application/json

{
  "success": true,
  "data": [
    {
      "general_hours_tracked": 1,
      "order_hours_tracked": 1,
      "technicianFirstName": "technicianFirstName",
      "technicianId": "technicianId",
      "technicianLaborRate": 1,
      "technicianLastName": "technicianLastName",
      "total_billed_hours": 1,
      "total_cost_hours": 1,
      "total_hours_tracked": 1,
      "total_labor_billed": 1,
      "total_labor_cost": 1,
      "vehicle_count": 1
    }
  ]
}
POST/v3/report/technicians/services

Services By Tech Report

Services By Tech Report

Body parameters

  • Name
    limit
    Type
    number
    Description
    the limit on the number of records to return
  • Name
    locationIds
    Type
    array
    Description
  • Name
    orderBy
    Type
    one of: any, any
    Description
    the order instructions for the result
  • Name
    skip
    Type
    number
    Description
    the number of records to skip for a paginated result
  • Name
    where
    Type
    object Required
    Description

Properties for where object

  • Name
    customerIds
    Type
    array
    Description
  • Name
    date_field
    Type
    object Required
    Description
  • Name
    date_field_identifier
    Type
    string
    Description
    Date Field Identifier (Invoiced or Completed)
  • Name
    order_paid_statuses
    Type
    array
    Description
  • Name
    order_status
    Type
    string
    Description
    Order Status (Estimate or Invoice)
  • Name
    technicianIds
    Type
    array
    Description
  • Name
    serviceIds
    Type
    array
    Description

Properties for date_field object

  • Name
    gte
    Type
    string
    Description
    optional greaterThanEqual date param
  • Name
    lte
    Type
    string
    Description
    optional lessThanEqual date param
  • Name
    period
    Type
    one of: 'allTime', 'before', 'custom', 'lastMonth', 'lastWeek', 'nextMonth', 'nextWeek', 'thisMonth', 'thisWeek', 'today', 'tomorrow', 'yearToDate', 'yesterday' Required
    Description

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
    success
    Type
    boolean Required
    Description

4xx 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 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
    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/report/technicians/services
curl https://api.shopmonkey.cloud/v3/report/technicians/services \ 
  -H "Authorization: Bearer ${SM_TOKEN}" \ 
  -X POST -H 'Content-Type: application/json' \ 
  --data '{ "where" : {} }'

Example Response
application/json

{
  "data": [
    {
      "dates": "2024-01-23T21:56:24.676Z",
      "orderCoalescedName": "orderCoalescedName",
      "orderId": "orderId",
      "orderNumber": "orderNumber",
      "serviceId": "serviceId",
      "serviceName": "serviceName",
      "service_hours_tracked": 1,
      "technicianFirstName": "technicianFirstName",
      "technicianId": "technicianId",
      "technicianLaborRate": 1,
      "technicianLastName": "technicianLastName",
      "total_billed_hours": 1,
      "total_cost_hours": 1,
      "total_labor_billed": 1,
      "total_labor_cost": 1
    }
  ],
  "success": true
}