ASP.NET Web API Help Page

Introduction

Provide a general description of your APIs here.

About

Retrieves About Information

API	Description
GET api/About?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}	Get about information

AccountAutoAuthentication

Retrieves Auto Authentication link for Account

API	Description
GET api/AccountAutoAuthentication/{ID}?validationKey={validationKey}&partnerKey={partnerKey}&vendorID={vendorID}&vendorPassword={vendorPassword}&APIGUID={APIGUID}&IDPassword={IDPassword}	Retrieves URL with GUID for account authorization using account ID and password ID for validationID PasswordURL with GUID for autoauthentication
GET api/AccountAutoAuthentication/{ID}?validationKey={validationKey}&partnerKey={partnerKey}&vendorID={vendorID}&vendorPassword={vendorPassword}&APIGUID={APIGUID}	Retrieves URL with GUID for account authorization using API GUID and ID ID for validationURL with GUID for autoauthentication

AccountDetail

Retrieves account detail

API	Description
GET api/AccountDetail?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&ResidentKey={ResidentKey}&MaximumReturned={MaximumReturned}&TransactionsAsOf={TransactionsAsOf}	Get AR account detail for an account Returned data record with ResidentTransactionKey=0 is balance forward record

AccountSearch

API	Description
GET api/AccountSearch?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&PropertyAccessLevel={PropertyAccessLevel}&IncludeClosed={IncludeClosed}&FindUsing={FindUsing}&CompanyKey={CompanyKey}	Retrieves account information using search criteria

AccountSSO

Manages account SSO

API	Description
GET api/AccountSSO?validationKey={validationKey}&partnerKey={partnerKey}&vendorID={vendorID}&vendorPassword={vendorPassword}&APIGUID={APIGUID}&SSOPosition={SSOPosition}&SSOGUID={SSOGUID}	Get auto-authentication URL SSO field position for validation (1-6)GUID
GET api/AccountSSO/{ID}?validationKey={validationKey}&partnerKey={partnerKey}&vendorID={vendorID}&vendorPassword={vendorPassword}&APIGUID={APIGUID}&SSOPosition={SSOPosition}&IDPassword={IDPassword}	Retrieves GUID for SSO authorization SSO field position for validation (1-6)ID for validationID Password
GET api/AccountSSO?validationKey={validationKey}&partnerKey={partnerKey}&vendorID={vendorID}&vendorPassword={vendorPassword}&APIGUID={APIGUID}&SSOGUID={SSOGUID}	Get auto-authentication URL GUID
GET api/AccountSSO/{ID}?validationKey={validationKey}&partnerKey={partnerKey}&vendorID={vendorID}&vendorPassword={vendorPassword}&APIGUID={APIGUID}&IDPassword={IDPassword}	Retrieves GUID for SSO authorization ID for validationID Password

AccountStatus

Retrieves account status information, including current billing

API	Description
GET api/AccountStatus?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&ResidentKey={ResidentKey}&BillingPeriod={BillingPeriod}	Get AR account detail for an account Returned data record with ResidentTransactionKey=0 is balance forward record

AllowedUploadExtensions

Retrieves allowed file extensions when uploading binary files

API	Description
GET api/AllowedUploadExtensions?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}	Retrieves allowed file extensions when uploading binary files

APIGUID

Retrieves GUID for authorization for resident, employee or vendor, used when calling most of the REST APIs

API	Description
GET api/APIGUID/{ID}?validationKey={validationKey}&partnerKey={partnerKey}&vendorID={vendorID}&vendorPassword={vendorPassword}&IDPassword={IDPassword}	No documentation available.
POST api/APIGUID?validationKey={validationKey}&partnerKey={partnerKey}	No documentation available.

APIGUIDAccount

Retrieves GUID for authorization for resident, used when calling most of the REST APIs

API	Description
GET api/APIGUIDAccount?validationKey={validationKey}&partnerKey={partnerKey}&vendorID={vendorID}&vendorPassword={vendorPassword}&accountID={accountID}&accountPassword={accountPassword}	Retrieves GUID for account authorization

APIGUIDAutoAuthenticator

Retrieves GUID for authorization using auto authenticator for resident, used when calling most of the REST APIs

API	Description
GET api/APIGUIDAutoAuthenticator?validationKey={validationKey}&partnerKey={partnerKey}&vendorID={vendorID}&vendorPassword={vendorPassword}&AuthenticationGUID={AuthenticationGUID}	No documentation available.

APIGUIDEmployee

Retrieves GUID for employee authorization, used when calling most of the REST APIs

