ASP.NET Web API Help Page

This method will retrieve product marketing data for a report marketing page

This method will retrieve product marketing page model for a report (product) identified by a URL slug set on the product model itself.

This method will return data for an Assessment Analysis report that will contain information for custom comparable properties specified on request. At least 3 properties are required to generate assessment analysis report.

This method will retrieve default assessment analysis report data for a property

This method will return data for an Assessment Analysis report that will contain information for custom comparable properties specified on request. At least 3 properties are required to generate assessment analysis report.

This method will retrieve default assessment analysis report data for a property

This method will retrieve multi-property appeal options comparison data for report

This method will retrieve all data associated with a full property tax report for an individual property based on the target appeal type and if this is the case, a most reset property value defined at purchase or thru an appraisal. Date of the purchase or an appraisal should be specified as part of the request

This method will retrieve data for the county report page to be distributed with every report.

This method will retrieve data for Property Tax Guide at Purchase report that helps clients understand what they should do before, at and after the closing in order to reduce their property taxes

This method will retrieve data for Property Market Analysis report that users will need for filing Over-valuation appeal for a property that has recently being purchaed or for which user has a recent appraisal

This method will retrieve data for Property Market Analysis report that users will need for filing Over-valuation appeal for a property that has recently being purchaed or for which user has a recent appraisal

This method will retrieve data for Market Property (Seller/Buyer) report that will be a marketing tool to realtors

This method will retrieve all property tax attorneys that we can refer to process appeal for a specific property by id

This method will retrieve real estate professional's data by their affiliate code

This method should be used to submitt appeal filing contact request to attorneys who use our network

This method will submit attorney filing contact request to random number of attorneys

This method should be used to submit exemption filing contact request to attorneys who use our network

This method will submit exemption filing contact request to random attorneys

This method will retrieve appeal contact requests for individual user

This method will retrieve exemption filing contact requests for individual user

This method will update filing contact request status for individual contact request

This method will update exemption filing contact request by id

This method will retrieve all partners that were signed up by user

This method will retrieve a collection of attorneys who refer business to the active user/attorney

This method will retrieve a collection of attorneys for account ledger screen

This method will update referrer attorney model

Use this method to retrieve account ledger row items for case fees associated with an active attorney

Use this method to retrieve account ledger row items for appeal fees associated with a referral attorney who is being charged a fee for every additional appeal due to low subscription montly fee

Use this method to retrieve account ledger row items for referral fees associated with a referral/share fee attorney

Use this method to retrieve account ledger row items for processing fees associated with a referral/share fee attorney

Use this method to retrieve account ledger row items for earnrf fees associated with a referral attorney whose processing fees were included in monthly subscription fees

Use this method to record a refund or referral payment to a referral attorney.

Use this method to update a refund or referral payment to a referral attorney.

Use this method to delete a refund or referral payment to a referral attorney.

This method will retrieve all Email Templates for a user

This method will allow user to add a new email template for an active user

This method will update existing email template for an active user

Delete existing email template for an active user

Use this method to retrieve all email tokens available on the platform

This method should be used to generate email body from email template specified on request

This method should return a filtered collection of submitted email requests; filtered by the start date and end date

No documentation available.

This method should be used to submit a new email request for one or more properties.

Use thid method to retrieve X number of emails pending delivery per original email request

Use this method to update delivery information on email records that were delivered to recipients by the email server

This method will retrieve all employees for an attorney (employer)

This method will retrieve all appeals assigned to a specific employee

This method will retrieve all available employee roles

This method will add a new employee record

Retrieve employee record by Employee Id

This method will update employee record

This method will delete individual employee by id

No documentation available.

This method will update user's Avatar to the uploaded images

This method will retrieve condo analysis results for all associations in a specific county identified by id.

No documentation available.

Use this method to retrieve condo analysis for a report

No documentation available.

No documentation available.

No documentation available.

No documentation available.

This method will retrieve taxcode statistics data for a Township Page based on the taxcode id. Data will be retrieve for a current appeal tax year only

