RENT MANAGER API

February 22, 2021 Publish By : EXPERT APP DEVS 107 min read Viewed By : 677
rent manager api

An API may be a threshold for obtaining information in and out of a business application. Some software system vendors offer APIs that enable data to flow in and out, whereas others offer an API that solely permits information to be forced out. The Rent Manager property management software system has a superb API. And it permits each pull information from the Rent Manager furthermore as posting information to the Rent Manager.

Below are the Rent Manager 12 Web API which is designed to follow REST ful principles. Header of the API will remain the same in all API except authentication. You will get APIToken from authorized user API.

Header

Charset = UTF-8

Content-Type = application/json

X-RM12Api-ApiToken = APIToken

  • Authentication

  • Authorize User

Authenticate a user with their rent manager database. If authentication is successful the server will respond with an APIToken. The APIToken must be passed in the X-RM12Api-ApiToken header for all other requests.

Method

POST

URL

Authentication/AuthorizeUser

Header

Content-type: Application/json, text/json

Parameters

{

  "Username": "test_username",

  "Password": "test_password",

  "LocationID": "3",

}

Response

APIToken

 

User Authentication

  • Authorize Token

Authenticate a user token to their database.

Method

POST

URL

Authentication/AuthorizeToken?token={token}

Response

APIToken

  • Change Location

Change the location for the user’s API token.

Method

POST

URL

Authentication/ChangeLocation?locationID={locationID}

Response

If a user is active in that location then it will give a response of success.

  • Deauthorize

Invalidate a  user’s API token.

Method

POST

URL

Authentication/DeAuthorize?token={token}

Response

“Successfully Logged Out.”

  • Tenants

  • Get All Tenants

Return a collection of entities of a resource. This request returns a collection of tenants with pagination. May use features on the query string including: field, embed, Filters, pagenumber, pagesize, nocontent and orderby to control result returned.

Method

GET

URL

Tenants?filters={filters}&embeds={embeds}&orderingOptions={orderingOptions}&fields={fields}&getOptions={getOptions}

Response

Listing of tenants

  • New Tenant

Create or update entities of the specified tenant. All POST requests on a collection of resources should include a List of DataModel objects of the correct type for the entities being modified.

Method

POST

URL

Tenants?embeds=Contacts,Contacts.PhoneNumbers

Request Body

{"FirstName":"Test","LastName":"First","PropertyID":56,

"Contacts":"IsPrimary":true,"ContactID":-1,"FirstName"

:"Test","LastName":"First","MiddleName":"User","Email":

"testuser@mailinator.com","PhoneNumbers":[{"PhoneNumberID":-1,"PhoneNumberTypeID":"1","PhoneNumber":"9865327485"}]},

"RentPeriod":1,"RentDueDay":1}

Response

Newly created tenant 

  • Tenant Detail

Fetch a particular tenant details by passing TenantID in url. 

Method

GET

URL

Tenants/{TenantID}

Response

Tenant details

  • Delete Tenant

Delete a particular tenant by passing TenantID in url. The URL must include the ID of the entity to delete.

Method

DELETE

URL

Tenants/{TenantID}

Response

Delete Success

  • Vendors

  • Get All Vendors

Return a collection of entities of a vendor. May use features on the query string including: field, embed, Filters, pagenumber, pagesize, nocontent and orderby to control result returned.

Method

GET

URL

Vendors?filters={filters}&embeds={embeds}&fields={fields}&getOptions={getOptions}

Response

Listing of Vendors

  • New Vendor

Create or update entities of the specified vendor. 

Method

POST

URL

Vendors?embeds=Contact,VendorProperties,AssociatedProperties

Request Body

{"Name":"Test User","Payee":"Testing","Category":"Plumber","TaxID":"123456789","IsActive":"true",

"VendorProperties":[{"PropertyID":"56"}],"Contact":{"Email":"test@mailinator.com"}}

Response

Newly created vendor

  • Vendor Detail

Fetch a particular vendor details by passing TenantID in url. 

Method

GET

URL

Vendors/{VendorID}

Response

Vendor Details

  • Delete Vendor

Delete a particular vendor by passing VendorID in url. The URL must include the ID of the entity to delete. e Th

Method

DELETE

URL

Vendors/{VendorID}

Response

Delete Success

  • Service Manager Issues

  • Get All Service Manager Issues

Return a collection of entities of a service manager issues. 

Method

GET

URL

ServiceManagerIssues?filters={filters}&embeds={embeds}&fields={fields}&getOptions={getOptions}

Response

Listing of Service Manager Issues

  • New Service Manager Issue

Create or update entities of the specified service manager issue. 

Method

POST

URL

ServiceManagerIssues?embeds=ServiceManagerIssueLinkedTenants,ServiceManagerIssueLinkedProperties,

ServiceManagerIssueLinkedUnits,Tenants,status,Units.Addresses&field=CreateUserID

Request Body

{"Description":"Test Description","PriorityID":"3","StatusID":2,"CreateUserID":"15287",

"Title":"Test Description","CategoryID":"4","ServiceManagerIssueLinkedTenants":

{"TenantID":"15287"},"ServiceManagerIssueLinkedProperties":{"PropertyID":"56"},

"ServiceManagerIssueLinkedUnits":{"UnitID":"1490"},"Tenants":{"TenantID":"15287"}}

Response

Newly created service manager issue

  • Service Manager Issue Detail

Fetch a particular service manager issue details by passing ServiceManagerIssueID in url. 

Method

GET

URL

ServiceManagerIssues/{ServiceManagerIssueID}

Response

Service Manager Issue Details

  • Delete Service Manager Issue

Delete a particular service manager issue by passing ServiceManagerIssueID in url. The URL must include the ID of the entity to delete.  Te Th

Method

DELETE

URL

ServiceManagerIssues/{ServiceManagerIssueID}

Response

Delete Success

  • Assign to User

Assign a service manager issue to a specific user. The request body must include the AssignedToUserID. he  of h

Method

POST

URL

ServiceManagerIssues?embeds=PayeeAccount&fields=PayeeAccount,PayeeAccountID,ServiceManagerIssueID

Header

Charset = UTF-8

Content-Type = application/json

X-RM12Api-ApiToken = APIToken

Response

Service manager issue updated data

  • Resolve work

Resolve the work those are assigned to vendor.

Method

POST

URL

ServiceManagerIssues/?fields=IsClosed,AssignedCloseDate,PayeeAccountID,ServiceManagerIssueID,Title,StatusID,Resolution,AssignedToUserID

Request Body

{"id":1830,"ServiceManagerIssueID":198531,"PayeeAccountID":15288,"Title":"Testing vendor RM integration","Resolution":"Testing 123 9\/15"}

Response

Service manager issue resolved

  • Properties

  • Get All Properties

Return a collection of entities of a property. May use features on the query string including: field, embed, Filters, pagenumber, pagesize, nocontent and orderby to control result returned.

Method

GET

URL

Properties?filters={filters}&embeds={embeds}&orderingOptions={orderingOptions}&fields={fields}&getOptions={getOptions}

Response

Listing of Properties

  • New Property

Create or update entities of the specified property.

Method

POST

URL

Properties?saveOptions={saveOptions}&fields={fields}&embeds={embeds}

Request Body

{

    "PropertyID": 1,

    "Name": "sample property",

    "ShortName": "sample short property",

    "IsActive": true

}

Response

Newly created property

  • Property Detail

Fetch a particular property details by passing PropertyID in url. 

Method

GET

URL

Properties/{PropertyID}

Response

Property Details

  • Delete Property

Delete a particular property by passing PropertyID in url. The URL must include the ID of the entity to delete.

Method

DELETE

URL

Properties/{PropertyID}

Response

Delete Success

  • Units

  • Get All Units

Return a collection of entities of a unit. May use features on the query string including: field, embed, Filters, pagenumber, pagesize, nocontent and orderby to control result returned.

Method

GET

URL

Units?filters={filters}&embeds={embeds}&fields={fields}&getOptions={getOptions}

Response

Listing of Units

  • New Unit

Create or update entities of the specified unit. 

Method

POST

URL

Units?fields={fields}&embeds={embeds}

Request Body

{

    "UnitID": 1,

    "Name": "sample string",

    "SortOrder": 8

}

Response

Newly created unit

  • Unit Detail

Fetch a particular unit details by passing UnitID in url. 

Method

GET

URL

Units/{UnitID}

Response

Units Details

  • Delete Unit

Delete a particular unit by passing UnitID in url. The URL must include the ID of the entity to delete.

Method

DELETE

URL

Units/{UnitID }

Response

Delete Success

  • Web Users

  • Get All Web Users

Return a collection of web users. 

Method

GET

URL

WebUsers?filters={filters}&embeds={embeds}&fields={fields}&getOptions={getOptions}

Response

Listing of Web User

  • New Web User

Create or update entities of the specified web user. 

Method

POST

URL

WebUsers?saveOptions={saveOptions}&fields={fields}&embeds={embeds}

Request Body

{

    "WebUserID": 1,

    "UserName": "sample test",

    "UserNameIsVerified": true,

    "EmailAddress": "sample test address",

    "IsVerifiedEmail": true,

    "FirstName": "sample first name",

    "LastName": "sample last name",

    "LastSuccessfulLogin": "2020-12-24T05:05:11.2188257-05:00",

    "LastFailedLogin": "2020-12-24T05:05:11.2188257-05:00",

    "LastLogout": "2020-12-24T05:05:11.2188257-05:00",

    "LastLockout": "2020-12-24T05:05:11.2188257-05:00",

    "FailedLogins": 8,

    "IsPasswordReset": true,

    "CreateDate": "2020-12-24T05:05:11.2188257-05:00",

    "CreateUserID": 11,

    "UpdateDate": "2020-12-24T05:05:11.2188257-05:00",

    "UpdateUserID": 13,

    "ConcurrencyID": 14,

    "IsOptInCreditReporting": true,

    "CreditReportingID": 16,

    "ViewedOWAWhatsNew": true,

    "MetaTag": "sample meta tag"

  }

Response

Newly created web user

  • Web User Detail

Fetch a particular web user details by passing WebUserID in url. 

Method

GET

URL

WebUsers/{WebUserID}

Response

Web User Details

  • Delete Web User

Delete a particular web user by passing WebUserID in url. The URL must include the ID of the entity to delete.

Method

DELETE

URL

WebUsers/{WebUserID}

Response

Delete Success

  • Web User Accounts

  • Get All Web Users Accounts

Return a collection of web user accounts. 

Method

GET

URL

WebUserAccounts?filters={filters}&embeds={embeds}&orderingOptions={orderingOptions}&fields={fields}&getOptions={getOptions}

Response

Listing of Web User Accounts

  • New Web User Account

Create or update entities of the specified web user account. 

Method

POST

URL

WebUserAccounts?fields={fields}&embeds={embeds}

Request Body

{

    "WebUserAccountID": 1,

    "WebUserID": 2,

    "AccountID": 3,

    "DisplayID": 4,

    "Nickname": "sample string 5",

    "IsDefault": true,

    "IsEnabled": true,

    "CreateDate": "2020-12-24T09:52:59.6821214-05:00",

    "UpdateDate": "2020-12-24T09:52:59.6821214-05:00",

    "MetaTag": "sample string 11"

}