API	Description
GET api/APIGUIDEmployee?validationKey={validationKey}&partnerKey={partnerKey}&vendorID={vendorID}&vendorPassword={vendorPassword}&employeeID={employeeID}&employeePassword={employeePassword}	Retrieves GUID for employee authorization

APIGUIDVendor

Retrieves GUID for vendor authorization, used when calling most of the REST APIs

API	Description
GET api/APIGUIDVendor?validationKey={validationKey}&partnerKey={partnerKey}&vendorID={vendorID}&vendorPassword={vendorPassword}	No documentation available.

APInvoices

Add Invoices into VMS

API	Description
POST api/APInvoices?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}	No documentation available.

AppMapsKey

Retrieves APP Maps Key

API	Description
GET api/AppMapsKey?VendorID={VendorID}&vendorPassword={vendorPassword}&APIGUID={APIGUID}	Retrieves APP Maps Key

Architectural

Retrieves architecturals

API	Description
GET api/Architectural?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&CompanyKey={CompanyKey}&CommunityKey={CommunityKey}&IncludeClosed={IncludeClosed}	Get records for company or community
GET api/Architectural?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&UnitKey={UnitKey}&IncludeClosed={IncludeClosed}	Get records for unit
POST api/Architectural?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}	No documentation available.
PUT api/Architectural?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}	No documentation available.
DELETE api/Architectural/{id}	No documentation available.

ArchitecturalNote

Retrieves architectural notes

API	Description
GET api/ArchitecturalNote?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&CompanyKey={CompanyKey}&CommunityKey={CommunityKey}&IncludeClosed={IncludeClosed}&Imagebit={Imagebit}	Get records for company or community
GET api/ArchitecturalNote?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&UnitKey={UnitKey}&IncludeClosed={IncludeClosed}&Imagebit={Imagebit}	Get records for unit
GET api/ArchitecturalNote?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&ArchitecturalKey={ArchitecturalKey}&Imagebit={Imagebit}	Get records for archectural
POST api/ArchitecturalNote?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}	No documentation available.
PUT api/ArchitecturalNote?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}	No documentation available.

ArchitecturalTask

Retrieves architectural tasks

API	Description
GET api/ArchitecturalTask?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&CompanyKey={CompanyKey}&CommunityKey={CommunityKey}&IncludeClosed={IncludeClosed}&Imagebit={Imagebit}	Get records for company or community
GET api/ArchitecturalTask?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&UnitKey={UnitKey}&IncludeClosed={IncludeClosed}&Imagebit={Imagebit}	Get records for unit
GET api/ArchitecturalTask?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&ArchitecturalKey={ArchitecturalKey}&Imagebit={Imagebit}	Get records for archectural
POST api/ArchitecturalTask?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}	No documentation available.
PUT api/ArchitecturalTask?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}	No documentation available.

ARPostTransaction

Post AR transaction

API	Description
POST api/ARPostTransaction?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}	Post AR transactions Process transactions to accounts

BankSSO

Retrieves SSO URL for request bank

API	Description
GET api/BankSSO?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&SSOToken={SSOToken}	Get SSO URL for requested bank token SSO tokens [SSOAAB] [SSOCLICKPAY]

BlastSearch

API	Description
POST api/BlastSearch?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}	Searches for residents based on search criteria

CallDetail

API	Description
GET api/CallDetail?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&CompanyKey={CompanyKey}&EmployeeKey={EmployeeKey}&PropertyAccessLevel={PropertyAccessLevel}&CallStatus={CallStatus}	Retrieves detail of requested resident notes

CallSummary

API	Description
GET api/CallSummary?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&CompanyKey={CompanyKey}&EmployeeKey={EmployeeKey}&PropertyAccessLevel={PropertyAccessLevel}	Retrieves open summary of requested task areas

Committee

Manages Committee records

API	Description
GET api/Committee?VendorID={VendorID}&vendorPassword={vendorPassword}&APIGUID={APIGUID}&CompanyKey={CompanyKey}	Retrieves list of committees

CommitteeMember

Manages Committee Member records

API	Description
GET api/CommitteeMember?VendorID={VendorID}&vendorPassword={vendorPassword}&APIGUID={APIGUID}&CommitteeKey={CommitteeKey}&ResidentContactKey={ResidentContactKey}	Retrieves list of committee members

CommonCode

Retrieves list of defined commoncodes

