Welcome to the documentation for the serviceminder.io API. All requests must be POST operations with JSON formatted payloads. Each request must also include a valid APIKey parameter. API keys may be generated inside serviceminder.io.

accountingclasses

create

POST https://serviceminder.io/api/accountingclasses/create

Parameter Type Required Comments
NameSearch string Yes
OrganizationId int32 No
AccountingClassId int32 No
Name string Yes
TerritoryID string Yes
PostalCodes String[] Yes
Matches AccountingClassPostalCodes[] Yes
ApiKey string Yes
ResultCode int32 Yes
Message string Yes

get

POST https://serviceminder.io/api/accountingclasses/get

Parameter Type Required Comments
NameSearch string Yes
OrganizationId int32 No
AccountingClassId int32 No
Name string Yes
TerritoryID string Yes
PostalCodes String[] Yes
Matches AccountingClassPostalCodes[] Yes
ApiKey string Yes
ResultCode int32 Yes
Message string Yes

update

POST https://serviceminder.io/api/accountingclasses/update

Parameter Type Required Comments
NameSearch string Yes
OrganizationId int32 No
AccountingClassId int32 No
Name string Yes
TerritoryID string Yes
PostalCodes String[] Yes
Matches AccountingClassPostalCodes[] Yes
ApiKey string Yes
ResultCode int32 Yes
Message string Yes

appointments

book

POST https://serviceminder.io/api/appointments/book

Parameter Type Required Comments
AppointmentId int32 Yes
ContactId int32 Yes
ServiceId int32 Yes
IncludeCompleted boolean No
SearchDate string Yes
TargetDate string Yes
Duration string Yes
Quantity double Yes
Discount decimal No
Timeframe string Yes
SlotWindowDays int32 No
Notes string Yes
NotificationUri string Yes
SkipConflictChecks boolean No
CallCenterTransactionId int32 No
Slots AppointmentSlot[] Yes
AddOnParts AddOnPart[] Yes
NotificationOptions String[] Yes
RootProposalId int32 No
CancelReasonId int32 Yes
ApiKey string Yes
ResultCode int32 Yes
Message string Yes

cancel

POST https://serviceminder.io/api/appointments/cancel

Parameter Type Required Comments
AppointmentId int32 Yes
ContactId int32 Yes
ServiceId int32 Yes
IncludeCompleted boolean No
SearchDate string Yes
TargetDate string Yes
Duration string Yes
Quantity double Yes
Discount decimal No
Timeframe string Yes
SlotWindowDays int32 No
Notes string Yes
NotificationUri string Yes
SkipConflictChecks boolean No
CallCenterTransactionId int32 No
Slots AppointmentSlot[] Yes
AddOnParts AddOnPart[] Yes
NotificationOptions String[] Yes
RootProposalId int32 No
CancelReasonId int32 Yes
ApiKey string Yes
ResultCode int32 Yes
Message string Yes

feedback

POST https://serviceminder.io/api/appointments/feedback

Parameter Type Required Comments
HashKey string Yes
Note string Yes
ContactMe boolean Yes
Score int32 No
Positive boolean Yes
Negative boolean Yes
ApiKey string Yes
ResultCode int32 Yes
Message string Yes

find

POST https://serviceminder.io/api/appointments/find

Parameter Type Required Comments
AppointmentId int32 Yes
ContactId int32 Yes
ServiceId int32 Yes
IncludeCompleted boolean No
SearchDate string Yes
TargetDate string Yes
Duration string Yes
Quantity double Yes
Discount decimal No
Timeframe string Yes
SlotWindowDays int32 No
Notes string Yes
NotificationUri string Yes
SkipConflictChecks boolean No
CallCenterTransactionId int32 No
Slots AppointmentSlot[] Yes
AddOnParts AddOnPart[] Yes
NotificationOptions String[] Yes
RootProposalId int32 No
CancelReasonId int32 Yes
ApiKey string Yes
ResultCode int32 Yes
Message string Yes

queue

POST https://serviceminder.io/api/appointments/queue