This method will retrieve taxcode statistics data for a Township Page based on the taxcode id. Data will be retrieve for a current appeal tax year only

No documentation available.

This method will retrieve all system users order by the join date

This method will retrieve user profile of a logged in system user

This method will retrieve user profile of a system user when requested by another system user who has previously logged into the system

This method will retrieve profile page model for a system user identified by his user id

This method should be used to update user profile of a system user

This method will update system user's Avatar to the uploaded images

This method will delete a specific system user using specified username

This method will delete a specific system user using specified username

This method will retrieve a list of county assignments for a target user

This method will add a new county assignment to user

No documentation available.

This method will delete an existing county assignment for user

This method will delete an existing county assignment for user

This method will update county assignments for user

This method will retrieve employment details for a system user

This method will add employment details to user by user id

This method will update existing employment details for user by user id

This method will retrieve company's latest privacy policy

This method will retrieve company's latest service agreement

This method will retrieve company's latest terms of use policy

This method will retrieve company's latest information for the about page

This method will retrieve content of any page by type

This methid will retrieve all FAQ items in the system

This method will retrieve company's eula policy

This method will retrieve appeal history/performance for a company

This method will find the first 10 properties that match search string entered by users

This method will resolve multiple address search requests

This method will retrieve a potential comparable property by id

This method will retrieve property address record based on request criteria specified by client

This method will return property assessment change statistics for a property with a specified pin

This method will return property tax rate change statistics for a property with a specified pin

This method will retrieve property tax statistics for a property to be displayed on the Township page

This method will retrieve property tax statistics for a property to be displayed on the Township page

No documentation available.

No documentation available.

This method will retrieve property exemptions historical data for a specific property and x number of history years.

This method will retrieve all documents generated for a specific property by a particular user

No documentation available.

Use this method to retrieve property tax payment information for property as it is specified by the assessor

No documentation available.

No documentation available.

No documentation available.

No documentation available.

No documentation available.

This method will link appeal cases created by attorney for all business user properties to active use

Process request to create new client, new property, and new appeal for the new property for specifc attorney by Id

This method will retrieve content of a specific site page identified by the slug used for loading it.

This method will retrieve content of a specific site page identified by the slug used for loading it.

This method will retrieve reference state data to be used in state selection

This method will retrieve reference state data for all supported states to be used in state selection

This method will retrieve all counties for selection control in state with specified id

This method will retrieve all supported counties for a selection controls in specified state

This method will retrieve all employment types

This method will retrieve user alert types supported by the system

This method will retrieve priority levels supported by the system

This method should be used to retrieve agency case status values

This method should be used to retrieve upload document types

This method should be used to retrieve list of existing deeds

Use this method to retrieve available payment methods

Use this method to retrieve available payment types

No documentation available.

This method should be used to retrieve list of supported calendar event types

This method will add a new client for a business user

This method will update record for an existing client for a business user

This method will delete an existing business client

This method will retrieve record for an existing business client by id

This method will retrieve models for all clients created by the business user

This method will retrieve models for all clients created by the business user

This method will retrieve a collection of calendar events for a user based on the specified date range or for a specific date. Specific date is set only when day parameter is specified on request; otherwise a first and last days of a month identified in the request will be taken

This method will add a new calendar event to user's calendar

This method will update content of a calendar event by userid and eventid.

This method will delete a single calendar event using its id.

This method will import attorney's client/property data into database from csv import file

This method will all user to subscribe to all appeal schedule change email notification from out platform on a per township basis

This method will allow user to unsubscribe from previously subscribed appeal schedule change notifications for a specific township and user

This method will validate catcha user token received from the client

This method will allow user to submiscribe to appeal support notification requests based on their property class

This method will retrieve all appeal notifications for an active user

No documentation available.

No documentation available.

This method will retrieve all gift certificates purchase by user

This method will create new gift certificate records for a user

This method will update/customize existing gift certificate for user