API	Description
GET api/CommonCode?vendorID={vendorID}&vendorPassword={vendorPassword}&APIGUID={APIGUID}&Filter1={Filter1}&Filter2={Filter2}	Retrieves list of defined commoncodes
GET api/CommonCode?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&Filter1={Filter1}	Retrieves list of defined commoncodes

CommunicationRequest

Manages email processes

API	Description
POST api/CommunicationRequest?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&Mode={Mode}	Sends communications

CommuniqueAccount

Manages Bank Account statistics

API	Description
GET api/CommuniqueAccount?VendorID={VendorID}&vendorPassword={vendorPassword}&APIGUID={APIGUID}&CompanyKey={CompanyKey}&GLCompanyDepartmentKey={GLCompanyDepartmentKey}&ga_GLType={ga_GLType}&Period={Period}	Manages Bank Account statistics

CommuniqueProfitLoss

Manages Profit and Loss statistics

API	Description
GET api/CommuniqueProfitLoss?VendorID={VendorID}&vendorPassword={vendorPassword}&APIGUID={APIGUID}&CompanyKey={CompanyKey}&GLCompanyDepartmentKey={GLCompanyDepartmentKey}&BeginPeriod={BeginPeriod}&EndPeriod={EndPeriod}	Retrieves profit/loss, budget data

CommuniqueProperty

Manages Architectural, Compliance, Delinquency, Work Order

API	Description
GET api/CommuniqueProperty?VendorID={VendorID}&vendorPassword={vendorPassword}&APIGUID={APIGUID}&CompanyKey={CompanyKey}&ResidentKey={ResidentKey}&BeginPeriod={BeginPeriod}&EndPeriod={EndPeriod}	Manages property statistics

CommunityList

API	Description
GET api/CommunityList?vendorID={vendorID}&vendorPassword={vendorPassword}&APIGUID={APIGUID}&CompanyKey={CompanyKey}	Retrieves list of associated properties for passed GUID type

CompanyDocument

Manages Company Document records

API	Description
GET api/CompanyDocument?VendorID={VendorID}&vendorPassword={vendorPassword}&APIGUID={APIGUID}	Retrieves list of company documents for passed APIGUID
GET api/CompanyDocument?VendorID={VendorID}&vendorPassword={vendorPassword}&APIGUID={APIGUID}&CompanyKey={CompanyKey}&CommitteeKey={CommitteeKey}	Retrieves list of company documents
GET api/CompanyDocument?VendorID={VendorID}&vendorPassword={vendorPassword}&APIGUID={APIGUID}&DeltaDate={DeltaDate}&CompanyKey={CompanyKey}	Retrieves list of company documents

CompanyEmployeeLink

Manages Company Employee Link records

API	Description
POST api/CompanyEmployeeLink?APIGUID={APIGUID}&GetCall={GetCall}	Retrieves Company/Employee Linked data

CompanyList

Retrieves list of communities

API	Description
GET api/CompanyList?vendorID={vendorID}&vendorPassword={vendorPassword}&APIGUID={APIGUID}	Retrieves list of associated properties for passed GUID type
GET api/CompanyList?vendorID={vendorID}&vendorPassword={vendorPassword}&APIGUID={APIGUID}&EmployeeKey={EmployeeKey}	Retrieves list of associated properties for an employee
GET api/CompanyList?vendorID={vendorID}&vendorPassword={vendorPassword}&VendorKey={VendorKey}&APIGUID={APIGUID}	Retrieves list of associated properties for an vendor

CompanyNote

Manages Company Note records

API	Description
GET api/CompanyNote?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&CompanyNoteKey={CompanyNoteKey}	Get company note records for company
GET api/CompanyNote?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&CompanyKey={CompanyKey}&EmployeeKey={EmployeeKey}&CompanyNoteArea={CompanyNoteArea}&IncludeClosed={IncludeClosed}	Get company note records for company, employee, using type, removing duplicate task records
POST api/CompanyNote?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}	No documentation available.
PUT api/CompanyNote?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}	No documentation available.
DELETE api/CompanyNote?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&CompanyNoteKey={CompanyNoteKey}	No documentation available.

CompanyNoteTask

Manages Company Note Task records

API	Description
GET api/CompanyNoteTask?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&CompanyNoteKey={CompanyNoteKey}&CompanyNoteTaskKey={CompanyNoteTaskKey}	Get records for company or community
POST api/CompanyNoteTask?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}	No documentation available.
PUT api/CompanyNoteTask?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}	No documentation available.
DELETE api/CompanyNoteTask?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&CompanyNoteTaskKey={CompanyNoteTaskKey}	No documentation available.

