Welcome!

Welcome to Buildium’s API—a powerful, RESTful programming interface that lets you leverage valuable Buildium data.

Using HTTP requests, you can create integrations with applications that specialize in accounting, lead tracking, and more. Enjoy greater flexibility, transparency, and control over your business!

What's in this Guide?

This guide is full of simple, easy-to-follow instructions that’ll help you use Buildium’s API like a pro.

Topics include:

• choosing the right resources for your use case
• making HTTP requests to any resource
• understanding data and response codes

Excited to get going? We’ll walk you through the setup process.

Note: To take advantage of the Buildium Open API you must have a Premium Subscription.

Before you can use Buildium’s API, you’ll need to make some tweaks to your account settings.

Enabling the API

In order to start creating your keys and making requests, you’ll need to enable the API.

Tip: You’ll need an administrator user role with access to Application settings to set things up properly.

​ Let's Begin!

1. Sign in to your Buildium account from your browser.

2. Open the Settings menu and click Application settings.

3. Under System preferences, click Api settings. A modal will appear.

4. Click the Open API toggle to turn it on. Then click Save.

Congratulations! Your account's enabled. Now, you’re ready to start managing API keys.

If you are having issues enabling the API within your account you can submit a Support request for assistance.

Account-level API keys authenticate every request and keep things secure.

API keys have two components: a “client ID” and a “secret”.

• Client IDs are similar to usernames. They’re used to identify your Buildium account and are safe to share.
• Secrets are similar to passwords. They must be kept confidential.

Whenever you make a request, you’ll need the API key’s client ID and secret. If you forget it, make a mistake, or try to use information that’s linked to a deleted key, the API will return a 401 response code.

Tip: We compiled a list of best practices that detail how securely store API keys. Give it a read!

Now that the Open APi is enabled, you’ll be able to create API keys. You’re almost there!

Tip: You’ll need an administrator user role to complete this step, too.

How to create an API key

1. Sign in to your Buildium account from your browser.

2. Open the Settings menu and click Developer Tools. The page will open automatically.

3. Click the Create API Key button. A modal will appear.

4. Enter a clear, memorable name and description for your API key. It’ll make it easier to locate the right key when you make a request. Once finished, click Next.

5. Now, choose which pieces of Buildium data you want this API key to have access to by marking the corresponding checkboxes. Once finished, click Next.

6. You successfully created an API key!

Important: This is your only chance to record the secret. Make sure it’s stored somewhere secure! If it’s forgotten, you’ll need to delete this key and start from scratch.

You have now successfully created an API key and have everything you need to send requests to the Buildium API!

Before moving on to making your first request please review Keeping your Keys Safe for an overview on securely storing your API keys.

If you are having issues creating API keys you can submit a Support request for assistance.

Based on their permissions, API keys could have full access to your account’s Buildium data. It’s important that you only grant access to trusted applications, securely record secrets, and consider a password manager to stay organized.

Recommended Practices

• Avoid hard-coding client IDs and secrets inside source files.
• Avoid storing client IDs and secrets in any files that may be committed to source control, particularly cloud-based source control platforms.
• Apply restrictions to client IDs and secrets shared with your staff. You can restrict a key to particular Buildium entities or to read-only access (GET resources only).
• Avoid sharing client IDs and secrets across public, insecure platforms.
• Establish a process to regularly recreate your client IDs and secrets from your Buildium account.
  
  

You’ve done a great job setting up your account, Now, we’ll walk you through how to access your data. It’s very straightforward and should only take a few minutes!

Tip: Looking for the right HTTP client? If you’re just getting started, we recommend Postman.

Let's Get Started!

Step 1: Get Your API Key

If you haven't yet done so, obtain your API key client ID and secret from your Buildium account. Your API key is how the Buildium API authenticates requests and ensures only you can access your data.

See Getting Started for a deeper dive into enabling the API and creating keys.

Step 2: Install a HTTP client

The Buildium API supports any standard HTTP client. If you're looking for a user-friendly HTTP client application, we recommend Postman – it allows you to access the Buildium API without writing code. We’ll use Postman for our example below to demonstrate sending an API request.

Step 3: Make a Sample Request

Let's dive in and make a simple request to get all the Rental Properties in your account. This will confirm your connectivity to our platform and validate the keys you created on our website. Simply follow the instructions below.

1. Open the Postman application.
2. Open the verb menu and select GET.
3. Enter the request endpoint in the field next to GET.

• Here’s the endpoint to get all rentals: https://api.buildium.com/v1/rentals.

4. To authenticate the request, enter your client ID and secret respectively in these request headers:

• x-buildium-client-id
• x-buildium-client-secret
• Your full request should look similar to the image below.

5. Review the parameters of your request on last time. Once finished, click Send.

6. If successful, you should see a JSON response and a 200 HTTP status code. Voilà! You've connected to the Buildium API.

If you've received an error response please review the JSON response message for a description of how to resolve the issue. You can also see more information about HTTP status codes in the Response Codes section. If you are still having trouble making a request after reviewing these sections please submit a Support request.

The Buildium API is built upon standard REST conventions. It's designed to use consistent resource-oriented URLs, accept and return JSON-encoded messages, and use standard HTTP status codes and verbs.

The base URL for production environment API requests is: https://api.buildium.com/

The base URL for sandbox environment API requests is: https://apisandbox.buildium.com/

In order to ensure all requests and responses are secure between the API consumer and Buildium servers, requests must be made using the https protocol. Any requests not made with the https protocol will be refused by the Buildium API platform.