This method will delete individual gift certificate by id

This method will generate gift certificate document so that client can download

This method will validate gift certificate code per client's request

This metod will retrieve influencer referral statistics system wide

No documentation available.

This method should be used to create new case record for a specific user property

This method should be used to create a new agency case for an existing user property case

This method should be used to retrieve simple models for all property case records on the existing user property

This method will retrieve active cases for a property by its address record id

This method will retrieve a single active appeal case for user by its user property id

This method will retrieve full property case details for an existing case

This method will retrieve property case details for a client portal

This method will update basic information on the existing property case record

This method will update employee assignment details on the existing property case record

This method will update appraisal details on the existing property case record

This method will update vacancy details on the existing property case record

This method will filing types for a case based on the case type and the agency id

Use this method to update appeal dates/base information on an individual agency case record

Use this method to update vacancy details on an individual agency case record

Use this method to update construction details on an individual agency case record

Use this method to update property description error details on an individual agency case record

Use this method to add a new Agency Case record for an existing User Property Case

Use this method to update individual filing record on an agency case

Use this method to delete individual filing record on an agency case

Use this method to update analysis and estimates data for each property improvement

Use this method to update comparable properties' pins on analysis and estimates data for each property improvement

Use this method to update multiple analysis and estimates data for all property improvements associated with the property at once

Use this method to retrieve comparable properties for agency case improvement analysis

Use this method to update analysis and estimates data for a condo association

Use this method to update appeal data for all condo units in the association

Use this method to refresh current year assessment for condo units in the association

This method should be used to record appeal status change intiated by client for a specific appeal of a specific user property

This method should be used to add new document category for an agency case

Use this method to delete an existing client document category by id. This will only be allowed if the category has IsDeleteAllowed flag set to falce

This method will retrieve product bundles for agency case by id

This method will retrieve product bundles for user property case type

No documentation available.

This method should be used to appeal history records for a property

Use this method to retrieve all existing appeal/exemption cases for an active user to display on their dashboard

Use this method to delete an existing usre property case

This method will generate case document for an existing case or agency case

This method will generate custom analysis report for a specific property if user has already purchased case for that property

This method should be used to force regeneration of documents and reports for a specific appeal and specific user property

This method should be used to upload document for an active case for a user property

This method will retrieve case specific document that were previously uploaded to the server

This method will delete existing appeal document from the server for a specific user property and for an active appeal

This method will create a new appeal note for an active appeal

This method should be used to retrieve notes for a specific case by id

This method should be used to delete existing case note for an active case

Use this method to update case fee for an existing case

No documentation available.

This method will create a new charge for a case

This method will update an existing charge by id

This method will delete existing charge/order by id

This method should be used to add a new charge the client for the appeal

Use this method to refund existing payment to user on the user case. This will create another payment record of type 'Refund' and will set Refundable flag to false on the original transaction.

This method should be used to retrieve log statements for a specific case by id

This method will submit data update request for properties in a specified township/county

No documentation available.

This method will retrieve all products that were setup in the system

This method will retrieve all product associated with the specific property appeal types picked for a property appeal

This method will retrieve popup data represented by a model of ProductBundle

This method will retrieve all product bundles for a specifid property and target appeal type specified on request.

This method will retrieve all product bundles that user can select individually on the UI

This method will retrieve all product bundles for a specifid property and target appeal type specified on request.

This method will retrieve exemption product bundles available for selected exemptions and their corresponding years

This method will retrieve all system supported subscription plans that can be displayed to end users

This method will retrieve all system supported subscription plans that can be displayed to end users

This method will retrieve site user information and settings using affiliate code specified as part of the iframe url

This method will create new web user record and add charge for that user to be paid at the later time

This method will update overpayment amount and set analyzed property id on the webuser record. This will allow us to associate analysis ran to a specific web user

Use this method to charge credit card of the site visitor for analysis fee prior to allowing the user to view Property Tax Analysis results

This method will retrieve counts for all list items on the donut shaped graph on the customer support page