Parameter Type Required Comments
AppointmentId int32 Yes
ContactId int32 Yes
QueueDate string Yes
Duration string Yes
Quantity double Yes
ServiceId int32 Yes
AddOnParts AddOnPart[] Yes
Demand int32 No
Discount decimal No
Notes string Yes
NotificationUri string Yes
CallCenterTransactionId int32 No
ApiKey string Yes
ResultCode int32 Yes
Message string Yes

quickbook

POST https://serviceminder.io/api/appointments/quickbook

Parameter Type Required Comments
ContactId int32 No
Name string Yes
Company string Yes
Address1 string Yes
Address2 string Yes
City string Yes
State string Yes
Zip string Yes
Country string Yes
PriPhone string Yes
PriPhoneLabel string Yes
AltPhone string Yes
AltPhoneLabel string Yes
Email string Yes
Channel string Yes
ChannelId int32 No
Campaign string Yes
CampaignId int32 No
Category string Yes
DigitalTrackingId string Yes
Unsubscribed boolean Yes
Tags String[] Yes
CustomFields CustomField[] Yes
Service string Yes
ServiceAgentEmail string Yes
AdditionalServiceAgentEmails String[] Yes
ScheduledStart datetime Yes
Duration int32 Yes
Quantity double Yes
Tentative boolean Yes
Confirmed boolean Yes
FirstAvailable boolean Yes
ConfirmationUri string Yes
EnRouteUri string Yes
InternalNotes string Yes
CustomerNotes string Yes
CallCenterTransactionId int32 No
ApiKey string Yes
ResultCode int32 Yes
Message string Yes

slotsearch

POST https://serviceminder.io/api/appointments/slotsearch

Parameter Type Required Comments
AppointmentId int32 Yes
ContactId int32 Yes
ServiceId int32 Yes
IncludeCompleted boolean No
SearchDate string Yes
TargetDate string Yes
Duration string Yes
Quantity double Yes
Discount decimal No
Timeframe string Yes
SlotWindowDays int32 No
Notes string Yes
NotificationUri string Yes
SkipConflictChecks boolean No
CallCenterTransactionId int32 No
Slots AppointmentSlot[] Yes
AddOnParts AddOnPart[] Yes
NotificationOptions String[] Yes
RootProposalId int32 No
CancelReasonId int32 Yes
ApiKey string Yes
ResultCode int32 Yes
Message string Yes

update

POST https://serviceminder.io/api/appointments/update

Parameter Type Required Comments
AppointmentId int32 Yes
ContactId int32 Yes
ServiceId int32 Yes
IncludeCompleted boolean No
SearchDate string Yes
TargetDate string Yes
Duration string Yes
Quantity double Yes
Discount decimal No
Timeframe string Yes
SlotWindowDays int32 No
Notes string Yes
NotificationUri string Yes
SkipConflictChecks boolean No
CallCenterTransactionId int32 No
Slots AppointmentSlot[] Yes
AddOnParts AddOnPart[] Yes
NotificationOptions String[] Yes
RootProposalId int32 No
CancelReasonId int32 Yes
ApiKey string Yes
ResultCode int32 Yes
Message string Yes

blogs

find

POST https://serviceminder.io/api/blogs/find

Parameter Type Required Comments
NameSearch string Yes
DateSearch string Yes
IdSearch string Yes
Matches Blog[] Yes
ApiKey string Yes
ResultCode int32 Yes
Message string Yes

get

POST https://serviceminder.io/api/blogs/get

Parameter Type Required Comments
NameSearch string Yes
DateSearch string Yes
IdSearch string Yes
Matches Blog[] Yes
ApiKey string Yes
ResultCode int32 Yes
Message string Yes

cancelreasons

all

POST https://serviceminder.io/api/cancelreasons/all

Parameter Type Required Comments
Id int32 No
Matches CancelReason[] Yes
ApiKey string Yes
ResultCode int32 Yes
Message string Yes

channels

all

POST https://serviceminder.io/api/channels/all

