Welcome to the documentation for the serviceminder 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. For examples and more complete documentation of how to use the API, visit Help after logging in.

accountingclasses

create

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

Parameter Type Required Direction 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 Output
Message string Yes Output

get

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

Parameter Type Required Direction 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 Output
Message string Yes Output

update

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

Parameter Type Required Direction 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 Output
Message string Yes Output

appointments

addtip

POST https://serviceminder.com/api/appointments/addtip

Parameter Type Required Direction Comments
AppointmentId int32 Yes
Amount decimal Yes
ApiKey string Yes
ResultCode int32 Yes Output
Message string Yes Output

book

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

Parameter Type Required Direction Comments
AppointmentId int32 Yes
ServiceName string Yes
ContactId int32 Yes
ServiceId int32 Yes
InvoiceId 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
EnRouteUri string Yes
ThirdPartyUrl string Yes
SkipConflictChecks boolean No
CallCenterTransactionId int32 No
Slots AppointmentSlot[] Yes
AddOnParts AddOnPart[] Yes
UpdateLines boolean No
NotificationOptions String[] Yes
UpdateActuals boolean No
ActualStart datetime No
ActualFinish datetime No
RootProposalId int32 No
CancelReasonId int32 Yes
UpdateNote string Yes
ApiKey string Yes
ResultCode int32 Yes Output
Message string Yes Output

cancel

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

Parameter Type Required Direction Comments
AppointmentId int32 Yes
ServiceName string Yes
ContactId int32 Yes
ServiceId int32 Yes
InvoiceId 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
EnRouteUri string Yes
ThirdPartyUrl string Yes
SkipConflictChecks boolean No
CallCenterTransactionId int32 No
Slots AppointmentSlot[] Yes
AddOnParts AddOnPart[] Yes
UpdateLines boolean No
NotificationOptions String[] Yes
UpdateActuals boolean No
ActualStart datetime No
ActualFinish datetime No
RootProposalId int32 No
CancelReasonId int32 Yes
UpdateNote string Yes
ApiKey string Yes
ResultCode int32 Yes Output
Message string Yes Output

feedback

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

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

find

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

Parameter Type Required Direction Comments
AppointmentId int32 Yes
ServiceName string Yes
ContactId int32 Yes
ServiceId int32 Yes
InvoiceId 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
EnRouteUri string Yes
ThirdPartyUrl string Yes
SkipConflictChecks boolean No
CallCenterTransactionId int32 No
Slots AppointmentSlot[] Yes
AddOnParts AddOnPart[] Yes
UpdateLines boolean No
NotificationOptions String[] Yes
UpdateActuals boolean No
ActualStart datetime No
ActualFinish datetime No
RootProposalId int32 No
CancelReasonId int32 Yes
UpdateNote string Yes
ApiKey string Yes
ResultCode int32 Yes Output
Message string Yes Output

query

POST https://serviceminder.com/api/appointments/query

Parameter Type Required Direction Comments
FromDate datetime No
ThroughDate datetime No
UpdatedFrom datetime No
UpdatedThrough datetime No
ContactId int32 No
ServiceAgentId int32 No
Skip int32 No
Take int32 No
Count int32 No
Appointments AppointmentSlot[] Yes
ApiKey string Yes
ResultCode int32 Yes Output
Message string Yes Output

queue

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

Parameter Type Required Direction Comments
AppointmentId int32 Yes
ServiceName string 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 Output
Message string Yes Output

quickbook

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

Parameter Type Required Direction Comments
ContactId int32 No
Name string Yes
Nickname 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 Output
Message string Yes Output

slotsearch

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