Response

Newly created web user account

  • Web User Account Detail

Fetch a particular web user account details by passing WebUserAccountID in url. 

Method

GET

URL

WebUserAccounts/{WebUserAccountID}

Response

Web User Account Details

  • Delete Web User Account

Delete a particular web user account by passing WebUserAccountID in url. The URL must include the ID of the entity to delete.

Method

DELETE

URL

WebUserAccounts/{WebUserAccountID}

Response

Delete Success

  • Account Groups

  • Get All Account Groups

Return a collection of account groups. 

Method

GET

URL

AccountGroups?filters={filters}&embeds={embeds}&orderingOptions={orderingOptions}&fields={fields}&getOptions={getOptions}

Response

Listing of Account Groups

  • New Account Groups

Create or update entities of the specified account groups. 

Method

POST

URL

AccountGroups?fields={fields}&embeds={embeds}

Request Body

{

    "AccountGroupID": 1,

    "Name": "sample string 2",

    "AccountGroupDetails": [],

    "MetaTag": "sample string 4"

}

Response

Newly created account group

  • Account Group Detail

Fetch a particular account group details by passing AccountGroupID in url. 

Method

GET

URL

AccountGroups/{AccountGroupID}

Response

Account Group Details

  • Delete Account Group

Delete a particular account group by passing AccountGroupID in url. The URL must include the ID of the entity to delete.

Method

DELETE

URL

AccountGroups/{AccountGroupID}

Response

Delete Success

  • Account Group Payments

  • Get All Account Group Payments

Return a collection of account group payments. 

Method

GET

URL

AccountGroupPayments?filters={filters}&embeds={embeds}&orderingOptions={orderingOptions}&fields={fields}&getOptions={getOptions}

Response

Listing of Account Group Payments

  • New Account Group Payment

Create or update entities of the specified account group payment. 

Method

POST

URL

AccountGroupPayments?saveOptions={saveOptions}&fields={fields}&embeds={embeds}

Request Body

{

    "AccountGroupPaymentID": 1,

    "CheckNumber": "sample check no",

    "Amount": 5.0,

    "TransactionDate": "2020-12-25T01:45:29.9984013-05:00",

    "FeeAccountID": 4,

    "PaymentFrom": "sample payment form",

    "Comment": "sample comment",

    "ReceiptID": 10,

    "HasChargeTypesWithChargeTypeBankSetup": true,

    "IsSplitPayment": true,

    "MetaTag": "sample meta tag"

  }

Response

Newly created account group payment

  • Account Group Payment Detail

Fetch a particular account group payment details by passing AccountGroupPaymentID in url. 

Method

GET

URL

AccountGroupPayments/{AccountGroupPaymentID}

Response

Account Group Payment Details

  • Delete Account Group Payment

Delete a particular account group payment by passing AccountGroupPaymentID in url. The URL must include the ID of the entity to delete.

Method

DELETE

URL

AccountGroupPayments/{AccountGroupPaymentID}

Response

Delete Success

  • Account Group Master Payments

  • Get All Account Group Master Payments

Return a collection of account group master payments. 

Method

GET

URL

AccountGroupMasterPayments?filters={filters}&embeds={embeds}&orderingOptions={orderingOptions}&fields={fields}&getOptions={getOptions}

Response

Listing of Account Group Master Payments

  • New Account Group Master Payment

Create or update entities of the specified account group master payment. 

Method

POST

URL

AccountGroupMasterPayments?saveOptions={saveOptions}&fields={fields}&embeds={embeds}

Request Body

{

    "AccountGroupMasterPaymentID": 1,

    "CheckNumber": "sample check no",

    "Amount": 5.0,

    "TransactionDate": "2020-12-25T02:16:21.4008688-05:00",

    "FeeAccountID": 6,

    "PaymentFrom": "sample payment form",

    "Comment": "sample comment",

    "ReceiptID": 9,

    "MetaTag": "sample meta tag"
}

Response

Newly created account group master payment

  • Account Group Master Payment Detail

Fetch a particular account group master payment details by passing AccountGroupMasterPaymentID in url. 

Method

GET

URL

AccountGroupMasterPayments/{AccountGroupMasterPaymentID}

Response

Account Group Master Payment Details

  • Delete Account Group Master Payment

Delete a particular account group master payment by passing AccountGroupMasterPaymentID in url. The URL must include the ID of the entity to delete.

Method

DELETE

URL

AccountGroupMasterPayments/{AccountGroupMasterPaymentID}

Response

Delete Success

  • Accounting Period Series

  • Get All Accounting Period Series

Return a collection of accounting period series. 

Method

GET

URL

AccountingPeriodSeries?filters={filters}&embeds={embeds}&orderingOptions={orderingOptions}&fields={fields}&getOptions={getOptions}

Response

Listing of Accounting Period Series

  • New Accounting Period Series

Create or update entities of the specified accounting period series. 

Method

POST

URL

AccountingPeriodSeries?fields={fields}&embeds={embeds}

Request Body

{

    "AccountingPeriodSeriesID": 1,

    "Name": "sample name"

}

Response

Newly created account period series

  • Accounting Period Series Detail

Fetch a particular accounting period series details by passing AccountingPeriodSeriesID in url. 

Method

GET

URL

AccountingPeriodSeries/{AccountingPeriodSeriesID}

Response

Accounting Period Series Details

  • Delete Accounting Period Series

Delete a particular accounting period series by passing AccountingPeriodSeriesID in url. The URL must include the ID of the entity to delete.

Method

DELETE

URL

AccountingPeriodSeries/{AccountingPeriodSeriesID}

Response

Delete Success

  • Accounting Period Years

  • Get All Accounting Period Years

Return a collection of accounting period years. 

Method

GET

URL

AccountingPeriodYears?filters={filters}&embeds={embeds}&orderingOptions={orderingOptions}&fields={fields}&getOptions={getOptions}

Response

Listing of Accounting Period Years

  • New Accounting Period Years

Create or update entities of the specified accounting period years. 

Method

POST

URL

AccountingPeriodYears?fields={fields}&embeds={embeds}

Request Body

{

    "AccountingPeriodYearID": 1,

    "Name": "sample name"

}

Response

Newly created account period year

  • Accounting Period Years Detail

Fetch a particular accounting period years details by passing AccountingPeriodYearID in url. 

Method

GET

URL

AccountingPeriodYears/{AccountingPeriodYearID}

Response

Accounting Period Year Details

  • Delete Accounting Period Year

Delete a particular accounting period year by passing AccountingPeriodYearID in url. The URL must include the ID of the entity to delete.

Method

DELETE

URL

AccountingPeriodYears/{AccountingPeriodYearID}

Response

Delete Success

  • Account Statements

  • Get All Account Statements

Return a collection of account statement.

Method

GET

URL

AccountStatements?filters={filters}&embeds={embeds}&orderingOptions={orderingOptions}&fields={fields}&getOptions={getOptions}

Response

Listing of Account Statement

  • New Account Statement

Create or update entities of the specified accounting period series. 

Method

POST

URL

AccountStatements?fields={fields}&embeds={embeds}

Request Body

{

    "AccountStatementID": 1,

    "AccountID": 2,

    "PropertyID": 3,

    "StatementDate": "2020-12-25T03:58:55.7228895-05:00",

    "Amount": 10.0,

    "StatementURL": "sample url",

    "IsDeleted": true,

    "CreateDate": "2020-12-25T03:58:55.7228895-05:00",

    "UpdateDate": "2020-12-25T03:58:55.7228895-05:00",

    "MetaTag": "sample meta"

}

Response

Newly created account statement

  • Account Statement Detail

Fetch a particular account statement by passing AccountStatementID in url. 

Method

GET

URL

AccountStatements/{AccountStatementID}

Response

Account Statement Details

  • Delete Account Statement

Delete a particular account statement by passing AccountStatementID in url. The URL must include the ID of the entity to delete.

Method

DELETE

URL

AccountStatements/{AccountStatementID}

Response

Delete Success

  • Amenities

  • Get All Amenities

Return a collection of amenities.

Method

GET

URL

Amenities?filters={filters}&embeds={embeds}&fields={fields}&getOptions={getOptions}

Response

Listing of Amenities

  • New Amenities

Create or update entities of the specified amenities. 

Method

POST

URL

Amenities?fields={fields}&embeds={embeds}

Request Body

{

    "AmenityID": 1,

    "Name": "sample string 2",

    "Comment": "sample string 3",

    "SortOrder": 4,

    "Price": 1.0,

    "CreateDate": "2020-12-25T08:35:55.8427272-05:00",

    "CreateUserID": 6,

    "UpdateDate": "2020-12-25T08:35:55.8427272-05:00",

    "UpdateUserID": 8,

    "MetaTag": "sample string 10"

}

Response

Newly created amenity

  • Amenities Detail

Fetch a particular amenity by passing AmenityID in url. 

Method

GET

URL

Amenities/{AmenityID}

Response

Amenity Details

  • Delete Amenity

Delete a particular amenity by passing AmenityID in url. The URL must include the ID of the entity to delete.

Method

DELETE

URL

Amenities/{AmenityID}

Response

Delete Success

  • Application Designs

  • Get All Application Designs

Return a collection of application designs.

Method

GET

URL

ApplicationDesigns?filters={filters}&fields={fields}&getOptions={getOptions}

Response

Listing of Application Design

  • New Application Design

Create or update entities of the specified application design. 

Method

POST

URL

ApplicationDesigns?fields={fields}&embeds={embeds}

Request Body

{

    "ApplicationDesignID": 1,

    "DisplayValue": "sample display value",

    "ScriptName": "sample script name",

    "ScriptValue": "sample script value",

    "OrderNumber": 5,

    "IsRequired": true,

    "MetaTag": "sample meta"

}

Response

Newly created application design

  • Application Design Detail

Fetch a particular application design by passing ApplicationDesignID in url. 

Method

GET

URL

ApplicationDesigns/{ApplicationDesignID}

Response

Application Design Details

  • Delete Application Design

Delete a particular application design by passing ApplicationDesignID in url. The URL must include the ID of the entity to delete.

Method

DELETE

URL

ApplicationDesigns/{ApplicationDesignID}

Response

Delete Success

  • Application Field Lead Sources

  • Get All Application Field Lead Sources

Return a collection of application field lead sources.

Method

GET

URL

ApplicationFieldLeadSources?filters={filters}&embeds={embeds}&fields={fields}&getOptions={getOptions}

Response

Listing of Application Field Lead Sources

  • New Application Field Lead Sources

Create or update entities of the specified application field lead sources. 

Method

POST

URL

ApplicationFieldLeadSources?fields={fields}&embeds={embeds}

Request Body

{

    "ApplicationFieldLeadSourceID": 1,

    "ApplicationFieldID": 2,

    "ProspectLeadSourceID": 3,

    "DisplayName": "sample display name",

    "SortOrder": 5,

    "MetaTag": "sample meta"

}

Response

Newly created application field lead source

  • Application Field Lead Source Detail

Fetch a particular application field lead sources by passing ApplicationFieldLeadSourceID in url. 

Method

GET

URL

ApplicationFieldLeadSources/{ApplicationFieldLeadSourceID}