This method will retrieve filtered record set of support requests for a specific time period and type specified as part on request

This method will retrieve page model data for the support requests' list page

This method will retrieve page model for Custom Support page viewed by specific user

This method will assign or re-assign a specific support request to a system user

This method will retrieve support request record

This method will retrieve page model for the support request editor page based on the specified support request id

This method will retrieve all support request comment for an individual support request

This method will retrieve support request comment for an existing comment id and support request id

This method should be used to delete an existing support request comment

This method will add a new support request comment to an existing support request record

This method should be used to update an individual support request comment

This method will retrieve all attachment records associated with an individual support request comment

This method will retrieve individual support request attachment record by id

This method should be used to add attachments to an existing support request comment

This method should be used to delete a previously added attachment on the support comment

This method should be used to update avatar image for the submitter of the support request. Image should be transmitted as a multi-part request

This method will update an existing support request in the system

This method will publish or turn off publishing of an individual support request.

This method should be used to retrieve client app configuration

This method will retrieve all website users order by the join date

This method will return instance of the UserProfile class for user identified with UserId

This method will update user profile for a currently logged in user

This method will update user's Avatar to the uploaded images

This method will update user's business logo

This method will add a new property for user who is currently logged in

This method will update user property that was previously added for a logged in user

This method should be used to update notes on an existing user property object

This method will retrieve all properties for a logged in user

This method will retrieve all properties for a logged in user; GetCachedUserPropertyModelsByPageAndFilteredAsync

This method will retrieve property status with user, but retrieving a matching user proeprty object, last active appeal object and its id

This method will retrieve all properties for a logged in user

This method will retrieve a full set of property details for a user property by id

Use this method to extract client user property record based on the id of the attorney's user property record and user property case id

This method will delete existing user property for a logged in user

This method should be used to upload document for a user property

This method will delete existing appeal document from the server for a specific user property

This method will retrieve all documents uploaded for a specific user property

This method will retrieve townships, their appeal schedules, agencies involved and re-assessment year data for all user properties

This method should be used to change user's password on the account

This method should be used to link an external social account to user's account for the purpose of login

This method will change property monitoring for each individual property

This method will retrieve account usage statistics for a user account

This method will retrieve affiliate usage statistics for a user account

This method will retrieve all user property lists that were previously created by a specific system user

This method will create a new user property list for user based on the provided information

This method should be used to delete existing user property list by id for specific user

This method will add a new user property to an existing list

This method should be used to add one or more properties to one or more custom lists at the same time

This method should be used to delete existing user property list by id for specific user

This method will retrieve client referrals for an individual influencer

This method will retrieve all client referrals done by logged in user

This method will retrieve all web user visitors and their tax analysis requests for a requested attorney

Use this method to update exisitng webuserrequest object for a web visitor

No documentation available.

This method will retrieve all purchases for a currently logged in user based on the query parameters specified by end user

No documentation available.

No documentation available.

No documentation available.

This method will retrieve ptd user appeal/property summary data for user's dashboard

This method will retrieve basic property record for active user with their case information.

This method will retrieve all of the existring credit cards for current user and active payment gateway

This method will create a new credit card for current user based on the card token specified on request

This method should be used to delete existing card for currently logged in by card id

No documentation available.

This method will update active attorney for user by id

This method will retrieve all townships for a specific county

This method will retrieve comparable property guidelines for a county

This method will retrieve time-series state equalization factor data for a county

This method will retrieve county model data for a county

This method will retrieve tax appeal guidelines for a county

This method will retrieve county statistics for a county

This method will retrieve county appeal locations for a county

This method will retrieve tax payment installments information for a county

This method will retrieve basic county information for a county

This method will retrieve all county agencies that are responsible for a property tax appeal

This method will retrieve all county agencies.

This method will retrieve all support appeal types for a specific county

Use this method to update appeal schedule for a specific county

This method will retrieve To-Do items for a specific user

This method will retrieve an individual to-do item created by user identified by id