CompanyPortal

Retrieves SSO URL for request bank

API	Description
GET api/CompanyPortal?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&CompanyKey={CompanyKey}	Get Company Portal Information

Compliance

API	Description
GET api/Compliance?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&CompanyKey={CompanyKey}&CommunityKey={CommunityKey}&IncludeClosed={IncludeClosed}	Get records for company or community
GET api/Compliance?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&UnitKey={UnitKey}&IncludeClosed={IncludeClosed}	Get records for unit
POST api/Compliance?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}	No documentation available.
PUT api/Compliance?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}	No documentation available.
DELETE api/Compliance/{id}	No documentation available.

ComplianceCount

Retrieves open compliance count

API	Description
GET api/ComplianceCount?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&CompanyKey={CompanyKey}&CommunityKey={CommunityKey}	No documentation available.

ComplianceDefinition

Retrieves compliance definitions

API	Description
GET api/ComplianceDefinition?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&CompanyKey={CompanyKey}	Get records for unit

ComplianceNote

API	Description
PUT api/ComplianceNote?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}	Allows for a Put of a compliance sequence

ComplianceSequence

Retrieves compliance notes

API	Description
GET api/ComplianceSequence?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&CompanyKey={CompanyKey}&CommunityKey={CommunityKey}&IncludeClosed={IncludeClosed}&Imagebit={Imagebit}	Get sequence records for company or community
GET api/ComplianceSequence?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&UnitKey={UnitKey}&IncludeClosed={IncludeClosed}&Imagebit={Imagebit}	Get sequence records for unit
GET api/ComplianceSequence?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&ComplianceKey={ComplianceKey}&Imagebit={Imagebit}	No documentation available.
POST api/ComplianceSequence?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}	No documentation available.
PUT api/ComplianceSequence?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}	No documentation available.

DelinquencySequence

Manage delinquency sequences

API	Description
POST api/DelinquencySequence?APIGUID={APIGUID}&GetCall={GetCall}	Get Delinquency sequences

DelinquencyStatus

Manage delinquency status

API	Description
POST api/DelinquencyStatus?APIGUID={APIGUID}&GetCall={GetCall}	Get Delinquency status information

Document

Manages retrival of AP, architectual, architectural task, compliance, company document, company note, resident, residenttask, collection vendor documents

API	Description
GET api/Document?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&DocumentArea={DocumentArea}&DocumentKey={DocumentKey}&CompanyKey={CompanyKey}&AccountKey={AccountKey}&ResidentContactKey={ResidentContactKey}&BaseURL={BaseURL}&OutputType={OutputType}&Filename={Filename}	Get DocumentArea Architectural = 1 ArchitecturalTask = 13 AP = 6 APNote = 10 APTask = 11 CompanyDocument = 4 CompanyNote = 5 CompanyNoteTask = 9 Compliance = 2 Resident = 3 ResidentTask = 12 ResidentCollection = 7 Vendor = 8 --BaseURL-- URL of web service --OutputType-- URL or FILE

Documents

Manages retrival of architectual and compliance documents for a parent key

API	Description
GET api/Documents?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&DocumentArea={DocumentArea}&DocumentKey={DocumentKey}&ResidentContactKey={ResidentContactKey}&Imagebit={Imagebit}	Get

eDistribution

Manages update of certified data in original note record using OriginationID, and adding additional note with attachment to ParentID

API	Description
POST api/eDistribution?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}	No documentation available.

EmailManagement

API	Description
GET api/EmailManagement?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&ResidentNoteKey={ResidentNoteKey}	Retrieves note information from a resident note, which can be used when replying back to the same call via email

EmailMethod

Manages system records

API	Description
GET api/EmailMethod?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}	Retrieves information about email method

Employee

API	Description
GET api/Employee?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&EmployeeKey={EmployeeKey}	Retrieves employee information

EmployeeKey

API	Description
GET api/EmployeeKey?validationKey={validationKey}&partnerKey={partnerKey}&vendorID={vendorID}&vendorPassword={vendorPassword}&employeeID={employeeID}&employeePassword={employeePassword}	Validates passed employee, with returned EmployeeKey

EmployeeList

API	Description
GET api/EmployeeList?vendorID={vendorID}&vendorPassword={vendorPassword}&APIGUID={APIGUID}&CompanyKey={CompanyKey}	No documentation available.

Form

Manages Forms

API	Description
GET api/Form?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}	Get General Forms
GET api/Form?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&CompanyKey={CompanyKey}	Get Forms linked to company