Response

Application Field Lead Source Details

  • Delete Application Field Lead Source

Delete a particular application field lead source by passing ApplicationFieldLeadSourceID in url. The URL must include the ID of the entity to delete.

Method

DELETE

URL

ApplicationFieldLeadSources/{ApplicationFieldLeadSourceID}

Response

Delete Success

  • Application Info

  • Get All Application Info

Return an application information.

Method

GET

URL

ApplicationInfo

Response

{ "ProductName": "Web API", "CurrentVersion": "12.671.7660.21928", "BuildTimestamp": "2020-12-21T12:16:06" }

  • Application

  • Get All Application

Return a collection of applications.

Method

GET

URL

Applications?filters={filters}&embeds={embeds}&orderingOptions={orderingOptions}&fields={fields}&getOptions={getOptions}

Response

Listing of Application

  • New Application

Create or update entities of the specified application. 

Method

POST

URL

Applications?saveOptions={saveOptions}&fields={fields}&embeds={embeds}

Request Body

{

    "ApplicationID": 1,

    "Status": true,

    "CreateDate": "2020-12-28T02:18:08.6967572-05:00",

    "IPAddress": "sample ip",

    "IsRead": true,

    "ContactID": 6,

    "AccountID": 7,

    "MetaTag": "sample meta"

}

Response

Newly created application

  • Application Detail

Fetch a particular application by passing ApplicationID in url. 

Method

GET

URL

Applications/{ApplicationID}

Response

Application Details

  • Delete Application

Delete a particular application by passing ApplicationID in url. The URL must include the ID of the entity to delete.

Method

DELETE

URL

Applications/{ApplicationID}

Response

Delete Success

  • Application Sub Applicant Field

  • Get All Application Sub Applicant Fields

Return a collection of application sub applicant fields.

Method

GET

URL

ApplicationSubApplicantFields?filters={filters}&embeds={embeds}&orderingOptions={orderingOptions}&fields={fields}&getOptions={getOptions}

Response

Listing of Application Sub Applicant Fields

  • New Application Sub Applicant Fields

Create or update entities of the specified application sub applicant fields. 

Method

POST

URL

ApplicationSubApplicantFields?fields={fields}&embeds={embeds}

Request Body

{

    "ApplicationSubApplicantFieldID": 1,

    "ApplicationMajorSectionID": 2

}

Response

Newly created application sub applicant field

  • Application Sub Applicant Field Detail

Fetch a particular application sub applicant field by passing ApplicationSubApplicantFieldID in url. 

Method

GET

URL

ApplicationSubApplicantFields/{ApplicationSubApplicantFieldID}

Response

Application Details

  • Delete Application Sub Applicant Field

Delete a particular application sub applicant field by passing ApplicationSubApplicantFieldID in url. The URL must include the ID of the entity to delete.

 

Method

DELETE

URL

ApplicationSubApplicantFields/{ApplicationSubApplicantFieldID}

Response

Delete Success

  • Application Summaries

  • Get Application Summaries

Return an application summary.

Method

GET

URL

ApplicationSummaries?filters={filters}&embeds={embeds}&orderingOptions={orderingOptions}&getOptions={getOptions}&fields={fields}&pageSize={pageSize}&pageNumber={pageNumber}&ignorePaging={ignorePaging}

Response

{

    "ApplicationID": 1,

    "ProspectApplicationID": 2,

    "AccountID": 3,

    "PropertyID": 4,

    "Name": "sample name",

    "ApplicationDate": "2020-12-28T02:25:37.7759187-05:00",

    "PhoneNumber": "sample phone",

    "MetaTag": "sample meta"

}

  • Appointments

  • Get All Appointments

Return a collection of appointments.

Method

GET

URL

Appointments?filters={filters}&embeds={embeds}&orderingOptions={orderingOptions}&fields={fields}&getOptions={getOptions}

Response

Listing of Appointments

  • New Appointment

Create or update entities of the specified appointment. 

Method

POST

URL

Appointments?fields={fields}&embeds={embeds}

Request Body

{

    "AppointmentID": 1,

    "ParentAppointmentID": 2,

    "StartDate": "2020-12-28T04:24:06.9045689-05:00",

    "EndDate": "2020-12-28T04:24:06.9045689-05:00",

    "ReminderDate": "2020-12-28T04:24:06.9045689-05:00",

    "Subject": "sample subject",

    "Description": "sample description",

    "ColorID": 8,

    "IsReminder": true,

    "IsRecurring": true,

    "CreateDate": "2020-12-28T04:24:06.9045689-05:00",

    "CreateUserID": 12,

    "UpdateDate": "2020-12-28T04:24:06.9045689-05:00",

    "UpdateUserID": 1,

    "TenantID": 14,

    "ProspectID": 15,

    "OwnerID": 16,

    "VendorID": 17,

    "IssueID": 18,

    "ServiceManagerIssueID": 19,

    "OwnerProspectID": 20,

    "AppointmentRecurrenceFromDate": "2020-12-28T04:24:06.9045689-05:00",

    "AppointmentRecurrenceToDate": "2020-12-28T04:24:06.9045689-05:00",

    "AppointmentRecurrenceValue1": 23,

    "AppointmentRecurrenceValue2": 24,

    "AppointmentRecurrenceDatePostedThru": "2020-12-28T04:24:06.9045689-05:00",

    "MetaTag": "sample meta"

}

Response

Newly created appointment

  • Appointment Detail

Fetch a particular appointment by passing AppointmentID in url. 

Method

GET

URL

Appointments/{AppointmentID}

Response

Appointment Details

  • Delete Appointment

Delete a particular appointment by passing AppointmentID in url. The URL must include the ID of the entity to delete.

Method

DELETE

URL

Appointments/{AppointmentID}

Response

Delete Success

  • Areas

  • Get All Areas

Return a collection of areas.

Method

GET

URL

Areas?filters={filters}&embeds={embeds}&orderingOptions={orderingOptions}&fields={fields}&getOptions={getOptions}

Response

Listing of Area

  • Area Detail

Fetch a particular area by passing AreaID in url. 

Method

GET

URL

Areas/{AreaID }

Response

Area Details

  • Area Items

  • Get All Area Items

Return a collection of area items.

Method

GET

URL

AreaItems?filters={filters}&embeds={embeds}&orderingOptions={orderingOptions}&fields={fields}&getOptions={getOptions}

Response

Listing of Area Items

  • Area Item Detail

Fetch a particular area item by passing AreaID in url. 

Method

GET

URL

AreaItems/{AreaItemID}

Response

Area Item Details

  • Area Item Statuses

  • Get All Area Item Statuses

Return a collection of area item statuses.

Method

GET

URL

AreaItemStatuses?filters={filters}&embeds={embeds}&orderingOptions={orderingOptions}&fields={fields}&getOptions={getOptions}

Response

Listing of Area Item Statuses

  • Area Item Status Detail

Fetch a particular area item status by passing AreaItemStatusID in url. 

Method

GET

URL

AreaItemStatuses/{AreaItemStatusID}

Response

Area Item Status Details

  • Assets

  • Get All Assets

Return a collection of assets.

Method

GET

URL

Assets?filters={filters}&embeds={embeds}&orderingOptions={orderingOptions}&fields={fields}&getOptions={getOptions}

Response

Listing of Assets

  • New Asset

Create or update entities of the specified asset. 

Method

POST

URL

Assets?fields={fields}&embeds={embeds}

Request Body

{

    "AssetID": 1,

    "AssetTag": "sample tag",

    "ModelNumber": "sample model",

    "SerialNumber": "sample serial",

    "PurchaseDate": "2020-12-28T06:07:11.1153337-05:00",

    "ServiceStartDate": "2020-12-28T06:07:11.1153337-05:00",

    "ServiceEndDate": "2020-12-28T06:07:11.1153337-05:00",

    "PurchasePrice": 8.0,

    "PayeeAccountID": 1,

    "SalePrice": 9.0,

    "Dimensions": "sample dimensions",

    "Bedrooms": 11,

    "Bathrooms": 12.0,

    "SquareFootage": 13,

    "VendorID": 1,

    "AssetManufacturerID": 1,

    "AssetTypeID": 14,

    "MaintenancePeriod": 15,

    "LastMaintenanceDate": "2020-12-28T06:07:11.1153337-05:00",

    "NextMaintenanceDate": "2020-12-28T06:07:11.1153337-05:00",

    "WarrantyInfo": "sample string 18",

    "WarrantyExpirationDate": "2020-12-28T06:07:11.1153337-05:00",

    "HasServiceAgreement": true,

    "ServiceAgreementExpiration": "2020-12-28T06:07:11.1153337-05:00",

    "Comment": "sample string 22",

    "FinancialPropertyID": 1,

    "FinancialUnitID": 1,

    "ManufactureDate": "2020-12-28T06:07:11.1309547-05:00",

    "IsTrackingFinancials": true,

    "IsAllowLeasing": true,

    "DefaultRent": 26.0,

    "IsActive": true,

    "Age": "sample age",

    "ServiceLength": "sample service length",

    "CreateDate": "2020-12-28T06:07:11.1309547-05:00",

    "CreateUserID": 31,

    "UpdateDate": "2020-12-28T06:07:11.1309547-05:00",

    "UpdateUserID": 33,

    "MetaTag": "sample meta"

}

Response

Newly created asset

  • Asset Detail

Fetch a particular asset by passing AssetID in url. 

Method

GET

URL

Assets/{AssetID}

Response

Asset Details

  • Delete Asset

Delete a particular asset by passing AssetID in url. The URL must include the ID of the entity to delete.

Method

DELETE

URL

Assets/{AssetID}

Response

Delete Success

  • Asset Manufacturers

  • Get All Asset Manufacturers

Return a collection of asset manufacturers.

Method

GET

URL

AssetManufacturers?filters={filters}&embeds={embeds}&orderingOptions={orderingOptions}&fields={fields}&getOptions={getOptions}

Response

Listing of Asset Manufacturers

  • New Asset Manufacturer

Create or update entities of the specified asset manufacturer. 

Method

POST

URL

AssetManufacturers?fields={fields}&embeds={embeds}

Request Body

{

    "AssetManufacturerID": 1,

    "Name": "sample name"

}

Response

Newly created asset manufacturer

  • Asset Manufacturer Detail

Fetch a particular asset manufacturer by passing AssetManufacturerID in url. 

Method

GET

URL

AssetManufacturers/{AssetManufacturerID}

Response

Asset Manufacturer Details

  • Delete Asset Manufacturer

Delete a particular asset manufacturer by passing AssetManufacturerID in url. The URL must include the ID of the entity to delete.

Method

DELETE

URL

AssetManufacturers/{AssetManufacturerID}

Response

Delete Success

  • Asset Status

  • Get All Asset Status

Return a collection of asset status.

Method

GET

URL

AssetStatus?filters={filters}&embeds={embeds}&orderingOptions={orderingOptions}&fields={fields}&getOptions={getOptions}

Response

Listing of Asset Status

  • New Asset Status

Create or update entities of the specified asset status. 

Method

POST

URL

AssetStatus?fields={fields}&embeds={embeds}

Request Body

{

    "AssetStatusID": 1,

    "Name": "sample name"

}

Response