Note: URL paths are case-sensitive to stay consistent with common REST standards. If your request doesn’t align with the documented URL path, you’ll receive a 404 response code reminding you of this constraint.

The Buildium API is version controlled. Versioning ensures backwards-incompatible changes to the API don’t impact any existing integrations.

Buildium uses only a major version nomenclature to manage changes. The current version of the Buildium API is version 1. By specifying a version in the resource request URL, you'll get expected responses regardless of future changes to the API. Here's an example of calling version 1 of the retrieve all rentals resource:

https://api.buildium.com/v1/rentals

Any request submitted without the version in the URL path will result in a 404 error response code.

Releasing Changes to the API

The Buildium API will continue to evolve to ensure it meets the needs of our customers. Changes will be defined as either backwards-compatible or backwards-incompatible.

We’ll always provide advance notice for all API releases–regardless of the type of modifications being made.

Backward-compatible Changes

Backward-compatible changes are modifications to the API that shouldn't impact existing integrations. They'll apply to the current version of the API. Simply put: you won’t need to change the version to consume new changes like these.

It's important as you develop against the Buildium API that you ensure these types of changes don't impact your integration. Here's are examples of backward-compatible modifications.

• Adding new API resources and/or endpoints.
• Adding new optional request parameters to existing API methods.
• Adding new properties to existing API responses and non-required properties for request messages.
• Changing property order in existing API responses.

All backward-compatible changes to the API will be documented in the Changelog.

Backwards-incompatible Changes

When backwards-incompatible changes to the API occur, a new version of the API will be released. You’ll need to update the URL path to consume resources under the new API version.

Backwards-incompatible changes include:

• Removing a property from a request and/or response message.
• Changing the name of a property in a message.
• Adding a required parameter to a request message.
• Changing existing enumeration values.

New versions of the API will have full reference documentation and an upgrade guide.

The Buildium API uses API key’s client IDs and secrets to authenticate requests.

An API key client ID and secret must be passed in every request header using the following parameters:

• x-buildium-client-id
• x-buildium-client-secret

Failing to provide both of them in the request header will cause the API to return a 401 HTTP status code.

Note: We currently do not support enabling CORS to access the Buildium API due to the security and authentication mechanisms we have in place to protect your data. Buildium supports authentication through API keys passed in the headers of a request versus a more CORS supported authentication mechanism like oAuth. Our recommendation is to access the Buildium API using server to server communication versus browser to server communication for the safest implementation.

Rate limits help us ensure consistent and reliable performance for all users, even during peak loads. That’s why we limit clients to 10 concurrent requests per second.

If your request rate violates that limit, a response code of 429 is returned. Simply retry the request after a short interval (~200ms).

The query string for a request is limited to a maximum length of 4096 characters. If the query string exceeds this length, the API will return a 500 HTTP status code.

All top-level API resources support bulk fetches. For instance, you can retrieve all Associations. These resources also allow for filtering criteria. Each resource has descriptions of the filter criteria available.

In addition to filtering, our API gives you the ability to control the returned data’s pagination and the sort order.

Pagination

Endpoints that return result sets allow for pagination using limit and offset request parameters to reduce the amount of data returned.

The limit request parameter will cap the number of results that come back in the response. If you don't specify a limit value, a default of 50 results are returned. The maximum limit value is 1000. If a limit value is specified greater than 1000, it will be overridden to the default to 1000.

The offset request parameter indicates the record position within the resultset to start at when returning the results. The offset is zero-based and is inclusive. If no offset value is submitted it will default to 0.

The total resultset count is returned in the HTTP Header X-Total-Count

Pagination Example

As an example, let's say we make a request to retrieve all rental properties with no paging parameters. Our response indicates in the X-Total-Count header that there are 150 total rental properties. We want to get only the last 50 results so we would submit a request with the offset set to 100 and the limit set to 50.

Note: The limit and offset parameter names are case-sensitive. If they aren't formatted correctly, the API will return a 404 HTTP status code.

Sorting Results

You can specify the sort order of returned data by assigning any property from the returned object to the orderby parameter in the querystring. For example:

orderby=LeaseType

By default, the sort is performed in ascending order. To specify sort order, use "asc" for ascending or "desc" for descending. For example:

orderby=LeaseType desc

Additionally, you can sort by multiple properties by comma separating the properties. For example:

orderby=Rent desc,City asc

Note: While the orderby parameter is case-sensitive, the properties specified in the orderby value aren't.

The Buildium API supports standard HTTP status codes.

If you are unable to resolve your issue after reviewing the API documentation our support team can assist you. Please fill out the form below and let us know how we can help.

To assist your development efforts Buildium offers a free Sandbox account with your Premium subscription. A sandbox is a development environment that is separate from your production account. Sandboxes duplicate much of the same property management functionality available in your production account and all of the resources available in the Open API. The benefit of the sandbox is that it's isolated from your primary account. This separation ensures that API operations you perform against the sandbox account during development of your integration do not corrupt the data in your production account.

To help you hit the ground running with your development efforts sandbox accounts are provisioned with realistic sample data. This ensures you have data to work with immediately and won’t have to spend time doing data entry. You always have the ability to add more data through the application and the Buildium Open API.

To create a sandbox account follow the steps below.

1. Sign in to your Buildium account from your browser.

2. Open the Settings menu and click Developer Tools.

3. Click the API Sandbox tab.

4. Click the Create sandbox button. A modal will appear.

5. Enter the name and email of the person that will be administering the sandbox account. When the sandbox creation process has completed an email will be sent to the email address submitted. This email will provide a link to the sandbox. After all fields have been filled out, click Create.

