Statement

WIP: A summary needs to be written for Statement

GET/v3/statement/:id

Find Statement

Find one Statement 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
Statement 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
companyId
Type
string Required
Description
Name
createdDate
Type
string Required
Description
Name
customerId
Type
string Required
Description
Name
duration
Type
integer Required
Description
::bigint
Name
fromDate
Type
string Required
Description
Name
id
Type
string Required
Description
Name
invoicesCount
Type
integer Required
Description
Name
locationId
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
name
Type
string Required
Description
Name
note
Type
string Required
Description
Name
paid
Type
boolean Required
Description
Name
paidCostCents
Type
integer Required
Description
Name
remainingCostCents
Type
integer Required
Description
Name
sent
Type
boolean Required
Description
Name
sentDate
Type
string Required
Description
Name
toDate
Type
string Required
Description
Name
totalCostCents
Type
integer Required
Description
Name
updatedDate
Type
string Required
Description

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

`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/statement/:id

curl https://api.shopmonkey.cloud/v3/statement/: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",
    "name": null,
    "fromDate": "fromDate",
    "toDate": "toDate",
    "sent": true,
    "sentDate": null,
    "customerId": "customerId",
    "locationId": "locationId",
    "paid": true,
    "invoicesCount": 1,
    "totalCostCents": 1,
    "remainingCostCents": 1,
    "paidCostCents": 1
  }
}

GET/v3/statement

List Statements

Find all Statements

This API has been deprecated and should no longer be used

Query String parameters

Name
collate
Type
boolean
Description
if set to true, use natural sort collation when used with orderBy
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/statement

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

Example Response
application/json

{
  "success": true,
  "data": [
    {
      "id": "id",
      "createdDate": "createdDate",
      "updatedDate": null,
      "companyId": "companyId",
      "name": null,
      "fromDate": "fromDate",
      "toDate": "toDate",
      "sent": true,
      "sentDate": null,
      "customerId": "customerId",
      "locationId": "locationId",
      "paid": true,
      "invoicesCount": 1,
      "totalCostCents": 1,
      "remainingCostCents": 1,
      "paidCostCents": 1
    }
  ]
}

POST/v3/statement/search

Search Statement entities

Search for Statement Entries

Body parameters

Consumes

The following content type is required: application/json

Name
collate
Type
boolean
Description
if set to true, use natural sort collation when used with orderBy
Name
limit
Type
number
Description
the limit on the number of records to return
Name
orderBy
Type
one of: any, any
Description
the order instructions for the result
Name
params
Type
object
Description
additonal 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

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/statement/search

curl https://api.shopmonkey.cloud/v3/statement/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",
      "name": null,
      "note": null,
      "fromDate": "fromDate",
      "toDate": "toDate",
      "sent": true,
      "sentDate": null,
      "customerId": "customerId",
      "locationId": "locationId",
      "paid": true,
      "invoicesCount": 1,
      "totalCostCents": 1,
      "remainingCostCents": 1,
      "paidCostCents": 1
    }
  ],
  "success": true
}

POST/v3/statement

Create Statement

Create a new Statement entry

Body parameters

Consumes

The following content type is required: application/json

Name
customerId
Type
string Required
Description
Name
fromDate
Type
string Required
Description
Name
name
Type
string
Description
Name
note
Type
string
Description
Name
toDate
Type
string Required
Description
Name
orderIds
Type
array
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
Statement schema

Properties for `data` object

Name
companyId
Type
string Required
Description
Name
createdDate
Type
string Required
Description
Name
customerId
Type
string Required
Description
Name
duration
Type
integer Required
Description
::bigint
Name
fromDate
Type
string Required
Description
Name
id
Type
string Required
Description
Name
invoicesCount
Type
integer Required
Description
Name
locationId
Type
string Required
Description
Name
name
Type
string Required
Description
Name
note
Type
string Required
Description
Name
paid
Type
boolean Required
Description
Name
paidCostCents
Type
integer Required
Description
Name
remainingCostCents
Type
integer Required
Description
Name
sent
Type
boolean Required
Description
Name
sentDate
Type
string Required
Description
Name
toDate
Type
string Required
Description
Name
totalCostCents
Type
integer Required
Description
Name
updatedDate
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/statement

curl https://api.shopmonkey.cloud/v3/statement \
  -H "Authorization: Bearer ${SM_TOKEN}" \
  -H 'Content-Type: application/json' \
  --data '{ "customerId" : "value", "fromDate" : "value", "toDate" : "value" }'

Example Response
application/json

{
  "success": true,
  "data": {
    "id": "id",
    "createdDate": "createdDate",
    "updatedDate": null,
    "companyId": "companyId",
    "name": null,
    "fromDate": "fromDate",
    "toDate": "toDate",
    "sent": true,
    "sentDate": null,
    "customerId": "customerId",
    "locationId": "locationId",
    "paid": true,
    "invoicesCount": 1,
    "totalCostCents": 1,
    "remainingCostCents": 1,
    "paidCostCents": 1
  }
}

PUT/v3/statement/:id

Update Statement

Update an existing Statement by id

URL parameters

Name
id
Type
string Required
Description

Body parameters

Consumes

The following content type is required: application/json

Name
customerId
Type
string
Description
Name
fromDate
Type
string
Description
Name
name
Type
string
Description
Name
note
Type
string
Description
Name
toDate
Type
string
Description
Name
orderIds
Type
array
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
Statement schema

Properties for `data` object

Name
companyId
Type
string Required
Description
Name
createdDate
Type
string Required
Description
Name
customerId
Type
string Required
Description
Name
duration
Type
integer Required
Description
::bigint
Name
fromDate
Type
string Required
Description
Name
id
Type
string Required
Description
Name
invoicesCount
Type
integer Required
Description
Name
locationId
Type
string Required
Description
Name
name
Type
string Required
Description
Name
note
Type
string Required
Description
Name
paid
Type
boolean Required
Description
Name
paidCostCents
Type
integer Required
Description
Name
remainingCostCents
Type
integer Required
Description
Name
sent
Type
boolean Required
Description
Name
sentDate
Type
string Required
Description
Name
toDate
Type
string Required
Description
Name
totalCostCents
Type
integer Required
Description
Name
updatedDate
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/statement/:id

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

Example Response
application/json

{
  "success": true,
  "data": {
    "id": "id",
    "createdDate": "createdDate",
    "updatedDate": null,
    "companyId": "companyId",
    "name": null,
    "fromDate": "fromDate",
    "toDate": "toDate",
    "sent": true,
    "sentDate": null,
    "customerId": "customerId",
    "locationId": "locationId",
    "paid": true,
    "invoicesCount": 1,
    "totalCostCents": 1,
    "remainingCostCents": 1,
    "paidCostCents": 1
  }
}

GET/v3/statement/:id/pdf

Download Statement PDF

Download a Statement as PDF document

This API has been deprecated and should no longer be used

URL parameters

Name
id
Type
string Required
Description

Query String parameters

Name
includeInvoices
Type
boolean Required
Description
Name
includeNote
Type
boolean Required
Description
Name
statementColumns
Type
array
Description
Name
download
Type
boolean
Description
The flag to include Content-Disposition forcing the browser to download the file instead of opening it for viewing
Name
orderBy
Type
string
Description

Example Request

GET

/v3/statement/:id/pdf

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

POST/v3/statement/:id/message

Send Statement

Send an existing Statement via email/sms

This API has been deprecated and should no longer be used

URL parameters

Name
id
Type
string Required
Description
the id for the object

Body parameters

Consumes

The following content type is required: application/json

Name
customerId
Type
string Required
Description
Name
emailId
Type
string
Description
Name
emailSubject
Type
string Required
Description
Name
includeInvoices
Type
boolean Required
Description
Name
includeNote
Type
boolean Required
Description
Name
orderBy
Type
object
Description
Name
phoneNumberId
Type
string
Description
Name
sendEmail
Type
boolean Required
Description
Name
sendSms
Type
boolean Required
Description
Name
statementColumns
Type
array
Description
Name
text
Type
string Required
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
Message schema

Properties for `data` object

Name
appointmentEvent
Type
one of: Rescheduled, Scheduled, Reminder, Confirm, Canceled, Acknowledgement Required
Description
Name
appointmentId
Type
string Required
Description
appointment associated with this message
Name
authorType
Type
one of: Customer, User, System Required
Description
Name
automatedCampaignId
Type
string Required
Description
the id of the automated campaign that generated this message
Name
avoidSMSQuietHours
Type
boolean Required
Description
Name
companyId
Type
string Required
Description
Name
contentType
Type
one of: PlainText, HTML Required
Description
Name
conversationId
Type
string Required
Description
Name
createdDate
Type
string Required
Description
Name
customerId
Type
string Required
Description
the id of the customer that authored or was sent the message
Name
deleted
Type
boolean Required
Description
if the record has been 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
deletedUserId
Type
string Required
Description
the user that deleted the record or null if not deleted
Name
detached
Type
boolean Required
Description
true if message is public but has no reference to a customer (only for migration purposes
Name
emailError
Type
string Required
Description
error sending email, if any
Name
emailId
Type
string Required
Description
the id of the customer email that authored or was sent the message
Name
emailStatus
Type
one of: Pending, Sent, Read, Error, Delivered, Unknown Required
Description
Name
emailSubject
Type
string Required
Description
overrides default email subject
Name
id
Type
string Required
Description
Name
imported
Type
boolean Required
Description
Name
internal
Type
boolean Required
Description
Name
isOrderShare
Type
boolean Required
Description
true if this message created via Order Share modal
Name
locationId
Type
string Required
Description
Name
locationReviewRequestId
Type
string Required
Description
the id of the review request
Name
oneTimeCampaignBatchId
Type
string Required
Description
the id of the one time campaign batch that generated this message
Name
oneTimeCampaignId
Type
string Required
Description
the id of the one time campaign that generated this message
Name
orderId
Type
string Required
Description
an order associated with this message
Name
orderShareType
Type
one of: Inspection, Order Required
Description
Name
origin
Type
one of: ChatBot, Scheduler, Campaign, Web, Mobile, CustomerOrderPage, SMS, Email Required
Description
Name
phoneNumberId
Type
string Required
Description
the id of the customer phone number that authored or was sent the message
Name
requestAppointmentConfirmation
Type
boolean Required
Description
if true, the email/sms will contain actions to confirm/decline an appointment
Name
sendEmail
Type
boolean Required
Description
if an email should be sent, is null if author is a Customer
Name
sendSms
Type
boolean Required
Description
if an sms should be sent, is null if author is a Customer
Name
shopRead
Type
boolean Required
Description
true if someone at the shop has read a Customer message, is null if author is a User
Name
smsError
Type
string Required
Description
error sending sms, if any
Name
smsStatus
Type
one of: Pending, Sent, Read, Error, Delivered, Unknown Required
Description
Name
suggestedReply
Type
string Required
Description
if we can suggest a reply, this will have a value to suggest to the user in the app
Name
suggestedReplyState
Type
one of: None, Partial, Full Required
Description
Name
text
Type
string Required
Description
appears in message center/thread (content of message if SMS, plaintext/preview if email
Name
type
Type
one of: Transactional, Marketing Required
Description
Name
updatedDate
Type
string Required
Description
Name
userId
Type
string Required
Description
the user who authored the message
Name
vehicleId
Type
string Required
Description
a vehicle associated with this message
Name
vendorId
Type
string Required
Description
a vendor associated with this message
Name
workRequestId
Type
string Required
Description
the id of the work request that generated this message
Name
emailDeliveries
Type
array
Description
Name
files
Type
array Required
Description
Name
orderDeleted
Type
boolean
Description
true if the order is deleted
Name
orderNumber
Type
string
Description
the order number
Name
smsDeliveries
Type
array
Description
Name
userColor
Type
string
Description
the color for the user

`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/statement/:id/message