Newly created asset status

  • Asset Status Detail

Fetch a particular asset status by passing AssetStatusID in url. 

Method

GET

URL

AssetStatus/{AssetStatusID}

Response

Asset Status Details

  • Delete Asset Status

Delete a particular asset status by passing AssetStatusID in url. The URL must include the ID of the entity to delete.

Method

DELETE

URL

AssetStatus/{AssetStatusID}

Response

Delete Success

  • Asset Status Workflows

  • Get All Asset Status Workflows

Return a collection of asset status workflows.

Method

GET

URL

AssetStatusWorkflows?filters={filters}&embeds={embeds}&orderingOptions={orderingOptions}&fields={fields}&getOptions={getOptions}

Response

Listing of Asset Status Workflow

  • New Asset Status Workflow

Create or update entities of the specified asset status workflow. 

Method

POST

URL

AssetStatusWorkflows?fields={fields}&embeds={embeds}

Request Body

{

    "AssetStatusWorkflowID": 1,

    "Name": "sample name",

    "Description": "sample description",

    "IsActive": true,

    "CreateDate": "2020-12-29T04:00:20.3239902-05:00",

    "CreateUserID": 6,

    "UpdateDate": "2020-12-29T04:00:20.3239902-05:00",

    "UpdateUserID": 8,

    "ConcurrencyID": 9,

    "MetaTag": "sample meta"

}

Response

Newly created asset status workflow

  • Asset Status Workflow Detail

Fetch a particular asset status workflow by passing AssetStatusWorkflowID in url. 

Method

GET

URL

AssetStatusWorkflows/{AssetStatusWorkflowID}

Response

Asset Status Workflow Details

  • Delete Asset Status Workflow

Delete a particular asset status workflow by passing AssetStatusWorkflowID in url. The URL must include the ID of the entity to delete.

Method

DELETE

URL

AssetStatusWorkflows/{AssetStatusWorkflowID}

Response

Delete Success

  • Asset Title Statuses

  • Get All Asset Title Status

Return a collection of asset title status.

Method

GET

URL

AssetTitleStatuses?filters={filters}&embeds={embeds}&orderingOptions={orderingOptions}&fields={fields}&getOptions={getOptions}

Response

Listing of Asset Title Status

  • New Asset Title Status

Create or update entities of the specified asset title status. 

Method

POST

URL

AssetTitleStatuses?fields={fields}&embeds={embeds}

Request Body

{

    "AssetTitleStatusID": 1,

    "Name": "sample string 2",

    "Description": "sample string 3",

    "SortOrder": 4,

    "CreateDate": "2020-12-29T04:05:03.2522085-05:00",

    "CreateUserID": 6,

    "UpdateDate": "2020-12-29T04:05:03.2522085-05:00",

    "UpdateUserID": 8,

    "ConcurrencyID": 9,

    "MetaTag": "sample string 11"

}

Response

Newly created asset title status

  • Asset Title Status Detail

Fetch a particular asset title status by passing AssetTitleStatusID in url. 

Method

GET

URL

AssetTitleStatuses/{AssetTitleStatusID}

Response

Asset Title Status Details

  • Delete Asset Title Status

Delete a particular asset title status by passing AssetTitleStatusID in url. The URL must include the ID of the entity to delete.

Method

DELETE

URL

AssetTitleStatuses/{AssetTitleStatusID}

Response

Delete Success

  • Asset Types

  • Get All Asset Types

Return a collection of asset types.

Method

GET

URL

AssetTypes?filters={filters}&embeds={embeds}&orderingOptions={orderingOptions}&fields={fields}&getOptions={getOptions}

Response

Listing of Asset Types

  • New Asset Types

Create or update entities of the specified asset types. 

Method

POST

URL

AssetTypes?fields={fields}&embeds={embeds}

Request Body

{

    "AssetTypeID": 1,

    "Name": "sample string 4",

    "Description": "sample string 5",

    "IsHome": true

}

Response

Newly created asset type

  • Asset Type Detail

Fetch a particular asset type by passing AssetTypeID in url. 

Method

GET

URL

AssetTypes/{AssetTypeID}

Response

Asset Type Details

  • Delete Asset Type

Delete a particular asset type by passing AssetTypeID in url. The URL must include the ID of the entity to delete.

Method

DELETE

URL

AssetTypes/{AssetTypeID}

Response

Delete Success

  • Banks

  • Get All Banks

Return a collection of banks.

Method

GET

URL

Banks?filters={filters}&embeds={embeds}&orderingOptions={orderingOptions}&fields={fields}&getOptions={getOptions}

Response

Listing of Banks

  • New Bank

Create or update entities of the specified bank. 

Method

POST

URL

Banks?fields={fields}&embeds={embeds}

Request Body

{

    "BankID": 1,

    "Name": "sample bank"

}

Response

Newly created bank

  • Bank Detail

Fetch a particular bank by passing BankID in url. 

Method

GET

URL

Banks/{BankID}

Response

Bank Details

  • Delete Bank

Delete a particular bank by passing BankID in url. The URL must include the ID of the entity to delete.

Method

DELETE

URL

Banks/{BankID}

Response

Delete Success

  • Bank Reconciliations

  • Get All Bank Reconciliations

Return a collection of bank reconciliations.

Method

GET

URL

BankReconciliations?filters={filters}&embeds={embeds}&orderingOptions={orderingOptions}&fields={fields}&getOptions={getOptions}

Response

Listing of Bank Reconciliations

  • New Bank Reconciliation

Create or update entities of the specified bank reconciliation. 

Method

POST

URL

BankReconciliations?fields={fields}&embeds={embeds}

Request Body

{

    "ReconciliationID": 1,

    "GeneralLedgerAccountID": 2,

    "ReconciliationDate": "2020-12-29T05:36:03.1688527-05:00",

    "PreviouslyReconciledAmount": 4.0,

    "Payments": 5.0,

    "Deposits": 6.0,

    "Goal": 7.0,

    "IsAuto": true,

    "IsManual": true,

    "IsSavedForLater": true,

    "IsReconciled": true,

    "ReportFileID": 12,

    "CreateDate": "2020-12-29T05:36:03.1844749-05:00",

    "CreateUserID": 14,

    "UpdateDate": "2020-12-29T05:36:03.1844749-05:00",

    "UpdateUserID": 16,

    "ConcurrencyID": 17,

    "MetaTag": "sample meta"

}

Response

Newly created bank reconciliation

  • Bank Reconciliation Detail

Fetch a particular bank reconciliation by passing BankID in url. 

Method

GET

URL

BankReconciliations/{ReconciliationID}

Response

Bank Reconciliation Details

  • Delete Bank Reconciliation

Delete a particular bank reconciliation by passing ReconciliationID in url. The URL must include the ID of the entity to delete.

Method

DELETE

URL

BankReconciliations/{ReconciliationID}

Response

Delete Success

  • Billable Expenses

  • Get All Billable Expenses

Return a collection of billable expenses.

Method

GET

URL

BillableExpenses?filters={filters}&embeds={embeds}&fields={fields}&pageSize={pageSize}&pageNumber={pageNumber}&ignorePaging={ignorePaging}

Response

Listing of Billable Expenses

  • Bills

  • Get All Bills

Return a collection of bills.

Method

GET

URL

Bills?filters={filters}&embeds={embeds}&orderingOptions={orderingOptions}&fields={fields}&getOptions={getOptions}

Response

Listing of Bills

  • New Bill

Create or update entities of the specified bill. 

Method

POST

URL

Bills?saveOptions={saveOptions}&fields={fields}&embeds={embeds}

Request Body

{

    "ID": 1,

    "AccountID": 2,

    "Reference": "sample reference",

    "Comment": "sample comment",

    "Amount": 5.0,

    "TransactionDate": "2020-12-29T05:48:20.0387213-05:00",

    "CreateDate": "2020-12-29T05:48:20.0387213-05:00",

    "CreateUserID": 8,

    "UpdateDate": "2020-12-29T05:48:20.0387213-05:00",

    "UpdateUserID": 10,

    "TransactionType": "Bill",

    "PostDate": "2020-12-29T05:48:20.0387213-05:00",

    "DueDate": "2020-12-29T05:48:20.0387213-05:00",

    "AmountAllocated": 13.0,

    "IsFullyAllocated": true,

    "TermID": 15,

    "BankID": 16,

    "IsApproved": true,

    "ApprovalUserID": 18,

    "ApprovalDate": "2020-12-29T05:48:20.0387213-05:00",

    "OwnerApprovalDate": "2020-12-29T05:48:20.0387213-05:00",

    "OwnerApprovalOwnerID": 19,

    "OwnerApprovalUserID": 20,

    "ReversalDate": "2020-12-29T05:48:20.0387213-05:00",

    "IsXIBill": true,

    "AvidInvoiceURL": "sample avid invoice url",

    "ConcurrencyID": 23,

    "PurchaseOrderID": 24,

    "TenantCheckID": 25,

    "TenantChargeID": 26,

    "PayeeAddress": "sample payee address",

    "EcheckEmail": "sample echeck email",

    "MetaTag": "sample meta"

}

Response

Newly created bills

  • Bill Detail

Fetch a particular bill by passing ID in url. 

Method

GET

URL

Bills/{ID}

Response

Bill Details

  • Delete Bill

Delete a particular bill by passing ID in url. The URL must include the ID of the entity to delete.

Method

DELETE

URL

Bills/{ID}

Response

Delete Success

  • Birds Eye View Colors

  • Get All Birds Eye View Colors

Return a collection of birds eye view colors.

Method

GET

URL

BirdsEyeViewColors?filters={filters}&embeds={embeds}&orderingOptions={orderingOptions}&fields={fields}&getOptions={getOptions}

Response

Listing of Birds Eye View Colors

  • New Birds Eye View Color

Create or update entities of the specified birds eye view color. 

Method

POST

URL

BirdsEyeViewColors?fields={fields}&embeds={embeds}

Request Body

{

    "Name": "sample name",

    "HexValue": "sample hex value"

}

Response

Newly created birds eye view color

  • Birds Eye View Color Detail

Fetch a particular birds eye view color by passing ID in url. 

Method

GET

URL

BirdsEyeViewColors/{ID}

Response

Birds Eye View Color Details

  • Delete Birds Eye View Color

Delete a particular bird eye view color by passing ID in url. The URL must include the ID of the entity to delete.

Method

DELETE

URL

BirdsEyeViewColors/{ID}

Response

Delete Success

  • Budgets

  • Get All Budgets

Return a collection of budgets.

Method

GET

URL

Budgets?filters={filters}&embeds={embeds}&orderingOptions={orderingOptions}&fields={fields}&getOptions={getOptions}

Response

Listing of Budgets

  • New Budget

Create or update entities of the specified budget. 

Method

POST

URL

Budgets?fields={fields}&embeds={embeds}

Request Body

{

    "BudgetID": 1,

    "BudgetYear": 2,

    "EntityID": 3,

    "GLAccountID": 4,

    "Comment": "sample comment",

    "CreateDate": "2020-12-30T09:15:28.0400319-05:00",

    "CreateUserID": 7,

    "UpdateDate": "2020-12-30T09:15:28.0400319-05:00",

    "UpdateUserID": 9,

    "Amount": 10.0,

    "MetaTag": "sample meta"

}