This method will create a new to-do item for user

This method will update an existing to-do item for user and id

This method will delete an existing to-do item for user by id

This method will retrieve user alerts for a specific user identified by an id. A second request parameter should be used to filter alerts being retrieved to all or unresolved alerts only

This method will retrieve a single user alert by id

This method will createa a new user alert targeted to a specific user

This method will resolve a single user alert based on its id

This method will delete individual user alert by id

This method will submit support request of any type

This method will retrieve praise feedback left by users that users have allowed to use for marking purposes on the website

Use this method to submit registration contact request for a pilot program from business landing page.

This method will retrieve all townships for a specific county

This method will retrieve ids for all townships that are fully or partially located in the specified zipcode

This method will retrieve ids for all townships with names that match search string specified by the user and are located in the specified county

This method will retrieve all county townships with property counts and statistical data for the heat map

This method will retrieve individual township data with property counts and statistical data for the heat map

This method will retrieve historical township tax rate statistical data for an individual township

This method will retrieve latest township tax rate statistical data for an individual township

This method will retrieve latest appeal schedule for all townships in the county identified by an id

This method will retrieve page model for the appeal schedule page for a specific county

No documentation available.

This method will retrieve latest appeal schedule for an individual township identified by a township id

This method will retrieve township appeal schedule for an individual township and a specific appeal year. If appeal year was not specified, current appeal year will be used

This method will return year over year percent change data for a min tax rate for all townships in an individual county for display on the township heat map

This method will return year over year percent change data for a avg tax rate for all townships in an individual county for display on the township heat map

This method will return year over year percent change data for a max tax rate for all townships in an individual county for display on the township heat map

This method will return year over year percent change data for a avg land assessment for all townships in an individual county for display on the township heat map

This method will return year over year percent change data for a avg building assessment for all townships in an individual county for display on the township heat map

This method will return year over year percent change data for a avg total assessment for all townships in an individual county for display on the township heat map

This method will retrieve a complete set of heat map data for all townships in an individual county identified by an id

This method will retrieve all township data for a Township Page based on the townshipId. Data will be retrieve for a current appeal tax year only

This method will retrieve latest tax rate statistics for all townships in an individual county

This method will retrieve latest assessment statistics for all townships in an individual county

No documentation available.

This method will retrieve a previously created cart for a current user for a specific property by id

This method will create a new shopping cart for a property and specific product

No documentation available.

This method will add a new product to a cart for a property with a specified discount code if known upfront

This method will apply discount code to a specific cart

This method will remove a product from a cart

This method will retrieve data records for all states that include state geometry and center

This method will retrieve all counties for a specific state

This method will retrieve company's latest privacy policy

This method will record user action when interracting with a specific advertiser

No documentation available.

This method will handle all stripe event notificaitons for Property Tax Detective Co

This method will handle all stripe event notification for Property Tax Fox LLC

This method will act as IPN message handler for all PayPal notifications

This method should be used to create new appeal record for a specific user property

This method should be used to retrieve simple models for all property appeal records on the existing user property

This method will retrieve active appeals for a property by its address record id

This method will retrieve a single active appeal for user by its user property id

This method will retrieve full property appeal details for an existing appeal

This method will charge client for appeal using fee specified by tax professional

This method will update existing property appeal record

Use this method to update appeal price for an existing appeal

This method will cancel an existing appeal

This method should be used to retrieve appeal status values

This method should be used to retrieve status logs for a specific user property and property appeal

This method should be used to record appeal status change intiated by client for a specific appeal of a specific user property

This method should be used to update appeal status change log on a specific appeal record for a specific user property

This method will generate custom analysis report for a specific property if user has already purchased appeal for that property

This method should be used to force regeneration of documents and reports for a specific appeal and specific user property

This method will generate appeal narrative document for an existing appeal

This method will generate client engagement/retention documents for existing appeal

This method will generate appeal decision letter for an existing appeal

No documentation available.

No documentation available.

No documentation available.