6. The provisioning process will now execute. It can take 2 - 3 minutes for the sandbox to be created. The page will automatically refresh with the provisioning status. When it completes you will see the sandbox status is Active along with details about the sandbox including the URL to the account. You can browse back to this page at any time if you need to look up the URL to the sandbox.

   
   

7. Once the sandbox has been created an email will be sent to the address you entered in the "Create sandbox" modal. To complete the activation of the sandbox open the email and click on the "Activate Account". This will allow you to create a password for your account and log into the sandbox.

8. You are now ready to begin making API requests to your sandbox! Please see Accessing the Sandbox for next steps on how to start making API requests.

Once your sandbox is created you can begin to access it through the Open API. Requests are made following all the same versioning, authentication, messages, etc that are used in the production environment with the exception of the base URL. The base URL for the sandbox is:
https://apisandbox.buildium.com/

You can read more about connecting to the API in the API Overview section.

Once you have completed your development and testing against the sandbox and you're ready to start using the integration in your production account simply change the base URL in your integration to the production API URL.

The core Buildium functionality is available in the sandbox environment, however there are some restrictions which include:

1. Add-on services, ePay and other paid services will not be available.
2. A maximum of 1500 units (rentals and associations) can be created within the sandbox.
3. A maximum of 50 rental tenants per lease can be created within the sandbox.
4. Communication emails will not be sent out. This protects you from inadvertently sending emails to your test accounts.

How many sandboxes can I create?

The Premium subscription plan allows you to create one sandbox.

Can I use my production keys to access my sandbox?

No. To ensure you are accessing the correct environment the API keys are restricted to the environment they were created in.

What is the throttle limit on requests to the sandbox?

A sandbox account is limited to 10 concurrent requests per second.

Can I reset sandbox data to its original state?

Resetting sandbox data is not supported at this time.

Can I delete a sandbox?

You cannot delete a sandbox at this time. Closing your account or changing subscription plans will delete your sandbox and it will be no longer accessible.

Can I delete the sandbox data?

Yes, you can manually delete records by logging into the web application.

Why do I see an error when I try to access add-on functionality like ePayments?

Certain functionality is restricted in the sandbox environment. Please see Sandbox Account Restrictions for an overview of these limitations.

Buildium webhooks allow your remote applications to listen for events within your Buildium account and react to those events in near real-time!

To implement webhooks you need to register a callback URL to your web server for the events you want to capture. Then Builidum will send notifications to that URL when the events occur making syncing data and automating workflows a breeze.

As an example, let’s say you’ve registered a callback to your application to receive “Lease Created” events. When a user within your Buildium account creates a new lease then a webhook callback from Buildium informs your app about this new lease. After your application receives the event it can then execute actions such as creating tasks to clean the apartment and change the locks.

Another advantage of using webhooks is that they allow your applications to respond to events in Buildium in near real time. Having events pushed to your platform as they happen is like calling the API every second to ask “Was a lease created”?

The diagram below illustrates how your application would integrate with Buildium webhooks.

Event notifications are Buildium’s way of letting you know when something interesting happens in your account. When a subscribed event occurs a new Event object is created and sent to your endpoint as part of a HTTPS POST request.

Event objects are simple data structures with fields that describe the entity and the event that occurred. The object will have the following fields:

Here is an example of an Event object, serialized as JSON, when a rental property has been updated:

{
"EventName": "Rental.Updated",
"EventDateTime": "2022-05-10T15:12:46.2317653Z",
"AccountId": 123456,
"PropertyId": 23
}

Note that the EventName is a constant value that can be used to determine the entity and the operation that triggered the event. This value is concatenation of the entity name and operation separated by a period. For example, if a rental property was updated the EventName value would be: Rental.Updated.

The event identifiers included in the Event object will provide the data necessary to query the Buildium Open API and retrieve the full entity.

The Webhook Events section below lists all of the available entities and their corresponding events that can be subscribed to. The grid also includes the EventName constants and sample JSON for each entity.

To take advantage of webhooks you’ll need to establish an endpoint that our Buildium servers can make a request to whenever the data you’re interested in changes. You can use one endpoint to handle several different event types at once or set up individual endpoints for specific events.

Your endpoint must be implemented to support the following:

• HTTPS protocol
• Be publicly available
• POST requests that consist of a JSON formatted payload sent as raw body type and a Content-Type of application/json.

When receiving webhook callbacks it is important that your endpoint responds promptly. If Buildium doesn’t receive a response within 10 seconds the callback is considered unsuccessful. As a best practice your endpoint should return a response prior to executing any complex logic to ensure a response within the 10 second duration. Any HTTP response code from your endpoint other than a 2XX is also considered an unsuccessful request. Buildium will retry unsuccessful events on the following intervals:

1. 1 minute
2. 10 minutes
3. 1 hour

If a callback for an event is unsuccessful after all three attempts Buildium will stop attempting to send the event message.

The webhook subscription will be suspended if there 20 consecutive failed attempts to send events to the URL. Upon suspension an email will be sent notifying you that the subscription has been paused. You can troubleshoot issues and enable the webhook by browsing to Settings > Developer Tools > Webhooks. The email is sent to the contact email address that is set when the webhook subscription is created or updated.

As you develop the callback endpoint you can use the JSON examples found in the webhook event grid to generate the mock payloads for testing. Once you are able to successfully receive the event callback you should implement a signature check to ensure the authenticity of of the request.

Signature Checks