curl https://api.shopmonkey.cloud/v3/statement/:id/message \
  -H "Authorization: Bearer ${SM_TOKEN}" \
  -H 'Content-Type: application/json' \
  --data '{ "customerId" : "value", "emailSubject" : "value", "includeInvoices" : false, "includeNote" : false, "sendEmail" : false, "sendSms" : false, "text" : "value" }'

Example Response
application/json

{
  "success": true,
  "data": {
    "id": "id",
    "createdDate": "createdDate",
    "updatedDate": null,
    "locationId": "locationId",
    "companyId": "companyId",
    "text": "text",
    "sendEmail": true,
    "emailSubject": null,
    "emailStatus": null,
    "emailError": null,
    "sendSms": true,
    "smsStatus": null,
    "smsError": null,
    "authorType": "authorType",
    "origin": "origin",
    "isOrderShare": true,
    "orderShareType": null,
    "customerId": null,
    "userId": null,
    "orderId": null,
    "appointmentId": null,
    "vehicleId": null,
    "vendorId": null,
    "shopRead": true,
    "internal": true,
    "detached": true,
    "conversationId": null,
    "deleted": true,
    "deletedUserId": null,
    "deletedDate": null,
    "deletedReason": null,
    "locationReviewRequestId": null,
    "suggestedReply": null,
    "suggestedReplyState": "suggestedReplyState",
    "requestAppointmentConfirmation": true,
    "appointmentEvent": null,
    "files": [
      {
        "fileName": "fileName",
        "fileSize": 1,
        "fileType": "fileType",
        "id": "id",
        "thumbnailUrl": "thumbnailUrl",
        "url": "url"
      }
    ],
    "orderNumber": null,
    "userColor": null
  }
}