Response

Newly created budget

  • Budget Detail

Fetch a particular budget by passing BudgetID in url. 

Method

GET

URL

Budgets/{BudgetID}

Response

Budget Details

  • Delete Budget

Delete a particular budget by passing BudgetID in url. The URL must include the ID of the entity to delete.

Method

DELETE

URL

Budgets/{BudgetID}

Response

Delete Success

  • Budget Annual Comments

  • Get All Budget Annual Comments

Return a collection of budget annual comments.

Method

GET

URL

BudgetAnnualComments?filters={filters}&embeds={embeds}&orderingOptions={orderingOptions}&fields={fields}&getOptions={getOptions}

Response

Listing of Budget Annual Comments

  • New Budget Annual Comment

Create or update entities of the specified budget annual comment. 

Method

POST

URL

BudgetAnnualComments?fields={fields}&embeds={embeds}

Request Body

{

    "BudgetAnnualCommentID": 1,

    "BudgetYear": 2,

    "GLAccountID": 3,

    "EntityID": 4,

    "Comment": "sample string 5",

    "CreateDate": "2020-12-30T09:27:47.6820364-05:00",

    "CreateUserID": 7,

    "UpdateDate": "2020-12-30T09:27:47.6820364-05:00",

    "UpdateUserID": 9,

    "MetaTag": "sample string 11"

}

Response

Newly created budget annual comment

  • Budget Annual Comment Detail

Fetch a particular budget annual comment by passing BudgetAnnualCommentID in url. 

Method

GET

URL

BudgetAnnualComments/{BudgetAnnualCommentID}

Response

Budget Annual Comment Details

  • Delete Budget Annual Comment

Delete a particular budget annual comment by passing BudgetAnnualCommentID in url. The URL must include the ID of the entity to delete.

Method

DELETE

URL

BudgetAnnualComments/{BudgetAnnualCommentID}

Response

Delete Success

  • Charges

  • Get All Charges

Return a collection of charges.

Method

GET

URL

Charges?filters={filters}&embeds={embeds}&orderingOptions={orderingOptions}&fields={fields}&getOptions={getOptions}

Response

Listing of Charges

  • New Charge

Create or update entities of the specified charge. 

Method

POST

URL

Charges?saveOptions={saveOptions}&fields={fields}&embeds={embeds}

Request Body

{

    "ChargeID": 2,

    "ID": 2,

    "AccountID": 3,

    "Reference": "sample reference",

    "Comment": "sample comment",

    "Amount": 6.0,

    "TransactionDate": "2020-12-30T09:33:02.6303628-05:00",

    "CreateDate": "2020-12-30T09:33:02.6303628-05:00",

    "CreateUserID": 9,

    "UpdateDate": "2020-12-30T09:33:02.6303628-05:00",

    "UpdateUserID": 11,

    "TransactionType": "Charge",

    "PropertyID": 12,

    "UnitID": 13,

    "ChargeTypeID": 14,

    "AmountAllocated": 15.0,

    "IsFullyAllocated": true,

    "IsSecurityDepositPriorToGLStartDate": true,

    "AccrualDebitID": 18,

    "AccrualCreditID": 19,

    "TenantBillID": 20,

    "TenantCheckID": 21,

    "MetaTag": "sample meta"

}

Response

Newly created charge

  • Charge Detail

Fetch a particular charge by passing ChargeID in url. 

Method

GET

URL

Charges/{ChargeID}

Response

Charge Details

  • Delete Charge

Delete a particular charge by passing ChargeID in url. The URL must include the ID of the entity to delete.

Method

DELETE

URL

Charges/{ChargeID}

Response

Delete Success

  • Charge Escalations

  • Get All Charge Escalations

Return a collection of charge escalations.

Method

GET

URL

ChargeEscalations?filters={filters}&embeds={embeds}&orderingOptions={orderingOptions}&fields={fields}&getOptions={getOptions}

Response

Listing of Charge Escalations

  • New Charge Escalations

Create or update entities of the specified charge escalations. 

Method

POST

URL

ChargeEscalations?fields={fields}&embeds={embeds}

Request Body

{

    "ChargeEscalationID": 1,

    "LeaseRenewalID": 2,

    "ChargeTypeID": 3,

    "CreateDate": "2020-12-30T09:47:45.0203902-05:00",

    "CreateUserID": 5,

    "UpdateDate": "2020-12-30T09:47:45.0203902-05:00",

    "UpdateUserID": 7,

    "ConcurrencyID": 8,

    "MetaTag": "sample meta"

}

Response

Newly created charge escalations

  • Charge Escalations Detail

Fetch a particular charge escalation by passing ChargeEscalationID in url. 

Method

GET

URL

ChargeEscalations/{ChargeEscalationID}

Response

Charge Escalations Details

  • Delete Charge Escalation

Delete a particular charge escalation by passing ChargeEscalationID in url. The URL must include the ID of the entity to delete.

Method

DELETE

URL

ChargeEscalations/{ChargeEscalationID}

Response

Delete Success

  • Charge Types

  • Get All Charge Type

Return a collection of charge types.

Method

GET

URL

ChargeTypes?filters={filters}&embeds={embeds}&orderingOptions={orderingOptions}&fields={fields}&getOptions={getOptions}

Response

Listing of Charge Types

  • New Charge Type

Create or update entities of the specified charge type. 

Method

POST

URL

ChargeTypes?fields={fields}&embeds={embeds}

Request Body

{

    "ChargeTypeID": 1,

    "Name": "sample string 2",

    "Description": "sample string 3"

}

Response

Newly created charge type

  • Charge Type Detail

Fetch a particular charge type by passing ChargeTypeID in url. 

Method

GET

URL

ChargeTypes/{ChargeTypeID}

Response

Charge Type Details

  • Delete Charge Type

Delete a particular charge type by passing ChargeTypeID in url. The URL must include the ID of the entity to delete.

Method

DELETE

URL

ChargeTypes/{ChargeTypeID}

Response

Delete Success

  • Chart of Account Mappings

  • Get All Chart of Account Mappings

Return a collection of charts of account mappings.

Method

GET

URL

ChartOfAccountsMappings?filters={filters}&embeds={embeds}&orderingOptions={orderingOptions}&fields={fields}&getOptions={getOptions}

Response

Listing of Chart of Account Mappings

  • New Chart of Account Mapping

Create or update entities of the specified chart of account mapping. 

Method

POST

URL

ChartOfAccountsMappings?fields={fields}&embeds={embeds}

Request Body

{

    "ChartOfAccountsMappingID": 1,

    "Name": "sample string 2"

}

Response

Newly created chart of account mapping

  • Chart of Account Mapping Detail

Fetch a particular chart of account mapping by passing ChartOfAccountsMappingID in url. 

Method

GET

URL

ChartOfAccountsMappings/{ChartOfAccountsMappingID}

Response

Chart of Account Mapping Details

  • Delete Chart Account Mappings

Delete a particular chart account mappings by passing ChartOfAccountsMappingID in url. The URL must include the ID of the entity to delete.

Method

DELETE

URL

ChartOfAccountsMappings/{ChartOfAccountsMappingID}

Response

Delete Success

  • Chart of Accounts Mapped Accounts

  • Get All Chart of Accounts Mapped Accounts

Return a collection of charts of accounts mapped accounts.

Method

GET

URL

ChartOfAccountsMappedAccounts?filters={filters}&embeds={embeds}&orderingOptions={orderingOptions}&fields={fields}&getOptions={getOptions}

Response

Listing of Chart of Accounts Mapped Accounts

  • New Chart of Accounts Mapped Accounts

Create or update entities of the specified chart of accounts mapped accounts. 

Method

POST

URL

ChartOfAccountsMappedAccounts?saveOptions={saveOptions}&fields={fields}&embeds={embeds}

Request Body

{

    "ChartOfAccountsMappedAccountID": 1,

    "ChartOfAccountsMappingID": 2,

    "ParentChartOfAccountsMappedAccountID": 3,

    "Name": "sample string 4",

    "Description": "sample description",

    "Reference": "sample reference",

    "SortOrder": 7,

    "Generation": 8,

    "CreateDate": "2020-12-30T10:08:05.7136614-05:00",

    "CreateUserID": 10,

    "UpdateDate": "2020-12-30T10:08:05.7136614-05:00",

    "UpdateUserID": 12,

    "ConcurrencyID": 13,

    "MetaTag": "sample meta"

}

Response

Newly created chart of accounts mapped account

  • Chart of Accounts Mapped Account Detail

Fetch a particular chart of accounts mapped accounts by passing ChartOfAccountsMappedAccountID in url. 

Method

GET

URL

ChartOfAccountsMappedAccounts/{ChartOfAccountsMappedAccountID}

Response

Chart of Accounts Mapped Account Details

  • Delete Chart Accounts Mapped Account

Delete a particular chart accounts mapped account by passing ChartOfAccountsMappedAccountID in url. The URL must include the ID of the entity to delete.

Method

DELETE

URL

ChartOfAccountsMappedAccounts/{ChartOfAccountsMappedAccountID}

Response

Delete Success

  • Check Details

  • Get All Check Details

Return a collection of check details.

Method

GET

URL

CheckDetails?filters={filters}&embeds={embeds}&orderingOptions={orderingOptions}&fields={fields}&getOptions={getOptions}

Response

Listing of Check Details

  • Check Detail Retrieve

Fetch a particular check details by passing CheckID in url. 

Method

GET

URL

CheckDetails/{CheckID}

Response

Check Details

  • Check List Items

  • Get All Checklist Items

Return a collection of checklist items.

Method

GET

URL

CheckListItems?filters={filters}&embeds={embeds}&orderingOptions={orderingOptions}&fields={fields}&getOptions={getOptions}

Response

Listing of Checklist Items

  • Checklist Items Retrieve

Fetch a particular checklist item by passing CheckListItemID in url. 

Method

GET

URL

CheckListItems/{CheckListItemID}

Response

Checklist Item Details

  • Checklist Templates

  • Get All Checklist Templates

Return a collection of checklist templates.

Method

GET

URL

CheckListTemplates?filters={filters}&embeds={embeds}&orderingOptions={orderingOptions}&fields={fields}&getOptions={getOptions}

Response

Listing of Checklist Templates

  • New Checklist Template

Create or update entities of the specified checklist template. 

Method

POST

URL

CheckListTemplates?fields={fields}&embeds={embeds}

Request Body

{

    "CheckListTemplateID": 1,

    "Name": "sample name",

    "IsActive": true,

    "CreateDate": "2021-01-01T01:59:44.6267972-05:00",

    "CreateUserID": 5,

    "UpdateDate": "2021-01-01T01:59:44.6267972-05:00",

    "UpdateUserID": 7,

    "ConcurrencyID": 8,

    "MetaTag": "sample meta"

}

Response

Newly created checklist template

  • Checklist Template Detail

Fetch a particular checklist template by passing CheckListTemplateID in url. 

Method

GET

URL

CheckListTemplates/{CheckListTemplateID}

Response

Checklist Template Details

  • Delete Checklist Template

Delete a particular checklist template by passing CheckListTemplateID in url. The URL must include the ID of the entity to delete.