Parameter Type Required Direction Comments
AppointmentId int32 Yes
ServiceName string Yes
ContactId int32 Yes
ServiceId int32 Yes
InvoiceId 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
EnRouteUri string Yes
ThirdPartyUrl string Yes
SkipConflictChecks boolean No
CallCenterTransactionId int32 No
Slots AppointmentSlot[] Yes
AddOnParts AddOnPart[] Yes
UpdateLines boolean No
NotificationOptions String[] Yes
UpdateActuals boolean No
ActualStart datetime No
ActualFinish datetime No
RootProposalId int32 No
CancelReasonId int32 Yes
UpdateNote string Yes
ApiKey string Yes
ResultCode int32 Yes Output
Message string Yes Output

update

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

Parameter Type Required Direction Comments
AppointmentId int32 Yes
ServiceName string Yes
ContactId int32 Yes
ServiceId int32 Yes
InvoiceId 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
EnRouteUri string Yes
ThirdPartyUrl string Yes
SkipConflictChecks boolean No
CallCenterTransactionId int32 No
Slots AppointmentSlot[] Yes
AddOnParts AddOnPart[] Yes
UpdateLines boolean No
NotificationOptions String[] Yes
UpdateActuals boolean No
ActualStart datetime No
ActualFinish datetime No
RootProposalId int32 No
CancelReasonId int32 Yes
UpdateNote string Yes
ApiKey string Yes
ResultCode int32 Yes Output
Message string Yes Output

blogs

find

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

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

get

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

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

cancelreasons

all

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

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

channels

all

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

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

bulkupdate

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

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

campaigns

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

Parameter Type Required Direction 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 Output
Message string Yes Output

contacts

addnote

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

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

addtags

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

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

addupdate

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

Parameter Type Required Direction Comments
NameSearch string Yes
PhoneSearch string Yes
EmailSearch string Yes
AddressSearch string Yes
IdSearch int32 No
DigitalTrackingIdSearch string Yes
Matches Contact[] Yes
ReturnPmtOnFile boolean Yes
DistributeLead boolean Yes
Skip int32 No
Limit int32 No
ApiKey string Yes
ResultCode int32 Yes Output
Message string Yes Output

listtags

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

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

locate

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

Parameter Type Required Direction Comments
NameSearch string Yes
PhoneSearch string Yes
EmailSearch string Yes
AddressSearch string Yes
IdSearch int32 No
DigitalTrackingIdSearch string Yes
Matches Contact[] Yes
ReturnPmtOnFile boolean Yes
DistributeLead boolean Yes
Skip int32 No
Limit int32 No
ApiKey string Yes
ResultCode int32 Yes Output
Message string Yes Output

logcall

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

Parameter Type Required Direction Comments
Length int32 Yes
Chars char Yes

removetags

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

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

upload

POST https://serviceminder.com/api/contacts/upload