Parameter Type Required Comments
Channels Channel[] Yes
ApiKey string Yes
ResultCode int32 Yes
Message string Yes

bulkupdate

POST https://serviceminder.io/api/channels/bulkupdate

Parameter Type Required Comments
Updates CampaignUpdate[] Yes
ApiKey string Yes
ResultCode int32 Yes
Message string Yes

campaigns

POST https://serviceminder.io/api/channels/campaigns

Parameter Type Required Comments
Cities City[] Yes
LeadSourceCategories Channel[] Yes
PostalCodes String[] Yes
Features String[] Yes
Channels Channel[] Yes
NamedTaxRates NamedTaxRate[] Yes
ApiKey string Yes
ResultCode int32 Yes
Message string Yes

contacts

addnote

POST https://serviceminder.io/api/contacts/addnote

Parameter Type Required Comments
ContactId int32 Yes
Note note Yes
ApiKey string Yes
ResultCode int32 Yes
Message string Yes

addtags

POST https://serviceminder.io/api/contacts/addtags

Parameter Type Required Comments
ContactId int32 Yes
TagList Tag[] Yes
ApiKey string Yes
ResultCode int32 Yes
Message string Yes

addupdate

POST https://serviceminder.io/api/contacts/addupdate

Parameter Type Required Comments
NameSearch string Yes
PhoneSearch string Yes
EmailSearch string Yes
IdSearch int32 No
Matches Contact[] Yes
ApiKey string Yes
ResultCode int32 Yes
Message string Yes

listtags

POST https://serviceminder.io/api/contacts/listtags

Parameter Type Required Comments
ContactId int32 Yes
TagList Tag[] Yes
ApiKey string Yes
ResultCode int32 Yes
Message string Yes

locate

POST https://serviceminder.io/api/contacts/locate

Parameter Type Required Comments
NameSearch string Yes
PhoneSearch string Yes
EmailSearch string Yes
IdSearch int32 No
Matches Contact[] Yes
ApiKey string Yes
ResultCode int32 Yes
Message string Yes

logcall

POST https://serviceminder.io/api/contacts/logcall

Parameter Type Required Comments
ContactId int32 No
CallerNumber string Yes
DialedNumber string Yes
CallStart datetime Yes
DurationSeconds int32 Yes
CallId string Yes
Direction int32 Yes
Disposition int32 Yes
ApiKey string Yes
ResultCode int32 Yes
Message string Yes

removetags

POST https://serviceminder.io/api/contacts/removetags

Parameter Type Required Comments
ContactId int32 Yes
TagList Tag[] Yes
ApiKey string Yes
ResultCode int32 Yes
Message string Yes

customfields

all

POST https://serviceminder.io/api/customfields/all

Parameter Type Required Comments
Id int32 No
Matches CustomField[] Yes
ApiKey string Yes
ResultCode int32 Yes
Message string Yes

datasubscriber

clear

POST https://serviceminder.io/api/datasubscriber/clear

Parameter Type Required Comments
ClearThroughId int32 No
EventCount int32 No
Events DataSubscriberEvent[] Yes
ApiKey string Yes
ResultCode int32 Yes
Message string Yes

downloadstatus

POST https://serviceminder.io/api/datasubscriber/downloadstatus

Parameter Type Required Comments
DownloadId string Yes
Records int32 No
Ready boolean Yes
ApiKey string Yes
ResultCode int32 Yes
Message string Yes

fetch

POST https://serviceminder.io/api/datasubscriber/fetch

Parameter Type Required Comments
ClearThroughId int32 No
EventCount int32 No
Events DataSubscriberEvent[] Yes
ApiKey string Yes
ResultCode int32 Yes
Message string Yes

getdownload

POST https://serviceminder.io/api/datasubscriber/getdownload

Parameter Type Required Comments
DownloadId string Yes
ApiKey string Yes
ResultCode int32 Yes
Message string Yes

postalcodes

POST https://serviceminder.io/api/datasubscriber/postalcodes