DELETE/v3/statement/:id

Delete Statement

Delete one Statement 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/statement/:id

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

Example Response
application/json

{
  "success": true
}

GET/v3/statement/:parentId/order

Find Statement Orders

Find all Orders for a Statement

URL parameters

Name
parentId
Type
string Required
Description
the id for the parent of the data to retrieve

Produces

The response content type: application/json

`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

`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/statement/:parentId/order

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

Example Response
application/json

{
  "data": [
    {
      "allowCollectPayment": true,
      "allowCustomerApplyCoupon": true,
      "allowCustomerAuthorization": true,
      "allowCustomerViewActivity": true,
      "allowCustomerViewAuthorizations": true,
      "allowCustomerViewInspections": true,
      "allowCustomerViewMessages": true,
      "appliedDiscountCents": 1,
      "appliedDiscountPercent": 1,
      "appliedDiscountValueType": "appliedDiscountValueType",
      "appointmentDates": "2026-03-02T00:06:31.811Z",
      "archived": true,
      "assignedTechnicianIds": [
        "assignedTechnicianIds"
      ],
      "attributionMessageId": null,
      "attributionSource": null,
      "authorized": true,
      "authorizedDate": null,
      "automatedCampaignId": null,
      "coalescedName": null,
      "companyId": "companyId",
      "complaint": null,
      "completedAuthorizedLaborHours": 1,
      "completedDate": null,
      "completedLaborHours": 1,
      "conversationId": null,
      "createdDate": "createdDate",
      "customerId": null,
      "deferredServiceCount": 1,
      "deleted": true,
      "deletedDate": null,
      "deletedReason": null,
      "deletedUserId": null,
      "depositFullyPaid": true,
      "depositFullyPaidDate": null,
      "discountCents": 1,
      "discountPercent": 1,
      "dueDate": null,
      "emailId": null,
      "epaCents": 1,
      "externalNumber": null,
      "feesCents": 1,
      "fullyPaidDate": null,
      "generatedCustomerName": null,
      "generatedName": null,
      "generatedVehicleName": null,
      "gstCents": 1,
      "hasPayments": true,
      "hstCents": 1,
      "id": "id",
      "imported": true,
      "inspectionCount": 1,
      "inspectionReviewStatus": "inspectionReviewStatus",
      "inspectionStatus": "inspectionStatus",
      "invoiced": true,
      "invoicedDate": null,
      "laborCents": 1,
      "locationId": "locationId",
      "messageCount": 1,
      "messagedDate": null,
      "mileageIn": null,
      "mileageOut": null,
      "name": null,
      "number": "number",
      "oneTimeCampaignId": null,
      "orderCreatedDate": "orderCreatedDate",
      "paid": true,
      "paidCostCents": 1,
      "partsCents": 1,
      "paymentDueDate": null,
      "paymentTermId": null,
      "phoneNumberId": null,
      "pstCents": 1,
      "publicId": "publicId",
      "purchaseOrderNumber": null,
      "readOnly": true,
      "readOnlyReason": null,
      "recommendation": null,
      "remainingCostCents": null,
      "repairOrderDate": null,
      "requestedDepositCents": 1,
      "requireESignatureOnAuthorization": true,
      "requireESignatureOnInvoice": true,
      "sentToCarfax": true,
      "serviceWriterId": null,
      "shopSuppliesCents": 1,
      "shopUnreadMessageCount": 1,
      "statementId": null,
      "status": "status",
      "subcontractsCents": 1,
      "taxCents": 1,
      "taxConfigId": null,
      "tiresCents": 1,
      "totalAuthorizedLaborHours": 1,
      "totalCostCents": 1,
      "totalLaborHours": 1,
      "transactionalFeeSubtotalCents": 1,
      "transactionalFeeTotalCents": 1,
      "transactionFeeConfigId": null,
      "updatedDate": null,
      "updatedSinceSignedInvoice": true,
      "vehicleId": null,
      "workflowStatusDate": "workflowStatusDate",
      "workflowStatusId": null,
      "workflowStatusPosition": null,
      "appointments": [
        {
          "allDay": true,
          "attributionMessageId": null,
          "attributionSource": null,
          "automatedCampaignId": null,
          "cancellationNote": null,
          "chatBotSessionId": null,
          "color": "color",
          "companyId": "companyId",
          "confirmationStatus": "confirmationStatus",
          "confirmationSubject": null,
          "confirmationTemplateIdentifier": null,
          "confirmationText": null,
          "createdDate": "createdDate",
          "customerEmailId": null,
          "customerId": null,
          "customerPhoneNumberId": null,
          "duration": null,
          "endDate": "endDate",
          "id": "id",
          "isRecurringParent": true,
          "lastRecurrenceEndDate": null,
          "legacyHydratedReminder": true,
          "locationId": "locationId",
          "name": "name",
          "note": "note",
          "oneTimeCampaignId": null,
          "orderId": null,
          "origin": "origin",
          "originalEndDate": null,
          "originalStartDate": null,
          "publicId": "publicId",
          "recurring": true,
          "recurringAppointmentId": null,
          "recurringExceptionId": null,
          "reminderSubject": null,
          "reminderTemplateIdentifier": null,
          "reminderText": null,
          "removedFromRecurrency": true,
          "rruleset": null,
          "sendConfirmation": true,
          "sendReminder": true,
          "startDate": "startDate",
          "updatedDate": null,
          "useEmail": true,
          "useSMS": true,
          "vehicleId": null
        }
      ],
      "authorizations": [
        {
          "authorizedCostCents": 1,
          "companyId": "companyId",
          "createdDate": "createdDate",
          "customerId": null,
          "date": "date",
          "id": "id",
          "locationId": "locationId",
          "method": "method",
          "note": "note",
          "orderId": "orderId",
          "serviceAuthorizationReset": true,
          "serviceWriterId": null,
          "updatedDate": null
        }
      ],
      "customFields": {},
      "customer": {
        "address1": null,
        "address2": null,
        "appointmentCount": 1,
        "city": null,
        "coalescedFirstNameOrCompanyName": null,
        "companyId": "companyId",
        "companyName": null,
        "country": null,
        "createdDate": "createdDate",
        "customerType": "customerType",
        "deferredServiceCount": 1,
        "deleted": true,
        "deletedDate": null,
        "deletedReason": null,
        "deletedUserId": null,
        "discountPercent": 1,
        "dotNumber": null,
        "externalId": null,
        "finixIdentityId": null,
        "firstName": null,
        "fleetId": null,
        "gstExempt": true,
        "hstExempt": true,
        "id": "id",
        "imported": true,
        "laborMatrixId": null,
        "laborRateId": null,
        "lastName": null,
        "lastTimeOrderWorked": null,
        "locationIds": [
          "locationIds"
        ],
        "marketingOptIn": true,
        "messageCount": 1,
        "normalizedFirstName": null,
        "normalizedLastName": null,
        "normalizedName": null,
        "note": "note",
        "orderCount": 1,
        "originLocationId": null,
        "paymentTermId": null,
        "postalCode": null,
        "preferredContactMethod": null,
        "preferredLanguage": "preferredLanguage",
        "pricingMatrixId": null,
        "pstExempt": true,
        "publicId": "publicId",
        "referralSourceId": null,
        "showLaborHours": true,
        "showLaborNote": true,
        "showPartCostAndQuantity": true,
        "showPartNote": true,
        "showPartNumber": true,
        "state": null,
        "statementCount": 1,
        "taxExempt": true,
        "transactionCount": 1,
        "updatedDate": null,
        "vehicleCount": 1,
        "website": null,
        "customFields": {},
        "emails": [
          {
            "email": "email",
            "id": "id",
            "primary": true
          }
        ],
        "phoneNumbers": [
          {
            "extension": null,
            "id": "id",
            "number": "number",
            "primary": true,
            "type": null,
            "userDefinedType": null
          }
        ]
      },
      "inspections": [
        {
          "companyId": "companyId",
          "completed": true,
          "completedById": null,
          "completedDate": null,
          "createdById": null,
          "createdDate": "createdDate",
          "id": "id",
          "locationId": "locationId",
          "name": "name",
          "note": null,
          "orderId": "orderId",
          "ordinal": 1,
          "recommended": true,
          "templateId": null,
          "updatedDate": null
        }
      ],
      "paymentTerm": {
        "id": "id",
        "name": "name"
      },
      "profitability": {
        "labor": {
          "discountCents": 1,
          "discountPercent": 1,
          "profitCents": 1,
          "profitPercent": 1,
          "retailCents": 1,
          "wholesaleCents": 1
        },
        "parts": {
          "discountCents": 1,
          "discountPercent": 1,
          "profitCents": 1,
          "profitPercent": 1,
          "retailCents": 1,
          "wholesaleCents": 1
        },
        "subcontracts": {
          "discountCents": 1,
          "discountPercent": 1,
          "profitCents": 1,
          "profitPercent": 1,
          "retailCents": 1,
          "wholesaleCents": 1
        },
        "tires": {
          "discountCents": 1,
          "discountPercent": 1,
          "profitCents": 1,
          "profitPercent": 1,
          "retailCents": 1,
          "wholesaleCents": 1
        },
        "totalDiscountCents": 1,
        "totalDiscountPercent": 1,
        "totalProfitCents": 1,
        "totalProfitPercent": 1,
        "totalRetailCents": 1,
        "totalWholesaleCents": 1
      },
      "services": [
        {
          "authorizationStatus": "authorizationStatus",
          "calculatedDiscountCents": 1,
          "calculatedDiscountPercent": 1,
          "calculatedEpaCents": 1,
          "calculatedFeeCents": 1,
          "calculatedGSTCents": 1,
          "calculatedHSTCents": 1,
          "calculatedLaborCents": 1,
          "calculatedPartsCents": 1,
          "calculatedPSTCents": 1,
          "calculatedShopSuppliesCents": 1,
          "calculatedSubcontractsCents": 1,
          "calculatedTaxCents": 1,
          "calculatedTiresCents": 1,
          "categoryId": null,
          "companyId": "companyId",
          "createdDate": "createdDate",
          "deferredDate": null,
          "deferredReason": null,
          "discountCents": 1,
          "discountPercent": 1,
          "discountValueType": "discountValueType",
          "epaCents": 1,
          "epaPercent": 1,
          "epaValueType": "epaValueType",
          "excludedFromDeferred": true,
          "fixedPriceCents": 1,
          "gstCents": 1,
          "gstPercent": 1,
          "gstValueType": "gstValueType",
          "hidden": true,
          "hideLineItemPricing": true,
          "hstCents": 1,
          "hstPercent": 1,
          "hstValueType": "hstValueType",
          "id": "id",
          "lineItemInventoryStatus": "lineItemInventoryStatus",
          "lineItemOrder": [
            "lineItemOrder"
          ],
          "locationId": "locationId",
          "lumpSum": true,
          "motorApplicationId": null,
          "name": "name",
          "note": "note",
          "orderId": "orderId",
          "ordinal": 1,
          "pricing": "pricing",
          "provider": null,
          "providerApplicationId": null,
          "pstCents": 1,
          "pstPercent": 1,
          "pstValueType": "pstValueType",
          "recommended": true,
          "revived": true,
          "revivedFromId": null,
          "shopSuppliesApplied": true,
          "shopSuppliesCents": 1,
          "shopSuppliesPercent": 1,
          "shopSuppliesValueType": "shopSuppliesValueType",
          "sourceServiceId": null,
          "taxCents": 1,
          "taxPercent": 1,
          "taxValueType": "taxValueType",
          "totalCents": 1,
          "updatedDate": null,
          "fees": [
            {
              "amountCents": 1,
              "categoryId": null,
              "companyId": "companyId",
              "createdDate": "createdDate",
              "feeType": "feeType",
              "id": "id",
              "inventoryFeeId": null,
              "laborId": null,
              "lineItemEntity": null,
              "locationId": "locationId",
              "name": "name",
              "orderId": "orderId",
              "ordinal": 1,
              "partId": null,
              "percent": 1,
              "serviceId": "serviceId",
              "sourceItemId": null,
              "subcontractId": null,
              "subtotalCents": null,
              "tireId": null,
              "updatedDate": null,
              "category": {
                "id": "id",
                "name": "name",
                "parent": {
                  "id": "id",
                  "name": "name"
                }
              }
            }
          ],
          "labors": [
            {
              "applicationId": null,
              "categoryId": null,
              "companyId": "companyId",
              "completed": true,
              "completedDate": null,
              "costHours": null,
              "costRateCents": null,
              "costTotalCents": null,
              "createdDate": "createdDate",
              "discountCents": 1,
              "discountPercent": 1,
              "discountValueType": "discountValueType",
              "hours": 1,
              "id": "id",
              "inventoryLaborId": null,
              "laborMatrixDate": null,
              "laborMatrixId": null,
              "locationId": "locationId",
              "motorApplicationId": null,
              "multiplier": 1,
              "multiplierType": "multiplierType",
              "name": null,
              "note": "note",
              "orderId": "orderId",
              "ordinal": 1,
              "provider": null,
              "providerApplicationId": null,
              "rateCents": 1,
              "rateId": null,
              "serviceId": "serviceId",
              "showHours": true,
              "showNote": true,
              "skillRequired": null,
              "skillRequiredDescription": null,
              "sourceItemId": null,
              "taxable": true,
              "taxableGST": true,
              "taxableHST": true,
              "taxablePST": true,
              "technicianId": null,
              "updatedDate": null,
              "category": {
                "id": "id",
                "name": "name",
                "parent": {
                  "id": "id",
                  "name": "name"
                }
              },
              "laborMatrix": {
                "id": "id",
                "name": "name"
              },
              "laborRate": {
                "id": "id",
                "name": "name"
              }
            }
          ],
          "parts": [
            {
              "binLocation": "binLocation",
              "categoryId": null,
              "companyId": "companyId",
              "createdDate": "createdDate",
              "discountCents": 1,
              "discountPercent": 1,
              "discountValueType": "discountValueType",
              "fixedPriceLimitPriceCents": null,
              "fixedPriceLimitQuantity": null,
              "fixedPriceLimitType": null,
              "id": "id",
              "inventoryPartId": null,
              "inventoryStatus": "inventoryStatus",
              "inventoryTransferPartId": null,
              "locationId": "locationId",
              "motorApplicationId": null,
              "motorCommercialPartsId": null,
              "name": "name",
              "note": "note",
              "orderId": "orderId",
              "ordinal": 1,
              "partNumber": null,
              "pcDbTerminologyId": null,
              "pricingMatrixDate": null,
              "pricingMatrixId": null,
              "provider": null,
              "providerApplicationId": null,
              "purchaseOrderPartId": null,
              "purchaseStatus": null,
              "quantity": 1,
              "reduceInventoryCount": true,
              "reserved": true,
              "retailCostCents": 1,
              "serviceId": "serviceId",
              "showCostAndQuantity": true,
              "showNote": true,
              "showPartNumber": true,
              "sourceItemId": null,
              "taxable": true,
              "taxableGST": true,
              "taxableHST": true,
              "taxablePST": true,
              "updatedDate": null,
              "url": null,
              "vendorId": null,
              "wholesaleCostCents": null,
              "category": {
                "id": "id",
                "name": "name",
                "parent": {
                  "id": "id",
                  "name": "name"
                }
              },
              "pricingMatrix": {
                "id": "id",
                "name": "name"
              },
              "vendor": {
                "id": "id",
                "name": "name"
              },
              "inventoryPart": {
                "availableQuantity": 1,
                "id": "id",
                "minCriticalQuantity": 1,
                "name": "name",
                "quantity": 1,
                "retailCostCents": 1
              }
            }
          ],
          "subcontracts": [
            {
              "categoryId": null,
              "companyId": "companyId",
              "costCents": 1,
              "createdDate": "createdDate",
              "discountCents": 1,
              "discountPercent": 1,
              "discountValueType": "discountValueType",
              "id": "id",
              "locationId": "locationId",
              "name": "name",
              "note": null,
              "orderId": "orderId",
              "ordinal": 1,
              "retailCostCents": 1,
              "serviceId": "serviceId",
              "showNote": true,
              "sourceItemId": null,
              "taxable": true,
              "taxableGST": true,
              "taxableHST": true,
              "taxablePST": true,
              "updatedDate": null,
              "vendorId": null,
              "category": {
                "id": "id",
                "name": "name",
                "parent": {
                  "id": "id",
                  "name": "name"
                }
              },
              "vendor": {
                "id": "id",
                "name": "name"
              }
            }
          ],
          "tires": [
            {
              "binLocation": null,
              "calculatedName": "calculatedName",
              "companyId": "companyId",
              "createdDate": "createdDate",
              "discountCents": 1,
              "discountPercent": 1,
              "discountValueType": "discountValueType",
              "federalExciseTaxCents": 1,
              "generatedBrandName": "generatedBrandName",
              "generatedModelName": "generatedModelName",
              "id": "id",
              "inventoryStatus": "inventoryStatus",
              "inventoryTireId": null,
              "inventoryTransferTireId": null,
              "locationId": "locationId",
              "name": "name",
              "note": null,
              "orderId": "orderId",
              "ordinal": 1,
              "partNumber": null,
              "pricingMatrixDate": null,
              "pricingMatrixId": null,
              "purchaseOrderTireId": null,
              "purchaseStatus": null,
              "quantity": 1,
              "reduceInventoryCount": true,
              "reserved": true,
              "retailCostCents": 1,
              "serviceId": "serviceId",
              "showNote": true,
              "showPartNumber": true,
              "showPriceAndQuantity": true,
              "size": null,
              "sizeFormat": "sizeFormat",
              "sourceItemId": null,
              "taxable": true,
              "taxableGST": true,
              "taxableHST": true,
              "taxablePST": true,
              "tireIdentificationNumbers": [
                "tireIdentificationNumbers"
              ],
              "tireModelId": null,
              "updatedDate": null,
              "url": null,
              "wasteTireFee": 1,
              "wholesaleCostCents": null,
              "pricingMatrix": {
                "id": "id",
                "name": "name"
              },
              "tireModel": {
                "id": "id",
                "name": "name"
              },
              "inventoryTire": {
                "availableQuantity": 1,
                "id": "id",
                "minCriticalQuantity": 1,
                "name": "name",
                "quantity": 1,
                "retailCostCents": 1
              }
            }
          ]
        }
      ],
      "vehicle": {
        "appointmentCount": 1,
        "baseId": null,
        "bedLength": null,
        "bodyStyle": null,
        "bodyStyleId": null,
        "coalescedVINorHIN": null,
        "color": null,
        "companyId": "companyId",
        "computed_ymm": null,
        "configurationStatus": null,
        "createdDate": "createdDate",
        "customPhoto": true,
        "deferredServiceCount": 1,
        "deleted": true,
        "deletedDate": null,
        "deletedReason": null,
        "deletedUserId": null,
        "drivetrain": null,
        "drivetype": null,
        "drivetypeId": null,
        "drivingCondition": null,
        "engine": null,
        "engineId": null,
        "externalId": null,
        "frontTireSize": null,
        "hin": null,
        "id": "id",
        "imported": true,
        "lastServicedDate": null,
        "length": null,
        "lengthUnit": null,
        "licensePlate": null,
        "licensePlateCountry": "licensePlateCountry",
        "licensePlateState": null,
        "locationIds": [
          "locationIds"
        ],
        "make": null,
        "makeId": null,
        "messageCount": 1,
        "mileage": null,
        "mileageLogCount": 1,
        "mileageUnit": "mileageUnit",
        "model": null,
        "modelId": null,
        "name": null,
        "note": "note",
        "odometer": true,
        "orderCount": 1,
        "originLocationId": null,
        "ownerCount": 1,
        "preferredLaborGuide": "preferredLaborGuide",
        "productionDate": null,
        "rearTireSize": null,
        "region": null,
        "serial": null,
        "size": "size",
        "stockPhoto": true,
        "submodel": null,
        "submodelId": null,
        "tirePressureLogCount": 1,
        "transmission": null,
        "transmissionId": null,
        "transmissionMfrCode": null,
        "transmissionSpeed": null,
        "type": null,
        "unit": null,
        "updatedDate": null,
        "vcdbId": null,
        "vcdbVehicleId": null,
        "vin": null,
        "year": null,
        "customFields": {},
        "tirePressureLogs": [
          {
            "companyId": "companyId",
            "createdDate": "createdDate",
            "frontLeft": null,
            "frontRight": null,
            "id": "id",
            "locationId": "locationId",
            "orderId": "orderId",
            "rearLeft": null,
            "rearRight": null,
            "updatedDate": null,
            "vehicleId": "vehicleId"
          }
        ]
      },
      "workflowStatus": {
        "id": "id",
        "name": null
      }
    }
  ],
  "success": true
}