FormDetail

Manages form detail GET / PUT

API	Description
GET api/FormDetail?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&WebFormKey={WebFormKey}	Get Form Detail
GET api/FormDetail?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&WebFormKey={WebFormKey}&CompanyKey={CompanyKey}&VendorPayKey={VendorPayKey}	Get Form Detail
GET api/FormDetail?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&WebFormKey={WebFormKey}&CompanyKey={CompanyKey}&VendorPayKey={VendorPayKey}&ResidentContactKey={ResidentContactKey}	Get Form Detail
POST api/FormDetail?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}	Post form

GLAccount

Manages chart of account records

API	Description
POST api/GLAccount?APIGUID={APIGUID}&GetCall={GetCall}	Retrieves GL account by PrimaryKey

GLAccountBalance

Manages chart of account balance requests

API	Description
POST api/GLAccountBalance?APIGUID={APIGUID}&GetCall={GetCall}	Retrieves GL balances

GLAccountInformation

Manages Profit and Loss statistics

API	Description
GET api/GLAccountInformation?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&GLAccountKey={GLAccountKey}&GLCompanyDepartmentKey={GLCompanyDepartmentKey}&BeginPeriod={BeginPeriod}&EndPeriod={EndPeriod}	Retrieves GL transactions
GET api/GLAccountInformation?VendorID={VendorID}&vendorPassword={vendorPassword}&APIGUID={APIGUID}&CompanyKey={CompanyKey}&GLCompanyDepartmentKey={GLCompanyDepartmentKey}&Category={Category}&ga_GLType={ga_GLType}&BeginPeriod={BeginPeriod}&EndPeriod={EndPeriod}	Retrieves GL transactions for a specific category

GLCompanyDepartment

Manages GL company department requests

API	Description
POST api/GLCompanyDepartment?APIGUID={APIGUID}&GetCall={GetCall}	Retrieves GL company departments

GoogleMapsKey

Retrieves Google Maps Key

API	Description
GET api/GoogleMapsKey?VendorID={VendorID}&vendorPassword={vendorPassword}&APIGUID={APIGUID}	Retrieves Google Maps Key

HTMLManagement

API	Description
GET api/HTMLManagement?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&EmployeeKey={EmployeeKey}&CompanyKey={CompanyKey}	Retrieves list of available HTML templates
GET api/HTMLManagement?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&HTMLTemplateName={HTMLTemplateName}&CompanyKey={CompanyKey}	Retrieves the HTML content of the request filename
POST api/HTMLManagement?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}	Adds HTML template to folder

iXpert

Retrieves iXpert information

API	Description
GET api/iXpert?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&RequestAreaBitMap={RequestAreaBitMap}&FindUsing={FindUsing}&CompanyKey={CompanyKey}&ResidentKey={ResidentKey}&ActiveRecords={ActiveRecords}	Get requested inforamtion for request

MergeDocument

Create merge document

API	Description
GET api/MergeDocument?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&DocumentListArea={DocumentListArea}&FileName={FileName}&RecordKey={RecordKey}	Create RTF for merge template abd document list area

MergeDocumentList

Request List of Merge Templates

API	Description
GET api/MergeDocumentList?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&DocumentListArea={DocumentListArea}	Get list of available merge templates

MultiLink

API	Description
GET api/MultiLink?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&ResidentKey={ResidentKey}	Get MultiLink records
POST api/MultiLink/{ID}?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&IDPassword={IDPassword}	Post MultiLink record
DELETE api/MultiLink?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&MultiUnitLinkKey={MultiUnitLinkKey}	Delete MultiLink record

PaymentReconciliation

Process payment reconciliation

API	Description
PUT api/PaymentReconciliation?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}	Process payment reconciliation Process payments against AR transactions, with a returned list of items if transaction is not in correct period

PayorList

Retrieves list of payors (companies) for vendor

API	Description
GET api/PayorList?vendorID={vendorID}&vendorPassword={vendorPassword}&APIGUID={APIGUID}	Retrieves list of associated properties for passed GUID

Query

Retrieves data

API	Description
POST api/Query?APIGUID={APIGUID}	No documentation available.

Resident

API	Description
GET api/Resident?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&CompanyKey={CompanyKey}&ResidentKey={ResidentKey}	Retrieves resident data r_Type Values: 0 Owner (Primary) 1 Tenant 2 Compliance 3 Collection 4 Management Company 5 Collection Vendor 6 Future Owner 100+ Custom Client Types
GET api/Resident?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&DeltaDate={DeltaDate}&CompanyKey={CompanyKey}&ResidentKey={ResidentKey}	Get unit delta records for resident