Method

DELETE

URL

CheckListTemplates/{CheckListTemplateID}

Response

Delete Success

  • Checks

  • Get All Checks

Return a collection of checks.

Method

GET

URL

Checks?filters={filters}&embeds={embeds}&fields={fields}&getOptions={getOptions}

Response

Listing of Checks

  • New Checks

Create or update entities of the specified checks. 

Method

POST

URL

Checks?saveOptions={saveOptions}&fields={fields}&embeds={embeds}

Request Body

{

    "ID": 1,

    "AccountID": 2,

    "Reference": "sample reference",

    "Comment": "sample comment",

    "Amount": 5.0,

    "TransactionDate": "2021-01-01T02:24:14.648283-05:00",

    "CreateDate": "2021-01-01T02:24:14.648283-05:00",

    "CreateUserID": 8,

    "UpdateDate": "2021-01-01T02:24:14.648283-05:00",

    "UpdateUserID": 10,

    "TransactionType": "Check",

    "EcheckEmail": "sample Echeck Email",

    "BankID": 12,

    "Payee": "sample payee",

    "PayeeAddress": "sample payee address",

    "ReconcileID": 15,

    "ElectronicReconcileID": 16,

    "ReversalReconcileID": 17,

    "ReversalElectronicReconcileID": 18,

    "ReversalDate": "2021-01-01T02:24:14.648283-05:00",

    "IsReversed": true,

    "IsXICheck": true,

    "IsNachaCheck": true,

    "TenantBillID": 21,

    "TenantChargeID": 22,

    "MetaTag": "sample meta"

}

Response

Newly created checks

  • Checks Detail

Fetch a particular check by passing ID in url. 

Method

GET

URL

Checks/{ID}

Response

Checks Details

  • Delete Checks

Delete a particular check by passing ID in url. The URL must include the ID of the entity to delete.

Method

DELETE

URL

Checks/{ID}

Response

Delete Success

  • Colors

  • Get All Colors

Return a collection of colors.

Method

GET

URL

Colors?filters={filters}&embeds={embeds}&orderingOptions={orderingOptions}&fields={fields}&getOptions={getOptions}

Response

Listing of Colors

  • New Color

Create or update entities of the specified color. 

Method

POST

URL

Colors?fields={fields}&embeds={embeds}

Request Body

{

    "ColorID": 2,

    "Name": "sample name",

    "HexValue": "sample hex value"

}

Response

Newly created color

  • Color Detail

Fetch a particular color by passing ColorID in url. 

Method

GET

URL

Colors/{ColorID}

Response

Color Details

  • Delete Color

Delete a particular color by passing ColorID in url. The URL must include the ID of the entity to delete.

Method

DELETE

URL

Colors/{ColorID}

Response

Delete Success

  • Commercial Recoverable Expenses

  • Get All Commercial Recoverable Expenses

Return a collection of commercial recoverable expenses.

Method

GET

URL

CommercialRecoverableExpenses?filters={filters}&embeds={embeds}&fields={fields}&getOptions={getOptions}

Response

Listing of Commercial Recoverable Expenses

  • New Commercial Recoverable Expense

Create or update entities of the specified commercial recoverable expense. 

Method

POST

URL

CommercialRecoverableExpenses?fields={fields}&embeds={embeds}

Request Body

{

    "CommercialRecoverableExpenseID": 1,

    "ChargeTypeID": 2,

    "TenantDivisionUserDefinedFieldID": 3,

    "TenantIsProRataShare": true,

    "TenantIsAdministrativeFees": true,

    "AmountPropertyUserDefinedFieldID": 6,

    "AmountTenantUserDefinedFieldID": 7,

    "AmountMonths": 8,

    "AmountIsIncrease": true,

    "AmountIncreasePercentage": 10.0,

    "AmountSpecific": 11.0,

    "IsSubtractBaseAmount": true,

    "CreateDate": "2021-01-01T03:51:30.0432484-05:00",

    "CreateUserID": 14,

    "UpdateDate": "2021-01-01T03:51:30.0432484-05:00",

    "UpdateUserID": 16,

    "ConcurrencyID": 17,

    "MetaTag": "sample meta"

}

Response

Newly created commercial recoverable expense

  • Color Detail

Fetch a particular commercial recoverable expense by passing CommercialRecoverableExpenseID in url. 

Method

GET

URL

CommercialRecoverableExpenses/{CommercialRecoverableExpenseID}

Response

Commercial Recoverable Expense Details

  • Delete Commercial Recoverable Expense

Delete a particular commercial recoverable expense by passing CommercialRecoverableExpenseID in url. The URL must include the ID of the entity to delete.

Method

DELETE

URL

CommercialRecoverableExpenses/{CommercialRecoverableExpenseID}

Response

Delete Success

  • Contacts

  • Get All Contacts

Return a collection of contacts.

Method

GET

URL

Contacts?filters={filters}&embeds={embeds}&fields={fields}&getOptions={getOptions}

Response

Listing of Contacts

  • New Contact

Create or update entities of the specified contact. 

Method

POST

URL

Contacts?saveOptions={saveOptions}&fields={fields}&embeds={embeds}

Request Body

{

    "ContactID": 1,

    "FirstName": "sample first name",

    "LastName": "sample last ma,e",

    "MiddleName": "sample middle name",

    "IsPrimary": true,

    "ContactTypeID": 6,

    "DateOfBirth": "2021-01-01T03:55:06.7446-05:00",

    "FederalTaxID": "sample federal tax id",

    "Comment": "sample comment",

    "Email": "sample email",

    "License": "sample license",

    "Vehicle": "sample vehicle",

    "ImageID": 14,

    "IsShowOnBill": true,

    "Employer": "sample employer",

    "CreateDate": "2021-01-01T03:55:06.7446-05:00",

    "CreateUserID": 18,

    "UpdateDate": "2021-01-01T03:55:06.7446-05:00",

    "AnnualIncome": 1.0,

    "UpdateUserID": 20,

    "ParentID": 21,

    "MetaTag": "sample meta"

}

Response

Newly created contact

  • Contact Detail

Fetch a particular contact by passing ContactID in url. 

Method

GET

URL

Contacts/{ContactID}

Response

Contact Details

  • Delete Contact

Delete a particular contact by passing ContactID in url. The URL must include the ID of the entity to delete.

Method

DELETE

URL

Contacts/{ContactID}

Response

Delete Success

  • Contact Types

  • Get All Contact Types

Return a collection of contact types.

Method

GET

URL

ContactTypes?filters={filters}&embeds={embeds}&orderingOptions={orderingOptions}&fields={fields}&getOptions={getOptions}

Response

Listing of Contact Types

  • New Contact Type

Create or update entities of the specified contact type. 

Method

POST

URL

ContactTypes?fields={fields}&embeds={embeds}

Request Body

{

    "ContactTypeID": 1,

    "Name": "sample name"

}

Response

Newly created contact type

  • Contact Type Detail

Fetch a particular contact type by passing ContactTypeID in url. 

Method

GET

URL

ContactTypes/{ContactTypeID}

Response

Contact Type Details

  • Delete Contact Type

Delete a particular contact type by passing ContactTypeID in url. The URL must include the ID of the entity to delete.

Method

DELETE

URL

ContactTypes/{ContactTypeID}

Response

Delete Success

  • Credit Card Reconciliations

  • Get All Credit Card Reconciliation

Return a collection of credit card reconciliation.

Method

GET

URL

CreditCardReconciliations?filters={filters}&embeds={embeds}&orderingOptions={orderingOptions}&fields={fields}&getOptions={getOptions}

Response

Listing of Credit Card Reconciliation

  • New Credit Card Reconciliation

Create or update entities of the specified credit card reconciliation. 

Method

POST

URL

CreditCardReconciliations?fields={fields}&embeds={embeds}

Request Body

{

    "CreditCardReconciliationID": 2,

    "CreditCardID": 3,

    "ReconciliationDate": "2021-01-01T05:13:08.5087401-05:00",

    "PreviouslyReconciledAmount": 5.0,

    "Charges": 6.0,

    "Credits": 7.0,

    "Goal": 8.0,

    "IsSavedForLater": true,

    "IsReconciled": true,

    "ReportFileID": 11,

    "CreateDate": "2021-01-01T05:13:08.5087401-05:00",

    "CreateUserID": 13,

    "UpdateDate": "2021-01-01T05:13:08.5087401-05:00",

    "UpdateUserID": 15,

    "ConcurrencyID": 16,

    "MetaTag": "sample meta"

}

Response

Newly created credit card reconciliation

  • Credit Card Reconciliation Detail

Fetch a particular credit card reconciliation by passing CreditCardReconciliationID in url. 

Method

GET

URL

CreditCardReconciliations/{CreditCardReconciliationID}

Response

Credit Card Reconciliation Details

  • Delete Credit Card Reconciliation

Delete a particular credit card reconciliation by passing CreditCardReconciliationID in url. The URL must include the ID of the entity to delete.

Method

DELETE

URL

CreditCardReconciliations/{CreditCardReconciliationID}

Response

Delete Success

  • Credit Cards

  • Get All Credit Cards

Return a collection of credit cards.

Method

GET

URL

CreditCards?filters={filters}&embeds={embeds}&orderingOptions={orderingOptions}&fields={fields}&getOptions={getOptions}

Response

Listing of Credit Cards

  • New Credit Card

Create or update entities of the specified credit card. 

Method

POST

URL

CreditCards?fields={fields}&embeds={embeds}

Request Body

{

    "CreditCardID": 1,

    "ParentCreditCardID": 2,

    "Name": "sample name",

    "Description": "sample description",

    "Reference": "sample reference",

    "IsActive": true,

    "SortOrder": 7,

    "Generation": 8,

    "Balance": 1.0,

    "ClearedBalance": 1.0,

    "CreateDate": "2021-01-01T05:19:28.6524-05:00",

    "CreateUserID": 10,

    "UpdateDate": "2021-01-01T05:19:28.6524-05:00",

    "UpdateUserID": 12,

    "ConcurrencyID": 13,

    "MetaTag": "sample meta"

}

Response

Newly created credit card

  • Credit Card Detail

Fetch a particular credit card by passing CreditCardID in url. 

Method

GET

URL

CreditCards/{CreditCardID}

Response

Credit Card Details

  • Delete Credit Card

Delete a particular credit card by passing CreditCardID in url. The URL must include the ID of the entity to delete.

Method

DELETE

URL

CreditCards/{CreditCardID}

Response

Delete Success

  • Credit Card Transactions

  • Get All Credit Card Transactions

Return a collection of credit card transactions.

Method

GET

URL

CreditCardTransactions?filters={filters}&embeds={embeds}&fields={fields}&getOptions={getOptions}

Response

Listing of Credit Card Transactions

  • New Credit Card Transaction

Create or update entities of the specified credit card transaction. 

Method

POST

URL

CreditCardTransactions?saveOptions={saveOptions}&fields={fields}&embeds={embeds}

Request Body