It is strongly recommended that you validate webhook event signatures in your application to ensure that the request came from Buildium and not a bad actor attempting to impersonate Buildium, alter event messages after they have been sent, or perform replay attacks. While validating the request isn’t required to read the payload, it is strongly recommended to ensure the authenticity of the request and ensure the overall security and data integrity of your application.

All webhook callback requests include the signature and a timestamp in the HTTP headers.

The signature is a concatenation of the timestamp value and the event message hashed by a secret key. The secret key is generated for you when creating webhook subscriptions. It is important to keep this key stored safely as you would with any other credentials.

The following steps outline how to use the secret key, the event message and the HTTP header values to verify the request:

1. Concatenate the value of the buildium-webhook-timestamp header with the body of the event with a period character in between the two values. The body of the event must have all newlines removed and not contain spaces after the colon between property names and values. For example

   {
     "EventName": "Rental.Created",
     "EventDateTime": "2022-12-22T16:18:20.876772Z",
     "AccountId": 123456,
     "PropertyId": 78910
   }
   

   would be passed into your verification method as:

   {"EventName":"Rental.Created","EventDateTime":"2022-12-22T16:18:20.876772Z","AccountId":123456,"PropertyId":78910}
   

2. Hash the concatenated string using the HMACSHA256 algorithm setting the webhook secret key as the algorithm key.
3. Convert the resulting hash bytes to a base64 string.
4. Compare the base64 string to the value of the buildium-webhook-signature header. If the values match with a case sensitive comparison, the message has been validated to have come from Buildium.