Parameter Type Required Comments
ClearThroughId int32 No
EventCount int32 No
Events DataSubscriberEvent[] Yes
ApiKey string Yes
ResultCode int32 Yes
Message string Yes

startdownload

POST https://serviceminder.io/api/datasubscriber/startdownload

Parameter Type Required Comments
CreatedFrom datetime No
CreatedThrough datetime No
UpdatedFrom datetime No
UpdatedThrough datetime No
DateFrom datetime No
DateThrough datetime No
Appointments downloadappointmentsettings Yes
Contacts downloadcontactsettings Yes
Invoices downloadinvoicesettings Yes
Proposals downloadproposalsettings Yes
Kind string Yes
DownloadId string Yes
ApiKey string Yes
ResultCode int32 Yes
Message string Yes

organizations

cancel

POST https://serviceminder.io/api/organizations/cancel

Parameter Type Required Comments
OrganizationId int32 No
Name string Yes
PrimaryPhone string Yes
Email string Yes
Website string Yes
Timezone string Yes
StartAddress address Yes
Radius int32 Yes
BillingAddress address Yes
OpenTimeGranularity int32 No
PostalCodes string Yes
ServiceAgents ServiceAgent[] Yes
Services Service[] Yes
Users User[] Yes
ApiKey string Yes
ResultCode int32 Yes
Message string Yes

create

POST https://serviceminder.io/api/organizations/create

Parameter Type Required Comments
OrganizationId int32 No
Name string Yes
PrimaryPhone string Yes
Email string Yes
Website string Yes
Timezone string Yes
StartAddress address Yes
Radius int32 Yes
BillingAddress address Yes
OpenTimeGranularity int32 No
PostalCodes string Yes
ServiceAgents ServiceAgent[] Yes
Services Service[] Yes
Users User[] Yes
ApiKey string Yes
ResultCode int32 Yes
Message string Yes

details

POST https://serviceminder.io/api/organizations/details

Parameter Type Required Comments
OrganizationId int32 No
Name string Yes
PrimaryPhone string Yes
Email string Yes
Website string Yes
Timezone string Yes
StartAddress address Yes
Radius int32 Yes
BillingAddress address Yes
OpenTimeGranularity int32 No
PostalCodes string Yes
ServiceAgents ServiceAgent[] Yes
Services Service[] Yes
Users User[] Yes
ApiKey string Yes
ResultCode int32 Yes
Message string Yes

query

POST https://serviceminder.io/api/organizations/query

Parameter Type Required Comments
PublicName string Yes
InternalName string Yes
LocationId string Yes
Organizations OrganizationDetails[] Yes
ApiKey string Yes
ResultCode int32 Yes
Message string Yes

update

POST https://serviceminder.io/api/organizations/update

Parameter Type Required Comments
OrganizationId int32 No
Name string Yes
PrimaryPhone string Yes
Email string Yes
Website string Yes
Timezone string Yes
StartAddress address Yes
Radius int32 Yes
BillingAddress address Yes
OpenTimeGranularity int32 No
PostalCodes string Yes
ServiceAgents ServiceAgent[] Yes
Services Service[] Yes
Users User[] Yes
ApiKey string Yes
ResultCode int32 Yes
Message string Yes

part

details

POST https://serviceminder.io/api/part/details

Parameter Type Required Comments
Id int32 Yes
ApiKey string Yes
ResultCode int32 Yes
Message string Yes

getdimension

POST https://serviceminder.io/api/part/getdimension

Parameter Type Required Comments
DimensionId int32 Yes
ApiKey string Yes
ResultCode int32 Yes
Message string Yes

getpartdimensions

POST https://serviceminder.io/api/part/getpartdimensions

Parameter Type Required Comments
PartId int32 No
Dimensions string Yes
ApiKey string Yes
ResultCode int32 Yes
Message string Yes

proposal

create

POST https://serviceminder.io/api/proposal/create