ResidentAccountType

Retrieves list of defined resident account types

API	Description
GET api/ResidentAccountType?VendorID={VendorID}&vendorPassword={vendorPassword}&APIGUID={APIGUID}	Retrieves list of Resident Acount Types

ResidentContact

API	Description
GET api/ResidentContact?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&ResidentKey={ResidentKey}&ResidentContactKey={ResidentContactKey}	Retrieves resident contact data rc_Type Values: 0 All Correspondences 1 Billing 2 Mailing 3 Contact 4 Management Company 5 Tenant 6 Collection
GET api/ResidentContact?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&DeltaDate={DeltaDate}&CompanyKey={CompanyKey}	Get unit delta records for resident contact
POST api/ResidentContact?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}	Post ResidentContact record
PUT api/ResidentContact?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}	Put ResidentContact record

ResidentContactDevice

API	Description
GET api/ResidentContactDevice?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&rt_DeviceID={rt_DeviceID}&ResidentContactKey={ResidentContactKey}	Get Device ID
GET api/ResidentContactDevice?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&rt_PushToken={rt_PushToken}&rt_DeviceID={rt_DeviceID}&ResidentContactKey={ResidentContactKey}	Get Device ID
POST api/ResidentContactDevice?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}	Post Device ID
DELETE api/ResidentContactDevice?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&rt_PushToken={rt_PushToken}&ResidentContactKey={ResidentContactKey}	Delete Device ID

ResidentContactNotification

API	Description
GET api/ResidentContactNotification?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&ResidentContactKey={ResidentContactKey}	No documentation available.
PUT api/ResidentContactNotification?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}	Put ResidentContact record

ResidenteStatementValidator

API	Description
GET api/ResidenteStatementValidator?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&ResidentKey={ResidentKey}&Couponcode={Couponcode}&PostChargesToBuilder={PostChargesToBuilder}&SkipInvoiceDistribution={SkipInvoiceDistribution}&ProductType={ProductType}	Validates resident ability to receive electonic statements

ResidentLinkedAccount

API	Description
GET api/ResidentLinkedAccount?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&ResidentKey={ResidentKey}	Retrieves all resident sub accounts

ResidentMessage

API	Description
GET api/ResidentMessage?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&ResidentKey={ResidentKey}	Retrieves resident push notes
PUT api/ResidentMessage?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}	Retrieves resident push notes

ResidentNote

API	Description
GET api/ResidentNote?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&ResidentKey={ResidentKey}&IncludeClosed={IncludeClosed}	Retrieves resident notes
GET api/ResidentNote?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&ResidentNoteKey={ResidentNoteKey}	No documentation available.
POST api/ResidentNote?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}	No documentation available.
PUT api/ResidentNote?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}	No documentation available.
DELETE api/ResidentNote?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&ResidentNoteKey={ResidentNoteKey}	No documentation available.

ResidentNoteTask

API	Description
GET api/ResidentNoteTask?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&ResidentNoteKey={ResidentNoteKey}	Retrieves resident note task data
POST api/ResidentNoteTask?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}	No documentation available.
PUT api/ResidentNoteTask?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}	No documentation available.
DELETE api/ResidentNoteTask?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&ResidentNoteTaskKey={ResidentNoteTaskKey}	No documentation available.

ResidentNotificationEmailOnly

API	Description
PUT api/ResidentNotificationEmailOnly?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}	Put Notification Email Only Flag and Email Address

ResidentNotificationOptOut

API	Description
PUT api/ResidentNotificationOptOut?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}	Put Notification OptOut Flag and Email Address

ResidentPaymentLink

API	Description
GET api/ResidentPaymentLink?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&ResidentContactKey={ResidentContactKey}	Retrieves payment links for resident contact

ResidentSummary

API	Description
GET api/ResidentSummary?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&SSOPosition={SSOPosition}&SSOGUID={SSOGUID}	Retrieves resident data. If no SSO passed, then use only the ResidentContact key for the resident APIGUID
GET api/ResidentSummary?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&ResidentKey={ResidentKey}	Retrieves resident data. If no SSO passed, then use only the ResidentContact key for the resident APIGUID

ResidentTelephone