Statement

URL parameters

Produces

200 Response

Properties for data object

Properties for meta object

4xx Response

5xx Response

Example Request

Example Responseapplication/json

Query String parameters

Produces

200 Response

Properties for meta object

4xx Response

5xx Response

Example Request

Example Responseapplication/json

Body parameters

Consumes

Produces

200 Response

4xx Response

5xx Response

Example Requestapplication/json

Example Responseapplication/json

Body parameters

Consumes

Produces

200 Response

Properties for data object

4xx Response

5xx Response

Example Requestapplication/json

Example Responseapplication/json

URL parameters

Body parameters

Consumes

Produces

200 Response

Properties for data object

4xx Response

5xx Response

Example Requestapplication/json

Example Responseapplication/json

URL parameters

Query String parameters

Example Request

URL parameters

Body parameters

Consumes

Produces

200 Response

Properties for data object

4xx Response

5xx Response

Example Requestapplication/json

Example Responseapplication/json

URL parameters

Produces

200 Response

Properties for data object

4xx Response

5xx Response

Example Requestapplication/json

Example Responseapplication/json

URL parameters

Produces

200 Response

Properties for meta object

4xx Response

5xx Response

Example Request

Example Responseapplication/json

`200` Response

Properties for `data` object

Properties for `meta` object

`4xx` Response

`5xx` Response

Example Response
application/json

`200` Response

Properties for `meta` object

`4xx` Response

`5xx` Response

Example Response
application/json

`200` Response

`4xx` Response

`5xx` Response

Example Request
application/json

Example Response
application/json

`200` Response

Properties for `data` object

`4xx` Response

`5xx` Response

Example Request
application/json

Example Response
application/json

`200` Response

Properties for `data` object

`4xx` Response

`5xx` Response

Example Request
application/json

Example Response
application/json

`200` Response

Properties for `data` object

`4xx` Response

`5xx` Response

Example Request
application/json

Example Response
application/json

`200` Response

Properties for `data` object

`4xx` Response

`5xx` Response

Example Request
application/json

Example Response
application/json

`200` Response

Properties for `meta` object

`4xx` Response

`5xx` Response

Example Response
application/json