Parameter Type Required Comments
Id int32 Yes
ContactId int32 Yes
Date string Yes
Status string Yes
AcceptedDate string Yes
ServiceId int32 Yes
Description string Yes
Duration int32 Yes
BasePrice decimal Yes
UnitPrice decimal Yes
Quantity double Yes
Subtotal decimal Yes
Tax decimal Yes
Taxable boolean Yes
Title string Yes
OwnerUserId int32 No
DepositRate double No
DepositRequired boolean No
SelectedSolution idname Yes
ProposalLines ProposalLine[] Yes
ChangeOrders ProposalSummary[] Yes
BundledProposals ProposalSummary[] Yes
ProposalNotes ProposalNote[] Yes
CustomerNotes string Yes
ApiKey string Yes
ResultCode int32 Yes
Message string Yes

details

POST https://serviceminder.io/api/proposal/details

Parameter Type Required Comments
Id int32 Yes
ContactId int32 Yes
Date string Yes
Status string Yes
AcceptedDate string Yes
ServiceId int32 Yes
Description string Yes
Duration int32 Yes
BasePrice decimal Yes
UnitPrice decimal Yes
Quantity double Yes
Subtotal decimal Yes
Tax decimal Yes
Taxable boolean Yes
Title string Yes
OwnerUserId int32 No
DepositRate double No
DepositRequired boolean No
SelectedSolution idname Yes
ProposalLines ProposalLine[] Yes
ChangeOrders ProposalSummary[] Yes
BundledProposals ProposalSummary[] Yes
ProposalNotes ProposalNote[] Yes
CustomerNotes string Yes
ApiKey string Yes
ResultCode int32 Yes
Message string Yes

query

POST https://serviceminder.io/api/proposal/query

Parameter Type Required Comments
Scope string Yes
FromDate datetime No
ThroughDate datetime No
FromAccepted datetime No
ThroughAccepted datetime No
OwnerUserId int32 No
ContactId int32 No
Skip int32 No
Take int32 No
Count int32 No
Proposals Proposal[] Yes
ApiKey string Yes
ResultCode int32 Yes
Message string Yes

update

POST https://serviceminder.io/api/proposal/update

Parameter Type Required Comments
Id int32 Yes
ContactId int32 Yes
Date string Yes
Status string Yes
AcceptedDate string Yes
ServiceId int32 Yes
Description string Yes
Duration int32 Yes
BasePrice decimal Yes
UnitPrice decimal Yes
Quantity double Yes
Subtotal decimal Yes
Tax decimal Yes
Taxable boolean Yes
Title string Yes
OwnerUserId int32 No
DepositRate double No
DepositRequired boolean No
SelectedSolution idname Yes
ProposalLines ProposalLine[] Yes
ChangeOrders ProposalSummary[] Yes
BundledProposals ProposalSummary[] Yes
ProposalNotes ProposalNote[] Yes
CustomerNotes string Yes
ApiKey string Yes
ResultCode int32 Yes
Message string Yes

serviceagents

all

POST https://serviceminder.io/api/serviceagents/all

Parameter Type Required Comments
Matches ServiceAgent[] Yes
ApiKey string Yes
ResultCode int32 Yes
Message string Yes

services

all

POST https://serviceminder.io/api/services/all

Parameter Type Required Comments
Id int32 No
IncludeParts boolean No
Matches Service[] Yes
ApiKey string Yes
ResultCode int32 Yes
Message string Yes

details

POST https://serviceminder.io/api/services/details

Parameter Type Required Comments
Id int32 No
IncludeParts boolean No
Matches Service[] Yes
ApiKey string Yes
ResultCode int32 Yes
Message string Yes

settings

channelcampaigns

POST https://serviceminder.io/api/settings/channelcampaigns

Parameter Type Required Comments
Cities City[] Yes
LeadSourceCategories Channel[] Yes
PostalCodes String[] Yes
Features String[] Yes
Channels Channel[] Yes
NamedTaxRates NamedTaxRate[] Yes
ApiKey string Yes
ResultCode int32 Yes
Message string Yes

channels

POST https://serviceminder.io/api/settings/channels