This method should be used to upload document for an active appeal for a user property

This method will retrieve appeal specific document that were previously uploaded to the server

This method will delete existing appeal document from the server for a specific user property and for an active appeal

This method will create a new appeal note for an active appeal

This method should be used to retrieve appeal notes for a specific appeal by id

This method should be used to update existing appeal note on an active appeal

This method should be used to delete existing appeal note for an active appeal

This method will return results of the purchase price analysis

This method will run market analysis on a property using property's appraised value

This method will run default assessment analysis for a specific property that does not use any custom parameters for prperty comparison

This method will run exemption analysis for the property and the owner based on the user ownership and personal profile

This method will find all missing exemptions for the homeowner that he can apply for in this tax year (current year)

This method will find all certificates of error that homeowner can apply for this year. Certificates of Error are refunds for which homeowner can apply for. They represent past exemptions for the last 3 years that user was entitled to but did not receive. User can file a certificate of error for each of these exemptions in order to receive a refund.

This method will retrieve and return tax analysis recommendations for a specific property and year

This method will check system level appeal support for a particular property using its id

This method will check system level appeal support for a particular property using its id

This method will validate appeal by running a full property tax analysis and suggesting all appropriate appeals for a target property based on the information entered by the user

This method will find comparable properties for a target property identified by id based on comparison criteria specified as part of input. If only property id was specified, default comparison criteria will be applied.

This method will retrieve various comparable property counts available for assessment analysis for an individual property using its id

This method will retrieve data for assessment analysis review page for a specified property.

This method will retrieve page data for Market Analysis Review page that will be used to expalin analysis results to end user who tried to analyze their property. This method will handle either apprisal based market analysis or purchase price based market analysis

This method will retrieve IDs of all comparable properties that were identified for a target subject property

This method will retrieve all potential comparable properties for a subject property based on its record id

This method will return menu items for search and compare screen that should be displayed and provided to users during the analysis of a specific subject property

This method will validate comparable property against a target subject property to ensure it is a proper comparable property and can be used for Assessment Analysis report.

This method will e-mail analysis results for a specific property to end user using e-mail he specifies on the screen

No documentation available.

No documentation available.

No documentation available.

No documentation available.

This is a new method for creating an orde record

This method should be used to retrieve all order records for current user

No documentation available.

This method will retrieve order by id for a current user

This method should be used to charge client for a non-appeal related orders

This method will refund a specific charge on an order

This method will retrieve all documents generated for an existing order

This method should be used to force generation of documents and reports for a specific order

This method should be used to force generation of documents and reports for a specific order and specific user property

This method will generate exemption documents purchased for a specific order

No documentation available.

This method will try to find property(ies) that match user entered address or pin

This method will try to find property(ies) that match user entered address or pin

This method will run property tax analysis for a user selected property

This method will run property exemption analysis for a user selected property

This method will find all townships by zipcode

This method will retrieve appeal schedule for township user picked

This method will submit exemption filing help request to us

This method will persist new messanger user as the user who contacted/interracted with chatbot; subscribed user

No documentation available.

Use this method to generate marketing report for prospect client requested by influencer

No documentation available.

This method should be used to get all existing subscriptions for currently logged in user

This method should be used to subscribe user to one of the supported product plans

This method should be used to change existing active subscription, but upgrading or downgrading it.

This method should be used to cancel a currently active subscription for user

This method should be used to re-activate subscription pending cancellation.

This method will validate coupon submitted by user at the time of purchasing a subscription

No documentation available.

This method should be used to get all existing subscriptions for currently logged in user

This method should be used to subscribe user to one of the supported product plans

This method should be used to change existing active subscription, but upgrading or downgrading it.

This method should be used to cancel a currently active subscription for user

This method should be used to re-activate subscription pending cancellation.

No documentation available.

No documentation available.

No documentation available.

No documentation available.

No documentation available.

No documentation available.

No documentation available.

No documentation available.

No documentation available.

No documentation available.

No documentation available.