Sample Validation Code (C#)

private static bool ClientSideValidate(
string eventNotificationMessage, 
string timestamp, 
string signature)
{
   var signedPayload = $"{timestamp}.{eventNotificationMessage}";
   var hasher = new HMACSHA256(Encoding.UTF8.GetBytes(m_secretKey));
   var computedHash = hasher.ComputeHash(Encoding.UTF8.GetBytes(signedPayload));
   var computedHashString = Convert.ToBase64String(computedHash);

   return computedHashString.Equals(signature);
}

Once you’ve successfully validated the message you can begin to process it with confidence it came from the Buildium platform and has not been altered after it has been sent.

To test your validation logic you can generate requests to your URL with headers you generate using the similar logic you created for validating the values.

Once your endpoint is ready to be tested end to end you will need to create a webhook subscription in your Buildium account. The subscription can be created by browsing to Settings > Developer Tools > Webhooks and then clicking the “Add webhook” button.

Once you’ve configured a new webhook, events will be sent to your endpoint as they are triggered within the account. So all you have to do is execute the action you want to test. You can expect webhook callbacks to your endpoint to fire within a few seconds to a few minutes from the event occurring in the Buildium platform. To determine if the events have been sent and/or see the resulting response from your platform you can view the webhook subscription event history page.

We strongly suggest you test your webhooks in your Buildium API sandbox account to ensure you don’t corrupt data in your production account. Once the integration is fully tested you can register the webhook in your production account.

NOTE: Due to our current security policies we do not support webhook callbacks to the Ngrok platform. We understand Ngrok can be useful for testing local webhook development and we hope to be able to support that platform safely and securely soon. In the meantime, we recommend using other websites and tools that can capture the webhook event HTTP request payload and headers and replay it manually on your local machine with a tool such as Postman.

• Be sure to validate the signature on all incoming requests and consider rolling your secret keys on a regular basis. A new secret key can be generated by clicking the "Generate key" link next to the current secret key value when updating the webhook subscription.
• Your webhook endpoints should be configured to receive only the types of events required by your integration. Listening for extra events (or all events) will put undue strain on your server and is not recommended.
• Be sure your platform can handle duplicate events correctly. We do our best to ensure an event is only sent one time, but due to the distributed nature of the process we can not make any guarantees. We advise you to guard against duplicated event receipts by making your event processing idempotent. One way of doing this is logging the events you’ve processed, and then not processing already-logged events.
• Buildium does not guarantee delivery of events in the order in which they are generated within the platform. For example, creating a lease might generate the following events - Lease.Created, Tenant.Created. Your endpoint shouldn’t expect delivery of these events in this order and should handle this accordingly. You can use the API to fetch any missing data. For example, you can fetch the lease resource using the information from tenant if you happen to receive that event first.

The grid below details the available webhooks events along with their EventName and JSON message schema.

2024-11-19

API Updates

• Partial payment setting resources have been released:
  • Retrieve the partial payment settings for residents
  • Retrieve all partial payment settings for a lease
  • Retrieve all partial payment settings for an ownership account
  • Update the partial payment settings for residents
  • Update partial payment settings for a lease
  • Update partial payment settings for an ownership account
• Multiple work orders can now be created for the same task, when creating a work order
• Title, DueDate, Priority, and Status are now supported fields for work orders. These values can be retrieved, created, or updated for the following endpoints:
  • Retrieve all work orders
  • Create a work order
  • Update a work order
  • Retrieve a work order
• Multiple entry contact users are now retrieved, created, or updated via the EntryContacts property for the following endpoints:
  • Create a work order
  • Update a work order
  • Retrieve a work order
• When retrieving work orders, using the statuses, duedatefrom, duedateto, priorities, or title query parameters will now search against the new work order fields, rather than the task fields.
• FirstOccurrenceDate has been added to recurring transaction resources:
  • Retrieve all recurring transactions for a lease
  • Retrieve all recurring transactions for an ownership account

2024-09-17

API Updates

• BillId can optionally be provided to the Lease Ledger's Create a charge or the Ownership Account's Ledger to tie a charge to a bill.
• Read endpoints for lease and ownership account ledger charges have been released:
  • Lease Ledger's Retrieve all charges
  • Lease Ledger's Retrieve a charge
  • Ownership Account Ledger's Retrieve all charges
  • Ownership Account Ledger's Retrieve a charge

2024-08-20

API Updates

• Accounts receivable, accounts payable, undeposited funds, and bank account ids can no longer be used in lines when creating or updating checks. Doing so will result in a 422 Unprocessible Entity result.
• The following template ids can no longer be used when sending an email. Doing so will result in a 422 Unprocessible Entity result.
  • 1 (Tenant Statement)
  • 2 (Homeowner Statement)
  • 3 (Rental Owner Statement)
  • 123 (Association Tenant Invoice)
  • 124 (Rental Tenant Invoice)
• UnitIds is available as a filter option for retrieving all tenants.
• LastUpdatedDateTime has been added to applicant resources.
• LastUpdatedFrom and LastUpdatedTo are available as filter options for retrieving all applicants.
• PrimaryAddress, AlternateAddress, and MailingPreference have been added to association owner resources when retrieving all association lockbox data.

2024-07-16

API Updates

• The ability to retrieve and create architectural requests for associations has been released:
  • Retrieve all architectural requests
  • Create an architectural request
  • Retrieve an architectural request
  • Retrieve all files for an architectural request
  • Upload an architectural request file
  • Retrieve an architectural request file
  • Download an architectural request file

2024-06-18

API Updates

• AggregateBalancesByUnitId has been added to the request parameters on the retrieve all general ledger account balances to breakdown balances per unit.

2024-05-21

Webhook Updates

• New webhook events have been added for the following resource:
  • Task history

2024-04-23

API Updates

• UserType has been added to the CreatedByUser and LastUpdatedByUser properties for task history resources.

2024-04-16

API Updates

• General ledger transaction resources can now be filtered by LastUpdatedFrom and LastUpdatedTo.
• LastUpdatedDateTime has been added to general ledger transaction resources.
• The ability to update a deposit withholding has been released.
  • Update a deposit withholding for a lease
  • Update a deposit withholding for an ownership account
• We have released our first PATCH endpoint! PATCH allows for partial updates of resources without having to provide an entire resource representation in a PUT.
  • Our first PATCH endpoint provides the ability to Update a bill.

2024-03-19

API Updates

• The ability to create and update rent schedules been released:
  • Create a rent schedule
  • Update a rent schedule
• Reconciliation resources have been released:
  • Retrieve all reconciliations
  • Retrieve a reconciliation
  • Retrieve all transactions for a reconciliation
  • Retrieve a reconciliation's balance
  • Create a reconciliation
  • Update a reconciliation
  • Update a reconciliation's balance
  • Finalize a manual reconciliation
  • Clear transactions for a reconciliation
  • Un-clear transactions for a reconciliation
• General ledger transactions results can now be filtered by unit through the selectionentityunitid field:
  • Retrieve all general ledger transactions

2024-02-20

API Updates

• Meter reading resources and webhook events have been released:
  • Delete meter reading details for an association and date
  • Delete meter reading details for a rental and date
  • Retrieve all meter reading details for an association
  • Retrieve all meter reading details for a rental
  • Retrieve all meter readings for an association
  • Retrieve all meter readings for a rental
  • Create/Update meter reading details for a rental
  • Create/Update meter reading details for an association

2024-01-23

API Updates

• Unit level accounting changes have been released:
  • UnitId has been added, as optional, to the AccountingEntity property for accounting transactions request resources.
  • Unit has been added to the AccountingEntity property for accounting transactions response resources.
  • As part of those changes listed above, the following endpoints have been updated:
    • Create a check
    • Update a check
    • Retrieve a check
    • Retrieve all checks
    • Create a deposit
    • Update a deposit
    • Retrieve a deposit
    • Retrieve all deposits
    • Create a quick deposit
    • Update a quick deposit
    • Retrieve a quick deposit
    • Retrieve all quick deposits
    • Create a bill
    • Update a bill
    • Retrieve a bill
    • Retrieve all bills
    • Create a bill payment
    • Retrieve a bill payment
    • Retrieve all bill payments
    • Create a withdrawal
    • Update a withdrawal
    • Retrieve a withdrawal
    • Retrieve all withdrawals
    • Create a transfer
    • Update a transfer
    • Retrieve a transfer
    • Retrieve all transfers
    • Create a credit
    • Retrieve a credit
    • Create a refund
    • Retrieve a refund
    • Create a general journal entry
    • Update a general journal entry
    • Retrieve a general ledger transaction
    • Retrieve all general ledger transactions
    • Retrieve all general ledger entries
  • UnitId has been added to the Lines property for lease accounting transactions response resources.
    • Retrieve all lease transactions
    • Retrieve a lease transaction
    • Create a charge
    • Update a charge
    • Create a payment
    • Create a payment (auto allocated)
    • Create a payment reversal
    • Create a credit
    • Create a deposit withholding
• Requests to create a deposit that contain payment ids that do not exist or have already been deposited will include those payment ids in the error response.
• The ability to update a ledger payment has been released for leases and ownership accounts.

2023-12-12

API Updates

• File sharing resources have been released:
  • Retrieve a file's share settings
  • Update a file's share settings
• TransactionTypeEnum has been added as a property to lease and ownership account transaction response resources.
• MoveInDate has been added as a property to each resource in the Tenants property of a lease resource.

2023-11-14

API Updates

• The ability to set sharing options while creating a resident request task has been released.
• AccountNumberUnmasked has been added as a property to bank account response resources.
• DelinquencyStatus has been added as a property to each Ownership Account in the response for association lockbox data response resources.

2023-10-17

API Updates

• Check files endpoints have been released:
  • Retrieve all files for a check
  • Retrieve a file for a check
  • Download a file for a check
  • Upload a file for a check
  • Delete a file for a check
• The ability to create a payment for multiple bills with one check has been released.

2023-09-19

API Updates

• Lease ePay settings endpoints have been released:
  • Retrieve ePay settings for a lease
  • Update ePay settings for a lease
• The ability to filter ownership accounts and associations by ids has been released.

2023-08-16

API Updates

• Rental owner contribution request endpoints have been released:
  • Retrieve contribution details included for a rental owner contribution request
  • Update contribution details included for a rental owner contribution request
• The ability to retrieve all association bank lockbox data has been released.
• The ability to create payments using configured allocation settings have been released:
  • Create a lease ledger payment with automatic allocations
  • Create an ownership account ledger payment with automatic allocations
• Budget resources will now round values within the MonthlyAmounts collection to two decimal places.

2023-07-18

API Updates

• The ability to retrieve all general ledger entries has been released.
• Retail cash user endpoints have been released:
  • Retrieve all retail cash users
  • Retrieve a retail cash user
  • Update a retail cash user
• TaxInformation has been added as a property to Association response resources.
• TaxInformation has been added as an optional property when creating an association.

Webhook Updates

• New webhook events have been added for the following resources:
  • Vendor transactions

2023-06-20

API Updates

• The ability to retrieve all lease renewals has been released.
• Image management endpoints have been released:
  • Retrieve images for rentals and rental units
  • Retrieve an image for rentals and rental units
  • Update an image for rentals and rental units
  • Delete an image for rentals and rental units
  • Reorder images for rentals and rental units
  • Upload photos for rentals and rental units
  • Create images using video links for rentals and rental units
  • Download an image for rentals and rental units

2023-05-16

API Updates

• TenantIds and ApplicantIds can optionally be provided to the create a lease endpoint.
• The Lines property for recurring charge transactions is now populated on the following endpoints:
  • Retrieve all recurring transactions for a lease
  • Retrieve all recurring transactions for an ownership account
• EPay settings endpoints have been released:
  • Retrieve EPay settings for a rental
  • Update EPay settings for a rental
  • Retrieve EPay settings for an association
  • Update EPay settings for an association
• The ability to inactivate or reactivate rentals and associations have been released:
  • Inactivate a rental
  • Reactivate a rental
  • Inactivate an association
  • Reactivate an association
• Renters insurance endpoints have been released:
  • Retrieve all renters insurance policies
  • Retrieve a renters insurance policy
• Applicant Status has been added to the response for the following endpoints:
  • Retrieve all applicants
  • Retrieve an applicant
  • Create an applicant

2023-04-18

API Updates

• The ability to retrieve accounting lock periods has been released:
  • Retrieve accounting lock periods
• Email related endpoints have been released:
  • Retrieve all emails
  • Retrieve an email
  • Create an email
  • Retrieve all email recipients
  • Retrieve all communication templates
  • Retrieve a communication template
• The ability to retrieve resident center users has been released:
  • Retrieve all resident center users
• Vendor transaction related endpoints have been released:
  • Create a credit
  • Retrieve a credit
  • Create a refund
  • Retrieve a refund
• Lease and ownership account deposit and charge related endpoints have been released:
  • Create an ownership account deposit withholding
  • Update an ownership account charge
  • Create a lease deposit withholding
  • Update a lease charge
• The create a lease endpoint now includes the ability to provide amounts for ProratedFirstMonthRent and ProratedLastMonthRent.

2023-03-21

API Updates

• Property groups related endpoints have been released:
  • Retrieve all property groups
  • Retrieve a property group
  • Create a property group
  • Update a property group
• Bill files related endpoints have been released:
  • Retrieve all files for a bill
  • Retrieve a file for a bill
  • Upload a bill file
  • Download a bill file
  • Delete a bill file
• Bill payment creation has been released:
  • Create a bill payment
• Bills can now be filtered by approval statuses:
  • Retrieve all bills
• The bill message now includes an ApprovalStatus field.
• The lease message now includes a Tenants collection, which includes the Id and Status of all tenants that have ever been associated with the lease.
• The create a property now includes an optional Units field for providing unit information for the rental property being created.

2023-02-21

API Updates

• Lease renewal related endpoints have been released:
  • Retrieve all lease renewals
  • Retrieve a lease renewal
  • Create a lease renewal

2022-12-13

API Updates

• Accounting related endpoints have been released:
  • Create a general ledger account
  • Update a general ledger account
• The general ledger account message will now include DefaultAccountName and ParentGLAccountId.
• Filtering by last updated date and time capabilities have been released for the following endpoint:
  • Retrieve all leases
• The lease message will now include LastUpdatedDateTime.

2022-11-15

API Updates

• Endpoints for announcements have been released:
  • Retrieve all announcements
  • Retrieve an announcement
  • Retrieve all announcement properties
  • Create an announcement
  • Expire an announcement
• The create an owner endpoint now accepts optional tax information.
• The retrieve all owners and retrieve an owner endpoints now return tax information.

2022-10-18

API Updates

• Task history related endpoints have been released! You can now retrieve and update task history notes as well as upload and download task history file attachments.
  • Retrieve all task history
  • Retrieve a task history
  • Update a task history
  • Retrieve task history file meta data
  • Upload a task history file
  • Download a task history file
  • Delete a task history file

Webhook Updates

• New webhook events have been added for the following resources:
  • Bank Accounts
  • Bank Account Transactions
  • Bills
  • Bill Payments
  • Budgets
  • General Ledger Accounts
  • Phone logs

2022-09-20

API Updates

• Accounting related endpoints have been released:
  • Create a general journal entry
  • Update a general journal entry
  • Retrieve a lease ledger refund
  • Create a lease ledger refund
  • Retrieve an ownership account refund
  • Create and ownership account refund

Webhook Updates

• Webhooks have been released! Please refer to the Webhooks section of the documentation for more details.

2022-08-16

API Updates

• The retrieve account info endpoint now includes Id and Url fields.
• Endpoints for recurring transactions have been released for leases:
  • Retrieve all recurring transactions
  • Retrieve a recurring charge
  • Create a recurring charge
  • Retrieve a recurring payment
  • Create a recurring payment
  • Retrieve a recurring credit
  • Create a recurring credit
• Endpoints for recurring transactions have been released for ownership accounts:
  • Retrieve all recurring transactions
  • Retrieve a recurring charge
  • Create a recurring charge
  • Retrieve a recurring payment
  • Create a recurring payment
  • Retrieve a recurring credit
  • Create a recurring credit
• The Create Resident Requests endpoint now supports IsEntryPermittedByResident, DoesResidentHavePets, and ResidentEntryNotes as optional inputs.

2022-07-19

API Updates

• The general ledger account message will now include the account's status. This value comes back in a property named IsActive on the following endpoints:
  • Retrieve all bills
  • Create a bill
  • Retrieve a bill
  • Update a bill
  • Retrieve all general ledger transactions
  • Retrieve a general ledger transaction
  • Retrieve all general ledger accounts
  • Retrieve a general ledger account
  • Retrieve all general ledger account balances
  • Retrieve all bank accounts
  • Create a bank account
  • Retrieve a bank account
  • Update a bank account
  • Retrieve a transfer
  • Create a ledger charge
  • Create a ledger credit
  • Create a ledger payment
  • Retrieve ownership account transactions
  • Retrieve an ownership account transaction
  • Create a charge
  • Create a credit
  • Create a payment
  • Create a payment reversal
  • Retrieve all lease transactions
  • Retrieve a lease transaction
• Filtering by last updated date and time capabilities have been released for the following endpoint:
  • Retrieve all vendors

2022-06-14

API Updates

• Budgets capabilities have been released including:
  • The ability to retrieve all budgets
  • The ability to retrieve a budget
  • The ability to create a budget
  • The ability to update a budget

2022-05-24

API Updates

• When creating a resident request, if AssignedToUserId is not provided, assignment rules in the resident center settings (if configured) will be used for assignment.
• Filtering by last updated date and time capabilities have been released for the following endpoints:
  • Associations
  • Association units
  • Association owners
  • Association tenants
  • Rental properties
  • Rental units
  • Rental owners
  • Rental tenants

2022-04-19

API Updates

• Preferred vendor capabilities have been released including:
  • The ability to retrieve and update preferred vendors for associations.
  • The ability to retrieve and update preferred vendors for rental properties.

2022-03-22

API Updates

• Association owners, association tenants and board members are now filterable by their created date and time.
• Appliance information and service history is now available for associations and rental properties.
• Lease rent schedules are now available.

2022-02-15

API Updates

• Additional rental data is now available including:
  • The ability to retrieve and update rental amenities for properties and units.
  • The ability to retrieve, create and delete lease move out dates.
  • The ability to create a payment reversal.
• Additional applicant capabilities are available including:
  • The ability to retrieve and create applicant notes.
  • When an applicant is converted to a tenant a new TenantId field on the applicant message will link the two resources.
  • The ability to filter the Retrieve all Applicants endpoint by email address.
• The ability to retrieve file metadata as well as upload and download files related to the following resources - Accounts, Associations, Association Owners, Association Units, Leases, Ownership Accounts, Public Assets, Rentals, Rental Owners, RentalUnits, Tenants and Vendors.

2022-01-18

API Updates

• Additional association data is now available including:
  • The ability retrieve, create and delete association board members.
  • Association fiscal month and day can now be retrieved and updated as part of the Association endpoints.
  • Staff members can now be assigned as the association manager for a given association.
• Additional association owner data is now available including:
  • Association owner occupancy status can be retrieved and updated.
  • Association owner tax payer identification number can be retrieved and updated as part of the association owner endpoints.
  • The date and time the association owner record was created is now being returned in the response payload.
• Additional association tenant features are now available including:
  • The ability to set the move out date.
  • The date and time the association tenant record was created is now being returned in the response payload.
• Updating bills now includes the ability to edit line items.
• The ability to retrieve client leads has been introduced. Note, this data is only available if you have an All Property Management account.

2021-12-14

API Updates

• Additional bank account endpoints have been added to retrieve, create and update bank accounts and bank account transactions.

2021-11-16

API Updates

• The URL to the rental application for listings is now being returned in a new property called RentalApplicationUrl. This new property is included in the following endpoints:
  • Retrieve all listings
  • Retrieve a listing
  • Create a listing
• AssignedToUserId is no longer required as input for the following endpoints:
  • Create a rental owner request
  • Update a rental owner request
  • Create a resident request
  • Update a resident request
• Ability to retrieve a single association ownership account transaction has been released:
  • Retrieve a single ownership account transaction

2021-10-19

API Updates

• The taxpayer identifier for rental tenants is now being returned in a new property named TaxId. This new property is included in the following endpoints:
  • Retrieve all tenants
  • Retrieve a tenant
  • Create a rental tenant
  • Update a rental tenant
  • Retrieve all leases
  • Retrieve a lease
  • Create a lease
  • Update a lease
• The lease message has been updated to include the day of the month the tenant payments are due. This value comes back in a property named PaymentDueDay on the following the following endpoints:
  • Retrieve all leases
  • Retrieve a lease
  • Create a lease
  • Update a lease
• Rental and association messages will now include the operating bank account identifier. This value comes back in a new property named OperatingBankAccountId on the following endpoints:
  • Retrieve all associations
  • Retrieve an association
  • Create an association
  • Update an association
  • Retrieve all rental properties
  • Retrieve a rental property
  • Create a rental property
  • Update a rental property

2021-09-21

API Updates

• Outstanding balance resource capabilities have been released. Outstanding balances can be retrieved for the following resources:
  • Leases
  • Ownership Accounts
• Work order id will be returned on bills, and is an optional input for creating a bill:
  • Retrieve all bills
  • Retrieve a bill
  • Create a bill

2021-08-24

API Updates

• Note read and write capabilities have been released. Notes can be retrieved, created, updated for the following resources:
  • Rentals - properties, units, owners, leases and tenants
  • Associations - properties, units, owners, ownership accounts and tenants
  • Vendors
  • Applicant Groups

2021-07-20

API Updates

• Rental applicant, applicant groups and application write capabilities have been released. These new endpoints will support creating and updating rental applicants and applicant groups as well as enabling the updating of rental application statuses.
  • Create an Applicant Group
  • Update an Applicant Group
  • Create an Applicant
  • Update an Applicant
  • Update an Application

2021-06-22

API Updates

• Bill and bill payment resources have been released. These new endpoints will support retrieve, create and update functionality for bills and retrieve functionality for bill payments. Creating and updating bill payments will be available in a future release.
  • Retrieve bills
  • Create a bill
  • Update a bill
  • Retrieve bill payments
• Rental applicant, applicant groups and application read capabilities have been released. These new endpoints will support retrieving rental applicants, applicant groups and their rental applications. Creating and updating applicants and applicant groups will be available in a future release.
  • Retrieve Applicant Groups
  • Retrieve Applicants
  • Retrieve Applications
• Rental leases can now be filtered by the date and time they were created. The lease created date and time are also being returned as part of the lease response message.
  • Retrieve all leases

2021-05-18

API Updates

• Work order resources have been released. These new endpoints will support retrieve, create and update functionality for work orders. Review the Work Order documentation for more information.
• Create capabilities have been released for association ownership account and rental lease ledger transactions. These new endpoints will allow for the creation of ledger charges, payments and credits.
  • Create Rental Lease Ledger Payments
  • Create Rental Lease Ledger Credits
  • Create Association Ownership Account Ledger Charges
  • Create Association Ownership Account Ledger Payments
  • Create Association Ownership Account Ledger Credits

2021-04-20

API Updates

• Task resources have been released. These new endpoints will support retrieve, create and update functionality for all task request types. Review the Tasks documentation for more information.
• Vendor create and update capabilities have been released. These new endpoints will support creating and updating vendors.
  • Create Vendors
  • Update Vendors

2021-02-16

API Updates

• Phone log resources have been released. These new endpoints will support create, update and retrieve functionality for phone logs.
• Enhancements to the leases resource have been released. These new endpoints will support create and update functionality for leases.
• Ability to filter by phone has been released for the following:
  • Rental Owners
  • Vendors

2020-12-15

API Updates

• Rental listing resources have been released. These new endpoints will support create and retrieve functionality for:
  • Listing Contacts
  • Listings

2020-11-17

API Updates

• Create capabilities have been released for the following resources:
  • Rental Tenants
  • Association Ownership Accounts
  • Association Owners
• Update capabilities have been released for the following resources:
  • Rental Tenants
  • Association Owners
• Retrieve all Association Owners and Association Tenants can now be filtered by statuses: Active, Past and Future.
• The rental tenant message now returns the following properties:
  • AlternateEmail
  • Comment
  • MailingPreference
• The rental property message now includes the following properties:
  • OperatingBankAccountId
  • Reserve
• The Association Ownership Account message now includes AssociationOwnerIds which is a list of all of the association owner identifiers that belong to the ownership account.

2020-10-20

API Updates

• Create capabilities have been released for the following resources:
  • Rental Properties
  • Rental Owners
  • Rental Units
  • Asssociation Properties
  • Asssociation Units
  • Asssociation Tenants
• Update capabilities have been released for the following resources:
  • Rental Properties
  • Rental Owners
  • Rental Units
  • Asssociation Properties
  • Asssociation Units
  • Asssociation Tenants

Feature Enhancements

• Sandbox environments can now be created for developing and testing your integrations. Learn more about how to take advantage of this new capability in the API Sandbox section of the documentation.

2020-09-15

API Updates

• General ledger account balances are now available through the Retrieve all general ledger account balances endpoint. This new endpoint provides the ability to retrieve the general ledger account balances as of a given date.

2020-08-18

API Updates

• General ledger transactions are now available through the Retrieve all general ledger transactions endpoint. These new endpoints provide the ability to retrieve all transactions or use a set of filters including specific rental/association properties, rental owners, date ranges, and others to find specific transactions.

2020-07-21

API Updates

• Association Owners response message now returns board member terms including the start date, end date and position.
• Two new resources were added to retrieve Users and User Roles.
• The general ledger response message now includes the property IsBankAccount. This is a boolean property that indicates whether the general ledger account is also a bank account.
• A Country property has been added to all Address messages. This property contains an enumeration indicating the country of the address.

Bank account resources provide access to bank accounts.