API	Description
GET api/ResidentTelephone?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&ResidentContactKey={ResidentContactKey}	Retrieves ResidentTelephone data
GET api/ResidentTelephone?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&DeltaDate={DeltaDate}&CompanyKey={CompanyKey}	Get ResidentTelephone delta records
POST api/ResidentTelephone?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}	Post ResidentTelephone records
PUT api/ResidentTelephone?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}	Put ResidentTelephone records
DELETE api/ResidentTelephone?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&ResidentTelephoneKey={ResidentTelephoneKey}	Delete ResidentTelephone record

Rule

Retrieves compliance rules

API	Description
GET api/Rule?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&CompanyKey={CompanyKey}	No documentation available.

RulePicklist

Retrieves compliance rules picklist

API	Description
GET api/RulePicklist?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&CompanyKey={CompanyKey}	No documentation available.

SchedulerEvents

Retrieves open scheduler events

API	Description
GET api/SchedulerEvents?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&CompanyKey={CompanyKey}	Get open calendar items
POST api/SchedulerEvents?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}	Allows for a Post of a schedule event
PUT api/SchedulerEvents?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}	Allows for a Put of a schedule event
DELETE api/SchedulerEvents?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&CompanyEventKey={CompanyEventKey}	No documentation available.

SendMessageToFCM

Manages PUSH to FCM

API	Description
POST api/SendMessageToFCM?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}	Firebase Message Controller

SetAccountHash

Manage resident contact record

API	Description
PUT api/SetAccountHash?validationKey={validationKey}&VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&ResidentContactKey={ResidentContactKey}&HRequest={HRequest}	No documentation available.

SSOBankValidation

Validates User GUID

API	Description
GET api/SSOBankValidation?validationKey={validationKey}&partnerKey={partnerKey}&VendorID={VendorID}&VendorPassword={VendorPassword}&userAPIGUID={userAPIGUID}&email={email}	No documentation available.

TaskDetail

API	Description
GET api/TaskDetail?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&CompanyKey={CompanyKey}&RequestTaskAreasBit={RequestTaskAreasBit}&PropertyAccessLevel={PropertyAccessLevel}	Retrieves open details of requested task areas

TaskSummary

API	Description
GET api/TaskSummary?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&CompanyKey={CompanyKey}&RequestTaskAreasBit={RequestTaskAreasBit}&PropertyAccessLevel={PropertyAccessLevel}	Retrieves open summary of requested task areas

Unit

Retrieves units

API	Description
GET api/Unit?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&CompanyKey={CompanyKey}&CommunityKey={CommunityKey}	Get unit records for company or community. Code will add GEO tab information to unit if google API key is in web.config file
GET api/Unit?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&DeltaDate={DeltaDate}&CompanyKey={CompanyKey}	Get delta records for unit. Code will add GEO tab information to unit if google API key is in web.config file
GET api/Unit?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&ResidentKey={ResidentKey}	Get unit records for account. Code will add GEO tab information to unit if google API key is in web.config file

UserProfile

Retrieves User Profile

API	Description
GET api/UserProfile?validationKey={validationKey}&partnerKey={partnerKey}&VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}	No documentation available.

Vendor

Manages Vendor

API	Description
GET api/Vendor?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&CompanyKey={CompanyKey}&VendorKey={VendorKey}	Get records for company
POST api/Vendor?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}	No documentation available.
PUT api/Vendor?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}	No documentation available.

VendorContact

Manages VendorContact

API	Description
GET api/VendorContact?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&CompanyKey={CompanyKey}&VendorKey={VendorKey}	Get records for company
POST api/VendorContact?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}	No documentation available.
PUT api/VendorContact?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}	No documentation available.

VendorDocument

Manages Vendor Document records

API	Description
GET api/VendorDocument?VendorID={VendorID}&vendorPassword={vendorPassword}&APIGUID={APIGUID}&CompanyKey={CompanyKey}	Retrieves list of vendor document for a company

VendorInvoice

Add memorized Invoice Code will use a memorized payable if exists, otherwise add one, then use it to create a new one

API	Description
POST api/VendorInvoice?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}	No documentation available.

VendorList

Manages Vendor List of vendors and contacts

API	Description
GET api/VendorList?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&CompanyKey={CompanyKey}&VendorKey={VendorKey}	Get records for company

VendorLocation

Manages VendorLocation

API	Description
GET api/VendorLocation?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&CompanyKey={CompanyKey}&VendorKey={VendorKey}	Get records for company
POST api/VendorLocation?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}	No documentation available.
PUT api/VendorLocation?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}	No documentation available.

VendorSecurity

Retrieves Vendor Secuirty Rights

API	Description
GET api/VendorSecurity?validationKey={validationKey}&partnerKey={partnerKey}&VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&CompanyKey={CompanyKey}	No documentation available.