Parameter Type Required Direction Comments
upload upload Yes
files ienumerable`1 Yes

customfields

all

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

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

datasubscriber

clear

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

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

downloadstatus

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

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

fetch

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

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

forecasts

POST https://serviceminder.com/api/datasubscriber/forecasts

Parameter Type Required Direction Comments
Organizations OrganizationForecast[] Yes
ApiKey string Yes
ResultCode int32 Yes Output
Message string Yes Output

getdownload

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

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

postalcodes

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

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

startdownload

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

Parameter Type Required Direction Comments
CreatedFrom datetime No
CreatedThrough datetime No
UpdatedFrom datetime No
UpdatedThrough datetime No
DateFrom datetime No
DateThrough datetime No
CompletedBefore datetime No
CompletedAfter datetime No
OrganizationId int32 No
RowId int32 No
Appointments downloadappointmentsettings Yes
Contacts downloadcontactsettings Yes
Deposits downloaddepositsettings Yes
Invoices downloadinvoicesettings Yes
InvoiceLines downloadinvoicelinesettings Yes
Proposals downloadproposalsettings Yes
Services downloadservicesettings Yes
CampaignBudgets downloadcampaignbudgetsettings Yes
RevenueForecasts downloadrevenueforecastsettings Yes
ChannelsCampaigns downloadchannelscampaignssettings Yes
Kind string Yes
DownloadId string Yes
UserId int32 No
ApiKey string Yes
ResultCode int32 Yes Output
Message string Yes Output

download

downloadstatus

POST https://serviceminder.com/api/download/downloadstatus

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

getdownload

POST https://serviceminder.com/api/download/getdownload

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

startdownload

POST https://serviceminder.com/api/download/startdownload

Parameter Type Required Direction Comments
CreatedFrom datetime No
CreatedThrough datetime No
UpdatedFrom datetime No
UpdatedThrough datetime No
DateFrom datetime No
DateThrough datetime No
CompletedBefore datetime No
CompletedAfter datetime No
OrganizationId int32 No
RowId int32 No
Appointments downloadappointmentsettings Yes
Contacts downloadcontactsettings Yes
Deposits downloaddepositsettings Yes
Invoices downloadinvoicesettings Yes
InvoiceLines downloadinvoicelinesettings Yes
Proposals downloadproposalsettings Yes
Services downloadservicesettings Yes
CampaignBudgets downloadcampaignbudgetsettings Yes
RevenueForecasts downloadrevenueforecastsettings Yes
ChannelsCampaigns downloadchannelscampaignssettings Yes
Kind string Yes
DownloadId string Yes
UserId int32 No
ApiKey string Yes
ResultCode int32 Yes Output
Message string Yes Output

invoice

get

POST https://serviceminder.com/api/invoice/get

Parameter Type Required Direction Comments
InvoiceId int32 Yes
Invoice invoice Yes
Payments Payment[] Yes
ApiKey string Yes
ResultCode int32 Yes Output
Message string Yes Output

import

POST https://serviceminder.com/api/invoice/import

Parameter Type Required Direction Comments
Invoice invoice Yes
InvoiceId int32 No
ApiKey string Yes
ResultCode int32 Yes Output
Message string Yes Output

query

POST https://serviceminder.com/api/invoice/query

Parameter Type Required Direction Comments
FromDate datetime No
ThroughDate datetime No
UpdatedFrom datetime No
UpdatedThrough datetime No
ContactId int32 No
Status invoicestatus No
Skip int32 No
Take int32 No
Count int32 No
Invoices Invoice[] Yes
ApiKey string Yes
ResultCode int32 Yes Output
Message string Yes Output

organizations

cancel

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

Parameter Type Required Direction Comments
OrganizationId int32 No
LocationId string Yes
Name string Yes
InternalName string Yes
LegalEntityName string Yes
TaxpayerID string Yes
OpenSince datetime No
PrimaryPhone string Yes
Email string Yes
Website string Yes
Timezone string Yes
StartAddress address Yes
Radius int32 Yes
SlotSearchWindowDays int32 Yes
BillingAddress address Yes
OpenTimeGranularity int32 No
PostalCodes string Yes
ServiceAgents ServiceAgent[] Yes
Services Service[] Yes
Users User[] Yes
CustomFields CustomField[] Yes
ApiKey string Yes
ResultCode int32 Yes Output
Message string Yes Output

create

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

Parameter Type Required Direction Comments
OrganizationId int32 No
LocationId string Yes
Name string Yes
InternalName string Yes
LegalEntityName string Yes
TaxpayerID string Yes
OpenSince datetime No
PrimaryPhone string Yes
Email string Yes
Website string Yes
Timezone string Yes
StartAddress address Yes
Radius int32 Yes
SlotSearchWindowDays int32 Yes
BillingAddress address Yes
OpenTimeGranularity int32 No
PostalCodes string Yes
ServiceAgents ServiceAgent[] Yes
Services Service[] Yes
Users User[] Yes
CustomFields CustomField[] Yes
ApiKey string Yes
ResultCode int32 Yes Output
Message string Yes Output

details

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

Parameter Type Required Direction Comments
OrganizationId int32 No
LocationId string Yes
Name string Yes
InternalName string Yes
LegalEntityName string Yes
TaxpayerID string Yes
OpenSince datetime No
PrimaryPhone string Yes
Email string Yes
Website string Yes
Timezone string Yes
StartAddress address Yes
Radius int32 Yes
SlotSearchWindowDays int32 Yes
BillingAddress address Yes
OpenTimeGranularity int32 No
PostalCodes string Yes
ServiceAgents ServiceAgent[] Yes
Services Service[] Yes
Users User[] Yes
CustomFields CustomField[] Yes
ApiKey string Yes
ResultCode int32 Yes Output
Message string Yes Output

query

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

Parameter Type Required Direction Comments
PublicName string Yes
InternalName string Yes
LocationId string Yes
PostalCode string Yes
IncludeInactive boolean Yes
Organizations OrganizationDetails[] Yes
ApiKey string Yes
ResultCode int32 Yes Output
Message string Yes Output

update

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

Parameter Type Required Direction Comments
OrganizationId int32 No
LocationId string Yes
Name string Yes
InternalName string Yes
LegalEntityName string Yes
TaxpayerID string Yes
OpenSince datetime No
PrimaryPhone string Yes
Email string Yes
Website string Yes
Timezone string Yes
StartAddress address Yes
Radius int32 Yes
SlotSearchWindowDays int32 Yes
BillingAddress address Yes
OpenTimeGranularity int32 No
PostalCodes string Yes
ServiceAgents ServiceAgent[] Yes
Services Service[] Yes
Users User[] Yes
CustomFields CustomField[] Yes
ApiKey string Yes
ResultCode int32 Yes Output
Message string Yes Output

part

details

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

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

getdimension

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

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

getpartdimensions

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

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

payment

import

POST https://serviceminder.com/api/payment/import

Parameter Type Required Direction Comments
Payment payment Yes
PaymentId int32 No
ApiKey string Yes
ResultCode int32 Yes Output
Message string Yes Output

query

POST https://serviceminder.com/api/payment/query

Parameter Type Required Direction Comments
FromDate datetime No
ThroughDate datetime No
CreatedFrom datetime No
CreatedThrough datetime No
ContactId int32 No
InvoiceId int32 No
Skip int32 No
Take int32 No
Count int32 No
Payments Payment[] Yes
ApiKey string Yes
ResultCode int32 Yes Output
Message string Yes Output

proposal

accept

POST https://serviceminder.com/api/proposal/accept

Parameter Type Required Direction Comments
ProposalId int32 Yes
Name string Yes
SignatureData string Yes
IpAddress string Yes
ApiKey string Yes
ResultCode int32 Yes Output
Message string Yes Output

alltemplates

POST https://serviceminder.com/api/proposal/alltemplates

Parameter Type Required Direction Comments
Templates ProposalTemplate[] Yes
ApiKey string Yes
ResultCode int32 Yes Output
Message string Yes Output

create

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

Parameter Type Required Direction Comments
Id int32 Yes
ContactId int32 Yes
Contact contact Yes Output
ClientUrl string Yes
Date string Yes
Status string Yes
AcceptedDate string Yes
ServiceId int32 Yes
ServiceName string Yes
Description string Yes
Duration int32 Yes
BasePrice decimal Yes
UnitPrice decimal Yes
Quantity double Yes
Subtotal decimal Yes
Tax decimal Yes
NamedTaxRate namedtaxrate Yes
Taxable boolean Yes
Title string Yes
DeliveryUri 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
ChangeOrderForProposalId int32 No
BundleWithProposalId int32 No
IncludePaymentPlans boolean Yes
PaymentPlanRequired boolean No
DistributeParts boolean Yes
CustomFields CustomField[] Yes
ApiKey string Yes
ResultCode int32 Yes Output
Message string Yes Output

details

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

Parameter Type Required Direction Comments
Id int32 Yes
ContactId int32 Yes
Contact contact Yes Output
ClientUrl string Yes
Date string Yes
Status string Yes
AcceptedDate string Yes
ServiceId int32 Yes
ServiceName string Yes
Description string Yes
Duration int32 Yes
BasePrice decimal Yes
UnitPrice decimal Yes
Quantity double Yes
Subtotal decimal Yes
Tax decimal Yes
NamedTaxRate namedtaxrate Yes
Taxable boolean Yes
Title string Yes
DeliveryUri 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
ChangeOrderForProposalId int32 No
BundleWithProposalId int32 No
IncludePaymentPlans boolean Yes
PaymentPlanRequired boolean No
DistributeParts boolean Yes
CustomFields CustomField[] Yes
ApiKey string Yes
ResultCode int32 Yes Output
Message string Yes Output

query

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

Parameter Type Required Direction Comments
Scope string Yes
FromDate datetime No
ThroughDate datetime No
FromAccepted datetime No
ThroughAccepted datetime No
UpdatedFrom datetime No
UpdatedThrough 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 Output
Message string Yes Output

quote

POST https://serviceminder.com/api/proposal/quote

Parameter Type Required Direction Comments
ContactId int32 Yes
ServiceId int32 No
ServiceName string Yes
ProposalTemplateId int32 No
ReturnDates boolean Yes
ReturnProposal boolean Yes
ScheduleDates SubscriptionDate[] Yes
Proposal proposal Yes
ApiKey string Yes
ResultCode int32 Yes Output
Message string Yes Output

update

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

Parameter Type Required Direction Comments
Id int32 Yes
ContactId int32 Yes
Contact contact Yes Output
ClientUrl string Yes
Date string Yes
Status string Yes
AcceptedDate string Yes
ServiceId int32 Yes
ServiceName string Yes
Description string Yes
Duration int32 Yes
BasePrice decimal Yes
UnitPrice decimal Yes
Quantity double Yes
Subtotal decimal Yes
Tax decimal Yes
NamedTaxRate namedtaxrate Yes
Taxable boolean Yes
Title string Yes
DeliveryUri 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
ChangeOrderForProposalId int32 No
BundleWithProposalId int32 No
IncludePaymentPlans boolean Yes
PaymentPlanRequired boolean No
DistributeParts boolean Yes
CustomFields CustomField[] Yes
ApiKey string Yes
ResultCode int32 Yes Output
Message string Yes Output

upload

POST https://serviceminder.com/api/proposal/upload

Parameter Type Required Direction Comments
upload upload Yes
files ienumerable`1 Yes