{

    "ID": 1,

    "CreditCardID": 2,

    "ReconcileID": 3,

    "ElectronicReconcileID": 4,

    "AccountID": 5,

    "Reference": "sample reference",

    "Comment": "sample comment",

    "Amount": 8.0,

    "TransactionDate": "2021-01-04T06:31:56.7014976-05:00",

    "CreateDate": "2021-01-04T06:31:56.7014976-05:00",

    "CreateUserID": 11,

    "UpdateDate": "2021-01-04T06:31:56.7014976-05:00",

    "UpdateUserID": 13,

    "TransactionType": "CreditCard",

    "MetaTag": "sample meta"

}

Response

Newly created credit card transaction

  • Credit Card Transaction Detail

Fetch a particular credit card transaction by passing ID in url. 

Method

GET

URL

CreditCardTransactions/{ID}

Response

Credit Card Transaction Details

  • Delete Credit Card Transaction

Delete a particular credit card transaction by passing ID in url. The URL must include the ID of the entity to delete.

Method

DELETE

URL

CreditCardTransactions/{ID}

Response

Delete Success

  • Credits

  • Get All Credits

Return a collection of credits.

Method

GET

URL

Credits?filters={filters}&embeds={embeds}&fields={fields}&getOptions={getOptions}

Response

Listing of Credits

  • New Credit

Create or update entities of the specified credit. 

Method

POST

URL

Credits?saveOptions={saveOptions}&fields={fields}&embeds={embeds}

Request Body

{

    "ID": 1,

    "AccountID": 2,

    "ChargeTypeID": 3,

    "TransactionType": "Credit",

    "CreateDate": "2021-01-04T06:35:32.7340096-05:00",

    "UpdateDate": "2021-01-04T06:35:32.7340096-05:00",

    "CreateUserID": 6,

    "UpdateUserID": 7,

    "TransactionDate": "2021-01-04T06:35:32.7340096-05:00",

    "PropertyID": 9,

    "UnitID": 10,

    "AmountAllocated": 11.0,

    "IsFullyAllocated": true,

    "IsSecurityDepositPriorToGLStartDate": true,

    "IsRecordingCashReallocations": true,

    "IsRecordingCashPreallocationsAsLiability": true,

    "IsRecordingAccrualPrepayments": true,

    "ReversalDate": "2021-01-04T06:35:32.7340096-05:00",

    "Reference": "sample reference",

    "Comment": "sample comment",

    "Amount": 19.0,

    "MetaTag": "sample meta"

}

Response

Newly created credit

  • Credits Detail

Fetch a particular credit by passing ID in url. 

Method

GET

URL

Credits/{ID}

Response

Credit Details

  • Delete Credit

Delete a particular credit by passing ID in url. The URL must include the ID of the entity to delete.

Method

DELETE

URL

Credits/{ID}

Response

Delete Success

  • Custom Forms

  • Get All Custom Forms

Return a collection of custom forms.

Method

GET

URL

CustomForms?filters={filters}&embeds={embeds}&orderingOptions={orderingOptions}&fields={fields}&getOptions={getOptions}

Response

Listing of Custom Forms

  • Custom Form Detail

Fetch a particular custom form by passing ID in url. 

Method

GET

URL

CustomForms/{CustomFormID}

Response

Custom Form Details

  • Custom Privilege Categories

  • Get All Custom Privilege Categories

Return a collection of custom privilege categories.

Method

GET

URL

CustomPrivilegeCategories?filters={filters}&embeds={embeds}&fields={fields}&getOptions={getOptions}

Response

Listing of custom privilege categories

  • New Custom Privilege Category

Create or update entities of the specified custom privilege category. 

Method

POST

URL

CustomPrivilegeCategories?fields={fields}&embeds={embeds}

Request Body

{

    "CustomPrivilegeCategoryID": 1,

    "Name": "sample name",

    "MetaTag": "sample meta"

}

Response

Newly created custom privilege category

  • Custom Privilege Category Detail

Fetch a particular custom privilege category by passing CustomPrivilegeCategoryID in url. 

Method

GET

URL

CustomPrivilegeCategories/{CustomPrivilegeCategoryID}

Response

Custom Privilege Category Details

  • Delete Custom Privilege Category

Delete a particular custom privilege category by passing CustomPrivilegeCategoryID in url. The URL must include the ID of the entity to delete.

Method

DELETE

URL

CustomPrivilegeCategories/{CustomPrivilegeCategoryID}

Response

Delete Success

  • Custom Privileges

  • Get All Custom Privileges

Return a collection of custom privileges.

Method

GET

URL

CustomPrivileges?filters={filters}&embeds={embeds}&fields={fields}&getOptions={getOptions}

Response

Listing of custom privileges

  • New Custom Privilege

Create or update entities of the specified custom privilege. 

Method

POST

URL

CustomPrivileges?fields={fields}&embeds={embeds}

Request Body

{

    "CustomPrivilegeID": 1,

    "CustomPrivilegeCategoryID": 2,

    "Name": "sample name",

    "Description": "sample description",

    "IsHidden": true,

    "IsAdd": true,

    "IsView": true,

    "IsEdit": true,

    "IsDelete": true,

    "IsOn": true,

    "MetaTag": "sample meta"

}

Response

Newly created custom privileges

  • Custom Privilege Detail

Fetch a particular custom privilege by passing CustomPrivilegeID in url. 

Method

GET

URL

CustomPrivileges/{CustomPrivilegeID}

Response

Custom Privilege Details

  • Delete Custom Privilege Category

Delete a particular custom privilege by passing CustomPrivilegeID in url. The URL must include the ID of the entity to delete.  

Method

DELETE

URL

CustomPrivileges/{CustomPrivilegeID}

Response

Delete Success

  • Custom Products

  • Get All Custom Products

Return a collection of custom products.

Method

GET

URL

CustomProducts?filters={filters}&embeds={embeds}&fields={fields}&getOptions={getOptions}

Response

Listing of custom products

  • New Custom Product

Create or update entities of the specified custom product. 

Method

POST

URL

CustomProducts?fields={fields}&embeds={embeds}

Request Body

{

    "CustomProductID": 1,

    "Name": "sample name",

    "MetaTag": "sample meta"

}

Response

Newly created custom product

  • Custom Product Detail

Fetch a particular custom product by passing CustomProductID in url. 

Method

GET

URL

CustomProducts/{CustomProductID}

Response

Custom Product Details

  • Delete Custom Product

Delete a particular custom product by passing CustomProductID in url. The URL must include the ID of the entity to delete.  

Method

DELETE

URL

CustomProducts/{CustomProductID}

Response

Delete Success

  • Custom Product System Preferences

  • Get All Custom Product System Preferences

Return a collection of custom product system preferences.

Method

GET

URL

CustomProductSystemPreferences?filters={filters}&embeds={embeds}&fields={fields}&getOptions={getOptions}

Response

Listing of custom product system preferences

  • New Custom Product System Preference

Create or update entities of the specified custom product system preference. 

Method

POST

URL

CustomProductSystemPreferences?fields={fields}&embeds={embeds}

Request Body

{

    "CustomProductSystemPreferenceID": 1,

    "CustomProductID": 2,

    "Preference": "sample preference",

    "Value": "sample value",

    "MetaTag": "sample meta"

}

Response

Newly created custom product system preference

  • Custom Product System Preference Detail

Fetch a particular custom product by passing CustomProductSystemPreferenceID in url. 

Method

GET

URL

CustomProductSystemPreferences/{CustomProductSystemPreferenceID}

Response

Custom Product System Preference Details

  • Delete Custom Product System Preference

Delete a particular custom product system preference by passing CustomProductSystemPreferenceID in url. The URL must include the ID of the entity to delete.  

Method

DELETE

URL

CustomProductSystemPreferences/{CustomProductSystemPreferenceID}

Response

Delete Success

  • Custom Reports

  • Get All Custom Reports

Return a collection of custom reports.

Method

GET

URL

CustomReports?filters={filters}&embeds={embeds}&fields={fields}&getOptions={getOptions}

Response

Listing of custom reports

  • New Custom Report

Create or update entities of the specified custom report. 

Method

POST

URL

CustomReports?fields={fields}&embeds={embeds}

Request Body

{

    "CustomReportID": 1,

    "Name": "sample name",

    "ReportType": "NotSet",

    "Title": "sample title",

    "TitleFormat": "sample title format",

    "SubTitle": "sample subtitle",

    "SubTitleFormat": "sample subtitle format",

    "FileID": 7,

    "BeforeReport": "sample before report",

    "BeforeRecord": "sample before record",

    "AfterRecord": "sample after record",

    "MarginTop": 11.0,

    "MarginRight": 12.0,

    "MarginBottom": 13.0,

    "MarginLeft": 14.0,

    "Description": "sample description",

    "SortOrder": 16,

    "IsSystem": true,

    "Height": 18.0,

    "Width": 19.0,

    "CreateDate": "2021-01-11T04:06:18.7444982-05:00",

    "UpdateDate": "2021-01-11T04:06:18.7444982-05:00",

    "CreateUserID": 22,

    "UpdateUserID": 23,

    "MetaTag": "sample meta"

}

Response

Newly created custom report

  • Custom Report Detail

Fetch a particular custom report by passing CustomReportID in url. 

Method

GET

URL

CustomReports/{CustomReportID}

Response

Custom Report Details

  • Delete Custom Product

Delete a particular custom product by passing CustomProductID in url. The URL must include the ID of the entity to delete.  

Method

DELETE

URL

CustomProducts/{CustomProductID}

Response

Delete Success

  • Deposits

  • Get All Deposits

Return a collection of deposits.

Method

GET

URL

Deposits?filters={filters}&embeds={embeds}&orderingOptions={orderingOptions}&fields={fields}&getOptions={getOptions}

Response

Listing of deposits

  • New Deposit

Create or update entities of the specified deposit. 

Method

POST

URL

Deposits?saveOptions={saveOptions}&fields={fields}&embeds={embeds}

Request Body

{

    "DepositID": 1,

    "BankID": 2,

    "Comment": "sample comment",

    "TransactionDate": "2021-01-11T05:59:22.050343-05:00",

    "Amount": 5.0,

    "ReconcileID": 6,

    "ElectronicReconcileID": 7,

    "DepositTypeID": 8,

    "CreateDate": "2021-01-11T05:59:22.050343-05:00",

    "CreateUserID": 10,

    "UpdateDate": "2021-01-11T05:59:22.050343-05:00",

    "UpdateUserID": 12,

    "MetaTag": "sample meta"

}

Response

Newly created deposit

  • Deposit Detail

Fetch a particular deposit by passing DepositID in url. 

Method

GET

URL

Deposits/{DepositID}

Response

Deposit Details

  • Delete Deposit

Delete a particular deposit by passing DepositID in url. The URL must include the ID of the entity to delete.  

Method

DELETE

URL

Deposits/{DepositID}

Response

Delete Success

  • Document Packets

  • Get All Document Packets

Return a collection of document packets.

Method

GET

URL

DocumentPackets?filters={filters}&embeds={embeds}&orderingOptions={orderingOptions}&fields={fields}&getOptions={getOptions}

Response

Listing of document packets

  • New Document Packet

Create or update entities of the specified document packet. 

Method

POST

URL

DocumentPackets?fields={fields}&embeds={embeds}

Request Body

