{"info":{"_postman_id":"e4ce71c2-762a-4230-b0f9-c189d03f5810","name":"ServiceMonster API V1","description":"

\n\n

About

Welcome to the ServiceMonster Developer Page! Here you can find all API documentation for
our V1 environment. Code References and Snippets are in the right hand pane.

If you have any questions please feel free to contact us at developer@servicemonster.net.

Getting Started

Using the API

Part 1: Returning a collection

To begin using the ServiceMonster REST API you will first and foremost need an authentication token. If you do not have an authentication token, please see the page on Creating a Basic Token. The token not only gives you access to the REST API, but it is also what ties your requests to a ServiceMonster Company ID.

Once you have your token, it is highly recommended that you compose your first HTTP requests with a program such as Fiddler Web Debugger. This program will allow you to compose requests, and to view the data that is returned from a properly formatted request. It is not necessary to use this third-party application, but it does make it very clear as to what is required in the request, what is returned in the data-set and how it is formatted. The following examples in this getting started tutorial will use the Fiddler Web Debugger.

In Fiddler, select the “Composer” tab to begin creating your HTTP request. In the Request Header, add the following lines:

Content-Type: application/json
Authorization: Basic {Your Token Here}

Please be careful to put a space between “Basic” and your token. This is what your Request Header should look like for all future HTTP Requests:

\n\n

Now to compose the request itself. We will begin by doing a simple query of “Accounts” records. Directly above the Request Header section there is a drop-down list containing the available HTTP actions: GET, POST, PUT, etc.... Of these options, the REST API uses 4 which each relate to a CRUD operation. POST = create, GET = read, PUT = update, and DELETE = delete. For this example we will leave the drop-down list with “GET” selected.

Next to the drop-down list there is an address bar. This is where you will specify the resource you are trying to access. For our example, Accounts, the address will look like this:

\n\n

First, you must use the HTTPS secure protocol. Regular HTTP requests will not work, and will result in a 404 “Not Found” error. Second is the address “api.servicemonster.net”. This will always be the address you should use to access any resource through the REST API. Third, after the address is the version number. Currently we are on version 1. Requests made to /v1/ will still continue to work after /v2/ is made available, thereby ensuring that any updates we make will not break a piece of software utilizing our API. Finally, after the version comes the resource that we are trying to access, in this case “accounts.” The address is not case-sensitive.

Once your request is complete, hit the button in the top-right of the screen. In the left side of the screen is the list of HTTP requests that have been made by your system, with the most recent request at the bottom.

\n\n

The “Host” for our request should be “api.servicemonster.net” and the URL should be “/v1/accounts.” With your request selected, change the tab on the right side of the screen from “Composer” to “Inspectors.”

\n\n

Beneath the Request Headers section is another row of tabs that allow you to view the data after it has been de-serialized in a variety of formats. The data returned by the API is serialized in JSON, fiddler should recognize this and automatically select the JSON tab, but if it does not, then select that tab now. (Alternatively, you can double-click the request in the Request List). The data returned should look something like this:

\n\n

At the top of the JSON package is the count. This number tells you how many records there are in the database for the type of resource selected. By default, the API will only return the first 10 records, however you can increase the “Page Size” or return a different “Page Index.” (See “Part IV: Parameters)

Part 2: Returning a Single Record top

Returning a single record is very similar to returning a collection, however we must include the record identifier. The record identifier will be of the type “GUID” (Globally Unique Identifier)* and will be added to the end of the request address like so:

\n\n

This request will return the information regarding a single account. If you have successfully received a collection of account records, you can use the “accountID” property from one of those records as your record identifier. The property that contains the record identifier will have the resource name (“account,” in this case) in lowercase plus the letters “ID” capitalized. Ie: accountID, orderID, siteID, etc...

Part 3: Returning Child Collections

You can also request collections of data that “belong” to a record. For example, you may want to return a collection of the Orders that have been created for a specific Account. To do this, construct your request like you were returning a single Account record, and then add the child-resource to the end of it like so:

\n\n

This request would return to us the orders for the account with accountID equal to “990d83de-0d9a-444f-bfd7-09101c756151.”

Part 4: Parameters

Please view the Parameters page Parameters

Part 5: Creating a New Record

A few of the resources made accessible by the API are set as read-only. For those, you will be unable to create new records. However, the majority of the ServiceMonster resources allow you to insert a new record via the API. In this example, we will add a new Account.

First, set the drop-down list in the Fiddler Request Composer to “POST.” Second, we will construct the address as if we were requesting a collection; like so:

\n\n

The content for the resource we are trying to add goes in to the Request Body. For each type of resource, at least one property is required. If you were to hit “Execute” without typing anything into the Request Body, you will get the following error that basically just says it was expecting some data:

\n\n

That is because a JSON data package must be encapsulated with the curly braces { and }. If we simply put the open and closed curly braces into the request body, and hit “Execute” with our empty data-set, we will get the following error message that contains more meaningful information:

\n\n

For Accounts, the only property that is required is accountName. If more of the properties were required, they would be listed here as well. This can be a good way to determine what fields will need to be supplied in order to create a record. To create a new Account with the absolute minimum of information, compose your Request Body so that it looks like the following:

{ \"accountName\":\"New Account\" }

If you have constructed your request properly, the record will be created, and the record identifier will be returned in a JSON package. Some properties are read-only, so if you try to insert a record and have supplied a property that is read-only, you will get an error message and the record will not be created.

Part 6: Updating a Record

Similar to requesting a single record, you must supply the record ID in order to do an Update. You must also change the action drop-down list to “PATCH.”

Then, form the Request Body like you did for a POST including the fields you want to update. None of the fields are required to do an update, however some of them are read-only. Also, you cannot update a required property with a blank or null value.

Part 7: Deleting a Record top
Just like fetching or updating a single record, we need to supply a record ID to delete a record through the API. This time we will set the HTTP Action drop-down list to “DELETE”

Creating a Basic Token

Create an API Key

Login to ServiceMonster at six.servicemonster.net (You will need to use an administrator account)
\n
Navigate to Settings from the bar on the Left, and select \"API Users\"
\n
Click \"+API User\" at the top of the list of existing API Keys.
\n
Select a role, usually Admin and supply a note (optional), click \"Submit\"
\n
A set of API Credentials will appear. Make sure you save the password, as it will not be retrievable if you lose it.
\n

Api User Roles

Admin - Can Create, Read, Update, and Delete on any of the available resources. Use of this role is typically not necessary.
\n
Super User - Can Create, Read and Update. Can not Delete. Most records can be archived or de-activated without deleting, so this Role should be able to achieve everything necessary for implementations.
\n
Read Only - can only Read.
\n
WebForms - can not perform any actions EXCEPT Creating new Web Lead records.
\n

Create a Basic Token using base64encode

Open https://www.base64encode.org/
Make sure you are set to encode, then in the top box paste your username and password generated in step one. They should be seperated by a colon. Then press \"Encode\"
Ex: \"username\":\"password\"

\n\n

The encoded string generated is your Basic Token. You can use it by supplying it in your request Headers.

Ajax Example:

See javascript code snippet to the right.

var settings = {\n  \"url\": \"https://api.servicemonster.net/v1/accounts\",\n  \"method\": \"GET\",\n  \"headers\": {\n    \"authorization\": \"Basic ***********\"\n  }\n}\n$.ajax(settings).done(function (response) {\n  console.log(response);\n});\n\n

GET Parameters

GET Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Example
fields	limits the return to the specified columns	v1/accounts?fields=id,accountName
limit	limits the number of records returned for paging	v1/accounts?limit=25
pageIndex	The page of results to be returned. (example returns records 101-125)	v1/accounts?limit=25&pageIndex=4

GET Where Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Description
wField	The data field to check against
wValue	The value to filter on. (Use \" \" for spaces)
wOperator	(optional)The type of camparison to be made. Default is the equals operator; do not include this parameter if you are looking for an exact match to the supplied value. (\"gt\") greater than; (\"lt\") less than(\"like\") LIKE, '%'s are added before and after value. See examples below.

GET Where Examples

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Example	Description
.../v1/account?wField=lastName&wValue=Smith	Returns all Accounts where the Last Name equals \"Smith\"
.../v1/orders?wField=balanceDue&wValue=100&wOperator=gt	Returns all Orders where the balance due is greater than $100.00
.../v1/leadSources?wField=name&wValue=magazine&wOperator=like	Returns all Lead Sources that have the word \"magazine\" somewhere in the name.

Vendor Information

Overview

ServiceMonster is proud to offer data-integration to third party vendors who would like to offer their services to our customers.

Once you are approved as a vendor we will create a test company for you within the ServiceMonster test site (http://west-test.servicemonster.net/servicemonster). You will then be able to log in to ServiceMonster and create your own API credentials. Once you have created a set of API credentials you can start creating, reading, and modifying data through the API test site (http://west-test.servicemonster.net/smapi) and start building out your integration with ServiceMonster company data.

One key component to completing integration with ServiceMonster customer data, is the process through which the end-user will grant access to your application. This process is outlined in detail in this document and in this diagram.

Vendor Access Request

** Creating Company-Specific API Credentials through the ServiceMonster API **

When you are first approved as a vendor, you will be given a set of credentials as well as an Application ID for each app that you have in the marketplace that integrates with ServiceMonster data. You will use this AppID both when validating the API access request, and when completing the request to retrieve credentials.

** Check if API Request is valid: **

GET https://api.servicemonster.net/v1/apiRequests/{AppID}/{RequestID}\nAuthorization:  Basic {your token here}\n\n

This validation check must occur within 30 minutes from when the API request was created. After that it expires and the user will need to generate a new link (by refreshing the marketplace page).

{\n  \"companyKey\": \"5001\",\n  \"companyName\": \"Principal Focus\",\n  \"address1\": \"4204 Meridian St\",\n  \"address2\": \"Suite 105\",\n  \"city\": \"Bellingham\",\n  \"state\": \"WA\",\n  \"zip\": \"98226\",\n  \"phone\": \"(888) 901-3300\"\n}\n\n

If the Request is still valid, the API will return information specific to the company that has generated the API Access request. e.g.

You can use this data to pre-fill your purchase form. Once the customer has completed the purchasing process, you can then use your AppID and the RequestID again to “complete” the request, and have the API return a set of credentials that will allow you to access that company’s data.

** Completing the API Request: **

POST    https://api.servicemonster.net/v1/apiRequests   \nAuthorization:  Basic {your token here}\nContent-Type:   application/json\nRequest Body:\n{\n  \"requestID\": \"{RequestID}\",\n  \"appID\": \"{AppID}\"\n}\n\n

The API Request must be completed within 1 hour from when the API request was created. After that it expires and the user will need to generate a new link (by refreshing the marketplace page).

{\n  \"password\": \"**\",\n  \"userName\": \"**\"\n}\n\n

Upon a successful post of the API Request object, the new credentials will be returned:

Once you have the credentials, you can Base64 them into a token to use when authenticating your requests: Creating a Basic Token

Vendor Request Flow

\n\n

Using Postman

\n\n

Postman is a powerful tool for developing and testing API. By clicking the 'Run in Postman' button at the top of this page you can access a collection of all the requests available in the ServiceMonster API. For more information on getting started with Postman, see the official documentation.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Getting Started","slug":"getting-started"},{"content":"Creating a Basic Token","slug":"creating-a-basic-token"},{"content":"GET Parameters","slug":"get-parameters"},{"content":"Vendor Information","slug":"vendor-information"},{"content":"Using Postman","slug":"using-postman"}],"owner":"3295919","collectionId":"e4ce71c2-762a-4230-b0f9-c189d03f5810","publishedId":"RVg2A8sE","public":true,"customColor":{"top-bar":"3E6DB5","right-sidebar":"18488A","highlight":"00A650"},"publishDate":"2018-02-27T18:23:00.000Z"},"item":[{"name":"Accounts","item":[{"name":"Accounts","id":"0acd4288-33b2-4957-9db8-3ca40a0b6dd5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.servicemonster.net/v1/accounts","description":"

Request a list of Accounts

Create a new Account.

Include the desired properties in the request body to create a new account. Be sure to provide the required properties.

Properties

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Data Type	Required	Read Only	Default Value	Description
accountID	Guid	-	Yes	-	The guid identifer for the account.
accountName	String	AccountName is not required as long as CompanyName (commercial accounts) or FirstName and LastName (residential accounts) are supplied.	-	-	The name of the Account as it appears in the Accounts list
accountReferralID	Guid	-	-	-	If the Lead Source is set to \"Account Referral\", then this ID is used to define the referring account.
accountSubType	String	-	-	-	The user-defined sub-category for the account.
accountType	String	-	-	Customer	The type of account. ie Customer, Prospect, etc..
acquisitionDate	DateTime	-	-	-	The date that this account was created.
active	Boolean	-	-	True	Whether this account is currently active.
address1	String	-	-	-	Line 1 of the account's street address
address2	String	-	-	-	Line 2 of the account's street address
alert	Boolean	-	-	False	Calls attention to the account.
city	String	-	-	-	The city where the account-holder is located
comment	String	-	-	-	Comment about the account.
commercial	Boolean	-	-	False	Whether or not this account is for a residential or commercial location.
companyID	Guid	-	Yes	-	The ID of the company to which this account belongs.
companyKey	Guid	-	Yes	-	The ID of the company to which this account belongs.
companyName	String	-	-	-	The country where the account-holder is located
country	String	-	-	-	The country where the account-holder is located
county	String	-	-	-	The county where the account-holder is located
courierRoute	String	-	-	-	The courier route for this account.
createdBy	String	-	Yes	-	The username of the person who created this account.
createdOn	DateTime	-	Yes	-	The date and time that this acocunt was created.
doNotCall	Boolean	-	-	False	Whether or not this person would like to receive phone calls.
doNotEmail	Boolean	-	-	False	Whether or not this person would like to receive emails.
doNotMail	Boolean	-	-	False	Whether or not this person would like to receive mail.
email	String	-	-	-	The email address for this account.
externalRefID	String	-	-	-	This can be the ID of this account in a different system. ie Quickbooks.
fax	String	-	-	-	The fax number for this account
firstName	String	-	-	-	The first name of the account-holder
flagForReview	Boolean	-	-	False	Whether or not this account needs to be reviewed.
lastName	String	-	-	-	The last name of the account-holder
lastStatementDate	DateTime	-	-	-	The date of the most recent statement.
lastJobDate	DateTime	-	Yes	-	The date of the most recent Job.
leadSourceID	Guid	-	-	-	The ID of the Lead Source for this account.
nextJobDate	DateTime	-	Yes	-	The date of the soonest upcoming Job.
note	String	-	-	-	A note about this account
paymentTerm	String	-	-	-	Used to determine when a customer's invoice is past due. (Due Upon Receipt, Net 15, Net 30, Net 60)
phone1	String	-	-	-	The first phone number for this account.
phone1Label	String	-	-	Phone 1	The label for the first phone number.
canText1	Boolean				Whether the first phone number can be texted.
phone2	String	-	-	-	The second phone number for this account.
phone2Label	String	-	-	Phone 2	The label for the second phone number
canText2	Boolean				Whether the second phone number can be texted.
phone3	String	-	-	-	The third phone number for this account
phone3Label	String	-	-	Phone 3	The label for the third phone number
canText3	Boolean				Whether the third phone number can be texted.
reference	String	-	-	-	A custom field.
salutation	String	-	-	-	The title for the account-holder
securityGroup	String	-	-	-	The security group for this account
siteReference	String	-	-	-	-
state	String	-	-	-	The county where the account-holder is located
taxExempt	Boolean	-	-	False	Whether this account is subject to taxes.
taxID	Guid	-	-	-	The identifier of the tax-rate for this account
zip	String	-	-	-	The zip-code where the account-holder is located
timeStamp	DateTime	-	Yes	-	The date and time that this account was last modified.
userName	String	-	Yes	-	The username of the person who last edited this account.

Request a specific Account

Update a specific Account

Provide the desired properties in the request body to update the specified account.

Properties

Field Name	Data Type	Required	Read Only	Default Value	Description
accountID	Guid	-	Yes	-	The guid identifer for the account.
accountName	String	Yes	-	-	The account's name.
accountReferralID	Guid	-	-	-	If the Lead Source is set to \"Account Referral\", then this ID is used to define the referring account.
accountSubType	String	-	-	-	The user-defined sub-category for the account.
accountType	String	-	-	Customer	The type of account. ie Customer, Prospect, etc..
acquisitionDate	DateTime	-	-	-	The date that this account was created.
active	Boolean	-	-	True	Whether this account is currently active.
address1	String	-	-	-	Line 1 of the account's street address
address2	String	-	-	-	Line 2 of the account's street address
alert	Boolean	-	-	False	Calls attention to the account.
city	String	-	-	-	The city where the account-holder is located
comment	String	-	-	-	Comment about the account.
commercial	Boolean	-	-	False	Whether or not this account is for a residential or commercial location.
companyID	Guid	-	Yes	-	The ID of the company to which this account belongs.
companyKey	Guid	-	Yes	-	The ID of the company to which this account belongs.
companyName	String	-	-	-	The country where the account-holder is located
country	String	-	-	-	The country where the account-holder is located
county	String	-	-	-	The county where the account-holder is located
courierRoute	String	-	-	-	The courier route for this account.
createdBy	String	-	Yes	-	The username of the person who created this account.
createdOn	DateTime	-	Yes	-	The date and time that this acocunt was created.
doNotCall	Boolean	-	-	False	Whether or not this person would like to receive phone calls.
doNotEmail	Boolean	-	-	False	Whether or not this person would like to receive emails.
doNotMail	Boolean	-	-	False	Whether or not this person would like to receive mail.
email	String	-	-	-	The email address for this account.
externalRefID	String	-	-	-	This can be the ID of this account in a different system. ie Quickbooks.
fax	String	-	-	-	The fax number for this account
firstName	String	-	-	-	The first name of the account-holder
flagForReview	Boolean	-	-	False	Whether or not this account needs to be reviewed.
lastName	String	-	-	-	The last name of the account-holder
lastStatementDate	DateTime	-	-	-	The date of the most recent statement.
lastJobDate	DateTime	-	Yes	-	The date of the most recent Job.
leadSourceID	Guid	-	-	-	The ID of the Lead Source for this account.
nextJobDate	DateTime	-	Yes	-	The date of the soonest upcoming Job.
note	String	-	-	-	A note about this account
paymentTerm	String	-	-	-	Used to determine when a customer's invoice is past due. (Due Upon Receipt, Net 15, Net 30, Net 60)
phone1	String	-	-	-	The first phone number for this account.
phone1Label	String	-	-	Phone 1	The label for the first phone number.
phone2	String	-	-	-	The second phone number for this account.
phone2Label	String	-	-	Phone 2	The label for the second phone number
phone3	String	-	-	-	The third phone number for this account
phone3Label	String	-	-	Phone 3	The label for the third phone number
reference	String	-	-	-	A custom field.
salutation	String	-	-	-	The title for the account-holder
securityGroup	String	-	-	-	The security group for this account
siteReference	String	-	-	-	-
state	String	-	-	-	The county where the account-holder is located
taxExempt	Boolean	-	-	False	Whether this account is subject to taxes.
taxID	Guid	-	-	-	The identifier of the tax-rate for this account
zip	String	-	-	-	The zip-code where the account-holder is located
timeStamp	DateTime	-	Yes	-	The date and time that this account was last modified.
userName	String	-	Yes	-	The username of the person who last edited this account.

Delete a specific Account

Request the Profile for specified Account

Request a list of Call Activities

Create a new Call Activity

Include the desired properties in the request body to create a call activity. Be sure to provide the required properties.

Properties

Field Name	Data Type	Required	Read Only	Default Value	Description
activityID	Guid	-	Yes	-	The guid identifer for the activity.
accountID	Guid	Yes	-	-	The ID of the account to which this activity applies.
activityCategory	String	-	-	-	The category for this activity.
activityDateTime	DateTime	-	-	-	The date and time that this activity begins.
activitySubType	String	-	-	-	The Sub-Type of the activity.
companyID	Guid	-	Yes	-	The ID of the company to which this activity belongs.
completionDate	DateTime	-	-	-	The date and time that this activity was completed.
dueDate	DateTime	-	-	-	The date and time that this activity must be completed by.
note	String	-	-	-	A note for this activity.
priority	String	-	-	-	The priority level of this activity.
isPrivate	Boolean	-	-	False	Whether or not this activity is private.
startDateTime	DateTime	-	-	-	The date and time that this activity begins.
status	String	-	-	Pending	The status for this activity.
subject	String	Yes	-	-	The title of this activity.
timeStamp	DateTime	-	Yes	-	The Date and Time that this activity was last modified.
userName	String	-	Yes	-	The username of the person who last edited this activity.

Request a specific Call Activity

Update a specific Call Activity.

Provide the desired properties in the request body to update the specified Call Activity.

Properties

Field Name	Data Type	Required	Read Only	Default Value	Description
activityID	Guid	-	Yes	-	The guid identifer for the activity.
accountID	Guid	Yes	-	-	The ID of the account to which this activity applies.
activityCategory	String	-	-	-	The category for this activity.
activityDateTime	DateTime	-	-	-	The date and time that this activity begins.
activitySubType	String	-	-	-	The Sub-Type of the activity.
companyID	Guid	-	Yes	-	The ID of the company to which this activity belongs.
completionDate	DateTime	-	-	-	The date and time that this activity was completed.
dueDate	DateTime	-	-	-	The date and time that this activity must be completed by.
note	String	-	-	-	A note for this activity.
priority	String	-	-	-	The priority level of this activity.
isPrivate	Boolean	-	-	False	Whether or not this activity is private.
startDateTime	DateTime	-	-	-	The date and time that this activity begins.
status	String	-	-	Pending	The status for this activity.
subject	String	Yes	-	-	The title of this activity.
timeStamp	DateTime	-	Yes	-	The Date and Time that this activity was last modified.
userName	String	-	Yes	-	The username of the person who last edited this activity.

Delete a specific Call Activity

Request a list of Credits

Create a new Credit

Include the desired properties in the request body to create a new credit. Be sure to provide the required properties.

Properties

Field Name	Data Type	Required	Read Only	Default Value	Description
creditID	Guid	-	Yes	-	The guid identifer for the credit.
accountID	Guid	Yes	-	-	The ID of the account to which this credit applies.
amount	Decimal	Yes	-	-	The amount of this credit.
companyID	Guid	-	Yes	-	The ID of the company to which this credit belongs.
createdBy	String	-	Yes	-	The username of the person who created this credit.
createdOn	DateTime	-	Yes	-	The date and time that this credit was created.
creditDate	DateTime	-	-	-	The date on which the credit will be applied.
creditMethod	String	-	-	-	The payment method for this credit.
datePosted	DateTime	-	Yes	-	The date that this credit was posted to the account.
memo	String	-	-	-	Memo for this credit.
refNo	String	-	-	-	A reference number.
splits	Array	-	-	-	An array of objects used to apply this payment to one or more orders. Each split object has an amount and an orderID.
timeStamp	DateTime	-	Yes	-	The date and time that this credit was last modified.
userName	String	-	Yes	-	The username of the person who last edited this credit.

Request a specific Credit

Gets the payment-splits for the specified Credit record

Request a list of employees.

Request a specific employee.

Request location tracking data for a specific employee.

Create a new Employee.

Include the desired properties in the request body to create a new employee. Be sure to provide the required properties.

Properties

Field Name	Data Type	Required	Read Only	Default Value	Description
employeeID	Guid	-	Yes	-	The guid identifer for the employee.
companyID	Guid	-	Yes	-	The guid identifer for the employee's company.
title	String	-	-	-	The title of the employee.
dateOfHire	DateTime	-	-	-	The date of hire for the employee.
active	Boolean	-	-	True	Whether or not this employee is active.
hidden	Boolean	-	-	False	Whether this account is currently active.
isTechnician	Boolean	-	-	-	Is this employee a technician.
isCorporate	Boolean	-	-	-	Is this a corporate employee.
isSalesRep	Boolean	-	-	-	Is this employee a sales rep.
firstName	String	Yes	-	-	The first name of the employee.
lastName	String	Yes	-	-	The last name of the employee.
address1	String	-	-	-	Line 1 of the employees address.
address2	String	-	-	-	Line 2 of the employees addres.
city	String	-	-	-	City of employee's address.
state	String	-	-	-	State of employee's address.
zip	String	-	-	-	Zip-code of employee's address.
country	String	-	-	-	Country of employee's address.
email	String	-	-	-	Employee's email address.
phone1	String	-	-	-	First phone number of employee.
phone1Label	String	-	-	-	Label for first phone number of employee.
phone2	String	-	-	-	Second phone number of employee.
phone2Label	String	-	-	-	Label for second phone number of employee.
phone3	String	-	-	-	Third phone number of employee.
phone3Label	String	-	-	-	Label for third phone number of employee.
ASPUserName	String	-	-	-	-

Update a specific Employee

Provide the desired properties in the request body to update the specific employee.

Properties

Field Name	Data Type	Required	Read Only	Default Value	Description
employeeID	Guid	-	Yes	-	The guid identifer for the employee.
companyID	Guid	-	Yes	-	The guid identifer for the employee's company.
title	String	-	-	-	The title of the employee.
dateOfHire	DateTime	-	-	-	The date of hire for the employee.
active	Boolean	-	-	True	Whether or not this employee is active.
hidden	Boolean	-	-	False	Whether this account is currently active.
isTechnician	Boolean	-	-	-	Is this employee a technician.
isCorporate	Boolean	-	-	-	Is this a corporate employee.
isSalesRep	Boolean	-	-	-	Is this employee a sales rep.
firstName	String	-	-	-	The first name of the employee.
lastName	String	-	-	-	The last name of the employee.
address1	String	-	-	-	Line 1 of the employees address.
address2	String	-	-	-	Line 2 of the employees addres.
city	String	-	-	-	City of employee's address.
state	String	-	-	-	State of employee's address.
zip	String	-	-	-	Zip-code of employee's address.
country	String	-	-	-	Country of employee's address.
email	String	-	-	-	Employee's email address.
phone1	String	-	-	-	First phone number of employee.
phone1Label	String	-	-	-	Label for first phone number of employee.
phone2	String	-	-	-	Second phone number of employee.
phone2Label	String	-	-	-	Label for second phone number of employee.
phone3	String	-	-	-	Third phone number of employee.
phone3Label	String	-	-	-	Label for third phone number of employee.
ASPUserName	String	-	-	-	-

Delete a specific employee.

Upload an Image

You can POST to this endpoint with an OrderID and a Base64 string containing the image data. You can also supply location data if desired.

Properties:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Data Type	Required	Read Only
orderID	Guid	yes	no
fileData	String	yes	no
description	String	no	no
fileName	String	yes	no
latitude	Decimal	no	no
longitude	Decimal	no	no

","auth":{"type":"basic","basic":{"password":"{{APIUser|5001|Password}}","username":"{{APIUser|5001|Username}}"},"isInherited":true,"source":{"_postman_id":"e4ce71c2-762a-4230-b0f9-c189d03f5810","id":"e4ce71c2-762a-4230-b0f9-c189d03f5810","name":"ServiceMonster API V1","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","images"],"host":["api","servicemonster","net"],"query":[],"variable":[]}},"response":[],"_postman_id":"0f3987a3-0fc4-4de4-9e7e-23b887d1ddf5"}],"id":"ead694d4-cf24-4055-bf6a-709db066b03f","_postman_id":"ead694d4-cf24-4055-bf6a-709db066b03f","description":"","auth":{"type":"basic","basic":{"password":"{{APIUser|5001|Password}}","username":"{{APIUser|5001|Username}}"},"isInherited":true,"source":{"_postman_id":"e4ce71c2-762a-4230-b0f9-c189d03f5810","id":"e4ce71c2-762a-4230-b0f9-c189d03f5810","name":"ServiceMonster API V1","type":"collection"}}},{"name":"Jobs","item":[{"name":"Jobs","id":"1ca4b404-db19-4f34-ba2c-1617fffae79a","request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://api.servicemonster.net/v1/jobs","description":"

Request a list of Jobs

\n","auth":{"type":"basic","basic":{"password":"{{APIUser|5001|Password}}","username":"{{APIUser|5001|Username}}"},"isInherited":true,"source":{"_postman_id":"e4ce71c2-762a-4230-b0f9-c189d03f5810","id":"e4ce71c2-762a-4230-b0f9-c189d03f5810","name":"ServiceMonster API V1","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","jobs"],"host":["api","servicemonster","net"],"query":[],"variable":[]}},"response":[{"id":"3ae4b268-2dc5-4910-8dff-7e91e51b66ce","name":"Jobs","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://api.servicemonster.net/v1/jobs"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 28 Jan 2023 00:34:23 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"5840"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 15415,\n \"items\": [\n {\n \"row_number\": 1,\n \"jobID\": \"6b2c23bd-195f-11e7-a090-b029e5ab07b7\",\n \"accountID\": \"4640cbfa-9d44-11e6-b8d5-d847350d2ee0\",\n \"actualDateTimeEnd\": \"2000-04-05T08:00:00\",\n \"actualDateTimeStart\": \"2000-04-05T07:00:00\",\n \"companyID\": \"7b63b42c-dfb3-e111-b4ef-0026b97e28d1\",\n \"routeID\": \"458ba682-8777-11e2-8e26-00155d467c2b\",\n \"estDateTimeEnd\": \"2000-04-05T08:00:00\",\n \"estDateTimeStart\": \"2000-04-05T07:00:00\",\n \"jobStatus\": \"Cancelled\",\n \"jobType\": \"Work\",\n \"note\": \"Broken glass and spilled milk\",\n \"orderID\": \"6b2c23ba-195f-11e7-a090-b029e5ab07b7\",\n \"timeStamp\": \"2018-04-24T12:25:11.797\",\n \"userName\": \"ServiceMonster\",\n \"onWaitlist\": false,\n \"techs\": \"Tech 1, Tech 2, Tech 3\"\n },\n {\n \"row_number\": 2,\n \"jobID\": \"60f3198c-1ae4-11e7-a090-b029e5ab07b7\",\n \"accountID\": \"4099543f-96ea-11e9-baeb-db9529528bd6\",\n \"actualDateTimeEnd\": \"2000-06-07T01:00:00\",\n \"actualDateTimeStart\": \"2000-06-07T00:00:00\",\n \"companyID\": \"7b63b42c-dfb3-e111-b4ef-0026b97e28d1\",\n \"routeID\": \"458ba682-8777-11e2-8e26-00155d467c2b\",\n \"estDateTimeEnd\": \"2000-06-07T01:00:00\",\n \"estDateTimeStart\": \"2000-06-07T00:00:00\",\n \"jobStatus\": \"Cancelled\",\n \"jobType\": \"Work\",\n \"orderID\": \"5afaf371-1ae4-11e7-a090-b029e5ab07b7\",\n \"timeStamp\": \"2018-04-24T12:25:11.857\",\n \"userName\": \"ServiceMonster\",\n \"onWaitlist\": false,\n \"techs\": \"Tech 1\"\n },\n {\n \"row_number\": 3,\n \"jobID\": \"95306d02-1ed3-11e7-a090-b029e5ab07b7\",\n \"accountID\": \"95306cf7-1ed3-11e7-a090-b029e5ab07b7\",\n \"actualDateTimeEnd\": \"2000-11-07T01:00:00\",\n \"actualDateTimeStart\": \"2000-11-07T00:00:00\",\n \"companyID\": \"7b63b42c-dfb3-e111-b4ef-0026b97e28d1\",\n \"routeID\": \"458ba682-8777-11e2-8e26-00155d467c2b\",\n \"estDateTimeEnd\": \"2000-11-07T01:00:00\",\n \"estDateTimeStart\": \"2000-11-07T00:00:00\",\n \"jobStatus\": \"Cancelled\",\n \"jobType\": \"Work\",\n \"orderID\": \"95306cfe-1ed3-11e7-a090-b029e5ab07b7\",\n \"timeStamp\": \"2018-04-24T12:25:11.92\",\n \"userName\": \"ServiceMonster\",\n \"onWaitlist\": false,\n \"techs\": \"Tech 1, Tech 3\"\n },\n {\n \"row_number\": 4,\n \"jobID\": \"f8550842-1413-11e9-9adf-c447bb73b9d0\",\n \"accountID\": \"411aabdb-4b99-11e2-bf0a-00155d467c2b\",\n \"actualDateTimeEnd\": \"2001-07-31T15:30:00\",\n \"actualDateTimeStart\": \"2001-07-31T12:30:00\",\n \"companyID\": \"7b63b42c-dfb3-e111-b4ef-0026b97e28d1\",\n \"routeID\": \"3511ace9-f899-11e8-9adf-c447bb73b9d0\",\n \"estDateTimeEnd\": \"2001-07-31T15:30:00\",\n \"estDateTimeStart\": \"2001-07-31T12:30:00\",\n \"jobStatus\": \"Scheduled\",\n \"jobType\": \"Work\",\n \"orderID\": \"f855083f-1413-11e9-9adf-c447bb73b9d0\",\n \"timeStamp\": \"2019-01-10T01:39:28.357\",\n \"userName\": \"servicemonster\",\n \"onWaitlist\": false\n },\n {\n \"row_number\": 5,\n \"jobID\": \"a770445d-9091-11ea-afe1-a699ad1ebdd6\",\n \"accountID\": \"c1b9f02f-315a-11ea-b228-94ccf8e56dd6\",\n \"actualDateTimeEnd\": \"2005-07-24T11:00:00\",\n \"actualDateTimeStart\": \"2005-07-24T10:00:00\",\n \"companyID\": \"7b63b42c-dfb3-e111-b4ef-0026b97e28d1\",\n \"routeID\": \"c0f621d3-acc7-11e9-a2a0-b2b59c3837cf\",\n \"estDateTimeEnd\": \"2005-07-24T11:00:00\",\n \"estDateTimeStart\": \"2005-07-24T10:00:00\",\n \"jobStatus\": \"Scheduled\",\n \"jobType\": \"Work\",\n \"orderID\": \"5c378c2f-8e53-11ea-afe1-a699ad1ebdd6\",\n \"timeStamp\": \"2020-05-07T13:36:43.447\",\n \"userName\": \"jmonster15\",\n \"onWaitlist\": false,\n \"techs\": \"Tech Plus, Tech 4, Tech 2, Tech 8\"\n },\n {\n \"row_number\": 6,\n \"jobID\": \"c4ffa177-9091-11ea-837c-a12965d10fc8\",\n \"accountID\": \"60f5a94a-1dec-e111-834a-002590274606\",\n \"actualDateTimeEnd\": \"2005-07-24T11:00:00\",\n \"actualDateTimeStart\": \"2005-07-24T10:30:00\",\n \"companyID\": \"7b63b42c-dfb3-e111-b4ef-0026b97e28d1\",\n \"routeID\": \"d058954c-d968-11e9-b8a4-d528a59d56d7\",\n \"estDateTimeEnd\": \"2005-07-24T11:00:00\",\n \"estDateTimeStart\": \"2005-07-24T10:30:00\",\n \"jobStatus\": \"Scheduled\",\n \"jobType\": \"Work\",\n \"orderID\": \"169e5409-8bc3-11ea-bbcb-873da4f37bc8\",\n \"timeStamp\": \"2020-05-07T13:37:29.567\",\n \"userName\": \"jmonster15\",\n \"onWaitlist\": false,\n \"techs\": \"Tech 4\"\n },\n {\n \"row_number\": 7,\n \"jobID\": \"d9053dca-9091-11ea-9238-ee65d7a3efc8\",\n \"accountID\": \"c1b9f02f-315a-11ea-b228-94ccf8e56dd6\",\n \"actualDateTimeEnd\": \"2005-07-25T09:00:00\",\n \"actualDateTimeStart\": \"2005-07-25T08:30:00\",\n \"companyID\": \"7b63b42c-dfb3-e111-b4ef-0026b97e28d1\",\n \"routeID\": \"d058954c-d968-11e9-b8a4-d528a59d56d7\",\n \"estDateTimeEnd\": \"2005-07-25T09:00:00\",\n \"estDateTimeStart\": \"2005-07-25T08:30:00\",\n \"jobStatus\": \"Scheduled\",\n \"jobType\": \"Work\",\n \"orderID\": \"7013b9fe-8e52-11ea-a71c-95ed8e0828c8\",\n \"timeStamp\": \"2020-05-07T13:38:00.143\",\n \"userName\": \"jmonster15\",\n \"onWaitlist\": false,\n \"techs\": \"Tech 8, Tech 7\"\n },\n {\n \"row_number\": 8,\n \"jobID\": \"f7c32e4f-1dec-e111-834a-002590274606\",\n \"accountID\": \"e6e9a94a-1dec-e111-834a-002590274606\",\n \"actualDateTimeEnd\": \"2006-10-01T15:00:00\",\n \"actualDateTimeStart\": \"2006-10-01T13:00:00\",\n \"companyID\": \"7b63b42c-dfb3-e111-b4ef-0026b97e28d1\",\n \"routeID\": \"e5108e4f-1dec-e111-834a-002590274606\",\n \"estDateTimeEnd\": \"2006-10-01T15:00:00\",\n \"estDateTimeStart\": \"2006-10-01T13:00:00\",\n \"jobStatus\": \"Complete\",\n \"jobType\": \"Work\",\n \"note\": \"Side door entrance\",\n \"orderID\": \"575fa84d-1dec-e111-834a-002590274606\",\n \"timeStamp\": \"2019-08-02T15:57:57.387\",\n \"userName\": \"pfsupport\"\n },\n {\n \"row_number\": 9,\n \"jobID\": \"fac32e4f-1dec-e111-834a-002590274606\",\n \"accountID\": \"e1e9a94a-1dec-e111-834a-002590274606\",\n \"actualDateTimeEnd\": \"2006-10-03T12:30:00\",\n \"actualDateTimeStart\": \"2006-10-03T10:30:00\",\n \"companyID\": \"7b63b42c-dfb3-e111-b4ef-0026b97e28d1\",\n \"routeID\": \"e6108e4f-1dec-e111-834a-002590274606\",\n \"estDateTimeEnd\": \"2006-10-03T12:30:00\",\n \"estDateTimeStart\": \"2006-10-03T10:30:00\",\n \"jobStatus\": \"Cancelled\",\n \"jobType\": \"Work\",\n \"orderID\": \"5a5fa84d-1dec-e111-834a-002590274606\",\n \"timeStamp\": \"2018-04-24T12:25:12.03\",\n \"userName\": \"ServiceMonster\",\n \"techs\": \"Tech Extra\"\n },\n {\n \"row_number\": 10,\n \"jobID\": \"f9c32e4f-1dec-e111-834a-002590274606\",\n \"accountID\": \"efe9a94a-1dec-e111-834a-002590274606\",\n \"actualDateTimeEnd\": \"2006-10-03T13:00:00\",\n \"actualDateTimeStart\": \"2006-10-03T11:00:00\",\n \"companyID\": \"7b63b42c-dfb3-e111-b4ef-0026b97e28d1\",\n \"routeID\": \"e5108e4f-1dec-e111-834a-002590274606\",\n \"estDateTimeEnd\": \"2006-10-03T13:00:00\",\n \"estDateTimeStart\": \"2006-10-03T11:00:00\",\n \"jobStatus\": \"Cancelled\",\n \"jobType\": \"Work\",\n \"orderID\": \"595fa84d-1dec-e111-834a-002590274606\",\n \"timeStamp\": \"2018-04-24T12:25:12.077\",\n \"userName\": \"ServiceMonster\"\n }\n ]\n}"}],"_postman_id":"1ca4b404-db19-4f34-ba2c-1617fffae79a"},{"name":"Jobs","id":"a7cad47c-a7af-4af1-91e6-c961380382d6","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"accountID\":\"GUID\",\n\t\"routeID\":\"GUID\",\n\t\"estDateTimeEnd\":\"DateTime\",\n\t\"estDateTimeStart\":\"DateTime\",\n\t\"orderID\":\"GUID\"\n}"},"url":"https://api.servicemonster.net/v1/jobs","description":"

Create a new Job

Include the desired properties in the request body to create a new Job. Be sure to provide the required properties.

Properties

Field Name	Data Type	Required	Read Only	Default Value	Description
jobID	Guid	-	Yes	-	The GUID identifier for this job.
accountID	Guid	Yes	-	-	The GUID of the account that this job is for.
actualDateTimeEnd	DateTime	-	-	-	When this job actually ended.
actualDateTimeStart	DateTime	-	-	-	When this job actually began.
colorOverride	String	-	-	-	The color that this job will appear as if not using default.
companyID	Guid	-	Yes	-	The ID of the company to which this job belongs.
createdBy	String	-	Yes	-	The username of the person who created this job.
createdOn	DateTime	-	Yes	-	The date and time that this job was created.
routeID	Guid	Yes	-	-	The ID of the route that will be used on this job.
estDateTimeEnd	DateTime	Yes	-	-	The date and time at which this job is estimated to end.
estDateTimeStart	DateTime	Yes	-	-	The date and time at which this job is estimated to begin.
jobStatus	String	-	-	Scheduled	The status of this job.
jobType	String	-	-	Work	What type of job this is.
note	String	-	-	-	A user-defined note for this job.
orderID	Guid	Yes	-	-	The ID of the Order for this job.
timeStamp	DateTime	-	Yes	-	The date and time that this job was last modified.
userName	String	-	Yes	-	-

Request a specific job

Update a specific job

Provide the desired properties in the request body to update the specified Job.

Properties

Field Name	Data Type	Required	Read Only	Default Value	Description
jobID	Guid	-	Yes	-	The GUID identifier for this job.
accountID	Guid	Yes	-	-	The GUID of the account that this job is for.
actualDateTimeEnd	DateTime	-	-	-	When this job actually ended.
actualDateTimeStart	DateTime	-	-	-	When this job actually began.
colorOverride	String	-	-	-	The color that this job will appear as if not using default.
companyID	Guid	-	Yes	-	The ID of the company to which this job belongs.
createdBy	String	-	Yes	-	The username of the person who created this job.
createdOn	DateTime	-	Yes	-	The date and time that this job was created.
routeID	Guid	Yes	-	-	The ID of the route that will be used on this job.
estDateTimeEnd	DateTime	Yes	-	-	The date and time at which this job is estimated to end.
estDateTimeStart	DateTime	Yes	-	-	The date and time at which this job is estimated to begin.
jobStatus	String	-	-	Scheduled	The status of this job.
jobType	String	-	-	Work	What type of job this is.
note	String	-	-	-	A user-defined note for this job.
orderID	Guid	Yes	-	-	The ID of the Order for this job.
timeStamp	DateTime	-	Yes	-	The date and time that this job was last modified.
userName	String	-	Yes	-	-

Delete a specific job

Request a list of Lead Sources

Create a new Lead Source

Include the desired properties in the request body to create a new lead source. Be sure to provide the required properties.

Properties

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Data Type	Required	Read Only	Default Value	Description
campaignID	Guid	-	Yes	-	The GUID ID for this lead-source.
active	Boolean	-	-	True	Whether or not this lead-source is active.
category	String	-	Yes	-	The category for this lead-source.
companyID	Guid	-	Yes	-	The ID of the company to which this lead-source belongs.
description	String	-	-	-	A description for this lead-source
fmsCampaignID	Integer	-	-	-	The ID of the FillMySchedule campaign that is related to this lead-source.
name	String	Yes	-	-	A name for this lead-source.
runOptionsXml	String	-	-	-	An XML file that defines the run option for this lead-source.
timeStamp	DateTime	-	-	-	The time and date that this lead-source was last modified.
userName	String	-	-	-	The username of the person who last modified this lead-source.

Request a specific Lead Source

Update a specific Lead Source

Provide the desired properties in the request body to update the specified Lead Source.

Properties

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Data Type	Required	Read Only	Default Value	Description
campaignID	Guid	-	Yes	-	The GUID ID for this lead-source.
active	Boolean	-	-	True	Whether or not this lead-source is active.
category	String	-	Yes	LeadSource	The category for this lead-source.
companyID	Guid	-	Yes	-	The ID of the company to which this lead-source belongs.
description	String	-	-	-	A description for this lead-source
fmsCampaignID	Integer	-	-	-	The ID of the FillMySchedule campaign that is related to this lead-source.
name	String	Yes	-	-	A name for this lead-source.
runOptionsXml	String	-	-	-	An XML file that defines the run option for this lead-source.
timeStamp	DateTime	-	-	-	The time and date that this lead-source was last modified.
userName	String	-	-	-	The username of the person who last modified this lead-source.

Delete a specific Lead Source

Create a new Line Item

Include the desired properties in the request body to create a Line Item. Be sure to provide the required properties.

Properties

Field Name	Data Type	Required	Read Only	Default Value	Description
lineItemID	Guid	-	Yes	-	The GUID for this line item.
companyID	Guid	-	Yes	-	The ID of the company to which this line-item belongs.
itemID	Guid	No	-	-	The GUID for the Order Item from which this Line Item is derived. If no ItemID is supplied, a Price and Quantity can be supplied to create an ad hoc Line Item.
orderID	Guid	Yes	-	-	The GUID of the order to which this line-item belongs.
price	Decimal	-	-	-	The price for this line-item.
quantity	Decimal	-	-	-	The quantity of items on this line-item.
rowIndex	Integer	-	-	-	The index of the row for this line-item.
serviceDate	String	-	-	-	The date that the service described on the line-item was performed.
taxed	Boolean	-	-	False/Derived	Whether or not tax is applicable to this line-item. If an ItemID is supplied, the default value will be taken from the Order Item.
total	Decimal	-	-	-	The total cost for this line-item.
upsale	Boolean	-	-	False/Derived	Whether or not this line-item is an upsell. If an ItemID is supplied, the default value will be taken from the Order Item.
description	String	-	-	-	If an ItemID is supplied, the default value will be taken from the Order Item.

Create a new Line Item

Include the desired properties in the request body to create a Line Item. Be sure to provide the required properties.

Properties

Field Name	Data Type	Required	Read Only	Default Value	Description
lineItemID	Guid	-	Yes	-	The GUID for this line item.
companyID	Guid	-	Yes	-	The ID of the company to which this line-item belongs.
itemID	Guid	Yes	-	-	The GUID for the item on this line-item.
orderID	Guid	Yes	-	-	The GUID of the order to which this line-item belongs.
price	Decimal	-	-	-	The price for this line-item.
quantity	Decimal	-	-	-	The quantity of items on this line-item.
rowIndex	Integer	-	-	-	The index of the row for this line-item.
serviceDate	String	-	-	-	The date that the service described on the line-item was performed.
taxed	Boolean	-	-	False	Whether or not tax is applicable to this line-item.
total	Decimal	-	-	-	The total cost for this line-item.
upsale	Boolean	-	-	False	Whether or not this line-item is an upsell.

Request a specific Line Item

Update a specific Line Item

Provide the desired properties in the request body to update the specified Line Item.

Properties

Field Name	Data Type	Required	Read Only	Default Value	Description
lineItemID	Guid	-	Yes	-	The GUID for this line item.
companyID	Guid	-	Yes	-	The ID of the company to which this line-item belongs.
itemID	Guid	Yes	-	-	The GUID for the item on this line-item.
orderID	Guid	Yes	-	-	The GUID of the order to which this line-item belongs.
price	Decimal	-	-	-	The price for this line-item.
quantity	Decimal	-	-	-	The quantity of items on this line-item.
rowIndex	Integer	-	-	-	The index of the row for this line-item.
serviceDate	String	-	-	-	The date that the service described on the line-item was performed.
taxed	Boolean	-	-	False	Whether or not tax is applicable to this line-item.
total	Decimal	-	-	-	The total cost for this line-item.
upsale	Boolean	-	-	False	Whether or not this line-item is an upsell.

Delete a specific Line Item

Retrieves the List Items for the specified List

Provide the list name in the url to retrieve the list items for the specified list.

Properties

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Data Type	Required	Read Only	Default Value	Description
listItemID	Guid	-	Yes	-	The GUID ID for this List Item.
value	String	-	Yes	-	The value for this List Item

List Names

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

List Name
account
account
activity
activity
activity
activity
activity
Order
Order
OrderItem

Get the list values that correspond to the values in SM6 Settings > Picklists

Supply the list name as it is displayed in SM6 and URL encoded. Omit any slashes and extra spaces.

eg: \"Products / Services Groups\" should be supplied as /lists/products%20services%20groups

\n","_postman_id":"dfadec09-c61b-4b3c-aa61-cf6df46f289e","auth":{"type":"basic","basic":{"password":"{{APIUser|5001|Password}}","username":"{{APIUser|5001|Username}}"},"isInherited":true,"source":{"_postman_id":"e4ce71c2-762a-4230-b0f9-c189d03f5810","id":"e4ce71c2-762a-4230-b0f9-c189d03f5810","name":"ServiceMonster API V1","type":"collection"}}},{"name":"Mail Activities","item":[{"name":"Mail Activities","id":"a32f04f7-5c6c-4187-ac00-c6fcf83b10b6","request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://api.servicemonster.net/v1/mailactivities","description":"

Request a list of Mail Activities

Request a specific Mail Activity

Request a list of Notes

Create a new Note.

Creates an Activity of the type Note that can be attached to an Account, an Order, or a Site.

Allowed Roles

Administrator
Manager
SuperUser
SuperTech
Technician

Properties

Field Name	Data Type	Required	Read Only	Default Value	Description
activityID	Guid	No	Yes	-	The ID for this Note.
companyID	Guid	No	Yes	-	The ID for this Company.
accountID	Guid	No	No	-	The ID of the Account to which this Note belongs.
orderID	Guid	No	No	-	The ID of the Order to which this Note belongs.
siteID	Guid	No	No	-	The ID of the Site to which this Note belongs. (note: you can not supply both a siteID and an orderID)
subject	String	Yes	No	-	Subject of the Note.
note	String	No	No	-	The body of the Note.
showOnSchedule	Boolean	No	No	-	Whether or not this Note should be shown on the schedule.
startDateTime	DateTime	No*	No	-	Note start time. *This is Required if showOnSchedule is True.
endDateTime	DateTime	No*	No	-	Note end time. *This is Required if showOnSchedule is True.
routeID	Guid	No*	No	-	The ID of the Route on which this Note is shown on the schedule. *This is Required if showOnSchedule is True.
userName	String	No	Yes	-	UserName of the user who last updated this record
timeStamp	DateTime	No	Yes	-	Date this record was last updated.

Request a specific Note

Request a list of Orders

Create a new Order

Include the desired properties in the request body to create a new Order. Be sure to provide the required properties.

Properties

Field Name	Data Type	Required	Read Only	Default Value	Description
orderID	Guid	-	Yes	-	The Order record identifier.
accountID	Guid	Yes	-	-	The ID of the Account to which this Order belongs.
actionItem	String	-	-	-	User-defined field for work order actions. ie Moving Furniture.
companyID	Guid	-	-	-	The ID of the company to which this order belongs.
leadsourceID	Guid	-	-	-	The ID of the Lead Source to which this order belongs.
correction	Decimal	-	-	-	A value used to adjust the order's total.
createdBy	String	-	Yes	-	The username of the person who created this order.
createdOn	DateTime	-	Yes	-	The date and time that this order was created.
dateCompleted	DateTime	-	-	-	The date that this order was completed, populated automatically.
dateCreated	DateTime	-	-	-	The date and time that this order was created. Can be changed by user.
dateOfLoss	DateTime	-	-	-	Date that damage or property-loss occurred.
datePosted	DateTime	-	-	-	The date that this order was posted.
discountPercent	Decimal	-	-	-	What percent to discount this order, if any. (0-100)
dueDate	DateTime	-	Yes	-	The date by which this order is due.
externalRefID	String	-	-	-	Hidden field can be used to store the ID that this order uses in a different system. ie Quickbooks.
flagForReview	Boolean	-	-	False	Whether or not this order needs to be reviewed.
grandTotal	Decimal	-	-	-	Total after Tax
group	String	-	-	-	Commonly used to categorize the orders for accounting or marketing purposes.
lineItems	Array				An array of LIneItem objects
note	String	-	-	-	A user-defined note field for this order.
orderNumber	Integer	-	-	-	The order number that is visible to the user.
orderType	String	-	-	Work Order	What type of order this is. (Work Order, Invoice, Estimate, Voided)
originalType	String	-	Yes	-	What type of order this was when it was created.
postToAccounting	Boolean	-	-	False	Whether or not this order will be posted to accounting.
printJobStartDateTime	DateTime	-	-	-	An optional date field that will override the order print out's job-date.
printStyleID	Guid	-	-	-	The ID of the print-style to be used for this order.
RefNumber	String	-	-	-	Used to tie this order to another record.
salesRepID	Guid	-	-	-	The ID of the sales rep who placed this order.
siteID	Guid	Yes	-	-	The ID of the site for this order.
subGroup	String	-	-	-	-
taxID	Guid	-	-	-	The ID of the tax-rate that this order uses.
taxRate	Decimal	-	-	-	The decimal tax-rate that this order uses if a taxID is not supplied.
timeStamp	DateTime	-	Yes	-	The date and time that this order was last modified.
userName	String	-	Yes	-	The username of the person who last modified this order.

Request a specific Order

Update a specific Order

Provide the desired properties in the request body to update the specified Order.

Properties

Field Name	Data Type	Required	Read Only	Default Value	Description
orderID	Guid	-	Yes	-	The order record identifier.
accountID	Guid	Yes	-	-	The ID of the account to which this order belongs.
actionItem	String	-	-	-	User-defined field for work order actions. ie Moving Furniture.
companyID	Guid	-	-	-	The ID of the company to which this order belongs.
correction	Decimal	-	-	-	A value used to adjust the order's total.
createdBy	String	-	Yes	-	The username of the person who created this order.
createdOn	DateTime	-	Yes	-	The date and time that this order was created.
dateCompleted	DateTime	-	-	-	The date that this order was completed, populated automatically.
dateCreated	DateTime	-	-	-	The date and time that this order was created. Can be changed by user.
dateOfLoss	DateTime	-	-	-	Date that damage or property-loss occurred.
datePosted	DateTime	-	-	-	The date that this order was posted.
discountPercent	Decimal	-	-	-	What percent to discount this order, if any. (0-100)
dueDate	DateTime	-	Yes	-	The date by which this order is due.
externalRefID	String	-	-	-	Hidden field can be used to store the ID that this order uses in a different system. ie Quickbooks.
flagForReview	Boolean	-	-	False	Whether or not this order needs to be reviewed.
group	String	-	-	-	Commonly used to categorize the orders for accounting or marketing purposes.
note	String	-	-	-	A user-defined note field for this order.
orderNumber	Integer	-	-	-	The order number that is visible to the user.
orderType	String	-	-	Work Order	What type of order this is. (Work Order, Invoice, Estimate, Voided)
originalType	String	-	Yes	-	What type of order this was when it was created.
postToAccounting	Boolean	-	-	False	Whether or not this order will be posted to accounting. NOTE: This is the OPPOSITE of the \"posted\" field in ServiceMonster.
printJobStartDateTime	DateTime	-	-	-	An optional date field that will override the order print out's job-date.
printStyleID	Guid	-	-	-	The ID of the print-style to be used for this order.
RefNumber	String	-	-	-	Used to tie this order to another record.
salesRepID	Guid	-	-	-	The ID of the sales rep who placed this order.
siteID	Guid	Yes	-	-	The ID of the site for this order.
subGroup	String	-	-	-	-
taxID	Guid	-	-	-	The ID of the tax-rate that this order uses.
taxRate	Decimal	-	-	-	The decimal tax-rate that this order uses if a taxID is not supplied.
timeStamp	DateTime	-	Yes	-	The date and time that this order was last modified.
userName	String	-	Yes	-	The username of the person who last modified this order.

Delete a specific Order

Request a PDF representation of a specific Order

Request a list of Order Items

Create a new Order Item

Include the desired properties in the request body to create an Order Item. Be sure to provide the required properties.

Properties

Field Name	Data Type	Required	Read Only	Default Value	Description
itemID	Guid	-	Yes	-	The ID of the Order Item.
active	Boolean	-	-	True	Whether or not this Order Item is able to be put on orders.
avgTime	Decimal	-	-	-	The amount of time (in hours) that this Order Item takes to complete. Only applies to Services.
commissionable	Boolean	-	-	False	Whether or not the Sales Rep will receive a commission for this Order Item.
companyID	Guid	-	Yes	-	The ID of the company to which this Order Item belongs.
description	String	-	-	-	A summary of this product or service
itemType	String	-	-	-	The type of the Order Item.
itemGroup	String	-	-	-	The group of the order item.
name	String	Yes	-	-	The name of the order otem.
price	Decimal	-	-	0.00	The price that will be set on a Line Item when this Order Item's OrderItemID is supplied, and a Price is not explicitly specified.
quantity	Decimal	-	-	1	The quantity of the order item.
taxed	Boolean	-	-	True	-
unitOfMeasure	String	-	-	-	-
userName	String	-	-	-	-
priceLocked	Boolean	-	-	-	-
addToFavorites	Boolean	-	-	false	-
upsaleItem	Boolean	-	-	false	-
subGroup	String	-	-	-	-
taxGroup	String	-	-	-	-
tags	String	-	-	-	-
priceList	String	-	-	-	-
quickCode	String	-	-	-	-

Request a specific Order Item

Update a specific Order Item

Include the desired properties in the request body to update an Order Item.

Properties

Field Name	Data Type	Required	Read Only	Default Value	Description
itemID	Guid	-	Yes	-	The ID of the Order Item.
active	Boolean	-	-	True	Whether or not this Order Item is able to be put on orders.
avgTime	Decimal	-	-	-	The amount of time (in hours) that this Order Item takes to complete. Only applies to Services.
commissionable	Boolean	-	-	False	Whether or not the Sales Rep will receive a commission for this Order Item.
companyID	Guid	-	Yes	-	The ID of the company to which this Order Item belongs.
description	String	-	-	-	A summary of this product or service
itemType	String	-	-	-	The type of the Order Item.
itemGroup	String	-	-	-	The group of the order item.
name	String	Yes	-	-	The name of the order otem.
price	Decimal	-	-	0.00	The price of the order item.
quantity	Decimal	-	-	1	The quantity of the order item.
taxed	Boolean	-	-	True	-
unitOfMeasure	String	-	-	-	-
userName	String	-	-	-	-
priceLocked	Boolean	-	-	-	-
addToFavorites	Boolean	-	-	false	-
upsaleItem	Boolean	-	-	false	-
subGroup	String	-	-	-	-
taxGroup	String	-	-	-	-
tags	String	-	-	-	-
priceList	String	-	-	-	-
quickCode	String	-	-	-	-

Delete a specific Order Item.

Request a list of Reminders

Request a specific Reminder

Update a specific Reminder

Provide the desired properties in the request body to update the specified Reminder.

Properties

Field Name	Data Type	Required	Read Only	Default Value	Description
reminderID	Guid	-	Yes	-	The guid identifer for the reminder
accountID	Guid	-	-	-	The ID of the account to which this reminder belongs.
companyID	Guid	-	-	-	The ID of the company to which this reminder belongs.
resourceID	Guid	-	-	-	The ID of the resource to be used in this reminder.
endDateTime	DateTime	-	-	-	The date and time at which this reminder ends.
name	String	-	-	-	A name for this reminder.
reminderTemplateID	Guid	-	-	-	The ID of the template that this reminder will use
showOnSchedule	Boolean	-	-	-	Whether or not this reminder will appear on the schedule.
siteID	Guid	-	-	-	The ID of the site to which this reminder is related.
startDateTime	DateTime	-	-	-	The date and time at which this reminder starts.
timeStamp	DateTime	-	-	-	The date and time that this reminder was last modified.
transactionDateTime	DateTime	-	-	-	Used to track when this reminder was dismissed or committed..
userName	String	-	-	-	The username of the person who last modified this reminder.

Delete a specific Reminder

Request a list of Routes

Request a specific Route

Update a specific Route

Provide the desired properties in the request body to update the specified Route.

Properties

Field Name	Data Type	Required	Read Only	Default Value	Description
routeID	Guid	-	Yes	-	The guid identifer for the route
active	Boolean	-	-	True	Whether or not this route is active
companyID	Guid	-	Yes	-	The guid identifer for the route's company
defaultJobDuration	Decimal	-	Yes	-	The default length of time for a job
employeeIDs	Array	-	Yes	-	A list of the IDs for the employees assigned to this Route
imageName	String	-	Yes	-	Name of the image used for this route
name	String	Yes	-	-	Name of this route
phone	String	-	-	-	Phone number for this route
resourceTypes	String	-	-	-	The types of resources used on this route
timeStamp	DateTime	-	Yes	-	Time and date that the route was created or last modified
userName	String	-	Yes	-	Name of the user who last modified this route

","auth":{"type":"basic","basic":{"password":"{{APIUser|5001|Password}}","username":"{{APIUser|5001|Username}}"},"isInherited":true,"source":{"_postman_id":"e4ce71c2-762a-4230-b0f9-c189d03f5810","id":"e4ce71c2-762a-4230-b0f9-c189d03f5810","name":"ServiceMonster API V1","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","routes","{id}"],"host":["api","servicemonster","net"],"query":[],"variable":[]}},"response":[],"_postman_id":"b3b90681-003c-4e9a-8832-cc8d2217d35d"}],"id":"dc7be031-bf8d-414d-808d-fdac2ec38d0b","_postman_id":"dc7be031-bf8d-414d-808d-fdac2ec38d0b","description":"","auth":{"type":"basic","basic":{"password":"{{APIUser|5001|Password}}","username":"{{APIUser|5001|Username}}"},"isInherited":true,"source":{"_postman_id":"e4ce71c2-762a-4230-b0f9-c189d03f5810","id":"e4ce71c2-762a-4230-b0f9-c189d03f5810","name":"ServiceMonster API V1","type":"collection"}}},{"name":"Schedule Items","item":[{"name":"Schedule Items","id":"919f2fc5-c24a-42ae-bdfe-17d91c916f1e","request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://api.servicemonster.net/v1/scheduleitems","description":"

Retrieves a list of Schedule Items for the date range specified.

Also returns the associated item (Job, Activity, Reminder, or Google Event).

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Data Type	Default Value	Description
startDate	DateTime	Current Day	The beginning of the date-range to query
endDate	DateTime	Current Day plus 7 days	The end of the date-range to query

Properties

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Data Type	Required	Read Only	Default Value	Description
ItemID	String	None	Yes	None	The GUID identifier for this schedule item.
ItemType	String	None	Yes	None	The type of schedule item.
routeID	String	None	Yes	None	The ID of the route on which this item is scheduled.
StartDateTime	DateTime	None	Yes	None	The date and time that this schedule item begins.
EndDateTime	DateTime	None	Yes	None	The date and time that this schedule item ends.
TimeStamp	DateTime	None	Yes	None	The date and time that this schedule item ends.
Item	Object	None	Yes	None	Fields specific to the Schedule Item. Properties vary based on ItemType.

","auth":{"type":"basic","basic":{"password":"{{APIUser|5001|Password}}","username":"{{APIUser|5001|Username}}"},"isInherited":true,"source":{"_postman_id":"e4ce71c2-762a-4230-b0f9-c189d03f5810","id":"e4ce71c2-762a-4230-b0f9-c189d03f5810","name":"ServiceMonster API V1","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","scheduleitems"],"host":["api","servicemonster","net"],"query":[],"variable":[]}},"response":[],"_postman_id":"919f2fc5-c24a-42ae-bdfe-17d91c916f1e"}],"id":"4b7f20c6-df03-4bf8-bb4e-c7ec70f38783","event":[{"listen":"prerequest","script":{"id":"985abd0d-56c1-4be0-a394-3f24eba267a8","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b94000d0-214a-4831-ab69-3e10c4bfcef9","type":"text/javascript","exec":[""]}}],"_postman_id":"4b7f20c6-df03-4bf8-bb4e-c7ec70f38783","description":"","auth":{"type":"basic","basic":{"password":"{{APIUser|5001|Password}}","username":"{{APIUser|5001|Username}}"},"isInherited":true,"source":{"_postman_id":"e4ce71c2-762a-4230-b0f9-c189d03f5810","id":"e4ce71c2-762a-4230-b0f9-c189d03f5810","name":"ServiceMonster API V1","type":"collection"}}},{"name":"Scheduling","item":[{"name":"Scheduling","id":"ad79dbcf-d8fa-48f9-9722-b7a0b89ba29d","request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://api.servicemonster.net/v1/scheduling","description":"

Retrieves a list of Schedule Items for the date range specified.

Only returns the data for the schedule event, and a flattened subset of properties from the associated event. Faster than /scheduleItems endpoint.

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Data Type	Default Value	Description
startDate	DateTime	Current Day	The beginning of the date-range to query
endDate	DateTime	Current Day plus 7 days	The end of the date-range to query
routeID	Guid	-	If supplied, will limit the response to items scheduled for this route
getJobColor	Boolean	True	If set to false, the Item Color will not be calculated. This can speed up the response time significantly.

Properties

Field Name	Data Type	Required	Read Only	Default Value	Description
ItemID	String	None	Yes	None	The GUID identifier for this schedule item.
ItemType	String	None	Yes	None	The type of schedule item.
routeID	String	None	Yes	None	The ID of the route on which this item is scheduled.
StartDateTime	DateTime	None	Yes	None	The date and time that this schedule item begins.
EndDateTime	DateTime	None	Yes	None	The date and time that this schedule item ends.
TimeStamp	DateTime	None	Yes	None	The date and time that this schedule item ends.
userName	String	None	Yes	None	Username of last edit.
accountID	GUID	None	Yes	None	The ID of the Account associated with this Schedule Item.
siteID	GUID	None	Yes	None	The ID of the Site where this event takes place.
orderID	GUID	None	Yes	None	The ID of the Order associated with this Schedule Item.
subject	String	None	Yes	None	If the Schedule Item is an Activitiy, this is the Activitie's subject,
note	String	None	Yes	None	If the Schedule Item is an Activitiy, this is the Activitie's note,
status	String	None	Yes	None	If the Schedule Item is a Job, this is the status of the Job.
priority	String	None	Yes	None	If the Schedule Item is a Job, this is the priority of the Job.
itemColor	String	None	Yes	None	This is the color of the event as it would appear on the ServiceMonster schedule.
jobType	String	None	Yes	None	If the Schedule item is a Job, this is the type of Job.
address1	String	None	Yes	None	Address info for the Site associated with this Schedule Item.
address2	String	None	Yes	None	Address info for the Site associated with this Schedule Item.
city	String	None	Yes	None	Address info for the Site associated with this Schedule Item.
state	String	None	Yes	None	Address info for the Site associated with this Schedule Item.
zip	String	None	Yes	None	Address info for the Site associated with this Schedule Item.
country	String	None	Yes	None	Address info for the Site associated with this Schedule Item.
latitude	Decimal	None	Yes	None	Location info for the Site associated with this Schedule Item.
longitude	Decimal	None	Yes	None	Location info for the Site associated with this Schedule Item.
employeeIDs	Array[GUID]	None	Yes	None	The ID(s) of the employee(s) assigned to this Schedule Item.

","auth":{"type":"basic","basic":{"password":"{{APIUser|5001|Password}}","username":"{{APIUser|5001|Username}}"},"isInherited":true,"source":{"_postman_id":"e4ce71c2-762a-4230-b0f9-c189d03f5810","id":"e4ce71c2-762a-4230-b0f9-c189d03f5810","name":"ServiceMonster API V1","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","scheduling"],"host":["api","servicemonster","net"],"query":[],"variable":[]}},"response":[],"_postman_id":"ad79dbcf-d8fa-48f9-9722-b7a0b89ba29d"}],"id":"5e0e780b-80d3-4a2c-84f8-caf8aa036b93","_postman_id":"5e0e780b-80d3-4a2c-84f8-caf8aa036b93","description":"","auth":{"type":"basic","basic":{"password":"{{APIUser|5001|Password}}","username":"{{APIUser|5001|Username}}"},"isInherited":true,"source":{"_postman_id":"e4ce71c2-762a-4230-b0f9-c189d03f5810","id":"e4ce71c2-762a-4230-b0f9-c189d03f5810","name":"ServiceMonster API V1","type":"collection"}}},{"name":"Service Items","item":[{"name":"Service Items","id":"e8fe3046-b898-4a1c-acd7-2ab8e749e34e","request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://api.servicemonster.net/v1/serviceitems","description":"

Request a list of Service Items

Request a specific Service Item

Request a list of Sites

Create a new Site

Include the desired properties in the request body to create a new site. Be sure to provide the required properties.

Properties

Field Name	Data Type	Required	Read Only	Default Value	Description
siteID	Guid	-	Yes	-	The guid identifer for the site
accountID	Guid	Yes	-	-	The ID of the account to which this site belongs.
active	Boolean	-	-	True	Whether or not this site is currently active.
address1	String	-	-	-	The first line of the street address for this site.
address2	String	-	-	-	The second line of the street address for this site.
city	String	-	-	-	The city for this site.
companyID	Guid	-	-	-	The Company ID to which this site belongs.
country	String	-	-	-	The country for this site.
county	String	-	-	-	The county for this site.
courierRoute	String	-	-	-	The courier-route for this site.
externalRefID	String	-	-	-	A user-defined field that can be used to store an ID from another system. ie Quickbooks.
isDefault	Boolean	-	-	False	Whether this site is the account's default site
latitude	Decimal	-	-	-	The latitude of this site's location.
longitude	Decimal	-	-	-	The longitude of this site's location.
name	String	Yes	-	-	This site's name.
note	String	-	-	-	A note for this site.
primaryContactID	Guid	-	-	-	The user ID of the person who is the primary contact.
reference	String	-	-	-	A user-defined field that can store any additional information about the site location.
state	String	-	-	-	The state of this site.
taxExempt	Boolean	-	-	False	Whether or not this site is exempt from taxation.
taxID	Guid	-	-	-	The ID of the tax-rate to be used at this site.
timeStamp	DateTime	-	Yes	-	The date and time that this site was last edited.
userName	String	-	Yes	-	The username of the person who last modified this site.
zip	String	-	-	-	The zip-code for this site.

Request a specific Site

Update a specific Site

Provide the desired properties in the request body to update the specified Site.

Properties

Field Name	Data Type	Required	Read Only	Default Value	Description
siteID	Guid	-	Yes	-	The guid identifer for the site
accountID	Guid	Yes	-	-	The ID of the account to which this site belongs.
active	Boolean	-	-	True	Whether or not this site is currently active.
address1	String	-	-	-	The first line of the street address for this site.
address2	String	-	-	-	The second line of the street address for this site.
city	String	-	-	-	The city for this site.
companyID	Guid	-	-	-	The Company ID to which this site belongs.
country	String	-	-	-	The country for this site.
county	String	-	-	-	The county for this site.
courierRoute	String	-	-	-	The courier-route for this site.
externalRefID	String	-	-	-	A user-defined field that can be used to store an ID from another system. ie Quickbooks.
latitude	Decimal	-	-	-	The latitude of this site's location.
longitude	Decimal	-	-	-	The longitude of this site's location.
name	String	Yes	-	-	This site's name.
note	String	-	-	-	A note for this site.
phone1	string	-	-	-	-
phone1Label	string	-	-	-	-
phone2	string	-	-	-	-
phone2Label	string	-	-	-	-
phone3	string	-	-	-	-
phone3Label	string	-	-	-	-
primaryContactID	Guid	-	-	-	The user ID of the person who is the primary contact.
reference	String	-	-	-	A user-defined field that can store any additional information about the site location.
state	String	-	-	-	The state of this site.
taxExempt	Boolean	-	-	False	Whether or not this site is exempt from taxation.
taxID	Guid	-	-	-	The ID of the tax-rate to be used at this site.
timeStamp	DateTime	-	Yes	-	The date and time that this site was last edited.
userName	String	-	Yes	-	The username of the person who last modified this site.
zip	String	-	-	-	The zip-code for this site.

Delete a specific Site

Request a list of Tasks

Create a new Task

Include the desired properties in the request body to create a new Task. Be sure to provide the required properties.

Properties

Field Name	Data Type	Required	Read Only	Default Value	Description
activityID	Guid	-	Yes	-	The guid identifer for the task
accountID	Guid	-	-	-	The ID of the account to which this task belongs.
activityCategory	String	-	-	-	The category that this task is under.
activityDateTime	DateTime	-	-	-	The date and time that this task will take place.
activitySubType	String	-	-	-	One of a user-defined set of values.
activityType	String	-	-	-	The type of activity, 'Task' in this case.
companyID	Guid	-	Yes	-	The ID of the company to which this task belongs.
completionDate	DateTime	-	-	-	The date by which this task should be completed.
dueDate	DateTime	-	-	-	The date on which this task is due.
endDateTime	DateTime	-	-	-	The date and time on which this task ended.
note	String	-	-	-	A note field for this task.
ownerName	String	-	-	-	The username of this task's owner.
priority	String	-	-	-	The priority of this task.
resourceID	String	-	-	-	The ID of the resource to be used in this task.
showOnSchedule	Boolean	-	-	False	Whether or not this task appears on the schedule.
startDateTime	DateTime	-	-	-	The time and date that this task will begin.
status	String	-	-	-	The current status of this task.
subject	String	Yes	-	-	The subject of this task.
timeStamp	DateTime	-	Yes	-	The time and date that this task was last modified.
userName	String	-	Yes	-	The username of the person who last edited this task.

Request a specific Task.

Update a specific Task

Provide the desired properties in the request body to update the specified Task.

Properties

Field Name	Data Type	Required	Read Only	Default Value	Description
activityID	Guid	-	Yes	-	The guid identifer for the task
accountID	Guid	-	-	-	The ID of the account to which this task belongs.
activityCategory	String	-	-	-	The category that this task is under.
activityDateTime	DateTime	-	-	-	The date and time that this task will take place.
activitySubType	String	-	-	-	One of a user-defined set of values.
activityType	String	-	-	-	The type of activity, 'Task' in this case.
companyID	Guid	-	Yes	-	The ID of the company to which this task belongs.
completionDate	DateTime	-	-	-	The date by which this task should be completed.
dueDate	DateTime	-	-	-	The date on which this task is due.
endDateTime	DateTime	-	-	-	The date and time on which this task ended.
note	String	-	-	-	A note field for this task.
ownerName	String	-	-	-	The username of this task's owner.
priority	String	-	-	-	The priority of this task.
resourceID	String	-	-	-	The ID of the resource to be used in this task.
showOnSchedule	Boolean	-	-	False	Whether or not this task appears on the schedule.
startDateTime	DateTime	-	-	-	The time and date that this task will begin.
status	String	-	-	-	The current status of this task.
subject	String	Yes	-	-	The subject of this task.
timeStamp	DateTime	-	Yes	-	The time and date that this task was last modified.
userName	String	-	Yes	-	The username of the person who last edited this task.

Delete a specific Task

Request a list of Tax Rates

Request a specific Tax Rate

Create a new Web Lead

Include the desired properties in the request body to create a new Web Lead. Be sure to provide the required properties.

For Web Leads, FirstName OR LastName is required. Phone # OR Email is required. You can supply leadSourceID to select an existing Marketing Lead Source. Or you can supply a leadSourceName that will either create a new Lead Source or select one with a matching name. If leadSourceID and leadSourceName are both null the Lead Source is set to \"PF:WebForms\".

Properties

ld Name	Data Type	Required	Max Length	Description
customerFirstName	String	Yes	64	Customer's First Name.
customerLastName	String	Yes	64	Customer's Last Name.
phone	String	Yes	32	-
email	String	Yes	128	-
address1	String	No	64	-
city	String	No	64	-
state	String	No	64	-
zip	String	No	32	-
country	String	-	64	-
note	String	-	4000	-
source	String	-	64	This can be whatever you want. If you have multiple web-forms, you may want to give each one a unique \"source\".
leadSourceID	GUID	No		ID of selected Lead Source
leadSourceName	String	No	64	Name of selected Lead Source (will perform lookup for existing marketing campaigns. Will create new Lead Source if not found.)
leadSourceGroup	String	No	64	This is the name of the Marketing Group that will be applied to this lead. The value must exist in the Marketing Groups picklist before it can be applied to a lead.
services	String	No	256	Customer provided details on servies to be performed
duration	Decimal	No		The length of the job to be created with this lead
routeID	GUID	No		The ID for the route on which to create the job for this lead
preferredTime	String	No	64	Customer provided details on the date they would like this job to be performed (No job created)
selectedTime	DateTime	No		The date and time selected by the customer for this lead's job (Job will be created)
notifyClient	Bool	No		Whether the client should receive an email notification that their lead was submitted. Defaults to true if not supplied.

","auth":{"type":"basic","basic":{"password":"{{APIUser|5001|Password}}","username":"{{APIUser|5001|Username}}"},"isInherited":true,"source":{"_postman_id":"e4ce71c2-762a-4230-b0f9-c189d03f5810","id":"e4ce71c2-762a-4230-b0f9-c189d03f5810","name":"ServiceMonster API V1","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","webleads"],"host":["api","servicemonster","net"],"query":[],"variable":[]}},"response":[],"_postman_id":"d5b017bb-3e9c-4242-9f4c-ea91d4ab3a89"}],"id":"0f9180ce-5012-4abb-b97f-1a696d5767fb","_postman_id":"0f9180ce-5012-4abb-b97f-1a696d5767fb","description":"","auth":{"type":"basic","basic":{"password":"{{APIUser|5001|Password}}","username":"{{APIUser|5001|Username}}"},"isInherited":true,"source":{"_postman_id":"e4ce71c2-762a-4230-b0f9-c189d03f5810","id":"e4ce71c2-762a-4230-b0f9-c189d03f5810","name":"ServiceMonster API V1","type":"collection"}}},{"name":"WebHooks","item":[],"id":"b5d6900a-490d-4255-b957-c72ea66db45c","description":"

API Endpoint URL: https://webapi.servicemonster.net/api/resthooks

ServiceMonster objects for which web hooks can be created:

Account
\n
Order
\n
Site
\n
Job (Appointment)
\n
Lead
\n
Payment
\n

Event Types:

OnCreated
\n
OnUpdated
\n
OnDeleted
\n
OnArchived
\n
OnInvoiced (Order only)
\n

Subscribing to a WebHook

POST to ../api/resthooks/subscriptions/subscribe
\n
Body:
\n

{

\"event”: object_eventType,

“target_url”: the URL that the object data is sent to when the event is triggered**

}

Example Body:

{

“event”: ”order_onUpdated”,

“target_url”: ”https://www.example.com/api/webhooks/{subscriptionId}”

}

Unsubscribing from a WebHook

POST to ../api/resthooks/subscriptions/unsubscribe
\n
Example Body:
\n

{

“target_url”: ”https://www.example.com/api/webhooks/{subscriptionId}”

}

Returning error code 410 to a request from the webhooks server will also cause the webhook subscription to be deactivated

Response Data

The data returned will be the Entity for which the subscription was triggered. (Account, Order, Site, Job or Lead)

Returning EntityType/EventType

**When the subscription is created, you can supply querystring parameters in your “target_url”. Eg:**“target_url”:”https://www.testendpoint.com/webhooks?entityType=account&eventType=updated”

\n","_postman_id":"b5d6900a-490d-4255-b957-c72ea66db45c","auth":{"type":"basic","basic":{"password":"{{APIUser|5001|Password}}","username":"{{APIUser|5001|Username}}"},"isInherited":true,"source":{"_postman_id":"e4ce71c2-762a-4230-b0f9-c189d03f5810","id":"e4ce71c2-762a-4230-b0f9-c189d03f5810","name":"ServiceMonster API V1","type":"collection"}}}],"auth":{"type":"basic","basic":{"password":"{{APIUser|5001|Password}}","username":"{{APIUser|5001|Username}}"}},"event":[{"listen":"prerequest","script":{"id":"638051da-b12b-4431-b22c-eee95d73fd9a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b48d1a37-a162-49be-83db-ae932fcbd5ec","type":"text/javascript","exec":[""]}}]}

About

Getting Started

Using the API

Part 1: Returning a collection

Part 2: Returning a Single Record top

Part 3: Returning Child Collections

Part 4: Parameters

Part 5: Creating a New Record

Part 6: Updating a Record

Creating a Basic Token

Create an API Key

Api User Roles

Create a Basic Token using base64encode

Ajax Example:

GET Parameters

Vendor Information

Overview

Vendor Access Request

Vendor Request Flow

Using Postman

Request a list of Accounts

Create a new Account.

Request a specific Account

Update a specific Account

Delete a specific Account

Request Call Activities related to a specific Account

Request Credits related to a specific Account

Request Mail Activities related to a specific Account

Request Note Activities related to a specific Account

Request Orders related to a specific Account

Request Sites related to a specific Account

Request Tasks related to a specific Account

Request a list of Call Activities

Create a new Call Activity

Request a specific Call Activity

Update a specific Call Activity.

Delete a specific Call Activity

Request a list of Credits

Create a new Credit

Request a specific Credit

Gets the payment-splits for the specified Credit record

Create a new Employee.

Update a specific Employee

Upload an Image

Properties:

Request a list of Jobs

Create a new Job

Request a specific job

Update a specific job

Delete a specific job

Request Timelogs related to a specific Job

Request a list of Lead Sources

Create a new Lead Source

Request a specific Lead Source

Update a specific Lead Source

Delete a specific Lead Source

Create a new Line Item

Create a new Line Item

Request a specific Line Item

Update a specific Line Item

Delete a specific Line Item

Retrieves the List Items for the specified List

Request a list of Mail Activities

Request a specific Mail Activity

Request a list of Notes

Create a new Note.

Request a specific Note

Request a list of Orders

Create a new Order

Request a specific Order

Update a specific Order

Delete a specific Order

Request a list of Call Activities related to a specific Order

Request a list of Credit records related to a specific Order

Request a list of Image URLs related to a specific Order

Gets a list of jobs related to a specific Order

Request a list of Line Items related to a specific Order

Request a list of Mail Activities related to a specific Order

Request a list of Note Activities related to a specific Order

Request a PDF representation of a specific Order