Parameter Type Required Comments
Cities City[] Yes
LeadSourceCategories Channel[] Yes
PostalCodes String[] Yes
Features String[] Yes
Channels Channel[] Yes
NamedTaxRates NamedTaxRate[] Yes
ApiKey string Yes
ResultCode int32 Yes
Message string Yes

features

POST https://serviceminder.io/api/settings/features

Parameter Type Required Comments
Cities City[] Yes
LeadSourceCategories Channel[] Yes
PostalCodes String[] Yes
Features String[] Yes
Channels Channel[] Yes
NamedTaxRates NamedTaxRate[] Yes
ApiKey string Yes
ResultCode int32 Yes
Message string Yes

leadsourcecategories

POST https://serviceminder.io/api/settings/leadsourcecategories

Parameter Type Required Comments
Cities City[] Yes
LeadSourceCategories Channel[] Yes
PostalCodes String[] Yes
Features String[] Yes
Channels Channel[] Yes
NamedTaxRates NamedTaxRate[] Yes
ApiKey string Yes
ResultCode int32 Yes
Message string Yes

namedtaxrates

POST https://serviceminder.io/api/settings/namedtaxrates

Parameter Type Required Comments
Cities City[] Yes
LeadSourceCategories Channel[] Yes
PostalCodes String[] Yes
Features String[] Yes
Channels Channel[] Yes
NamedTaxRates NamedTaxRate[] Yes
ApiKey string Yes
ResultCode int32 Yes
Message string Yes

radiuscities

POST https://serviceminder.io/api/settings/radiuscities

Parameter Type Required Comments
Cities City[] Yes
LeadSourceCategories Channel[] Yes
PostalCodes String[] Yes
Features String[] Yes
Channels Channel[] Yes
NamedTaxRates NamedTaxRate[] Yes
ApiKey string Yes
ResultCode int32 Yes
Message string Yes

radiuspostalcodes

POST https://serviceminder.io/api/settings/radiuspostalcodes

Parameter Type Required Comments
Cities City[] Yes
LeadSourceCategories Channel[] Yes
PostalCodes String[] Yes
Features String[] Yes
Channels Channel[] Yes
NamedTaxRates NamedTaxRate[] Yes
ApiKey string Yes
ResultCode int32 Yes
Message string Yes

test

echo

POST https://serviceminder.io/api/test/echo

Parameter Type Required Comments
ApiKey string Yes
ResultCode int32 Yes
Message string Yes

user

all

POST https://serviceminder.io/api/user/all

Parameter Type Required Comments
Matches User[] Yes
ApiKey string Yes
ResultCode int32 Yes
Message string Yes

create

POST https://serviceminder.io/api/user/create

Parameter Type Required Comments
Name string Yes
Email string Yes
MobilePhone string Yes
CreateServiceAgent boolean Yes
Role string Yes
ApiKey string Yes
ResultCode int32 Yes
Message string Yes

Objects

accountingclasspostalcodes

Parameter Type Required Comments
Id int32 No
AccountingClass string Yes
TerritoryID string Yes
PostalCodes String[] Yes

addonpart

Parameter Type Required Comments
PartId int32 Yes
Quantity double Yes
UnitPrice decimal Yes
UnitOfMeasure string Yes
RangePricing boolean No
Discount decimal No
Name string Yes

appointmentslot

