### Services All API Source: https://serviceminder.io/api/index Retrieves all services, optionally filtered by ID. This endpoint can be used to get a comprehensive list of services. ```APIDOC ## POST /api/services/all ### Description Retrieves all services, optionally filtered by ID. This endpoint can be used to get a comprehensive list of services. ### Method POST ### Endpoint https://serviceminder.com/api/services/all ### Parameters #### Request Body - **Id** (int32) - Optional - Identifier for a specific service. - **IncludeParts** (boolean) - Optional - Whether to include associated parts. - **Matches** (Service[]) - Required - An array of Service objects to match against. - **ApiKey** (string) - Required - API key for authentication. ### Response #### Success Response (200) - **ResultCode** (int32) - Indicates the result of the operation (e.g., 0 for success). - **Message** (string) - A message describing the result of the operation. ``` -------------------------------- ### POST /api/datasubscriber/startdownload Source: https://serviceminder.io/api/index Initiates a data download with specified settings and filters. Requires an API key for authentication. ```APIDOC ## POST /api/datasubscriber/startdownload ### Description Initiates a data download with specified settings and filters. Requires an API key for authentication. ### Method POST ### Endpoint https://serviceminder.com/api/datasubscriber/startdownload ### Parameters #### Query Parameters - **CreatedFrom** (datetime) - Optional - Filter by creation date from. - **CreatedThrough** (datetime) - Optional - Filter by creation date through. - **UpdatedFrom** (datetime) - Optional - Filter by update date from. - **UpdatedThrough** (datetime) - Optional - Filter by update date through. - **DateFrom** (datetime) - Optional - Filter by date from. - **DateThrough** (datetime) - Optional - Filter by date through. - **CompletedBefore** (datetime) - Optional - Filter by completion before. - **CompletedAfter** (datetime) - Optional - Filter by completion after. - **OrganizationId** (int32) - Optional - Filter by organization ID. - **RowId** (int32) - Optional - Filter by row ID. - **Appointments** (downloadappointmentsettings) - Required - Settings for downloading appointments. - **Contacts** (downloadcontactsettings) - Required - Settings for downloading contacts. - **Deposits** (downloaddepositsettings) - Required - Settings for downloading deposits. - **Invoices** (downloadinvoicesettings) - Required - Settings for downloading invoices. - **InvoiceLines** (downloadinvoicelinesettings) - Required - Settings for downloading invoice lines. - **Proposals** (downloadproposalsettings) - Required - Settings for downloading proposals. - **Services** (downloadservicesettings) - Required - Settings for downloading services. - **CampaignBudgets** (downloadcampaignbudgetsettings) - Required - Settings for downloading campaign budgets. - **RevenueForecasts** (downloadrevenueforecastsettings) - Required - Settings for downloading revenue forecasts. - **ChannelsCampaigns** (downloadchannelscampaignssettings) - Required - Settings for downloading channels campaigns. - **Kind** (string) - Required - The type of download. - **DownloadId** (string) - Required - A unique identifier for the download. - **UserId** (int32) - Optional - The user initiating the download. - **ApiKey** (string) - Required - Your unique API key for authentication. #### Request Body This endpoint does not use a request body; all parameters are passed as query parameters. ### Request Example ```json { "CreatedFrom": "2023-01-01T00:00:00Z", "Appointments": {"include": true}, "Contacts": {"include": true}, "Kind": "Full", "DownloadId": "download_start_123", "ApiKey": "YOUR_API_KEY" } ``` ### Response #### Success Response (200) - **ResultCode** (int32) - Indicates the result of the operation (0 for success). - **Message** (string) - A message describing the outcome of the operation. ``` -------------------------------- ### Download Campaign Budget Settings Source: https://serviceminder.io/api/index Settings for downloading campaign budget data. ```APIDOC ## DownloadCampaignBudgetSettings Object This object defines parameters for downloading campaign budget data. ### Parameters - **Year** (int32) - Required - The year for which to download campaign budget data. ``` -------------------------------- ### POST /api/download/startdownload Source: https://serviceminder.io/api/index Initiates a data download for various entities within the ServiceMinder system. This endpoint allows for granular control over the download parameters, including date ranges and specific settings for different data types. ```APIDOC ## POST /api/download/startdownload ### Description Initiates a data download for various entities within the ServiceMinder system. This endpoint allows for granular control over the download parameters, including date ranges and specific settings for different data types. ### Method POST ### Endpoint https://serviceminder.com/api/download/startdownload ### Parameters #### Request Body - **CreatedFrom** (datetime) - Optional - Specifies the start of the creation date range. - **CreatedThrough** (datetime) - Optional - Specifies the end of the creation date range. - **UpdatedFrom** (datetime) - Optional - Specifies the start of the update date range. - **UpdatedThrough** (datetime) - Optional - Specifies the end of the update date range. - **DateFrom** (datetime) - Optional - Specifies a general start date for the download. - **DateThrough** (datetime) - Optional - Specifies a general end date for the download. - **CompletedBefore** (datetime) - Optional - Filters downloads completed before this date. - **CompletedAfter** (datetime) - Optional - Filters downloads completed after this date. - **OrganizationId** (int32) - Optional - The ID of the organization to download data for. - **RowId** (int32) - Optional - The ID of a specific row to download. - **Appointments** (downloadappointmentsettings) - Required - Settings for downloading appointment data. - **Contacts** (downloadcontactsettings) - Required - Settings for downloading contact data. - **Deposits** (downloaddepositsettings) - Required - Settings for downloading deposit data. - **Invoices** (downloadinvoicesettings) - Required - Settings for downloading invoice data. - **InvoiceLines** (downloadinvoicelinesettings) - Required - Settings for downloading invoice line data. - **Proposals** (downloadproposalsettings) - Required - Settings for downloading proposal data. - **Services** (downloadservicesettings) - Required - Settings for downloading service data. - **CampaignBudgets** (downloadcampaignbudgetsettings) - Required - Settings for downloading campaign budget data. - **RevenueForecasts** (downloadrevenueforecastsettings) - Required - Settings for downloading revenue forecast data. - **ChannelsCampaigns** (downloadchannelscampaignssettings) - Required - Settings for downloading channel campaign data. - **Kind** (string) - Required - The type of download to initiate. - **DownloadId** (string) - Required - A unique identifier for the download request. - **UserId** (int32) - Optional - The ID of the user initiating the download. - **ApiKey** (string) - Required - Your API key for authentication. ### Response #### Success Response (200) - **ResultCode** (int32) - Output - Indicates the result of the operation. - **Message** (string) - Output - A message describing the result of the operation. ``` -------------------------------- ### Download Deposit Settings Source: https://serviceminder.io/api/index Settings for downloading deposit data. ```APIDOC ## DownloadDepositSettings Object This object defines parameters for downloading deposit data. ### Parameters - **IncludeExcludedOrgs** (boolean) - Optional - Whether to include data from excluded organizations. ``` -------------------------------- ### Download Revenue Forecast Settings Source: https://serviceminder.io/api/index Retrieves settings for downloading revenue forecasts. Requires a 'Year' parameter to specify the forecast year. ```APIDOC ## GET /websites/serviceminder_io_api/downloadrevenueforecastsettings ### Description Retrieves settings for downloading revenue forecasts for a specific year. ### Method GET ### Endpoint /websites/serviceminder_io_api/downloadrevenueforecastsettings ### Parameters #### Query Parameters - **Year** (int32) - Required - The year for which to retrieve forecast settings. ### Response #### Success Response (200) (Response structure not specified in the provided text, but would typically include a configuration object for revenue forecast downloads.) #### Response Example { "example": "(Response structure not specified)" } ``` -------------------------------- ### QuickBook API Source: https://serviceminder.io/api/index This endpoint allows for the creation of QuickBook entries, likely for appointment-related data synchronization with QuickBooks. ```APIDOC ## POST /api/appointments/quickbook ### Description This endpoint facilitates the creation of QuickBook entries, possibly for integrating appointment data with QuickBooks. ### Method POST ### Endpoint https://serviceminder.com/api/appointments/quickbook ### Parameters #### Request Body - **ContactId** (int32) - Optional - - **Name** (string) - Required - - **Nickname** (string) - Required - - **Company** (string) - Required - - **Address1** (string) - Required - - **Address2** (string) - Required - - **City** (string) - Required - - **State** (string) - Required - - **Zip** (string) - Required - - **Country** (string) - Required - - **PriPhone** (string) - Required - - **PriPhoneLabel** (string) - Required - - **AltPhone** (string) - Optional - - **AltPhoneLabel** (string) - Optional - - **Email** (string) - Required - - **Channel** (string) - Required - - **ChannelId** (int32) - Optional - - **Campaign** (string) - Required - - **CampaignId** (int32) - Optional - - **Category** (string) - Required - - **DigitalTrackingId** (string) - Required - - **Unsubscribed** (boolean) - Required - - **Tags** (String[]) - Required - - **CustomFields** (CustomField[]) - Required - - **Service** (string) - Required - - **ServiceAgentEmail** (string) - Required - - **AdditionalServiceAgentEmails** (String[]) - Required - - **ScheduledStart** (datetime) - Required - - **Duration** (int32) - Required - - **Quantity** (double) - Required - - **Tentative** (boolean) - Required - - **Confirmed** (boolean) - Required - - **FirstAvailable** (boolean) - Required - - **ConfirmationUri** (string) - Required - - **EnRouteUri** (string) - Required - - **InternalNotes** (string) - Required - - **CustomerNotes** (string) - Required - - **CallCenterTransactionId** (int32) - Optional - - **ApiKey** (string) - Required - ### Response #### Success Response (200) - **ResultCode** (int32) - Output - - **Message** (string) - Output - ``` -------------------------------- ### Download Appointment Settings Source: https://serviceminder.io/api/index Settings for downloading appointment data. ```APIDOC ## DownloadAppointmentSettings Object This object defines parameters for downloading appointment data. ### Parameters - **ScheduledFrom** (datetime) - Optional - Filter appointments scheduled from this date. - **ScheduledThrough** (datetime) - Optional - Filter appointments scheduled up to this date. - **CompletedFrom** (datetime) - Optional - Filter appointments completed from this date. - **CompletedThrough** (datetime) - Optional - Filter appointments completed up to this date. - **Scheduled** (boolean) - Optional - Include only scheduled appointments. - **Completed** (boolean) - Optional - Include only completed appointments. - **Queued** (boolean) - Optional - Include only queued appointments. - **Canceled** (boolean) - Optional - Include only canceled appointments. - **Started** (boolean) - Optional - Include only started appointments. - **IncludeCustomFields** (boolean) - Optional - Whether to include custom fields in the download. - **IncludeExcludedOrgs** (boolean) - Optional - Whether to include data from excluded organizations. - **IncludeOrgCustomFields** (boolean) - Optional - Whether to include custom fields from organizations. ``` -------------------------------- ### POST /api/channels/all Source: https://serviceminder.io/api/index Retrieves all available channels. Requires an API key for authentication. ```APIDOC ## POST /api/channels/all ### Description Retrieves all available channels. ### Method POST ### Endpoint https://serviceminder.com/api/channels/all ### Parameters #### Request Body - **Channels** (Channel[]) - Required - Array of channel objects. - **ApiKey** (string) - Required - Your API key for authentication. #### Response ##### Success Response (200) - **ResultCode** (int32) - Indicates the result of the operation. - **Message** (string) - A message describing the result of the operation. ``` -------------------------------- ### Download Channels Campaigns Settings Source: https://serviceminder.io/api/index Settings for downloading channels and campaign data. ```APIDOC ## DownloadChannelsCampaignsSettings Object This object defines parameters for downloading channels and campaign data. ### Parameters - **IncludeExcludedOrgs** (boolean) - Optional - Whether to include data from excluded organizations. ``` -------------------------------- ### Proposal API - Create Proposal Source: https://serviceminder.io/api/index Creates a new proposal with detailed information. This endpoint allows for comprehensive proposal creation, including line items, notes, and payment options. ```APIDOC ## create ### Description Creates a new proposal with detailed information. ### Method POST ### Endpoint https://serviceminder.com/api/proposal/create ### Parameters #### Request Body - **Id** (int32) - Required - The ID of the proposal. - **ContactId** (int32) - Required - The ID of the contact associated with the proposal. - **ClientUrl** (string) - Required - The URL of the client. - **Date** (string) - Required - The date of the proposal. - **Status** (string) - Required - The status of the proposal. - **AcceptedDate** (string) - Required - The date the proposal was accepted. - **ServiceId** (int32) - Required - The ID of the service. - **ServiceName** (string) - Required - The name of the service. - **Description** (string) - Required - The description of the proposal. - **Duration** (int32) - Required - The duration of the proposal. - **BasePrice** (decimal) - Required - The base price of the proposal. - **UnitPrice** (decimal) - Required - The unit price of the proposal. - **Quantity** (double) - Required - The quantity of items in the proposal. - **Subtotal** (decimal) - Required - The subtotal of the proposal. - **Tax** (decimal) - Required - The tax amount for the proposal. - **NamedTaxRate** (namedtaxrate) - Required - The named tax rate. - **Taxable** (boolean) - Required - Indicates if the proposal is taxable. - **Title** (string) - Required - The title of the proposal. - **DeliveryUri** (string) - Required - The delivery URI for the proposal. - **OwnerUserId** (int32) - Optional - The ID of the user who owns the proposal. - **DepositRate** (double) - Optional - The deposit rate for the proposal. - **DepositRequired** (boolean) - Optional - Indicates if a deposit is required. - **SelectedSolution** (idname) - Required - The selected solution for the proposal. - **ProposalLines** (ProposalLine[]) - Required - An array of proposal line items. - **ChangeOrders** (ProposalSummary[]) - Required - An array of change orders. - **BundledProposals** (ProposalSummary[]) - Required - An array of bundled proposals. - **ProposalNotes** (ProposalNote[]) - Required - An array of proposal notes. - **CustomerNotes** (string) - Required - Notes from the customer. - **ChangeOrderForProposalId** (int32) - Optional - The ID of the proposal for which this is a change order. - **BundleWithProposalId** (int32) - Optional - The ID of the proposal to bundle with. - **IncludePaymentPlans** (boolean) - Required - Indicates whether to include payment plans. - **PaymentPlanRequired** (boolean) - Optional - Indicates if a payment plan is required. - **DistributeParts** (boolean) - Required - Indicates whether to distribute parts. - **CustomFields** (CustomField[]) - Required - An array of custom fields. - **ApiKey** (string) - Required - API key for authentication. ### Response #### Success Response (200) - **ResultCode** (int32) - Indicates the result of the operation. - **Message** (string) - A message describing the result of the operation. ``` -------------------------------- ### POST /api/accountingclasses/create Source: https://serviceminder.io/api/index Creates a new accounting class with specified details. Requires Name, TerritoryID, PostalCodes, Matches, and an APIKey. ```APIDOC ## POST /api/accountingclasses/create ### Description Creates a new accounting class with specified details. Requires Name, TerritoryID, PostalCodes, Matches, and an APIKey. ### Method POST ### Endpoint https://serviceminder.com/api/accountingclasses/create ### Parameters #### Request Body - **NameSearch** (string) - Required - Search term for the name. - **OrganizationId** (int32) - Optional - The ID of the organization. - **AccountingClassId** (int32) - Optional - The ID of the accounting class. - **Name** (string) - Required - The name of the accounting class. - **TerritoryID** (string) - Required - The ID of the territory. - **PostalCodes** (String[]) - Required - An array of postal codes. - **Matches** (AccountingClassPostalCodes[]) - Required - An array of matching accounting class postal codes. - **ApiKey** (string) - Required - Your unique API key. ### Response #### Success Response (200) - **ResultCode** (int32) - Indicates the result of the operation. - **Message** (string) - A message describing the result. ``` -------------------------------- ### POST /api/download/getdownload Source: https://serviceminder.io/api/index Retrieves general download information for a given download ID. Requires an API key for authentication. ```APIDOC ## POST /api/download/getdownload ### Description Retrieves general download information for a given download ID. Requires an API key for authentication. ### Method POST ### Endpoint https://serviceminder.com/api/download/getdownload ### Parameters #### Query Parameters - **DownloadId** (string) - Required - The ID of the download to retrieve. - **ApiKey** (string) - Required - Your unique API key for authentication. #### Request Body This endpoint does not use a request body; all parameters are passed as query parameters. ### Request Example ```json { "DownloadId": "download_ghi", "ApiKey": "YOUR_API_KEY" } ``` ### Response #### Success Response (200) - **ResultCode** (int32) - Indicates the result of the operation (0 for success). - **Message** (string) - A message describing the outcome of the operation. ``` -------------------------------- ### POST /api/blogs/get Source: https://serviceminder.io/api/index Retrieves blog information based on specified search criteria. Requires an API key for authentication. ```APIDOC ## POST /api/blogs/get ### Description Retrieves blog information based on specified search criteria. ### Method POST ### Endpoint https://serviceminder.com/api/blogs/get ### Parameters #### Request Body - **NameSearch** (string) - Required - Search by name. - **DateSearch** (string) - Required - Search by date. - **IdSearch** (string) - Required - Search by ID. - **Matches** (Blog[]) - Required - Array of blog objects to match. - **ApiKey** (string) - Required - Your API key for authentication. #### Response ##### Success Response (200) - **ResultCode** (int32) - Indicates the result of the operation. - **Message** (string) - A message describing the result of the operation. ``` -------------------------------- ### Download Proposal Settings Source: https://serviceminder.io/api/index Retrieves settings for downloading proposals. Allows filtering by inclusion of bundles, tags, lines, custom fields, and geo-related data, with options for date ranges and status. ```APIDOC ## GET /websites/serviceminder_io_api/downloadproposalsettings ### Description Retrieves settings for downloading proposals. You can customize the data included, such as bundled items, tags, lines, and custom fields, and filter by date ranges and status. ### Method GET ### Endpoint /websites/serviceminder_io_api/downloadproposalsettings ### Parameters #### Query Parameters - **IncludeBundled** (boolean) - Required - Whether to include bundled items. - **IncludeTags** (boolean) - Required - Whether to include tags. - **IncludeLines** (boolean) - Required - Whether to include proposal lines. - **IncludeCustomFields** (boolean) - Required - Whether to include custom fields. - **IncludeOrgCustomFields** (boolean) - Required - Whether to include organization custom fields. - **IncludeGeoZones** (boolean) - Required - Whether to include geographical zones. - **IncludeGeoShapes** (boolean) - Required - Whether to include geographical shapes. - **IncludeSolutions** (boolean) - Required - Whether to include solutions. - **IncludeExcludedOrgs** (boolean) - Required - Whether to include data from excluded organizations. - **AcceptedBefore** (datetime) - Optional - Filter proposals accepted before this date. - **AcceptedAfter** (datetime) - Optional - Filter proposals accepted after this date. - **Status** (int32) - Optional - Filter by proposal status code. ### Response #### Success Response (200) (Response structure not specified in the provided text, but would typically include a configuration object for proposal downloads.) #### Response Example { "example": "(Response structure not specified)" } ``` -------------------------------- ### Proposal API - All Templates Source: https://serviceminder.io/api/index Retrieves all available proposal templates. This endpoint is useful for populating a list of templates for users to choose from when creating new proposals. ```APIDOC ## alltemplates ### Description Retrieves all available proposal templates. ### Method POST ### Endpoint https://serviceminder.com/api/proposal/alltemplates ### Parameters #### Request Body - **Templates** (ProposalTemplate[]) - Required - List of proposal templates. - **ApiKey** (string) - Required - API key for authentication. ### Response #### Success Response (200) - **ResultCode** (int32) - Indicates the result of the operation. - **Message** (string) - A message describing the result of the operation. ``` -------------------------------- ### Download Contact Settings Source: https://serviceminder.io/api/index Settings for downloading contact data. ```APIDOC ## DownloadContactSettings Object This object defines parameters for downloading contact data. ### Parameters - **InvoicedAfter** (datetime) - Optional - Filter contacts invoiced after this date. - **Tags** (string) - Optional - Filter contacts by a specific tag. - **WithEmails** (boolean) - Optional - Include only contacts with email addresses. - **WithoutEmails** (boolean) - Optional - Include only contacts without email addresses. - **NationalAccountsOnly** (boolean) - Optional - Include only national accounts. - **IncludeCustomFields** (boolean) - Optional - Whether to include custom fields in the download. - **IncludeOrgCustomFields** (boolean) - Optional - Whether to include custom fields from organizations. - **IncludeGeoZones** (boolean) - Optional - Whether to include geographical zones. - **IncludeGeoShapes** (boolean) - Optional - Whether to include geographical shapes. - **IncludeExcludedOrgs** (boolean) - Optional - Whether to include data from excluded organizations. ``` -------------------------------- ### Upload API (Proposal) Source: https://serviceminder.io/api/index This section details the parameters for uploading files associated with a proposal. ```APIDOC ## Upload API Endpoint (Proposal) ### Description This endpoint allows for the uploading of files, such as quotes or supporting documents, linked to a specific proposal. ### Method POST ### Endpoint `/websites/serviceminder_io_api/upload` (specifically for proposal uploads) ### Parameters #### Request Body - **ProposalId** (int32) - Required - The ID of the proposal to associate the upload with. - **Note** (string) - Optional - A note or description for the uploaded file. - **TagIds** (string) - Optional - Comma-separated IDs of tags to apply to the upload. - **UploadIds** (Int32[]) - Required - An array of IDs for the uploaded files. - **ApiKey** (string) - Required - API key for authentication. - **ResultCode** (int32) - Required - Result code of the operation. - **Message** (string) - Required - A message indicating the status of the operation. ### Request Example ```json { "ProposalId": 2001, "Note": "Final Quote Document", "TagIds": "2,7", "UploadIds": [67890], "ApiKey": "your_api_key", "ResultCode": 0, "Message": "Upload successful." } ``` ### Response #### Success Response (200) - **Message** (string) - Confirmation message. #### Response Example ```json { "Message": "File uploaded successfully for proposal." } ``` ``` -------------------------------- ### POST /api/test/echo Source: https://serviceminder.io/api/index A simple endpoint to test API connectivity. It echoes back the provided ApiKey, ResultCode, and Message. ```APIDOC ## POST /api/test/echo ### Description Tests API connectivity by echoing back the provided ApiKey, ResultCode, and Message. ### Method POST ### Endpoint https://serviceminder.com/api/test/echo ### Parameters #### Request Body - **ApiKey** (string) - Required ### Response #### Success Response (200) - **ResultCode** (int32) - Output - **Message** (string) - Output ``` -------------------------------- ### POST /api/datasubscriber/getdownload Source: https://serviceminder.io/api/index Retrieves download information for a given download ID. Requires an API key for authentication. ```APIDOC ## POST /api/datasubscriber/getdownload ### Description Retrieves download information for a given download ID. Requires an API key for authentication. ### Method POST ### Endpoint https://serviceminder.com/api/datasubscriber/getdownload ### Parameters #### Query Parameters - **DownloadId** (string) - Required - The ID of the download to retrieve. - **ApiKey** (string) - Required - Your unique API key for authentication. #### Request Body This endpoint does not use a request body; all parameters are passed as query parameters. ### Request Example ```json { "DownloadId": "download_xyz", "ApiKey": "YOUR_API_KEY" } ``` ### Response #### Success Response (200) - **ResultCode** (int32) - Indicates the result of the operation (0 for success). - **Message** (string) - A message describing the outcome of the operation. ``` -------------------------------- ### Proposal Template API Source: https://serviceminder.io/api/index Manages proposal templates, defining standard structures for creating new proposals. ```APIDOC ## Proposal Template ### Description Represents a template used for creating new proposals, including standard lines and details. ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body - **Id** (int32) - Required - Unique identifier for the proposal template. - **Name** (string) - Required - The name of the template. - **IsActive** (boolean) - Required - Whether the template is currently active. - **Quantity** (double) - Optional - Default quantity for items in the template. - **ServiceId** (int32) - Required - The ID of the service associated with the template. - **ServiceDescription** (string) - Required - A description of the service. - **CustomerNote** (string) - Required - Default customer notes for proposals created from this template. - **OrganizationId** (int32) - Required - The ID of the organization this template belongs to. - **CreatedAt** (datetime) - Required - Timestamp of creation. - **UpdatedAt** (datetime) - Required - Timestamp of last update. - **ProposalTemplateLines** (ProposalTemplateLine[]) - Required - An array of proposal template lines. ``` -------------------------------- ### Service API Source: https://serviceminder.io/api/index This section details the parameters for creating or updating a service within the ServiceMinder IO platform. ```APIDOC ## Service API Endpoint ### Description This endpoint allows for the creation or modification of service entries. It includes detailed information about the service's pricing, unit of measure, and subscription details. ### Method POST or PUT (Assumed based on parameter list for service creation/update) ### Endpoint `/websites/serviceminder_io_api/service` ### Parameters #### Request Body - **Id** (int32) - Required - Unique identifier for the service. - **Name** (string) - Required - The name of the service. - **Description** (string) - Required - A detailed description of the service. - **BasePrice** (decimal) - Required - The base price of the service. - **UnitPrice** (decimal) - Required - The price per unit of the service. - **UnitOfMeasure** (string) - Required - The unit of measure for the service (e.g., "hour", "day"). - **UnitDuration** (int32) - Optional - The duration of a single unit in minutes. - **Category** (string) - Required - The category the service belongs to. - **MinimumCharge** (decimal) - Optional - The minimum charge applicable for the service. - **Duration** (int32) - Required - The standard duration of the service in minutes. - **SelfSelect** (boolean) - Optional - Indicates if the service can be selected by users. - **Subscription** (boolean) - Required - Whether the service is a subscription-based service. - **Prorating** (boolean) - Required - Whether prorating is enabled for the service. - **SubscriptionVisits** (int32) - Required - The number of visits included in a subscription. - **SubscriptionInterval** (int32) - Optional - The interval for subscription renewals in days. - **SeasonStart** (datetime) - Optional - The start date for seasonal services. - **SeasonExpiration** (datetime) - Optional - The expiration date for seasonal services. - **RecurringDescription** (string) - Required - Description for recurring services. - **AvailableParts** (Part[]) - Required - An array of available parts for the service. - **PartCategories** (String[]) - Required - An array of part categories. - **PricingBands** (PricingBand[]) - Required - An array of pricing bands. - **QuantityOverrideCustomFieldId** (int32) - Optional - Custom field ID for quantity overrides. - **UnitPriceOverrideCustomFieldId** (int32) - Optional - Custom field ID for unit price overrides. - **DurationOverrideCustomFieldId** (int32) - Optional - Custom field ID for duration overrides. - **CapacityDemandOverrdieCustomFieldId** (int32) - Optional - Custom field ID for capacity demand overrides. - **MinimumOptions** (int32) - Optional - Minimum options allowed. - **MinimumSubtotal** (decimal) - Optional - Minimum subtotal amount. - **QuantityFormula** (string) - Required - Formula for calculating quantity. - **RecordWeatherData** (boolean) - Required - Whether to record weather data. - **CustomProperties** (dictionary`2) - Required - Custom properties for the service. ### Request Example ```json { "Id": 1, "Name": "Example Service", "Description": "This is a sample service.", "BasePrice": 50.00, "UnitPrice": 75.00, "UnitOfMeasure": "hour", "Duration": 60, "Category": "Maintenance", "Subscription": true, "Prorating": true, "SubscriptionVisits": 12, "RecurringDescription": "Monthly Maintenance", "AvailableParts": [], "PartCategories": [], "PricingBands": [], "QuantityFormula": "1", "RecordWeatherData": false, "CustomProperties": {} } ``` ### Response #### Success Response (200) - **Id** (int32) - The ID of the created or updated service. - **Message** (string) - Confirmation message. #### Response Example ```json { "Id": 1, "Message": "Service created successfully." } ``` ``` -------------------------------- ### Proposal Summary API Source: https://serviceminder.io/api/index Provides a summary of a proposal, including service details and status. ```APIDOC ## Proposal Summary ### Description A summary view of a proposal, containing key information like service, date, and status. ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body - **Id** (int32) - Required - Unique identifier for the proposal. - **Service** (idname) - Required - The service associated with the proposal summary. - **Date** (string) - Required - The date of the proposal. - **Status** (string) - Required - The status of the proposal. ``` -------------------------------- ### POST /api/user/create Source: https://serviceminder.io/api/index Creates a new user in the Serviceminder system. Requires user details such as name, email, phone number, role, and whether to create a service agent. ```APIDOC ## POST /api/user/create ### Description Creates a new user account in the Serviceminder system, including details like name, email, phone, and role. ### Method POST ### Endpoint https://serviceminder.com/api/user/create ### Parameters #### Request Body - **Name** (string) - Required - **Email** (string) - Required - **MobilePhone** (string) - Required - **CreateServiceAgent** (boolean) - Required - **Role** (string) - Required - **ApiKey** (string) - Required ### Response #### Success Response (200) - **ResultCode** (int32) - Output - **Message** (string) - Output ``` -------------------------------- ### POST /api/datasubscriber/fetch Source: https://serviceminder.io/api/index Fetches data subscriber events. Requires an API key for authentication. ```APIDOC ## POST /api/datasubscriber/fetch ### Description Fetches data subscriber events. Requires an API key for authentication. ### Method POST ### Endpoint https://serviceminder.com/api/datasubscriber/fetch ### Parameters #### Query Parameters - **ClearThroughId** (int32) - Optional - The ID up to which events should be cleared after fetching. - **EventCount** (int32) - Optional - The number of events to fetch. - **Events** (DataSubscriberEvent[]) - Required - An array of data subscriber events to fetch. - **ApiKey** (string) - Required - Your unique API key for authentication. #### Request Body This endpoint does not use a request body; all parameters are passed as query parameters. ### Request Example ```json { "ClearThroughId": 789, "EventCount": 50, "Events": [ { "eventId": "event2" } ], "ApiKey": "YOUR_API_KEY" } ``` ### Response #### Success Response (200) - **ResultCode** (int32) - Indicates the result of the operation (0 for success). - **Message** (string) - A message describing the outcome of the operation. ``` -------------------------------- ### Proposal Option API Source: https://serviceminder.io/api/index Defines options within a proposal, allowing for selection and configuration. ```APIDOC ## Proposal Option ### Description Represents an option within a proposal, which can be selected or deselected. ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body - **Id** (int32) - Required - Unique identifier for the proposal option. - **Name** (string) - Required - The name of the option. - **Selected** (boolean) - Required - Indicates if this option is selected. ``` -------------------------------- ### Download Invoice Line Settings Source: https://serviceminder.io/api/index Settings for downloading invoice line item data. ```APIDOC ## DownloadInvoiceLineSettings Object This object defines parameters for downloading invoice line item data. ### Parameters - **Open** (boolean) - Optional - Include only open invoice lines. - **Paid** (boolean) - Optional - Include only paid invoice lines. - **Voided** (boolean) - Optional - Include only voided invoice lines. - **Unapproved** (boolean) - Optional - Include only unapproved invoice lines. - **IncludeExcludedOrgs** (boolean) - Optional - Whether to include data from excluded organizations. ``` -------------------------------- ### POST /api/appointments/queue Source: https://serviceminder.io/api/index Queues an appointment for scheduling. Requires details about the appointment and desired scheduling time. ```APIDOC ## POST /api/appointments/queue ### Description Queues an appointment for scheduling. Requires details about the appointment and desired scheduling time. ### Method POST ### Endpoint https://serviceminder.com/api/appointments/queue ### Parameters #### Request Body - **AppointmentId** (int32) - Required - Unique identifier for the appointment. - **ServiceName** (string) - Required - The name of the service. - **ContactId** (int32) - Required - Unique identifier for the contact. - **QueueDate** (string) - Required - The desired date for the appointment to be queued. - **Duration** (string) - Required - The duration of the appointment. - **Quantity** (double) - Required - The quantity of the service. - **ServiceId** (int32) - Required - Unique identifier for the service. - **AddOnParts** (AddOnPart[]) - Required - Array of add-on parts. - **Demand** (int32) - Optional - The demand for the service. - **Discount** (decimal) - Optional - The discount applied to the service. - **Notes** (string) - Required - Any notes related to the appointment. - **NotificationUri** (string) - Required - URI for notifications. - **CallCenterTransactionId** (int32) - Optional - Transaction ID for call center. - **ApiKey** (string) - Required - API key for authentication. ### Response #### Success Response (200) - **ResultCode** (int32) - Indicates the result of the operation. - **Message** (string) - A message describing the result. ``` -------------------------------- ### POST /api/download/downloadstatus Source: https://serviceminder.io/api/index Checks the status of a general download operation. Requires an API key for authentication. ```APIDOC ## POST /api/download/downloadstatus ### Description Checks the status of a general download operation. Requires an API key for authentication. ### Method POST ### Endpoint https://serviceminder.com/api/download/downloadstatus ### Parameters #### Query Parameters - **DownloadId** (string) - Required - The ID of the download to check. - **Records** (int32) - Optional - The number of records downloaded. - **Ready** (boolean) - Required - Indicates if the download is ready. - **ApiKey** (string) - Required - Your unique API key for authentication. #### Request Body This endpoint does not use a request body; all parameters are passed as query parameters. ### Request Example ```json { "DownloadId": "download_def", "Records": 1000, "Ready": false, "ApiKey": "YOUR_API_KEY" } ``` ### Response #### Success Response (200) - **ResultCode** (int32) - Indicates the result of the operation (0 for success). - **Message** (string) - A message describing the outcome of the operation. ``` -------------------------------- ### POST /api/appointments/book Source: https://serviceminder.io/api/index Books a new appointment with detailed service and contact information. Requires multiple parameters including AppointmentId, ServiceName, ContactId, ServiceId, InvoiceId, SearchDate, TargetDate, Duration, Quantity, Timeframe, Slots, AddOnParts, CancelReasonId, UpdateNote, and an APIKey. ```APIDOC ## POST /api/appointments/book ### Description Books a new appointment with detailed service and contact information. Requires multiple parameters including AppointmentId, ServiceName, ContactId, ServiceId, InvoiceId, SearchDate, TargetDate, Duration, Quantity, Timeframe, Slots, AddOnParts, CancelReasonId, UpdateNote, and an APIKey. ### Method POST ### Endpoint https://serviceminder.com/api/appointments/book ### Parameters #### Request Body - **AppointmentId** (int32) - Required - The ID of the appointment. - **ServiceName** (string) - Required - The name of the service. - **ContactId** (int32) - Required - The ID of the contact. - **ServiceId** (int32) - Required - The ID of the service. - **InvoiceId** (int32) - Required - The ID of the invoice. - **IncludeCompleted** (boolean) - Optional - Whether to include completed services. - **SearchDate** (string) - Required - The date to search for appointments. - **TargetDate** (string) - Required - The target date for the appointment. - **Duration** (string) - Required - The duration of the appointment. - **Quantity** (double) - Required - The quantity of the service. - **Discount** (decimal) - Optional - The discount amount. - **Timeframe** (string) - Required - The timeframe for the appointment. - **SlotWindowDays** (int32) - Optional - The number of days to look ahead for available slots. - **Notes** (string) - Required - Additional notes for the appointment. - **NotificationUri** (string) - Required - The URI for notifications. - **EnRouteUri** (string) - Required - The URI for en-route notifications. - **ThirdPartyUrl** (string) - Required - A URL for a third party. - **SkipConflictChecks** (boolean) - Optional - Whether to skip conflict checks. - **CallCenterTransactionId** (int32) - Optional - The ID of a call center transaction. - **Slots** (AppointmentSlot[]) - Required - An array of available appointment slots. - **AddOnParts** (AddOnPart[]) - Required - An array of add-on parts. - **UpdateLines** (boolean) - Optional - Whether to update lines. - **NotificationOptions** (String[]) - Required - An array of notification options. - **UpdateActuals** (boolean) - Optional - Whether to update actuals. - **ActualStart** (datetime) - Optional - The actual start time. - **ActualFinish** (datetime) - Optional - The actual finish time. - **RootProposalId** (int32) - Optional - The ID of the root proposal. - **CancelReasonId** (int32) - Required - The ID of the cancellation reason. - **UpdateNote** (string) - Required - A note for updating the appointment. - **ApiKey** (string) - Required - Your unique API key. ### Response #### Success Response (200) - **ResultCode** (int32) - Indicates the result of the operation. - **Message** (string) - A message describing the result. ``` -------------------------------- ### POST /api/payment/import Source: https://serviceminder.io/api/index Imports payment information. ```APIDOC ## POST /api/payment/import ### Description Imports payment information. ### Method POST ### Endpoint https://serviceminder.com/api/payment/import ### Parameters #### Query Parameters - **Payment** (payment) - Required - The payment object to import. - **PaymentId** (int32) - Optional - The ID of the payment. - **ApiKey** (string) - Required - The API key for authentication. ### Response #### Success Response (200) - **ResultCode** (int32) - The result code of the operation. - **Message** (string) - A message indicating the status of the operation. ``` -------------------------------- ### POST /api/channels/campaigns Source: https://serviceminder.io/api/index Retrieves campaign information for channels based on various criteria. Requires an API key. ```APIDOC ## POST /api/channels/campaigns ### Description Retrieves campaign information for channels based on various criteria. ### Method POST ### Endpoint https://serviceminder.com/api/channels/campaigns ### Parameters #### Request Body - **Cities** (City[]) - Required - Array of city objects. - **LeadSourceCategories** (Channel[]) - Required - Array of channel objects. - **PostalCodes** (String[]) - Required - Array of postal codes. - **Features** (String[]) - Required - Array of features. - **Channels** (Channel[]) - Required - Array of channel objects. - **NamedTaxRates** (NamedTaxRate[]) - Required - Array of named tax rate objects. - **ApiKey** (string) - Required - Your API key for authentication. #### Response ##### Success Response (200) - **ResultCode** (int32) - Indicates the result of the operation. - **Message** (string) - A message describing the result of the operation. ``` -------------------------------- ### POST /api/proposal/accept Source: https://serviceminder.io/api/index Accepts a proposal by ID, requiring signature and IP address. ```APIDOC ## POST /api/proposal/accept ### Description Accepts a proposal by ID, requiring signature and IP address. ### Method POST ### Endpoint https://serviceminder.com/api/proposal/accept ### Parameters #### Query Parameters - **ProposalId** (int32) - Required - The ID of the proposal to accept. - **Name** (string) - Required - The name of the person accepting. - **SignatureData** (string) - Required - The signature data. - **IpAddress** (string) - Required - The IP address of the client. - **ApiKey** (string) - Required - The API key for authentication. ### Response #### Success Response (200) - **ResultCode** (int32) - The result code of the operation. - **Message** (string) - A message indicating the status of the operation. ```