VMSControl

API	Description
GET api/VMSControl?VendorID={VendorID}&vendorPassword={vendorPassword}&APIGUID={APIGUID}	Retrieves VMSControl record

WebURL

Retrieves list of URLS for company

API	Description
GET api/WebURL?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&CompanyKey={CompanyKey}	Retrieves list of URLs for company

WorkOrder

API	Description
GET api/WorkOrder?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&CompanyKey={CompanyKey}&CommunityKey={CommunityKey}&IncludeClosed={IncludeClosed}	No documentation available.
GET api/WorkOrder?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&UnitKey={UnitKey}&IncludeClosed={IncludeClosed}	No documentation available.
POST api/WorkOrder?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}	No documentation available.
PUT api/WorkOrder?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}	No documentation available.

WorkOrderDetail

API	Description
GET api/WorkOrderDetail?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&CompanyKey={CompanyKey}&CommunityKey={CommunityKey}&IncludeClosed={IncludeClosed}&Imagebit={Imagebit}	GET vendor pay detail records, using imagebit to determine types of thumbnailes to include in returned base64 imagebit is defined as follows: 1: Image types of BMP\|GIF\|JPG\|JPEG\|PNG\|TIFF 2: MP3\|WAV 4: MP4 8: PDF 16: Office types of EML\|MSG\|XLS\|PPT\|DOC 32: Standard documents of TXT\|RTF 64: Download all attachments, convert image to 640 and PNG, store information in downloadFileName and downloadImageBase64
GET api/WorkOrderDetail?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&UnitKey={UnitKey}&IncludeClosed={IncludeClosed}&Imagebit={Imagebit}	No documentation available.
GET api/WorkOrderDetail?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&VendorPayKey={VendorPayKey}&Imagebit={Imagebit}	No documentation available.
POST api/WorkOrderDetail?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}	No documentation available.
PUT api/WorkOrderDetail?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}	No documentation available.

WorkOrderItem

API	Description
GET api/WorkOrderItem?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&CompanyKey={CompanyKey}	No documentation available.

WorkOrderNote

API	Description
GET api/WorkOrderNote?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&CompanyKey={CompanyKey}&CommunityKey={CommunityKey}&IncludeClosed={IncludeClosed}&Imagebit={Imagebit}	GET vendor pay note records, using imagebit to determine types of thumbnailes to include in returned base64 imagebit is defined as follows: 1: Image types of BMP\|GIF\|JPG\|JPEG\|PNG\|TIFF 2: MP3\|WAV 4: MP4 8: PDF 16: Office types of EML\|MSG\|XLS\|PPT\|DOC 32: Standard documents of TXT\|RTF 64: Download all attachments, convert image to 640 and PNG, store information in downloadFileName and downloadImageBase64
GET api/WorkOrderNote?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&UnitKey={UnitKey}&IncludeClosed={IncludeClosed}&Imagebit={Imagebit}	No documentation available.
GET api/WorkOrderNote?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&VendorPayKey={VendorPayKey}&Imagebit={Imagebit}	No documentation available.
POST api/WorkOrderNote?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}	No documentation available.
PUT api/WorkOrderNote?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}	No documentation available.
DELETE api/WorkOrderNote?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&VendorPayNoteKey={VendorPayNoteKey}	No documentation available.

WorkOrderTask

API	Description
GET api/WorkOrderTask?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&CompanyKey={CompanyKey}&CommunityKey={CommunityKey}&IncludeClosed={IncludeClosed}&Imagebit={Imagebit}	Retrieves open summary of requested task areas imagebit is defined as follows: 1: Image types of BMP\|GIF\|JPG\|JPEG\|PNG\|TIFF 2: MP3\|WAV 4: MP4 8: PDF 16: Office types of EML\|MSG\|XLS\|PPT\|DOC 32: Standard documents of TXT\|RTF 64: Download all attachments, convert image to 640 and PNG, store information in downloadFileName and downloadImageBase64
GET api/WorkOrderTask?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&UnitKey={UnitKey}&IncludeClosed={IncludeClosed}&Imagebit={Imagebit}	No documentation available.
GET api/WorkOrderTask?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&VendorPayKey={VendorPayKey}&Imagebit={Imagebit}	No documentation available.
POST api/WorkOrderTask?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}	No documentation available.
PUT api/WorkOrderTask?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}	No documentation available.
DELETE api/WorkOrderTask?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&VendorPayTaskKey={VendorPayTaskKey}	No documentation available.