Parameter Type Required Comments
ContactId int32 Yes
AppointmentId int32 Yes
DateTime string Yes
DateTimeFormatted string Yes
ServiceAgentId int32 Yes
Quantity double No
Duration int32 No
ServiceAgentName string Yes
DurationFormatted string Yes
ServiceId int32 No
ServiceName string Yes
Discount decimal No
Total decimal No
NotificationUri string Yes
DriveTimeMinutes int32 Yes
DriveTimeWarning boolean Yes
ProposalId int32 Yes
RootProposalId int32 No
AddOnParts AddOnPart[] Yes
CustomProperties dictionary`2 Yes
ApiKey string Yes
ResultCode int32 Yes
Message string Yes

assemblyitem

Parameter Type Required Comments
PartId int32 Yes
PartName string Yes
Quantity decimal Yes

blog

Parameter Type Required Comments
Id int32 Yes
Slug string Yes
OrganizationId int32 Yes
UserId int32 Yes
Title string Yes
Content string Yes
Date datetime Yes
Tags String[] Yes
Summary string Yes
ImageThumbUrl string Yes
ImageFullUrl string Yes
ApiKey string Yes
ResultCode int32 Yes
Message string Yes

campaign

Parameter Type Required Comments
Id int32 Yes
Name string Yes
Description string Yes
Active boolean Yes
CampaignBudgets CampaignBudget[] Yes
CampaignActuals CampaignActual[] Yes

campaignactual

Parameter Type Required Comments
Amount decimal Yes
Year int32 Yes
Month int32 Yes
InvoiceUrl string Yes

campaignbudget

Parameter Type Required Comments
Budget decimal Yes
Type int32 Yes
Year int32 Yes
Month int32 No

campaignupdate

Parameter Type Required Comments
ChannelId int32 Yes
CampaignId int32 No
CampaignName string Yes
Year int32 Yes
Month int32 Yes
BudgetAmount decimal No
BudgetType int32 No
ActualAmount decimal No
InvoiceUrl string Yes
Results string Yes

cancelreason

Parameter Type Required Comments
Id int32 Yes
Reason string Yes

channel

Parameter Type Required Comments
Id int32 Yes
Name string Yes
Description string Yes
Campaigns Campaign[] Yes

city

Parameter Type Required Comments
Name string Yes
PostalCode string Yes

contact

Parameter Type Required Comments
Id int32 Yes
Hash string Yes
Name string Yes
Company string Yes
Address1 string Yes
Address2 string Yes
City string Yes
State string Yes
Zip string Yes
Phone string Yes
AltPhone string Yes
PhoneLabel string Yes
AltPhoneLabel string Yes
Email string Yes
LeadSource string Yes
Channel string Yes
Campaign string Yes
Category string Yes
IsCustomer boolean Yes
Country string Yes
DigitalTrackingId string Yes
ReferredByContactId int32 No
ReferredByHash string Yes
Unsubscribed boolean Yes
Notes Note[] Yes
CustomFields CustomField[] Yes
Tags String[] Yes
OpenInvoices ServiceDocumentLink[] Yes
OpenProposals ServiceDocumentLink[] Yes
ChannelId int32 Yes
CampaignId int32 Yes
IsValid boolean Yes
ApiKey string Yes
ResultCode int32 Yes
Message string Yes

customfield

Parameter Type Required Comments
Id int32 Yes
Name string Yes
Value object Yes
Type int32 Yes
TableType int32 Yes
Phase int32 No
Required boolean Yes
HelpText string Yes
CustomFieldCategory string Yes

datasubscriberevent

Parameter Type Required Comments
Id int32 Yes
QueuedAt datetime Yes
Payload object Yes

namedtaxrate

Parameter Type Required Comments
Id int32 Yes
Name string Yes
TaxRate double Yes

note

Parameter Type Required Comments
Id int32 Yes
Title string Yes
Body string Yes

organizationdetails

Parameter Type Required Comments
Id int32 Yes
PublicName string Yes
InternalName string Yes
PrimaryPhone string Yes
Email string Yes
Website string Yes
Timezone string Yes
StartAddress address Yes
Radius int32 Yes
BillingAddress address Yes
OpenTimeGranularity int32 No
PostalCodes string Yes
LocationID string Yes

part

Parameter Type Required Comments
Id int32 Yes
Name string Yes
Description string Yes
Category string Yes
Taxable boolean Yes
RequiredForService boolean No
ExcludeFromMinimum boolean No
RangePricing boolean Yes
IsActive boolean Yes
SelfSelect boolean Yes
IsAssembly boolean Yes
IsInternal boolean Yes
IsZeroAssemblyItemPrices boolean Yes
UnitPrice decimal Yes
UnitPriceMax decimal No
UnitCost decimal No
UnitDuration int32 No
DurationForQtyUnits int32 No
UnitOfMeasure string Yes
QtyPricing PartQtyPricing[] Yes
AssemblyItems AssemblyItem[] Yes
PartTemplate parttemplate Yes
StoreItemId int32 No

partqtypricing

Parameter Type Required Comments
AtLeast double Yes
LessThan double No
Price double Yes
ExcludeQuantity boolean Yes
OverageMode boolean Yes

pricingband

Parameter Type Required Comments
AtLeast double Yes
LessThan double No
Price double Yes
IsExcludeQuantity boolean Yes
IsOverageMode boolean Yes

proposal

Parameter Type Required Comments
Id int32 Yes
ContactId int32 Yes
Date string Yes
Status string Yes
AcceptedDate string Yes
ServiceId int32 Yes
Description string Yes
Duration int32 Yes
BasePrice decimal Yes
UnitPrice decimal Yes
Quantity double Yes
Subtotal decimal Yes
Tax decimal Yes
Taxable boolean Yes
Title string Yes
OwnerUserId int32 No
DepositRate double No
DepositRequired boolean No
SelectedSolution idname Yes
ProposalLines ProposalLine[] Yes
ChangeOrders ProposalSummary[] Yes
BundledProposals ProposalSummary[] Yes
ProposalNotes ProposalNote[] Yes
CustomerNotes string Yes
ApiKey string Yes
ResultCode int32 Yes
Message string Yes

proposalline

Parameter Type Required Comments
Id int32 Yes
Quantity double Yes
UnitPrice decimal Yes
RatePercent double No
MaxDiscount decimal No
ExtendedTotal decimal Yes
LineTax decimal Yes
Taxable boolean Yes
Discount decimal No
LineDescription string Yes
Notes string Yes
SortIndex int32 Yes
Part part Yes
ProposalOption proposaloption Yes
CustomFields CustomField[] Yes

proposalnote

Parameter Type Required Comments
Id int32 Yes
ProposalId int32 Yes
Note string Yes
CreatedAt datetime Yes

proposalsummary

Parameter Type Required Comments
Id int32 Yes
Service idname Yes
Date string Yes
Status string Yes

service

Parameter Type Required Comments
Id int32 Yes
Name string Yes
Description string Yes
BasePrice decimal Yes
UnitPrice decimal Yes
UnitOfMeasure string Yes
UnitDuration int32 No
Category string Yes
MinimumCharge decimal No
Duration int32 Yes
SelfSelect boolean No
Subscription boolean Yes
Prorating boolean Yes
AvailableParts Part[] Yes
PartCategories String[] Yes
PricingBands PricingBand[] Yes
QuantityOverrideCustomFieldId int32 No
UnitPriceOverrideCustomFieldId int32 No
DurationOverrideCustomFieldId int32 No
CapacityDemandOverrdieCustomFieldId int32 No
CustomProperties dictionary`2 Yes

serviceagent

Parameter Type Required Comments
Id int32 Yes
Name string Yes
Email string Yes
MobilePhone string Yes
StartDate string Yes
EndDate string Yes
TimeSlots TimeSlot[] Yes

servicedocumentlink

Parameter Type Required Comments
Date string Yes
Service string Yes
Link string Yes

tag

Parameter Type Required Comments
Id int32 Yes
Name string Yes

timeslot

Parameter Type Required Comments
DayOfWeek int32 No
NameOfDay string Yes
StartMinute int32 Yes
Minutes int32 Yes
StartDate string Yes
EndDate string Yes
ServiceCategoryName string Yes
PostalCodes string Yes
ApiKey string Yes
ResultCode int32 Yes
Message string Yes

user

Parameter Type Required Comments
Id int32 Yes
Email string Yes
Name string Yes
Active boolean Yes
ServiceAgentId int32 No
Role string Yes
ApiKey string Yes
ResultCode int32 Yes
Message string Yes