serviceagents

all

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

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

services

all

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

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

details

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

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

settings

channelcampaigns

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

Parameter Type Required Direction 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 Output
Message string Yes Output

channels

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

Parameter Type Required Direction 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 Output
Message string Yes Output

features

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

Parameter Type Required Direction 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 Output
Message string Yes Output

leadsourcecategories

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

Parameter Type Required Direction 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 Output
Message string Yes Output

namedtaxrates

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

Parameter Type Required Direction 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 Output
Message string Yes Output

radiuscities

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

Parameter Type Required Direction 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 Output
Message string Yes Output

radiuspostalcodes

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

Parameter Type Required Direction 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 Output
Message string Yes Output

task

create

POST https://serviceminder.com/api/task/create

Parameter Type Required Direction Comments
ContactId int32 Yes
Description string Yes
TaskType int32 Yes
DurationMinutes int32 No
Due string Yes
Category string Yes
TaskId int32 No
ApiKey string Yes
ResultCode int32 Yes Output
Message string Yes Output

test

echo

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

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

user

all

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

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

create

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

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

Objects

accountingclasspostalcodes

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

additionalserviceagent

Parameter Type Required Comments
StartMinute int32 No
Duration int32 No
ActualStartMinute int32 No
ActualDuration int32 No
ServiceAgent serviceagent Yes