{

    "DocumentPacketID": 1,

    "Name": "sample name",

    "Description": "sample description",

    "DocumentPacketType": "General",

    "SortOrder": 4,

    "CreateDate": "2021-01-12T06:25:37.9113245-05:00",

    "CreateUserID": 6,

    "UpdateDate": "2021-01-12T06:25:37.9113245-05:00",

    "UpdateUserID": 8,

    "ConcurrencyID": 9,

    "MetaTag": "sample meta"

}

Response

Newly created document packet

  • Document Packet Detail

Fetch a particular document packet by passing DocumetPacketID in url. 

Method

GET

URL

DocumentPackets/{DocumetPacketID}

Response

Document Packet Details

  • Delete Document Packet

Delete a particular document packet by passing DocumentPacketID in url. The URL must include the ID of the entity to delete.  

Method

DELETE

URL

DocumentPackets/{DocumetPacketID}

Response

Delete Success

  • Email Sent Items

  • Get All Email Sent Items

Return a collection of email sent items.

Method

GET

URL

EmailSentItems?filters={filters}&embeds={embeds}&fields={fields}&getOptions={getOptions}

Response

Listing of email sent items

  • New Email Sent Item

Create or update entities of the specified email sent item. 

Method

POST

URL

EmailSentItems?fields={fields}&embeds={embeds}

Request Body

{

    "EmailSentItemID": 1,

    "FromAddress": "sample from address",

    "Subject": "sample subject",

    "EmailSentDate": "2021-01-12T06:54:21.5854261-05:00",

    "MessageBody": "sample message body",

    "DisplayName": "sample display name",

    "IsSentIndividually": true,

    "UserID": 8,

    "IsHTML": true,

    "EmailSentFolderID": 10,

    "MetaTag": "sample meta"

}

Response

Newly created email sent item

  • Email Sent Item Detail

Fetch a particular email sent item by passing EmailSentItemID in url. 

Method

GET

URL

EmailSentItems/{EmailSentItemID}

Response

Email Sent Item Details

  • Delete Email Sent Item

Delete a particular email sent item by passing EmailSentItemID in url. The URL must include the ID of the entity to delete.  

Method

DELETE

URL

EmailSentItems/{EmailSentItemID}

Response

Delete Success

  • Estimates

  • Get All Estimates

Return a collection of estimates.

Method

GET

URL

Estimates?filters={filters}&embeds={embeds}&fields={fields}&getOptions={getOptions}

Response

Listing of estimates

  • New Estimate

Create or update entities of the specified estimate. 

Method

POST

URL

Estimates?fields={fields}&embeds={embeds}

Request Body

{

    "EstimateID": 1,

    "Reference": "sample reference",

    "EstimateNumber": "sample estimate number",

    "AccountID": 4,

    "SalesRepresentativeID": 5,

    "IssueDate": "2021-01-12T09:32:31.2177014-05:00",

    "IsActive": true,

    "PropertyID": 7,

    "TaxRate": 8.0,

    "IsTaxable": true,

    "TaxTypeID": 10,

    "Interest": 11,

    "TotalValue": 12.0,

    "Comments": "sample comments",

    "FromAddress": "sample from address",

    "ToAddress": "sample to address",

    "ApprovedRejectedBy": 16,

    "ApprovedRejectedOn": "2021-01-12T09:32:31.2177014-05:00",

    "OwnerSignature": "sample owner signature",

    "ExpirationDate": "2021-01-12T09:32:31.2177014-05:00",

    "CreateDate": "2021-01-12T09:32:31.2177014-05:00",

    "CreateUserID": 19,

    "UpdateDate": "2021-01-12T09:32:31.2177014-05:00",

    "UpdateUserID": 21,

    "PurchaseOrderID": 22,

    "InvoiceID": 23,

    "ServiceManagerIssueID": 24,

    "MetaTag": "sample meta"

}

Response

Newly created estimate

  • Estimate Detail

Fetch a particular estimate by passing EstimateID in url. 

Method

GET

URL

Estimates/{EstimateID}

Response

Estimate Details

  • Delete Estimate 

Delete a particular estimate by passing EstimateID in url. The URL must include the ID of the entity to delete.  

Method

DELETE

URL

Estimates/{EstimateID}

Response

Delete Success

  • Floors

  • Get All Floors

Return a collection of floors.

Method

GET

URL

Floors?filters={filters}&embeds={embeds}&fields={fields}&getOptions={getOptions}

Response

Listing of floors

  • New Floor

Create or update entities of the specified floor. 

Method

POST

URL

Floors?fields={fields}&embeds={embeds}

Request Body

{

    "FloorID": 1,

    "Name": "sample name",

    "SortOrder": 3,

    "CreateDate": "2021-01-12T09:37:14.507572-05:00",

    "CreateUserID": 5,

    "UpdateDate": "2021-01-12T09:37:14.507572-05:00",

    "UpdateUserID": 7,

    "MetaTag": "sample meta"

}

Response

Newly created floor

  • Floor Detail

Fetch a particular floor by passing FloorID in url. 

Method

GET

URL

Floors/{FloorID}

Response

Floor Details

  • Delete Floor

Delete a particular floor by passing FloorID in url. The URL must include the ID of the entity to delete.  

Method

DELETE

URL

Floors/{FloorID}

Response

Delete Success

  • GL Accounts

  • Get All GL Accounts

Return a collection of GL accounts.

Method

GET

URL

GLAccounts?filters={filters}&embeds={embeds}&orderingOptions={orderingOptions}&fields={fields}&getOptions={getOptions}

Response

Listing of GL accounts

  • New GL Account

Create or update entities of the specified GL account. 

Method

POST

URL

GLAccounts?fields={fields}&embeds={embeds}

Request Body

{

    "GLAccountID": 1,

    "ParentGLAccountID": 2,

    "Name": "sample name",

    "Description": "sample description",

    "Reference": "sample reference",

    "CAMRecoveryChargeTypeID": 6,

    "CAMReconcileChargeTypeID": 7,

    "IsActive": true,

    "IsEChecks": true,

    "SortOrder": 10,

    "Generation": 11,

    "PositivePayFormatID": 12,

    "NachaODFIBankID": 13,

    "CreateDate": "2021-01-13T01:26:15.1707465-05:00",

    "CreateUserID": 15,

    "UpdateDate": "2021-01-13T01:26:15.1707465-05:00",

    "UpdateUserID": 17,

    "ChildGLAccounts": [],

    "MetaTag": "sample meta"

}

Response

Newly created GL account

  • GL Account Detail

Fetch a particular GL account by passing GLAccountID in url. 

Method

GET

URL

GLAccounts/{GLAccountID}

Response

GL Account Details

  • Delete GL Account

Delete a particular GL account by passing GLAccountID in url. The URL must include the ID of the entity to delete.  

Method

DELETE

URL

GLAccounts/{GLAccountID}

Response

Delete Success

  • Guest Card Templates

  • Get All Guest Card Templates

Return a collection of guest card templates.

Method

GET

URL

GuestCardTemplates?filters={filters}&embeds={embeds}&orderingOptions={orderingOptions}&fields={fields}&getOptions={getOptions}

Response

Listing of guest card templates

  • Guest Card Template Detail

Fetch a particular guest card template by passing GuestCardTemplateID in url. 

Method

GET

URL

GuestCardTemplates/{GuestCardTemplateID}

Response

Guest Card Template Details

  • History

  • Get All History

Return a collection of history.

Method

GET

URL

History?filters={filters}&embeds={embeds}&orderingOptions={orderingOptions}&fields={fields}&getOptions={getOptions}

Response

Listing of history

  • History Detail

Fetch a particular history  by passing HistoryID in url. 

Method

GET

URL

History/{HistoryID}

Response

History Details

  • History Calls

  • Get All History Calls

Return a collection of history calls.

Method

GET

URL

HistoryCalls?filters={filters}&embeds={embeds}&fields={fields}&getOptions={getOptions}

Response

Listing of history calls

  • History Call Detail

Fetch a particular history call  by passing HistoryID in url. 

Method

GET

URL

HistoryCalls/{HistoryID}

Response

History Call Details

  • History Category

  • Get All History Category

Return a collection of history categories.

Method

GET

URL

HistoryCategory?filters={filters}&embeds={embeds}&orderingOptions={orderingOptions}&fields={fields}&getOptions={getOptions}

Response

Listing of history categories

  • New History Category

Create or update entities of the specified history category. 

Method

POST

URL

HistoryCategory?fields={fields}&embeds={embeds}

Request Body

{

    "HistoryCategoryID": 1,

    "Name": "sample name"

}

Response

Newly created history category

  • History Category Detail

Fetch a particular history category by passing HistoryCategoryID in url. 

Method

GET

URL

HistoryCategory/{HistoryCategoryID}

Response

History Category Details

  • Delete History Category

Delete a particular history category by passing HistoryCategoryID in url. The URL must include the ID of the entity to delete.  

Method

DELETE

URL

HistoryCategory/{HistoryCategoryID}

Response

Delete Success

  • History Emails

  • Get All History Emails

Return a collection of history emails.

Method

GET

URL

HistoryEmails?filters={filters}&embeds={embeds}&fields={fields}&getOptions={getOptions}

Response

Listing of history emails

  • History Email Detail

Fetch a particular history email  by passing HistoryID in url. 

Method

GET

URL

HistoryEmails/{HistoryID}

Response

History Email Details

  • History Notes

  • Get All History Notes

Return a collection of history notes.

Method

GET

URL

HistoryNotes?filters={filters}&embeds={embeds}&fields={fields}&getOptions={getOptions}

Response

Listing of history notes

  • History Note Detail

Fetch a particular history note  by passing HistoryID in url. 

Method

GET

URL

HistoryNotes/{HistoryID}

Response

History Note Details

  • History System Notes

  • Get All History System Notes

Return a collection of history system notes.

Method

GET

URL

HistorySystemNotes?filters={filters}&embeds={embeds}&orderingOptions={orderingOptions}&fields={fields}&getOptions={getOptions}

Response

Listing of history system notes

  • History System Note Detail

Fetch a particular history system note  by passing HistoryID in url. 

Method

GET

URL

HistorySystemNotes/{HistoryID}

Response

History System Note Details

  • History Violation Notes

  • Get All History Violation Notes

Return a collection of history violation notes.

Method

GET

URL

HistoryViolationNotes?filters={filters}&embeds={embeds}&orderingOptions={orderingOptions}&fields={fields}&getOptions={getOptions}

Response

Listing of history violation notes

  • History Violation Note Detail

Fetch a particular history violation note by passing HistoryID in url. 

Method

GET

URL

HistoryViolationNotes/{HistoryID}

Response

History Violation Note Details

  • History Visits

  • Get All History Visits

Return a collection of history visits.

Method

GET

URL

HistoryVisits?filters={filters}&embeds={embeds}&fields={fields}&getOptions={getOptions}

Response

Listing of history visits

  • History Visit Detail

Fetch a particular history visit by passing HistoryID in url. 

Method

GET

URL

HistoryVisits/{HistoryID}

Response

History Visit Details

  • Incoming Texts

  • Get All Incoming Texts

Return a collection of incoming texts.

Method

GET

URL

IncomingTexts?filters={filters}&embeds={embeds}&orderingOptions={orderingOptions}&fields={fields}&getOptions={getOptions}

Response

Listing of incoming texts