addonpart

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

address

Parameter Type Required Comments
Address1 string Yes
Address2 string Yes
City string Yes
State string Yes
Zip string Yes
ApiKey string Yes
ResultCode int32 Yes
Message 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
TipUrl string Yes
ThirdPartyUrl string Yes
TrackingUrl string Yes
ActualStart string Yes
ActualDuration int32 No
Status int32 No
Shadow boolean No
DriveTimeMinutes int32 Yes
DriveTimeWarning boolean Yes
ProposalId int32 Yes
RootProposalId int32 No
ReworkForAppointmentId int32 No
CancelReasonId int32 No
AddOnParts AddOnPart[] Yes
CustomProperties dictionary`2 Yes
AdditionalServiceAgents AdditionalServiceAgent[] 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
OrganizationId int32 No
Hash string Yes
Name string Yes
Nickname 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
Country string Yes
LocationID string Yes
TerritoryID string Yes
LeadSource string Yes
Channel string Yes
Campaign string Yes
Category string Yes
ChannelId int32 Yes
CampaignId int32 Yes
UtmMedium string Yes
UtmSource string Yes
UtmCampaign string Yes
IsCustomer boolean Yes
DigitalTrackingId string Yes
ReferredByContactId int32 No
OwnerUserId int32 No
ReferredByHash string Yes
ManagedByContactId int32 No
AutoOfferCode string Yes
FlashMessage string Yes
Unsubscribed boolean Yes
NamedTaxRate namedtaxrate Yes
PmtOnFileKind string Yes
PmtOnFileLast4 string Yes
PmtOnFileExpDate string Yes
UpdatePaymentOnFileUrl string Yes
DoNotText boolean Yes
DoNotEmail boolean Yes
Notes Note[] Yes
CustomFields CustomField[] Yes
Tags String[] Yes
ContactPictures ContactPicture[] Yes
ContactDocuments ContactDocument[] Yes
OpenInvoices ServiceDocumentLink[] Yes
OpenProposals ServiceDocumentLink[] Yes
IsValid boolean Yes
ApiKey string Yes
ResultCode int32 Yes
Message string Yes

contactdocument

Parameter Type Required Comments
Id int32 Yes
Filename string Yes
Notes string Yes
CreatedAt datetime Yes
UpdatedAt datetime Yes

contactpicture

Parameter Type Required Comments
Id int32 Yes
Filename string Yes
Notes string Yes
Width int32 Yes
Height int32 Yes
CreatedAt datetime Yes
UpdatedAt datetime Yes

customfield

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

datasubscriberevent

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

downloadappointmentsettings

Parameter Type Required Comments
ScheduledFrom datetime No
ScheduledThrough datetime No
CompletedFrom datetime No
CompletedThrough datetime No
Scheduled boolean Yes
Completed boolean Yes
Queued boolean Yes
Canceled boolean Yes
Started boolean Yes
IncludeCustomFields boolean Yes
IncludeExcludedOrgs boolean Yes
IncludeOrgCustomFields boolean Yes

downloadcampaignbudgetsettings

Parameter Type Required Comments
Year int32 Yes

downloadchannelscampaignssettings

Parameter Type Required Comments
IncludeExcludedOrgs boolean Yes

downloadcontactsettings

Parameter Type Required Comments
InvoicedAfter datetime No
Tags string Yes
WithEmails boolean Yes
WithoutEmails boolean Yes
NationalAccountsOnly boolean Yes
IncludeCustomFields boolean Yes
IncludeOrgCustomFields boolean Yes
IncludeGeoZones boolean Yes
IncludeGeoShapes boolean Yes
IncludeExcludedOrgs boolean Yes

downloaddepositsettings

Parameter Type Required Comments
IncludeExcludedOrgs boolean Yes

downloadinvoicelinesettings

Parameter Type Required Comments
Open boolean Yes
Paid boolean Yes
Voided boolean Yes
Unapproved boolean Yes
IncludeExcludedOrgs boolean Yes

downloadinvoicesettings

Parameter Type Required Comments
Open boolean Yes
Paid boolean Yes
Voided boolean Yes
Unapproved boolean Yes
IncludeLines boolean Yes
IncludeExcludedOrgs boolean Yes

downloadproposalsettings

Parameter Type Required Comments
IncludeBundled boolean Yes
IncludeTags boolean Yes
IncludeLines boolean Yes
IncludeCustomFields boolean Yes
IncludeOrgCustomFields boolean Yes
IncludeGeoZones boolean Yes
IncludeGeoShapes boolean Yes
IncludeSolutions boolean Yes
IncludeExcludedOrgs boolean Yes
AcceptedBefore datetime No
AcceptedAfter datetime No
Status int32 No

downloadrevenueforecastsettings

Parameter Type Required Comments
Year int32 Yes

forecast

Parameter Type Required Comments
Year int32 Yes
Month int32 Yes
Target decimal Yes

idname

Parameter Type Required Comments
Id int32 Yes
Name string Yes

invoice

Parameter Type Required Comments
Id int32 No
Number string Yes
Date datetime Yes
DatePaid datetime No
Status invoicestatus Yes
ContactId int32 Yes
ProposalId int32 No
AppointmentId int32 No
Subtotal decimal Yes
Tax decimal Yes
Total decimal Yes
BalanceDue decimal Yes
IncludedInEop boolean Yes
TaxRate double Yes
RateName string Yes
Terms string Yes
CustomerNotes string Yes
CanAcceptClientPayment boolean Yes
ClientPayUrl string Yes
ClientPdfUrl string Yes
Lines InvoiceLine[] Yes

invoiceline

Parameter Type Required Comments
Id int32 Yes
ServiceId int32 No
PartId int32 No
Description string Yes
Rate decimal Yes
Qty double Yes
Extended decimal Yes
Taxable boolean 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
LegalEntityName string Yes
TaxpayerID 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
CancelDate datetime No
TrialExpirationDate datetime No
Suspended boolean Yes
BillingPlan string Yes
BillingMethod int32 Yes
Users User[] Yes
CustomFields CustomField[] Yes
AccountManager user Yes
Region string Yes

organizationforecast

Parameter Type Required Comments
Organization idname Yes
Forecasts Forecast[] 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
IsAssemblySynchronizePricing 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
QuantityOverrideCustomFieldId int32 No
QtyPricing PartQtyPricing[] Yes
AssemblyItems AssemblyItem[] Yes
PartTemplate parttemplate Yes
StoreItemId int32 No
DistributionStart datetime No
DistributionEnd datetime No

partqtypricing

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

parttemplate

Parameter Type Required Comments
Id int32 Yes
OptionName string Yes
Selected boolean Yes

payment

Parameter Type Required Comments
Id int32 Yes
InvoiceId int32 Yes
ContactId int32 Yes
InvoiceNumber string Yes
Reference string Yes
TransactionId string Yes
Date datetime Yes
Amount decimal Yes
Method string Yes

pricingband

Parameter Type Required Comments
AtLeast double Yes
LessThan double No
Price double Yes
IsExcludeQuantity boolean Yes
IsOverageMode boolean Yes
CapacityDemand double No
Formula string Yes
Duration int32 Yes
InitialNRecurringPrice decimal No
IsOverageBand boolean Yes

proposal

Parameter Type Required Comments
Id int32 Yes
ContactId int32 Yes
Contact contact Yes
ClientUrl string Yes
Date string Yes
Status string Yes
AcceptedDate string Yes
ServiceId int32 Yes
ServiceName string Yes
Description string Yes
Duration int32 Yes
BasePrice decimal Yes
UnitPrice decimal Yes
Quantity double Yes
Subtotal decimal Yes
Tax decimal Yes
NamedTaxRate namedtaxrate Yes
Taxable boolean Yes
Title string Yes
DeliveryUri 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
ChangeOrderForProposalId int32 No
BundleWithProposalId int32 No
IncludePaymentPlans boolean Yes
PaymentPlanRequired boolean No
DistributeParts boolean Yes
CustomFields CustomField[] Yes
ApiKey string Yes
ResultCode int32 Yes
Message string Yes

proposaldateline

Parameter Type Required Comments
Id int32 Yes
ProposalOptionId int32 No
ProposalScheduleDateId int32 Yes
SortOrder int32 Yes
Part idname Yes
Quantity double Yes
UnitPrice decimal Yes
UnitCost decimal Yes
Extended decimal Yes
Taxable boolean Yes
Tax decimal Yes
Duration int32 No
Internal boolean No
Description string Yes
Notes string Yes
OptionName string Yes

proposalline

Parameter Type Required Comments
Id int32 Yes
Quantity double No
UnitPrice decimal No
UnitCost decimal No
RatePercent double No
MaxDiscount decimal No
ExtendedTotal decimal Yes
LineTax decimal Yes
Taxable boolean Yes
IsInternal boolean No
Discount decimal No
LineDescription string Yes
Notes string Yes
SortIndex int32 Yes
AssemblyLineId int32 No
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 No

proposaloption

Parameter Type Required Comments
Id int32 Yes
Name string Yes
Selected boolean Yes

proposalsummary

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

proposaltemplate

Parameter Type Required Comments
Id int32 Yes
Name string Yes
IsActive boolean Yes
Quantity double No
ServiceId int32 Yes
ServiceDescription string Yes
CustomerNote string Yes
OrganizationId int32 Yes
CreatedAt datetime Yes
UpdatedAt datetime Yes
ProposalTemplateLines ProposalTemplateLine[] Yes

proposaltemplateline

Parameter Type Required Comments
Id int32 Yes
Option string Yes
Quantity double No
Name string Yes
Description string Yes
ProposalTemplateId int32 Yes
PartId int32 Yes
Order int32 Yes
IsInternal boolean Yes
IsZeroPrice boolean Yes
QtyIsPercent boolean 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
SubscriptionVisits int32 Yes
SubscriptionInterval int32 No
SeasonStart datetime No
SeasonExpiration datetime No
RecurringDescription string Yes
AvailableParts Part[] Yes
PartCategories String[] Yes
PricingBands PricingBand[] Yes
QuantityOverrideCustomFieldId int32 No
UnitPriceOverrideCustomFieldId int32 No
DurationOverrideCustomFieldId int32 No
CapacityDemandOverrdieCustomFieldId int32 No
MinimumOptions int32 No
MinimumSubtotal decimal No
QuantityFormula string Yes
RecordWeatherData boolean Yes
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
Id int32 Yes

subscriptiondate

Parameter Type Required Comments
Id int32 Yes
Label string Yes
Date datetime Yes
Service idname Yes
ServiceId int32 No
DateIso string Yes
DateStr string Yes
DateFriendly string Yes
BasePrice decimal No
UnitPrice decimal No
SelectedDate string Yes
Subtotal decimal Yes
TaxableSubtotal decimal Yes
Duration string Yes
InternalNotes string Yes
IsExcludeFromProRating boolean Yes
IsRecurringMaster boolean Yes
IsRecurringShadow boolean Yes
Lines ProposalDateLine[] Yes
AlternateDates DateTime[] 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

upload

Parameter Type Required Comments
ContactId int32 Yes
Note string Yes
TagIds string Yes
UploadIds Int32[] Yes
ApiKey string Yes
ResultCode int32 Yes
Message string Yes

upload

Parameter Type Required Comments
ProposalId int32 Yes
Note string Yes
TagIds string Yes
UploadIds Int32[] 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